From 158fd7177686634e2086dd404aa8ce3c78869a56 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 25 Feb 2025 07:08:16 +0000 Subject: [PATCH 01/36] feat(aiplatform): update the api #### aiplatform:v1 The following keys were added: - resources.projects.resources.locations.methods.evaluateDataset (Total Keys: 12) - schemas.GoogleCloudAiplatformV1EvaluateDatasetRequest (Total Keys: 7) - schemas.GoogleCloudAiplatformV1EvaluationDataset (Total Keys: 4) - schemas.GoogleCloudAiplatformV1Metric (Total Keys: 9) - schemas.GoogleCloudAiplatformV1ModelVersionCheckpoint.properties.name.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1OutputConfig (Total Keys: 3) #### aiplatform:v1beta1 The following keys were deleted: - schemas.GoogleCloudAiplatformV1beta1GenerationConfig.properties.thinkingConfig.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig (Total Keys: 3) - schemas.GoogleCloudAiplatformV1beta1MachineSpec.properties.multihostGpuNodeCount (Total Keys: 2) The following keys were added: - resources.projects.resources.locations.methods.evaluateDataset (Total Keys: 12) - schemas.GoogleCloudAiplatformV1beta1EvaluateDatasetRequest (Total Keys: 7) - schemas.GoogleCloudAiplatformV1beta1EvaluationDataset (Total Keys: 4) - schemas.GoogleCloudAiplatformV1beta1Metric (Total Keys: 9) - schemas.GoogleCloudAiplatformV1beta1ModelVersionCheckpoint.properties.name.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1OutputConfig (Total Keys: 3) --- ..._v1.projects.locations.cachedContents.html | 12 +- ...cts.locations.deploymentResourcePools.html | 54 ++--- ...tform_v1.projects.locations.endpoints.html | 112 +++++------ ...ions.featureOnlineStores.featureViews.html | 16 +- .../dyn/aiplatform_v1.projects.locations.html | 91 +++++++++ ..._v1.projects.locations.indexEndpoints.html | 98 ++++----- ...platform_v1.projects.locations.models.html | 3 +- docs/dyn/aiplatform_v1.publishers.models.html | 28 +-- docs/dyn/aiplatform_v1beta1.endpoints.html | 9 - ...rojects.locations.batchPredictionJobs.html | 4 - ...ta1.projects.locations.cachedContents.html | 12 +- ...v1beta1.projects.locations.customJobs.html | 4 - ...cts.locations.deploymentResourcePools.html | 59 +++--- ..._v1beta1.projects.locations.endpoints.html | 129 ++++++------ ...ions.featureOnlineStores.featureViews.html | 16 +- ...aiplatform_v1beta1.projects.locations.html | 104 +++++++++- ...ts.locations.hyperparameterTuningJobs.html | 4 - ...ta1.projects.locations.indexEndpoints.html | 105 +++++----- ...eta1.projects.locations.modelMonitors.html | 4 - ...ons.modelMonitors.modelMonitoringJobs.html | 4 - ...orm_v1beta1.projects.locations.models.html | 3 +- ...rm_v1beta1.projects.locations.nasJobs.html | 8 - ...jects.locations.notebookExecutionJobs.html | 3 - ...ts.locations.notebookRuntimeTemplates.html | 5 - ...1.projects.locations.notebookRuntimes.html | 3 - ...rojects.locations.persistentResources.html | 4 - ....projects.locations.publishers.models.html | 9 - ..._v1beta1.projects.locations.schedules.html | 12 -- .../aiplatform_v1beta1.publishers.models.html | 69 +++---- .../documents/aiplatform.v1.json | 166 +++++++++++++++- .../documents/aiplatform.v1beta1.json | 188 +++++++++++++++--- 31 files changed, 837 insertions(+), 501 deletions(-) diff --git a/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html b/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html index bfaa94d763c..cfd2e38e8c6 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html +++ b/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html @@ -158,7 +158,7 @@

Method Details

"createTime": "A String", # Output only. Creation time of the cache entry. "displayName": "A String", # Optional. Immutable. The user-generated meaningful display name of the cached content. "expireTime": "A String", # Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what was sent on input. - "model": "A String", # Immutable. The name of the publisher model to use for cached content. Format: projects/{project}/locations/{location}/publishers/{publisher}/models/{model} + "model": "A String", # Immutable. The name of the `Model` to use for cached content. Currently, only the published Gemini base models are supported, in form of projects/{PROJECT}/locations/{LOCATION}/publishers/google/models/{MODEL} "name": "A String", # Immutable. Identifier. The server-generated resource name of the cached content Format: projects/{project}/locations/{location}/cachedContents/{cached_content} "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. Input only. Immutable. Developer set system instruction. Currently, text only "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. @@ -398,7 +398,7 @@

Method Details

"createTime": "A String", # Output only. Creation time of the cache entry. "displayName": "A String", # Optional. Immutable. The user-generated meaningful display name of the cached content. "expireTime": "A String", # Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what was sent on input. - "model": "A String", # Immutable. The name of the publisher model to use for cached content. Format: projects/{project}/locations/{location}/publishers/{publisher}/models/{model} + "model": "A String", # Immutable. The name of the `Model` to use for cached content. Currently, only the published Gemini base models are supported, in form of projects/{PROJECT}/locations/{LOCATION}/publishers/google/models/{MODEL} "name": "A String", # Immutable. Identifier. The server-generated resource name of the cached content Format: projects/{project}/locations/{location}/cachedContents/{cached_content} "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. Input only. Immutable. Developer set system instruction. Currently, text only "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. @@ -663,7 +663,7 @@

Method Details

"createTime": "A String", # Output only. Creation time of the cache entry. "displayName": "A String", # Optional. Immutable. The user-generated meaningful display name of the cached content. "expireTime": "A String", # Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what was sent on input. - "model": "A String", # Immutable. The name of the publisher model to use for cached content. Format: projects/{project}/locations/{location}/publishers/{publisher}/models/{model} + "model": "A String", # Immutable. The name of the `Model` to use for cached content. Currently, only the published Gemini base models are supported, in form of projects/{PROJECT}/locations/{LOCATION}/publishers/google/models/{MODEL} "name": "A String", # Immutable. Identifier. The server-generated resource name of the cached content Format: projects/{project}/locations/{location}/cachedContents/{cached_content} "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. Input only. Immutable. Developer set system instruction. Currently, text only "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. @@ -914,7 +914,7 @@

Method Details

"createTime": "A String", # Output only. Creation time of the cache entry. "displayName": "A String", # Optional. Immutable. The user-generated meaningful display name of the cached content. "expireTime": "A String", # Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what was sent on input. - "model": "A String", # Immutable. The name of the publisher model to use for cached content. Format: projects/{project}/locations/{location}/publishers/{publisher}/models/{model} + "model": "A String", # Immutable. The name of the `Model` to use for cached content. Currently, only the published Gemini base models are supported, in form of projects/{PROJECT}/locations/{LOCATION}/publishers/google/models/{MODEL} "name": "A String", # Immutable. Identifier. The server-generated resource name of the cached content Format: projects/{project}/locations/{location}/cachedContents/{cached_content} "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. Input only. Immutable. Developer set system instruction. Currently, text only "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. @@ -1173,7 +1173,7 @@

Method Details

"createTime": "A String", # Output only. Creation time of the cache entry. "displayName": "A String", # Optional. Immutable. The user-generated meaningful display name of the cached content. "expireTime": "A String", # Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what was sent on input. - "model": "A String", # Immutable. The name of the publisher model to use for cached content. Format: projects/{project}/locations/{location}/publishers/{publisher}/models/{model} + "model": "A String", # Immutable. The name of the `Model` to use for cached content. Currently, only the published Gemini base models are supported, in form of projects/{PROJECT}/locations/{LOCATION}/publishers/google/models/{MODEL} "name": "A String", # Immutable. Identifier. The server-generated resource name of the cached content Format: projects/{project}/locations/{location}/cachedContents/{cached_content} "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. Input only. Immutable. Developer set system instruction. Currently, text only "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. @@ -1414,7 +1414,7 @@

Method Details

"createTime": "A String", # Output only. Creation time of the cache entry. "displayName": "A String", # Optional. Immutable. The user-generated meaningful display name of the cached content. "expireTime": "A String", # Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what was sent on input. - "model": "A String", # Immutable. The name of the publisher model to use for cached content. Format: projects/{project}/locations/{location}/publishers/{publisher}/models/{model} + "model": "A String", # Immutable. The name of the `Model` to use for cached content. Currently, only the published Gemini base models are supported, in form of projects/{PROJECT}/locations/{LOCATION}/publishers/google/models/{MODEL} "name": "A String", # Immutable. Identifier. The server-generated resource name of the cached content Format: projects/{project}/locations/{location}/cachedContents/{cached_content} "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. Input only. Immutable. Developer set system instruction. Currently, text only "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. diff --git a/docs/dyn/aiplatform_v1.projects.locations.deploymentResourcePools.html b/docs/dyn/aiplatform_v1.projects.locations.deploymentResourcePools.html index 42751df1e06..9153ee4fd9a 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.deploymentResourcePools.html +++ b/docs/dyn/aiplatform_v1.projects.locations.deploymentResourcePools.html @@ -124,14 +124,14 @@

Method Details

{ # Request message for CreateDeploymentResourcePool method. "deploymentResourcePool": { # A description of resources that can be shared by multiple DeployedModels, whose underlying specification consists of a DedicatedResources. # Required. The DeploymentResourcePool to create. "createTime": "A String", # Output only. Timestamp when this DeploymentResourcePool was created. - "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration. # Required. The underlying DedicatedResources that the DeploymentResourcePool uses. + "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # Required. The underlying DedicatedResources that the DeploymentResourcePool uses. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], - "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine used by the prediction. + "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. @@ -145,9 +145,9 @@

Method Details

}, "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1"). }, - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). - "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. - "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial model deployment/mutation is desired. If set, the model deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). + "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. + "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "disableContainerLogging": True or False, # If the DeploymentResourcePool is deployed with custom-trained Models or AutoML Tabular Models, the container(s) of the DeploymentResourcePool will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true. @@ -242,14 +242,14 @@

Method Details

{ # A description of resources that can be shared by multiple DeployedModels, whose underlying specification consists of a DedicatedResources. "createTime": "A String", # Output only. Timestamp when this DeploymentResourcePool was created. - "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration. # Required. The underlying DedicatedResources that the DeploymentResourcePool uses. + "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # Required. The underlying DedicatedResources that the DeploymentResourcePool uses. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], - "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine used by the prediction. + "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. @@ -263,9 +263,9 @@

Method Details

}, "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1"). }, - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). - "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. - "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial model deployment/mutation is desired. If set, the model deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). + "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. + "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "disableContainerLogging": True or False, # If the DeploymentResourcePool is deployed with custom-trained Models or AutoML Tabular Models, the container(s) of the DeploymentResourcePool will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true. @@ -299,14 +299,14 @@

Method Details

"deploymentResourcePools": [ # The DeploymentResourcePools from the specified location. { # A description of resources that can be shared by multiple DeployedModels, whose underlying specification consists of a DedicatedResources. "createTime": "A String", # Output only. Timestamp when this DeploymentResourcePool was created. - "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration. # Required. The underlying DedicatedResources that the DeploymentResourcePool uses. + "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # Required. The underlying DedicatedResources that the DeploymentResourcePool uses. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], - "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine used by the prediction. + "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. @@ -320,9 +320,9 @@

Method Details

}, "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1"). }, - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). - "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. - "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial model deployment/mutation is desired. If set, the model deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). + "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. + "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "disableContainerLogging": True or False, # If the DeploymentResourcePool is deployed with custom-trained Models or AutoML Tabular Models, the container(s) of the DeploymentResourcePool will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true. @@ -364,14 +364,14 @@

Method Details

{ # A description of resources that can be shared by multiple DeployedModels, whose underlying specification consists of a DedicatedResources. "createTime": "A String", # Output only. Timestamp when this DeploymentResourcePool was created. - "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration. # Required. The underlying DedicatedResources that the DeploymentResourcePool uses. + "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # Required. The underlying DedicatedResources that the DeploymentResourcePool uses. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], - "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine used by the prediction. + "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. @@ -385,9 +385,9 @@

Method Details

}, "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1"). }, - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). - "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. - "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial model deployment/mutation is desired. If set, the model deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). + "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. + "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "disableContainerLogging": True or False, # If the DeploymentResourcePool is deployed with custom-trained Models or AutoML Tabular Models, the container(s) of the DeploymentResourcePool will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true. @@ -456,18 +456,18 @@

Method Details

"deployedModels": [ # DEPRECATED Use deployed_model_refs instead. { # A deployment of a Model. Endpoints contain one or more DeployedModels. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. - "minReplicaCount": 42, # Immutable. The minimum number of replicas this DeployedModel will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. + "minReplicaCount": 42, # Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. }, "createTime": "A String", # Output only. Timestamp when the DeployedModel was created. - "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. + "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], - "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine used by the prediction. + "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. @@ -481,9 +481,9 @@

Method Details

}, "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1"). }, - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). - "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. - "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial model deployment/mutation is desired. If set, the model deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). + "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. + "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "disableContainerLogging": True or False, # For custom-trained Models and AutoML Tabular Models, the container of the DeployedModel instances will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true. diff --git a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html index b05ee597d83..0386d28a65f 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html +++ b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html @@ -570,18 +570,18 @@

Method Details

"deployedModels": [ # Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively. { # A deployment of a Model. Endpoints contain one or more DeployedModels. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. - "minReplicaCount": 42, # Immutable. The minimum number of replicas this DeployedModel will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. + "minReplicaCount": 42, # Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. }, "createTime": "A String", # Output only. Timestamp when the DeployedModel was created. - "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. + "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], - "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine used by the prediction. + "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. @@ -595,9 +595,9 @@

Method Details

}, "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1"). }, - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). - "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. - "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial model deployment/mutation is desired. If set, the model deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). + "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. + "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "disableContainerLogging": True or False, # For custom-trained Models and AutoML Tabular Models, the container of the DeployedModel instances will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true. @@ -862,18 +862,18 @@

Method Details

{ # Request message for EndpointService.DeployModel. "deployedModel": { # A deployment of a Model. Endpoints contain one or more DeployedModels. # Required. The DeployedModel to be created within the Endpoint. Note that Endpoint.traffic_split must be updated for the DeployedModel to start receiving traffic, either as part of this call, or via EndpointService.UpdateEndpoint. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. - "minReplicaCount": 42, # Immutable. The minimum number of replicas this DeployedModel will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. + "minReplicaCount": 42, # Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. }, "createTime": "A String", # Output only. Timestamp when the DeployedModel was created. - "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. + "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], - "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine used by the prediction. + "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. @@ -887,9 +887,9 @@

Method Details

}, "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1"). }, - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). - "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. - "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial model deployment/mutation is desired. If set, the model deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). + "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. + "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "disableContainerLogging": True or False, # For custom-trained Models and AutoML Tabular Models, the container of the DeployedModel instances will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true. @@ -1994,18 +1994,18 @@

Method Details

"deployedModels": [ # Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively. { # A deployment of a Model. Endpoints contain one or more DeployedModels. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. - "minReplicaCount": 42, # Immutable. The minimum number of replicas this DeployedModel will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. + "minReplicaCount": 42, # Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. }, "createTime": "A String", # Output only. Timestamp when the DeployedModel was created. - "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. + "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], - "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine used by the prediction. + "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. @@ -2019,9 +2019,9 @@

Method Details

}, "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1"). }, - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). - "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. - "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial model deployment/mutation is desired. If set, the model deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). + "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. + "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "disableContainerLogging": True or False, # For custom-trained Models and AutoML Tabular Models, the container of the DeployedModel instances will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true. @@ -2241,18 +2241,18 @@

Method Details

"deployedModels": [ # Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively. { # A deployment of a Model. Endpoints contain one or more DeployedModels. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. - "minReplicaCount": 42, # Immutable. The minimum number of replicas this DeployedModel will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. + "minReplicaCount": 42, # Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. }, "createTime": "A String", # Output only. Timestamp when the DeployedModel was created. - "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. + "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], - "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine used by the prediction. + "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. @@ -2266,9 +2266,9 @@

Method Details

}, "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1"). }, - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). - "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. - "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial model deployment/mutation is desired. If set, the model deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). + "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. + "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "disableContainerLogging": True or False, # For custom-trained Models and AutoML Tabular Models, the container of the DeployedModel instances will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true. @@ -2486,18 +2486,18 @@

Method Details

{ # Request message for EndpointService.MutateDeployedModel. "deployedModel": { # A deployment of a Model. Endpoints contain one or more DeployedModels. # Required. The DeployedModel to be mutated within the Endpoint. Only the following fields can be mutated: * `min_replica_count` in either DedicatedResources or AutomaticResources * `max_replica_count` in either DedicatedResources or AutomaticResources * autoscaling_metric_specs * `disable_container_logging` (v1 only) * `enable_container_logging` (v1beta1 only) "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. - "minReplicaCount": 42, # Immutable. The minimum number of replicas this DeployedModel will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. + "minReplicaCount": 42, # Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. }, "createTime": "A String", # Output only. Timestamp when the DeployedModel was created. - "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. + "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], - "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine used by the prediction. + "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. @@ -2511,9 +2511,9 @@

Method Details

}, "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1"). }, - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). - "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. - "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial model deployment/mutation is desired. If set, the model deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). + "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. + "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "disableContainerLogging": True or False, # For custom-trained Models and AutoML Tabular Models, the container of the DeployedModel instances will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true. @@ -2711,18 +2711,18 @@

Method Details

"deployedModels": [ # Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively. { # A deployment of a Model. Endpoints contain one or more DeployedModels. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. - "minReplicaCount": 42, # Immutable. The minimum number of replicas this DeployedModel will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. + "minReplicaCount": 42, # Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. }, "createTime": "A String", # Output only. Timestamp when the DeployedModel was created. - "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. + "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], - "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine used by the prediction. + "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. @@ -2736,9 +2736,9 @@

Method Details

}, "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1"). }, - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). - "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. - "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial model deployment/mutation is desired. If set, the model deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). + "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. + "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "disableContainerLogging": True or False, # For custom-trained Models and AutoML Tabular Models, the container of the DeployedModel instances will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true. @@ -2945,18 +2945,18 @@

Method Details

"deployedModels": [ # Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively. { # A deployment of a Model. Endpoints contain one or more DeployedModels. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. - "minReplicaCount": 42, # Immutable. The minimum number of replicas this DeployedModel will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. + "minReplicaCount": 42, # Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. }, "createTime": "A String", # Output only. Timestamp when the DeployedModel was created. - "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. + "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], - "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine used by the prediction. + "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. @@ -2970,9 +2970,9 @@

Method Details

}, "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1"). }, - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). - "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. - "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial model deployment/mutation is desired. If set, the model deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). + "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. + "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "disableContainerLogging": True or False, # For custom-trained Models and AutoML Tabular Models, the container of the DeployedModel instances will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true. @@ -4073,18 +4073,18 @@

Method Details

"deployedModels": [ # Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively. { # A deployment of a Model. Endpoints contain one or more DeployedModels. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. - "minReplicaCount": 42, # Immutable. The minimum number of replicas this DeployedModel will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. + "minReplicaCount": 42, # Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. }, "createTime": "A String", # Output only. Timestamp when the DeployedModel was created. - "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. + "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], - "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine used by the prediction. + "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. @@ -4098,9 +4098,9 @@

Method Details

}, "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1"). }, - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). - "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. - "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial model deployment/mutation is desired. If set, the model deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). + "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. + "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "disableContainerLogging": True or False, # For custom-trained Models and AutoML Tabular Models, the container of the DeployedModel instances will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true. diff --git a/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.featureViews.html b/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.featureViews.html index 7d639c227be..24e93572888 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.featureViews.html +++ b/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.featureViews.html @@ -178,8 +178,8 @@

Method Details

"name": "A String", # Identifier. Name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}` "optimizedConfig": { # Configuration for FeatureViews created in Optimized FeatureOnlineStore. # Optional. Configuration for FeatureView created under Optimized FeatureOnlineStore. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # Optional. A description of resources that the FeatureView uses, which to large degree are decided by Vertex AI, and optionally allows only a modest additional configuration. If min_replica_count is not set, the default value is 2. If max_replica_count is not set, the default value is 6. The max allowed replica count is 1000. - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. - "minReplicaCount": 42, # Immutable. The minimum number of replicas this DeployedModel will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. + "minReplicaCount": 42, # Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. }, }, "satisfiesPzi": True or False, # Output only. Reserved for future use. @@ -406,8 +406,8 @@

Method Details

"name": "A String", # Identifier. Name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}` "optimizedConfig": { # Configuration for FeatureViews created in Optimized FeatureOnlineStore. # Optional. Configuration for FeatureView created under Optimized FeatureOnlineStore. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # Optional. A description of resources that the FeatureView uses, which to large degree are decided by Vertex AI, and optionally allows only a modest additional configuration. If min_replica_count is not set, the default value is 2. If max_replica_count is not set, the default value is 6. The max allowed replica count is 1000. - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. - "minReplicaCount": 42, # Immutable. The minimum number of replicas this DeployedModel will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. + "minReplicaCount": 42, # Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. }, }, "satisfiesPzi": True or False, # Output only. Reserved for future use. @@ -521,8 +521,8 @@

Method Details

"name": "A String", # Identifier. Name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}` "optimizedConfig": { # Configuration for FeatureViews created in Optimized FeatureOnlineStore. # Optional. Configuration for FeatureView created under Optimized FeatureOnlineStore. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # Optional. A description of resources that the FeatureView uses, which to large degree are decided by Vertex AI, and optionally allows only a modest additional configuration. If min_replica_count is not set, the default value is 2. If max_replica_count is not set, the default value is 6. The max allowed replica count is 1000. - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. - "minReplicaCount": 42, # Immutable. The minimum number of replicas this DeployedModel will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. + "minReplicaCount": 42, # Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. }, }, "satisfiesPzi": True or False, # Output only. Reserved for future use. @@ -607,8 +607,8 @@

Method Details

"name": "A String", # Identifier. Name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}` "optimizedConfig": { # Configuration for FeatureViews created in Optimized FeatureOnlineStore. # Optional. Configuration for FeatureView created under Optimized FeatureOnlineStore. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # Optional. A description of resources that the FeatureView uses, which to large degree are decided by Vertex AI, and optionally allows only a modest additional configuration. If min_replica_count is not set, the default value is 2. If max_replica_count is not set, the default value is 6. The max allowed replica count is 1000. - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. - "minReplicaCount": 42, # Immutable. The minimum number of replicas this DeployedModel will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. + "minReplicaCount": 42, # Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. }, }, "satisfiesPzi": True or False, # Output only. Reserved for future use. diff --git a/docs/dyn/aiplatform_v1.projects.locations.html b/docs/dyn/aiplatform_v1.projects.locations.html index 5cef78d537a..52fb24b0304 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.html @@ -248,6 +248,9 @@

Instance Methods

corroborateContent(parent, body=None, x__xgafv=None)

Given an input text, it returns a score that evaluates the factuality of the text. It also extracts and returns claims from the text and provides supporting facts.

+

+ evaluateDataset(location, body=None, x__xgafv=None)

+

Evaluates a dataset based on a set of given metrics.

evaluateInstances(location, body=None, x__xgafv=None)

Evaluates instances based on a given metric.

@@ -505,6 +508,94 @@

Method Details

} +
+ evaluateDataset(location, body=None, x__xgafv=None) +
Evaluates a dataset based on a set of given metrics.
+
+Args:
+  location: string, Required. The resource name of the Location to evaluate the dataset. Format: `projects/{project}/locations/{location}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for EvaluationService.EvaluateDataset.
+  "autoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Autorater config used for evaluation.
+    "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+    "flipEnabled": True or False, # Optional. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.
+    "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.
+  },
+  "dataset": { # The dataset used for evaluation. # Required. The dataset used for evaluation.
+    "bigquerySource": { # The BigQuery location for the input content. # BigQuery source holds the dataset.
+      "inputUri": "A String", # Required. BigQuery URI to a table, up to 2000 characters long. Accepted forms: * BigQuery path. For example: `bq://projectId.bqDatasetId.bqTableId`.
+    },
+    "gcsSource": { # The Google Cloud Storage location for the input content. # Cloud storage source holds the dataset.
+      "uris": [ # Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames.
+        "A String",
+      ],
+    },
+  },
+  "metrics": [ # Required. The metrics used for evaluation.
+    { # The metric used for dataset level evaluation.
+      "aggregationMetrics": [ # Optional. The aggregation metrics to use.
+        "A String",
+      ],
+      "bleuSpec": { # Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1. # Spec for bleu metric.
+        "useEffectiveOrder": True or False, # Optional. Whether to use_effective_order to compute bleu score.
+      },
+      "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric.
+      },
+      "pairwiseMetricSpec": { # Spec for pairwise metric. # Spec for pairwise metric.
+        "baselineResponseFieldName": "A String", # Optional. The field name of the baseline response.
+        "candidateResponseFieldName": "A String", # Optional. The field name of the candidate response.
+        "metricPromptTemplate": "A String", # Required. Metric prompt template for pairwise metric.
+        "systemInstruction": "A String", # Optional. System instructions for pairwise metric.
+      },
+      "pointwiseMetricSpec": { # Spec for pointwise metric. # Spec for pointwise metric.
+        "metricPromptTemplate": "A String", # Required. Metric prompt template for pointwise metric.
+        "systemInstruction": "A String", # Optional. System instructions for pointwise metric.
+      },
+      "rougeSpec": { # Spec for rouge score metric - calculates the recall of n-grams in prediction as compared to reference - returns a score ranging between 0 and 1. # Spec for rouge metric.
+        "rougeType": "A String", # Optional. Supported rouge types are rougen[1-9], rougeL, and rougeLsum.
+        "splitSummaries": True or False, # Optional. Whether to split summaries while using rougeLsum.
+        "useStemmer": True or False, # Optional. Whether to use stemmer to compute rouge score.
+      },
+    },
+  ],
+  "outputConfig": { # Config for evaluation output. # Required. Config for evaluation output.
+    "gcsDestination": { # The Google Cloud Storage location where the output is to be written to. # Cloud storage destination for evaluation output.
+      "outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist.
+    },
+  },
+}
+
+  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.
+  },
+}
+
+
evaluateInstances(location, body=None, x__xgafv=None)
Evaluates instances based on a given metric.
diff --git a/docs/dyn/aiplatform_v1.projects.locations.indexEndpoints.html b/docs/dyn/aiplatform_v1.projects.locations.indexEndpoints.html
index 9b1a09f92ce..9ddf246b7dc 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.indexEndpoints.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.indexEndpoints.html
@@ -135,18 +135,18 @@ 

Method Details

"deployedIndexes": [ # Output only. The indexes deployed in this endpoint. { # A deployment of an Index. IndexEndpoints contain one or more DeployedIndexes. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # Optional. A description of resources that the DeployedIndex uses, which to large degree are decided by Vertex AI, and optionally allows only a modest additional configuration. If min_replica_count is not set, the default value is 2 (we don't provide SLA when min_replica_count=1). If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. - "minReplicaCount": 42, # Immutable. The minimum number of replicas this DeployedModel will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. + "minReplicaCount": 42, # Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. }, "createTime": "A String", # Output only. Timestamp when the DeployedIndex was created. - "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration. # Optional. A description of resources that are dedicated to the DeployedIndex, and that need a higher degree of manual configuration. The field min_replica_count must be set to a value strictly greater than 0, or else validation will fail. We don't provide SLA when min_replica_count=1. If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. Available machine types for SMALL shard: e2-standard-2 and all machine types available for MEDIUM and LARGE shard. Available machine types for MEDIUM shard: e2-standard-16 and all machine types available for LARGE shard. Available machine types for LARGE shard: e2-highmem-16, n2d-standard-32. n1-standard-16 and n1-standard-32 are still available, but we recommend e2-standard-16 and e2-highmem-16 for cost efficiency. + "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # Optional. A description of resources that are dedicated to the DeployedIndex, and that need a higher degree of manual configuration. The field min_replica_count must be set to a value strictly greater than 0, or else validation will fail. We don't provide SLA when min_replica_count=1. If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. Available machine types for SMALL shard: e2-standard-2 and all machine types available for MEDIUM and LARGE shard. Available machine types for MEDIUM shard: e2-standard-16 and all machine types available for LARGE shard. Available machine types for LARGE shard: e2-highmem-16, n2d-standard-32. n1-standard-16 and n1-standard-32 are still available, but we recommend e2-standard-16 and e2-highmem-16 for cost efficiency. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], - "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine used by the prediction. + "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. @@ -160,9 +160,9 @@

Method Details

}, "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1"). }, - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). - "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. - "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial model deployment/mutation is desired. If set, the model deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). + "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. + "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "deployedIndexAuthConfig": { # Used to set up the auth on the DeployedIndex's private endpoint. # Optional. If set, the authentication is enabled for the private endpoint. @@ -305,18 +305,18 @@

Method Details

{ # Request message for IndexEndpointService.DeployIndex. "deployedIndex": { # A deployment of an Index. IndexEndpoints contain one or more DeployedIndexes. # Required. The DeployedIndex to be created within the IndexEndpoint. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # Optional. A description of resources that the DeployedIndex uses, which to large degree are decided by Vertex AI, and optionally allows only a modest additional configuration. If min_replica_count is not set, the default value is 2 (we don't provide SLA when min_replica_count=1). If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. - "minReplicaCount": 42, # Immutable. The minimum number of replicas this DeployedModel will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. + "minReplicaCount": 42, # Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. }, "createTime": "A String", # Output only. Timestamp when the DeployedIndex was created. - "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration. # Optional. A description of resources that are dedicated to the DeployedIndex, and that need a higher degree of manual configuration. The field min_replica_count must be set to a value strictly greater than 0, or else validation will fail. We don't provide SLA when min_replica_count=1. If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. Available machine types for SMALL shard: e2-standard-2 and all machine types available for MEDIUM and LARGE shard. Available machine types for MEDIUM shard: e2-standard-16 and all machine types available for LARGE shard. Available machine types for LARGE shard: e2-highmem-16, n2d-standard-32. n1-standard-16 and n1-standard-32 are still available, but we recommend e2-standard-16 and e2-highmem-16 for cost efficiency. + "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # Optional. A description of resources that are dedicated to the DeployedIndex, and that need a higher degree of manual configuration. The field min_replica_count must be set to a value strictly greater than 0, or else validation will fail. We don't provide SLA when min_replica_count=1. If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. Available machine types for SMALL shard: e2-standard-2 and all machine types available for MEDIUM and LARGE shard. Available machine types for MEDIUM shard: e2-standard-16 and all machine types available for LARGE shard. Available machine types for LARGE shard: e2-highmem-16, n2d-standard-32. n1-standard-16 and n1-standard-32 are still available, but we recommend e2-standard-16 and e2-highmem-16 for cost efficiency. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], - "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine used by the prediction. + "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. @@ -330,9 +330,9 @@

Method Details

}, "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1"). }, - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). - "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. - "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial model deployment/mutation is desired. If set, the model deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). + "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. + "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "deployedIndexAuthConfig": { # Used to set up the auth on the DeployedIndex's private endpoint. # Optional. If set, the authentication is enabled for the private endpoint. @@ -544,18 +544,18 @@

Method Details

"deployedIndexes": [ # Output only. The indexes deployed in this endpoint. { # A deployment of an Index. IndexEndpoints contain one or more DeployedIndexes. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # Optional. A description of resources that the DeployedIndex uses, which to large degree are decided by Vertex AI, and optionally allows only a modest additional configuration. If min_replica_count is not set, the default value is 2 (we don't provide SLA when min_replica_count=1). If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. - "minReplicaCount": 42, # Immutable. The minimum number of replicas this DeployedModel will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. + "minReplicaCount": 42, # Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. }, "createTime": "A String", # Output only. Timestamp when the DeployedIndex was created. - "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration. # Optional. A description of resources that are dedicated to the DeployedIndex, and that need a higher degree of manual configuration. The field min_replica_count must be set to a value strictly greater than 0, or else validation will fail. We don't provide SLA when min_replica_count=1. If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. Available machine types for SMALL shard: e2-standard-2 and all machine types available for MEDIUM and LARGE shard. Available machine types for MEDIUM shard: e2-standard-16 and all machine types available for LARGE shard. Available machine types for LARGE shard: e2-highmem-16, n2d-standard-32. n1-standard-16 and n1-standard-32 are still available, but we recommend e2-standard-16 and e2-highmem-16 for cost efficiency. + "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # Optional. A description of resources that are dedicated to the DeployedIndex, and that need a higher degree of manual configuration. The field min_replica_count must be set to a value strictly greater than 0, or else validation will fail. We don't provide SLA when min_replica_count=1. If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. Available machine types for SMALL shard: e2-standard-2 and all machine types available for MEDIUM and LARGE shard. Available machine types for MEDIUM shard: e2-standard-16 and all machine types available for LARGE shard. Available machine types for LARGE shard: e2-highmem-16, n2d-standard-32. n1-standard-16 and n1-standard-32 are still available, but we recommend e2-standard-16 and e2-highmem-16 for cost efficiency. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], - "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine used by the prediction. + "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. @@ -569,9 +569,9 @@

Method Details

}, "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1"). }, - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). - "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. - "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial model deployment/mutation is desired. If set, the model deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). + "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. + "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "deployedIndexAuthConfig": { # Used to set up the auth on the DeployedIndex's private endpoint. # Optional. If set, the authentication is enabled for the private endpoint. @@ -664,18 +664,18 @@

Method Details

"deployedIndexes": [ # Output only. The indexes deployed in this endpoint. { # A deployment of an Index. IndexEndpoints contain one or more DeployedIndexes. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # Optional. A description of resources that the DeployedIndex uses, which to large degree are decided by Vertex AI, and optionally allows only a modest additional configuration. If min_replica_count is not set, the default value is 2 (we don't provide SLA when min_replica_count=1). If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. - "minReplicaCount": 42, # Immutable. The minimum number of replicas this DeployedModel will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. + "minReplicaCount": 42, # Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. }, "createTime": "A String", # Output only. Timestamp when the DeployedIndex was created. - "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration. # Optional. A description of resources that are dedicated to the DeployedIndex, and that need a higher degree of manual configuration. The field min_replica_count must be set to a value strictly greater than 0, or else validation will fail. We don't provide SLA when min_replica_count=1. If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. Available machine types for SMALL shard: e2-standard-2 and all machine types available for MEDIUM and LARGE shard. Available machine types for MEDIUM shard: e2-standard-16 and all machine types available for LARGE shard. Available machine types for LARGE shard: e2-highmem-16, n2d-standard-32. n1-standard-16 and n1-standard-32 are still available, but we recommend e2-standard-16 and e2-highmem-16 for cost efficiency. + "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # Optional. A description of resources that are dedicated to the DeployedIndex, and that need a higher degree of manual configuration. The field min_replica_count must be set to a value strictly greater than 0, or else validation will fail. We don't provide SLA when min_replica_count=1. If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. Available machine types for SMALL shard: e2-standard-2 and all machine types available for MEDIUM and LARGE shard. Available machine types for MEDIUM shard: e2-standard-16 and all machine types available for LARGE shard. Available machine types for LARGE shard: e2-highmem-16, n2d-standard-32. n1-standard-16 and n1-standard-32 are still available, but we recommend e2-standard-16 and e2-highmem-16 for cost efficiency. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], - "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine used by the prediction. + "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. @@ -689,9 +689,9 @@

Method Details

}, "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1"). }, - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). - "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. - "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial model deployment/mutation is desired. If set, the model deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). + "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. + "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "deployedIndexAuthConfig": { # Used to set up the auth on the DeployedIndex's private endpoint. # Optional. If set, the authentication is enabled for the private endpoint. @@ -787,18 +787,18 @@

Method Details

{ # A deployment of an Index. IndexEndpoints contain one or more DeployedIndexes. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # Optional. A description of resources that the DeployedIndex uses, which to large degree are decided by Vertex AI, and optionally allows only a modest additional configuration. If min_replica_count is not set, the default value is 2 (we don't provide SLA when min_replica_count=1). If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. - "minReplicaCount": 42, # Immutable. The minimum number of replicas this DeployedModel will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. + "minReplicaCount": 42, # Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. }, "createTime": "A String", # Output only. Timestamp when the DeployedIndex was created. - "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration. # Optional. A description of resources that are dedicated to the DeployedIndex, and that need a higher degree of manual configuration. The field min_replica_count must be set to a value strictly greater than 0, or else validation will fail. We don't provide SLA when min_replica_count=1. If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. Available machine types for SMALL shard: e2-standard-2 and all machine types available for MEDIUM and LARGE shard. Available machine types for MEDIUM shard: e2-standard-16 and all machine types available for LARGE shard. Available machine types for LARGE shard: e2-highmem-16, n2d-standard-32. n1-standard-16 and n1-standard-32 are still available, but we recommend e2-standard-16 and e2-highmem-16 for cost efficiency. + "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # Optional. A description of resources that are dedicated to the DeployedIndex, and that need a higher degree of manual configuration. The field min_replica_count must be set to a value strictly greater than 0, or else validation will fail. We don't provide SLA when min_replica_count=1. If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. Available machine types for SMALL shard: e2-standard-2 and all machine types available for MEDIUM and LARGE shard. Available machine types for MEDIUM shard: e2-standard-16 and all machine types available for LARGE shard. Available machine types for LARGE shard: e2-highmem-16, n2d-standard-32. n1-standard-16 and n1-standard-32 are still available, but we recommend e2-standard-16 and e2-highmem-16 for cost efficiency. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], - "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine used by the prediction. + "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. @@ -812,9 +812,9 @@

Method Details

}, "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1"). }, - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). - "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. - "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial model deployment/mutation is desired. If set, the model deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). + "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. + "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "deployedIndexAuthConfig": { # Used to set up the auth on the DeployedIndex's private endpoint. # Optional. If set, the authentication is enabled for the private endpoint. @@ -898,18 +898,18 @@

Method Details

"deployedIndexes": [ # Output only. The indexes deployed in this endpoint. { # A deployment of an Index. IndexEndpoints contain one or more DeployedIndexes. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # Optional. A description of resources that the DeployedIndex uses, which to large degree are decided by Vertex AI, and optionally allows only a modest additional configuration. If min_replica_count is not set, the default value is 2 (we don't provide SLA when min_replica_count=1). If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. - "minReplicaCount": 42, # Immutable. The minimum number of replicas this DeployedModel will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. + "minReplicaCount": 42, # Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. }, "createTime": "A String", # Output only. Timestamp when the DeployedIndex was created. - "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration. # Optional. A description of resources that are dedicated to the DeployedIndex, and that need a higher degree of manual configuration. The field min_replica_count must be set to a value strictly greater than 0, or else validation will fail. We don't provide SLA when min_replica_count=1. If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. Available machine types for SMALL shard: e2-standard-2 and all machine types available for MEDIUM and LARGE shard. Available machine types for MEDIUM shard: e2-standard-16 and all machine types available for LARGE shard. Available machine types for LARGE shard: e2-highmem-16, n2d-standard-32. n1-standard-16 and n1-standard-32 are still available, but we recommend e2-standard-16 and e2-highmem-16 for cost efficiency. + "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # Optional. A description of resources that are dedicated to the DeployedIndex, and that need a higher degree of manual configuration. The field min_replica_count must be set to a value strictly greater than 0, or else validation will fail. We don't provide SLA when min_replica_count=1. If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. Available machine types for SMALL shard: e2-standard-2 and all machine types available for MEDIUM and LARGE shard. Available machine types for MEDIUM shard: e2-standard-16 and all machine types available for LARGE shard. Available machine types for LARGE shard: e2-highmem-16, n2d-standard-32. n1-standard-16 and n1-standard-32 are still available, but we recommend e2-standard-16 and e2-highmem-16 for cost efficiency. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], - "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine used by the prediction. + "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. @@ -923,9 +923,9 @@

Method Details

}, "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1"). }, - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). - "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. - "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial model deployment/mutation is desired. If set, the model deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). + "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. + "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "deployedIndexAuthConfig": { # Used to set up the auth on the DeployedIndex's private endpoint. # Optional. If set, the authentication is enabled for the private endpoint. @@ -1006,18 +1006,18 @@

Method Details

"deployedIndexes": [ # Output only. The indexes deployed in this endpoint. { # A deployment of an Index. IndexEndpoints contain one or more DeployedIndexes. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # Optional. A description of resources that the DeployedIndex uses, which to large degree are decided by Vertex AI, and optionally allows only a modest additional configuration. If min_replica_count is not set, the default value is 2 (we don't provide SLA when min_replica_count=1). If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. - "minReplicaCount": 42, # Immutable. The minimum number of replicas this DeployedModel will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. + "minReplicaCount": 42, # Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. }, "createTime": "A String", # Output only. Timestamp when the DeployedIndex was created. - "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration. # Optional. A description of resources that are dedicated to the DeployedIndex, and that need a higher degree of manual configuration. The field min_replica_count must be set to a value strictly greater than 0, or else validation will fail. We don't provide SLA when min_replica_count=1. If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. Available machine types for SMALL shard: e2-standard-2 and all machine types available for MEDIUM and LARGE shard. Available machine types for MEDIUM shard: e2-standard-16 and all machine types available for LARGE shard. Available machine types for LARGE shard: e2-highmem-16, n2d-standard-32. n1-standard-16 and n1-standard-32 are still available, but we recommend e2-standard-16 and e2-highmem-16 for cost efficiency. + "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # Optional. A description of resources that are dedicated to the DeployedIndex, and that need a higher degree of manual configuration. The field min_replica_count must be set to a value strictly greater than 0, or else validation will fail. We don't provide SLA when min_replica_count=1. If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. Available machine types for SMALL shard: e2-standard-2 and all machine types available for MEDIUM and LARGE shard. Available machine types for MEDIUM shard: e2-standard-16 and all machine types available for LARGE shard. Available machine types for LARGE shard: e2-highmem-16, n2d-standard-32. n1-standard-16 and n1-standard-32 are still available, but we recommend e2-standard-16 and e2-highmem-16 for cost efficiency. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], - "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine used by the prediction. + "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. @@ -1031,9 +1031,9 @@

Method Details

}, "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1"). }, - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). - "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. - "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial model deployment/mutation is desired. If set, the model deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). + "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. + "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "deployedIndexAuthConfig": { # Used to set up the auth on the DeployedIndex's private endpoint. # Optional. If set, the authentication is enabled for the private endpoint. diff --git a/docs/dyn/aiplatform_v1.projects.locations.models.html b/docs/dyn/aiplatform_v1.projects.locations.models.html index 5c210a6f691..7ecc99cdbc3 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.models.html +++ b/docs/dyn/aiplatform_v1.projects.locations.models.html @@ -1041,9 +1041,10 @@

Method Details

{ # Response message for ModelService.ListModelVersionCheckpoints "checkpoints": [ # List of Model Version checkpoints. - { # A proto representation of a Spanner-stored ModelVersionCheckpoint. The meaning of the fields is equivalent to their in-Spanner counterparts. + { # Describes the machine learning model version checkpoint. "checkpointId": "A String", # The ID of the checkpoint. "epoch": "A String", # The epoch of the checkpoint. + "name": "A String", # Identifier. The resource name of the ModelVersionCheckpoint. Format: `projects/{project}/locations/{location}/models/{model}/versions/{version}/checkpoints/{checkpoint}` "step": "A String", # The step of the checkpoint. }, ], diff --git a/docs/dyn/aiplatform_v1.publishers.models.html b/docs/dyn/aiplatform_v1.publishers.models.html index 329ae925bf4..1be628712c0 100644 --- a/docs/dyn/aiplatform_v1.publishers.models.html +++ b/docs/dyn/aiplatform_v1.publishers.models.html @@ -1042,8 +1042,8 @@

Method Details

"deploy": { # Model metadata that is needed for UploadModel or DeployModel/CreateEndpoint requests. # Optional. Deploy the PublisherModel to Vertex Endpoint. "artifactUri": "A String", # Optional. The path to the directory containing the Model artifact and any of its supporting files. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. - "minReplicaCount": 42, # Immutable. The minimum number of replicas this DeployedModel will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. + "minReplicaCount": 42, # Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. }, "containerSpec": { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # Optional. The specification of the container that is to be used when deploying this Model in Vertex AI. Not present for Large Models. "args": [ # Immutable. Specifies arguments for the command that runs when the container starts. This overrides the container's [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd). Specify this field as an array of executable and arguments, similar to a Docker `CMD`'s "default parameters" form. If you don't specify this field but do specify the command field, then the command from the `command` field runs without any additional arguments. See the [Kubernetes documentation about how the `command` and `args` fields interact with a container's `ENTRYPOINT` and `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). If you don't specify this field and don't specify the `command` field, then the container's [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#cmd) and `CMD` determine what runs based on their default behavior. See the Docker documentation about [how `CMD` and `ENTRYPOINT` interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). In this field, you can reference [environment variables set by Vertex AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to the `args` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). @@ -1170,14 +1170,14 @@

Method Details

"timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Must be greater or equal to period_seconds. Maps to Kubernetes probe argument 'timeoutSeconds'. }, }, - "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. + "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], - "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine used by the prediction. + "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. @@ -1191,9 +1191,9 @@

Method Details

}, "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1"). }, - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). - "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. - "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial model deployment/mutation is desired. If set, the model deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). + "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. + "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "deployMetadata": { # Metadata information about the deployment for managing deployment config. # Optional. Metadata information about this deployment config. @@ -1221,8 +1221,8 @@

Method Details

{ # Model metadata that is needed for UploadModel or DeployModel/CreateEndpoint requests. "artifactUri": "A String", # Optional. The path to the directory containing the Model artifact and any of its supporting files. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. - "minReplicaCount": 42, # Immutable. The minimum number of replicas this DeployedModel will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. + "minReplicaCount": 42, # Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. }, "containerSpec": { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # Optional. The specification of the container that is to be used when deploying this Model in Vertex AI. Not present for Large Models. "args": [ # Immutable. Specifies arguments for the command that runs when the container starts. This overrides the container's [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd). Specify this field as an array of executable and arguments, similar to a Docker `CMD`'s "default parameters" form. If you don't specify this field but do specify the command field, then the command from the `command` field runs without any additional arguments. See the [Kubernetes documentation about how the `command` and `args` fields interact with a container's `ENTRYPOINT` and `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). If you don't specify this field and don't specify the `command` field, then the container's [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#cmd) and `CMD` determine what runs based on their default behavior. See the Docker documentation about [how `CMD` and `ENTRYPOINT` interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). In this field, you can reference [environment variables set by Vertex AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to the `args` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). @@ -1349,14 +1349,14 @@

Method Details

"timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Must be greater or equal to period_seconds. Maps to Kubernetes probe argument 'timeoutSeconds'. }, }, - "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. + "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], - "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine used by the prediction. + "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. @@ -1370,9 +1370,9 @@

Method Details

}, "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1"). }, - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). - "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. - "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial model deployment/mutation is desired. If set, the model deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). + "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. + "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "deployMetadata": { # Metadata information about the deployment for managing deployment config. # Optional. Metadata information about this deployment config. diff --git a/docs/dyn/aiplatform_v1beta1.endpoints.html b/docs/dyn/aiplatform_v1beta1.endpoints.html index 9e741cfb728..c89436cbd27 100644 --- a/docs/dyn/aiplatform_v1beta1.endpoints.html +++ b/docs/dyn/aiplatform_v1beta1.endpoints.html @@ -304,9 +304,6 @@

Method Details

"A String", ], "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - }, "topK": 3.14, # Optional. If specified, top-k sampling will be used. "topP": 3.14, # Optional. If specified, nucleus sampling will be used. }, @@ -630,9 +627,6 @@

Method Details

"A String", ], "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - }, "topK": 3.14, # Optional. If specified, top-k sampling will be used. "topP": 3.14, # Optional. If specified, nucleus sampling will be used. }, @@ -1187,9 +1181,6 @@

Method Details

"A String", ], "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - }, "topK": 3.14, # Optional. If specified, top-k sampling will be used. "topP": 3.14, # Optional. If specified, nucleus sampling will be used. }, diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.batchPredictionJobs.html b/docs/dyn/aiplatform_v1beta1.projects.locations.batchPredictionJobs.html index d7aabc3c6fd..685da93d9e8 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.batchPredictionJobs.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.batchPredictionJobs.html @@ -147,7 +147,6 @@

Method Details

"acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -635,7 +634,6 @@

Method Details

"acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -1165,7 +1163,6 @@

Method Details

"acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -1666,7 +1663,6 @@

Method Details

"acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html b/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html index 00e4300d27c..17459991bc9 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html @@ -159,7 +159,7 @@

Method Details

"createTime": "A String", # Output only. Creation time of the cache entry. "displayName": "A String", # Optional. Immutable. The user-generated meaningful display name of the cached content. "expireTime": "A String", # Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what was sent on input. - "model": "A String", # Immutable. The name of the publisher model to use for cached content. Format: projects/{project}/locations/{location}/publishers/{publisher}/models/{model} + "model": "A String", # Immutable. The name of the `Model` to use for cached content. Currently, only the published Gemini base models are supported, in form of projects/{PROJECT}/locations/{LOCATION}/publishers/google/models/{MODEL} "name": "A String", # Immutable. Identifier. The server-generated resource name of the cached content Format: projects/{project}/locations/{location}/cachedContents/{cached_content} "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. Input only. Immutable. Developer set system instruction. Currently, text only "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. @@ -415,7 +415,7 @@

Method Details

"createTime": "A String", # Output only. Creation time of the cache entry. "displayName": "A String", # Optional. Immutable. The user-generated meaningful display name of the cached content. "expireTime": "A String", # Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what was sent on input. - "model": "A String", # Immutable. The name of the publisher model to use for cached content. Format: projects/{project}/locations/{location}/publishers/{publisher}/models/{model} + "model": "A String", # Immutable. The name of the `Model` to use for cached content. Currently, only the published Gemini base models are supported, in form of projects/{PROJECT}/locations/{LOCATION}/publishers/google/models/{MODEL} "name": "A String", # Immutable. Identifier. The server-generated resource name of the cached content Format: projects/{project}/locations/{location}/cachedContents/{cached_content} "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. Input only. Immutable. Developer set system instruction. Currently, text only "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. @@ -696,7 +696,7 @@

Method Details

"createTime": "A String", # Output only. Creation time of the cache entry. "displayName": "A String", # Optional. Immutable. The user-generated meaningful display name of the cached content. "expireTime": "A String", # Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what was sent on input. - "model": "A String", # Immutable. The name of the publisher model to use for cached content. Format: projects/{project}/locations/{location}/publishers/{publisher}/models/{model} + "model": "A String", # Immutable. The name of the `Model` to use for cached content. Currently, only the published Gemini base models are supported, in form of projects/{PROJECT}/locations/{LOCATION}/publishers/google/models/{MODEL} "name": "A String", # Immutable. Identifier. The server-generated resource name of the cached content Format: projects/{project}/locations/{location}/cachedContents/{cached_content} "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. Input only. Immutable. Developer set system instruction. Currently, text only "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. @@ -963,7 +963,7 @@

Method Details

"createTime": "A String", # Output only. Creation time of the cache entry. "displayName": "A String", # Optional. Immutable. The user-generated meaningful display name of the cached content. "expireTime": "A String", # Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what was sent on input. - "model": "A String", # Immutable. The name of the publisher model to use for cached content. Format: projects/{project}/locations/{location}/publishers/{publisher}/models/{model} + "model": "A String", # Immutable. The name of the `Model` to use for cached content. Currently, only the published Gemini base models are supported, in form of projects/{PROJECT}/locations/{LOCATION}/publishers/google/models/{MODEL} "name": "A String", # Immutable. Identifier. The server-generated resource name of the cached content Format: projects/{project}/locations/{location}/cachedContents/{cached_content} "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. Input only. Immutable. Developer set system instruction. Currently, text only "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. @@ -1238,7 +1238,7 @@

Method Details

"createTime": "A String", # Output only. Creation time of the cache entry. "displayName": "A String", # Optional. Immutable. The user-generated meaningful display name of the cached content. "expireTime": "A String", # Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what was sent on input. - "model": "A String", # Immutable. The name of the publisher model to use for cached content. Format: projects/{project}/locations/{location}/publishers/{publisher}/models/{model} + "model": "A String", # Immutable. The name of the `Model` to use for cached content. Currently, only the published Gemini base models are supported, in form of projects/{PROJECT}/locations/{LOCATION}/publishers/google/models/{MODEL} "name": "A String", # Immutable. Identifier. The server-generated resource name of the cached content Format: projects/{project}/locations/{location}/cachedContents/{cached_content} "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. Input only. Immutable. Developer set system instruction. Currently, text only "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. @@ -1495,7 +1495,7 @@

Method Details

"createTime": "A String", # Output only. Creation time of the cache entry. "displayName": "A String", # Optional. Immutable. The user-generated meaningful display name of the cached content. "expireTime": "A String", # Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what was sent on input. - "model": "A String", # Immutable. The name of the publisher model to use for cached content. Format: projects/{project}/locations/{location}/publishers/{publisher}/models/{model} + "model": "A String", # Immutable. The name of the `Model` to use for cached content. Currently, only the published Gemini base models are supported, in form of projects/{PROJECT}/locations/{LOCATION}/publishers/google/models/{MODEL} "name": "A String", # Immutable. Identifier. The server-generated resource name of the cached content Format: projects/{project}/locations/{location}/cachedContents/{cached_content} "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. Input only. Immutable. Developer set system instruction. Currently, text only "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.customJobs.html b/docs/dyn/aiplatform_v1beta1.projects.locations.customJobs.html index 33133b092ee..d3bdbeceaf5 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.customJobs.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.customJobs.html @@ -209,7 +209,6 @@

Method Details

"acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -338,7 +337,6 @@

Method Details

"acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -509,7 +507,6 @@

Method Details

"acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -651,7 +648,6 @@

Method Details

"acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.deploymentResourcePools.html b/docs/dyn/aiplatform_v1beta1.projects.locations.deploymentResourcePools.html index a8506690260..82ee5329773 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.deploymentResourcePools.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.deploymentResourcePools.html @@ -124,18 +124,17 @@

Method Details

{ # Request message for CreateDeploymentResourcePool method. "deploymentResourcePool": { # A description of resources that can be shared by multiple DeployedModels, whose underlying specification consists of a DedicatedResources. # Required. The DeploymentResourcePool to create. "createTime": "A String", # Output only. Timestamp when this DeploymentResourcePool was created. - "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration. # Required. The underlying DedicatedResources that the DeploymentResourcePool uses. + "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # Required. The underlying DedicatedResources that the DeploymentResourcePool uses. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], - "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine used by the prediction. + "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -145,9 +144,9 @@

Method Details

}, "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1"). }, - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). - "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. - "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial model deployment/mutation is desired. If set, the model deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). + "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. + "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "disableContainerLogging": True or False, # If the DeploymentResourcePool is deployed with custom-trained Models or AutoML Tabular Models, the container(s) of the DeploymentResourcePool will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true. @@ -242,18 +241,17 @@

Method Details

{ # A description of resources that can be shared by multiple DeployedModels, whose underlying specification consists of a DedicatedResources. "createTime": "A String", # Output only. Timestamp when this DeploymentResourcePool was created. - "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration. # Required. The underlying DedicatedResources that the DeploymentResourcePool uses. + "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # Required. The underlying DedicatedResources that the DeploymentResourcePool uses. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], - "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine used by the prediction. + "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -263,9 +261,9 @@

Method Details

}, "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1"). }, - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). - "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. - "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial model deployment/mutation is desired. If set, the model deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). + "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. + "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "disableContainerLogging": True or False, # If the DeploymentResourcePool is deployed with custom-trained Models or AutoML Tabular Models, the container(s) of the DeploymentResourcePool will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true. @@ -299,18 +297,17 @@

Method Details

"deploymentResourcePools": [ # The DeploymentResourcePools from the specified location. { # A description of resources that can be shared by multiple DeployedModels, whose underlying specification consists of a DedicatedResources. "createTime": "A String", # Output only. Timestamp when this DeploymentResourcePool was created. - "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration. # Required. The underlying DedicatedResources that the DeploymentResourcePool uses. + "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # Required. The underlying DedicatedResources that the DeploymentResourcePool uses. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], - "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine used by the prediction. + "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -320,9 +317,9 @@

Method Details

}, "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1"). }, - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). - "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. - "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial model deployment/mutation is desired. If set, the model deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). + "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. + "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "disableContainerLogging": True or False, # If the DeploymentResourcePool is deployed with custom-trained Models or AutoML Tabular Models, the container(s) of the DeploymentResourcePool will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true. @@ -364,18 +361,17 @@

Method Details

{ # A description of resources that can be shared by multiple DeployedModels, whose underlying specification consists of a DedicatedResources. "createTime": "A String", # Output only. Timestamp when this DeploymentResourcePool was created. - "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration. # Required. The underlying DedicatedResources that the DeploymentResourcePool uses. + "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # Required. The underlying DedicatedResources that the DeploymentResourcePool uses. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], - "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine used by the prediction. + "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -385,9 +381,9 @@

Method Details

}, "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1"). }, - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). - "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. - "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial model deployment/mutation is desired. If set, the model deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). + "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. + "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "disableContainerLogging": True or False, # If the DeploymentResourcePool is deployed with custom-trained Models or AutoML Tabular Models, the container(s) of the DeploymentResourcePool will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true. @@ -456,22 +452,21 @@

Method Details

"deployedModels": [ # DEPRECATED Use deployed_model_refs instead. { # A deployment of a Model. Endpoints contain one or more DeployedModels. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. - "minReplicaCount": 42, # Immutable. The minimum number of replicas this DeployedModel will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. + "minReplicaCount": 42, # Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. }, "createTime": "A String", # Output only. Timestamp when the DeployedModel was created. - "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. + "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], - "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine used by the prediction. + "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -481,9 +476,9 @@

Method Details

}, "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1"). }, - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). - "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. - "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial model deployment/mutation is desired. If set, the model deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). + "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. + "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "disableExplanations": True or False, # If true, deploy the model without explainable feature, regardless the existence of Model.explanation_spec or explanation_spec. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html index 4d50aa754bc..af3df37653e 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html @@ -377,9 +377,6 @@

Method Details

"A String", ], "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - }, "topK": 3.14, # Optional. If specified, top-k sampling will be used. "topP": 3.14, # Optional. If specified, nucleus sampling will be used. }, @@ -599,22 +596,21 @@

Method Details

"deployedModels": [ # Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively. { # A deployment of a Model. Endpoints contain one or more DeployedModels. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. - "minReplicaCount": 42, # Immutable. The minimum number of replicas this DeployedModel will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. + "minReplicaCount": 42, # Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. }, "createTime": "A String", # Output only. Timestamp when the DeployedModel was created. - "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. + "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], - "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine used by the prediction. + "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -624,9 +620,9 @@

Method Details

}, "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1"). }, - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). - "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. - "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial model deployment/mutation is desired. If set, the model deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). + "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. + "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "disableExplanations": True or False, # If true, deploy the model without explainable feature, regardless the existence of Model.explanation_spec or explanation_spec. @@ -905,22 +901,21 @@

Method Details

{ # Request message for EndpointService.DeployModel. "deployedModel": { # A deployment of a Model. Endpoints contain one or more DeployedModels. # Required. The DeployedModel to be created within the Endpoint. Note that Endpoint.traffic_split must be updated for the DeployedModel to start receiving traffic, either as part of this call, or via EndpointService.UpdateEndpoint. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. - "minReplicaCount": 42, # Immutable. The minimum number of replicas this DeployedModel will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. + "minReplicaCount": 42, # Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. }, "createTime": "A String", # Output only. Timestamp when the DeployedModel was created. - "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. + "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], - "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine used by the prediction. + "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -930,9 +925,9 @@

Method Details

}, "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1"). }, - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). - "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. - "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial model deployment/mutation is desired. If set, the model deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). + "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. + "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "disableExplanations": True or False, # If true, deploy the model without explainable feature, regardless the existence of Model.explanation_spec or explanation_spec. @@ -1779,9 +1774,6 @@

Method Details

"A String", ], "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - }, "topK": 3.14, # Optional. If specified, top-k sampling will be used. "topP": 3.14, # Optional. If specified, nucleus sampling will be used. }, @@ -2201,22 +2193,21 @@

Method Details

"deployedModels": [ # Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively. { # A deployment of a Model. Endpoints contain one or more DeployedModels. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. - "minReplicaCount": 42, # Immutable. The minimum number of replicas this DeployedModel will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. + "minReplicaCount": 42, # Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. }, "createTime": "A String", # Output only. Timestamp when the DeployedModel was created. - "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. + "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], - "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine used by the prediction. + "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -2226,9 +2217,9 @@

Method Details

}, "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1"). }, - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). - "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. - "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial model deployment/mutation is desired. If set, the model deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). + "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. + "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "disableExplanations": True or False, # If true, deploy the model without explainable feature, regardless the existence of Model.explanation_spec or explanation_spec. @@ -2496,22 +2487,21 @@

Method Details

"deployedModels": [ # Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively. { # A deployment of a Model. Endpoints contain one or more DeployedModels. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. - "minReplicaCount": 42, # Immutable. The minimum number of replicas this DeployedModel will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. + "minReplicaCount": 42, # Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. }, "createTime": "A String", # Output only. Timestamp when the DeployedModel was created. - "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. + "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], - "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine used by the prediction. + "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -2521,9 +2511,9 @@

Method Details

}, "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1"). }, - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). - "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. - "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial model deployment/mutation is desired. If set, the model deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). + "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. + "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "disableExplanations": True or False, # If true, deploy the model without explainable feature, regardless the existence of Model.explanation_spec or explanation_spec. @@ -2755,22 +2745,21 @@

Method Details

{ # Request message for EndpointService.MutateDeployedModel. "deployedModel": { # A deployment of a Model. Endpoints contain one or more DeployedModels. # Required. The DeployedModel to be mutated within the Endpoint. Only the following fields can be mutated: * `min_replica_count` in either DedicatedResources or AutomaticResources * `max_replica_count` in either DedicatedResources or AutomaticResources * autoscaling_metric_specs * `disable_container_logging` (v1 only) * `enable_container_logging` (v1beta1 only) "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. - "minReplicaCount": 42, # Immutable. The minimum number of replicas this DeployedModel will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. + "minReplicaCount": 42, # Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. }, "createTime": "A String", # Output only. Timestamp when the DeployedModel was created. - "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. + "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], - "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine used by the prediction. + "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -2780,9 +2769,9 @@

Method Details

}, "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1"). }, - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). - "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. - "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial model deployment/mutation is desired. If set, the model deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). + "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. + "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "disableExplanations": True or False, # If true, deploy the model without explainable feature, regardless the existence of Model.explanation_spec or explanation_spec. @@ -2993,22 +2982,21 @@

Method Details

"deployedModels": [ # Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively. { # A deployment of a Model. Endpoints contain one or more DeployedModels. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. - "minReplicaCount": 42, # Immutable. The minimum number of replicas this DeployedModel will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. + "minReplicaCount": 42, # Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. }, "createTime": "A String", # Output only. Timestamp when the DeployedModel was created. - "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. + "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], - "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine used by the prediction. + "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -3018,9 +3006,9 @@

Method Details

}, "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1"). }, - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). - "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. - "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial model deployment/mutation is desired. If set, the model deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). + "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. + "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "disableExplanations": True or False, # If true, deploy the model without explainable feature, regardless the existence of Model.explanation_spec or explanation_spec. @@ -3241,22 +3229,21 @@

Method Details

"deployedModels": [ # Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively. { # A deployment of a Model. Endpoints contain one or more DeployedModels. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. - "minReplicaCount": 42, # Immutable. The minimum number of replicas this DeployedModel will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. + "minReplicaCount": 42, # Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. }, "createTime": "A String", # Output only. Timestamp when the DeployedModel was created. - "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. + "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], - "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine used by the prediction. + "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -3266,9 +3253,9 @@

Method Details

}, "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1"). }, - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). - "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. - "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial model deployment/mutation is desired. If set, the model deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). + "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. + "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "disableExplanations": True or False, # If true, deploy the model without explainable feature, regardless the existence of Model.explanation_spec or explanation_spec. @@ -3961,9 +3948,6 @@

Method Details

"A String", ], "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - }, "topK": 3.14, # Optional. If specified, top-k sampling will be used. "topP": 3.14, # Optional. If specified, nucleus sampling will be used. }, @@ -4486,22 +4470,21 @@

Method Details

"deployedModels": [ # Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively. { # A deployment of a Model. Endpoints contain one or more DeployedModels. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. - "minReplicaCount": 42, # Immutable. The minimum number of replicas this DeployedModel will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. + "minReplicaCount": 42, # Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. }, "createTime": "A String", # Output only. Timestamp when the DeployedModel was created. - "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. + "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], - "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine used by the prediction. + "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -4511,9 +4494,9 @@

Method Details

}, "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1"). }, - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). - "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. - "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial model deployment/mutation is desired. If set, the model deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). + "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. + "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "disableExplanations": True or False, # If true, deploy the model without explainable feature, regardless the existence of Model.explanation_spec or explanation_spec. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.featureViews.html b/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.featureViews.html index 58efb0e81c7..eb656eb7d38 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.featureViews.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.featureViews.html @@ -181,8 +181,8 @@

Method Details

"name": "A String", # Identifier. Name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}` "optimizedConfig": { # Configuration for FeatureViews created in Optimized FeatureOnlineStore. # Optional. Configuration for FeatureView created under Optimized FeatureOnlineStore. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # Optional. A description of resources that the FeatureView uses, which to large degree are decided by Vertex AI, and optionally allows only a modest additional configuration. If min_replica_count is not set, the default value is 2. If max_replica_count is not set, the default value is 6. The max allowed replica count is 1000. - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. - "minReplicaCount": 42, # Immutable. The minimum number of replicas this DeployedModel will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. + "minReplicaCount": 42, # Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. }, }, "satisfiesPzi": True or False, # Output only. Reserved for future use. @@ -425,8 +425,8 @@

Method Details

"name": "A String", # Identifier. Name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}` "optimizedConfig": { # Configuration for FeatureViews created in Optimized FeatureOnlineStore. # Optional. Configuration for FeatureView created under Optimized FeatureOnlineStore. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # Optional. A description of resources that the FeatureView uses, which to large degree are decided by Vertex AI, and optionally allows only a modest additional configuration. If min_replica_count is not set, the default value is 2. If max_replica_count is not set, the default value is 6. The max allowed replica count is 1000. - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. - "minReplicaCount": 42, # Immutable. The minimum number of replicas this DeployedModel will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. + "minReplicaCount": 42, # Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. }, }, "satisfiesPzi": True or False, # Output only. Reserved for future use. @@ -554,8 +554,8 @@

Method Details

"name": "A String", # Identifier. Name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}` "optimizedConfig": { # Configuration for FeatureViews created in Optimized FeatureOnlineStore. # Optional. Configuration for FeatureView created under Optimized FeatureOnlineStore. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # Optional. A description of resources that the FeatureView uses, which to large degree are decided by Vertex AI, and optionally allows only a modest additional configuration. If min_replica_count is not set, the default value is 2. If max_replica_count is not set, the default value is 6. The max allowed replica count is 1000. - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. - "minReplicaCount": 42, # Immutable. The minimum number of replicas this DeployedModel will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. + "minReplicaCount": 42, # Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. }, }, "satisfiesPzi": True or False, # Output only. Reserved for future use. @@ -654,8 +654,8 @@

Method Details

"name": "A String", # Identifier. Name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}` "optimizedConfig": { # Configuration for FeatureViews created in Optimized FeatureOnlineStore. # Optional. Configuration for FeatureView created under Optimized FeatureOnlineStore. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # Optional. A description of resources that the FeatureView uses, which to large degree are decided by Vertex AI, and optionally allows only a modest additional configuration. If min_replica_count is not set, the default value is 2. If max_replica_count is not set, the default value is 6. The max allowed replica count is 1000. - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. - "minReplicaCount": 42, # Immutable. The minimum number of replicas this DeployedModel will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. + "minReplicaCount": 42, # Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. }, }, "satisfiesPzi": True or False, # Output only. Reserved for future use. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.html index 08429ab7b3c..27e7499bc54 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.html @@ -296,6 +296,9 @@

Instance Methods

deploy(destination, body=None, x__xgafv=None)

Deploys publisher models.

+

+ evaluateDataset(location, body=None, x__xgafv=None)

+

Evaluates a dataset based on a set of given metrics.

evaluateInstances(location, body=None, x__xgafv=None)

Evaluates instances based on a given metric.

@@ -581,18 +584,17 @@

Method Details

{ # Request message for ModelGardenService.DeployPublisherModel. "acceptEula": True or False, # Optional. Whether the user accepts the End User License Agreement (EULA) for the model. - "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration. # Optional. The dedicated resources to use for the endpoint. If not set, the default resources will be used. + "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # Optional. The dedicated resources to use for the endpoint. If not set, the default resources will be used. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], - "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine used by the prediction. + "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -602,14 +604,14 @@

Method Details

}, "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1"). }, - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). - "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. - "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial model deployment/mutation is desired. If set, the model deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). + "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. + "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "endpointDisplayName": "A String", # Optional. The user-specified display name of the endpoint. If not set, a default name will be used. "huggingFaceAccessToken": "A String", # Optional. The Hugging Face read access token used to access the model artifacts of gated models. - "model": "A String", # Required. The name of the PublisherModel resource. Format: `publishers/{publisher}/models/{publisher_model}@{version_id}`, or `publishers/hf-{hugging-face-author}/models/{hugging-face-model-name}@001` or Hugging Face model ID like `google/gemma-2-2b-it`. + "model": "A String", # Required. The model to deploy. Format: 1. `publishers/{publisher}/models/{publisher_model}@{version_id}`, or `publishers/hf-{hugging-face-author}/models/{hugging-face-model-name}@001`. 2. Hugging Face model ID like `google/gemma-2-2b-it`. 3. Custom model Google Cloud Storage URI like `gs://bucket`. 4. Custom model zip file like `https://abc.com/a.zip`. "modelDisplayName": "A String", # Optional. The user-specified display name of the uploaded model. If not set, a default name will be used. } @@ -642,6 +644,94 @@

Method Details

}
+
+ evaluateDataset(location, body=None, x__xgafv=None) +
Evaluates a dataset based on a set of given metrics.
+
+Args:
+  location: string, Required. The resource name of the Location to evaluate the dataset. Format: `projects/{project}/locations/{location}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for EvaluationService.EvaluateDataset.
+  "autoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Autorater config used for evaluation.
+    "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+    "flipEnabled": True or False, # Optional. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.
+    "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.
+  },
+  "dataset": { # The dataset used for evaluation. # Required. The dataset used for evaluation.
+    "bigquerySource": { # The BigQuery location for the input content. # BigQuery source holds the dataset.
+      "inputUri": "A String", # Required. BigQuery URI to a table, up to 2000 characters long. Accepted forms: * BigQuery path. For example: `bq://projectId.bqDatasetId.bqTableId`.
+    },
+    "gcsSource": { # The Google Cloud Storage location for the input content. # Cloud storage source holds the dataset.
+      "uris": [ # Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames.
+        "A String",
+      ],
+    },
+  },
+  "metrics": [ # Required. The metrics used for evaluation.
+    { # The metric used for dataset level evaluation.
+      "aggregationMetrics": [ # Optional. The aggregation metrics to use.
+        "A String",
+      ],
+      "bleuSpec": { # Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1. # Spec for bleu metric.
+        "useEffectiveOrder": True or False, # Optional. Whether to use_effective_order to compute bleu score.
+      },
+      "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric.
+      },
+      "pairwiseMetricSpec": { # Spec for pairwise metric. # Spec for pairwise metric.
+        "baselineResponseFieldName": "A String", # Optional. The field name of the baseline response.
+        "candidateResponseFieldName": "A String", # Optional. The field name of the candidate response.
+        "metricPromptTemplate": "A String", # Required. Metric prompt template for pairwise metric.
+        "systemInstruction": "A String", # Optional. System instructions for pairwise metric.
+      },
+      "pointwiseMetricSpec": { # Spec for pointwise metric. # Spec for pointwise metric.
+        "metricPromptTemplate": "A String", # Required. Metric prompt template for pointwise metric.
+        "systemInstruction": "A String", # Optional. System instructions for pointwise metric.
+      },
+      "rougeSpec": { # Spec for rouge score metric - calculates the recall of n-grams in prediction as compared to reference - returns a score ranging between 0 and 1. # Spec for rouge metric.
+        "rougeType": "A String", # Optional. Supported rouge types are rougen[1-9], rougeL, and rougeLsum.
+        "splitSummaries": True or False, # Optional. Whether to split summaries while using rougeLsum.
+        "useStemmer": True or False, # Optional. Whether to use stemmer to compute rouge score.
+      },
+    },
+  ],
+  "outputConfig": { # Config for evaluation output. # Required. Config for evaluation output.
+    "gcsDestination": { # The Google Cloud Storage location where the output is to be written to. # Cloud storage destination for evaluation output.
+      "outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist.
+    },
+  },
+}
+
+  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.
+  },
+}
+
+
evaluateInstances(location, body=None, x__xgafv=None)
Evaluates instances based on a given metric.
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.hyperparameterTuningJobs.html b/docs/dyn/aiplatform_v1beta1.projects.locations.hyperparameterTuningJobs.html
index 81aa9d5eb7d..a491ca524d8 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.hyperparameterTuningJobs.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.hyperparameterTuningJobs.html
@@ -325,7 +325,6 @@ 

Method Details

"acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -602,7 +601,6 @@

Method Details

"acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -921,7 +919,6 @@

Method Details

"acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -1211,7 +1208,6 @@

Method Details

"acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.indexEndpoints.html b/docs/dyn/aiplatform_v1beta1.projects.locations.indexEndpoints.html index 8720541903b..d815512c106 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.indexEndpoints.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.indexEndpoints.html @@ -135,22 +135,21 @@

Method Details

"deployedIndexes": [ # Output only. The indexes deployed in this endpoint. { # A deployment of an Index. IndexEndpoints contain one or more DeployedIndexes. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # Optional. A description of resources that the DeployedIndex uses, which to large degree are decided by Vertex AI, and optionally allows only a modest additional configuration. If min_replica_count is not set, the default value is 2 (we don't provide SLA when min_replica_count=1). If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. - "minReplicaCount": 42, # Immutable. The minimum number of replicas this DeployedModel will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. + "minReplicaCount": 42, # Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. }, "createTime": "A String", # Output only. Timestamp when the DeployedIndex was created. - "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration. # Optional. A description of resources that are dedicated to the DeployedIndex, and that need a higher degree of manual configuration. The field min_replica_count must be set to a value strictly greater than 0, or else validation will fail. We don't provide SLA when min_replica_count=1. If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. Available machine types for SMALL shard: e2-standard-2 and all machine types available for MEDIUM and LARGE shard. Available machine types for MEDIUM shard: e2-standard-16 and all machine types available for LARGE shard. Available machine types for LARGE shard: e2-highmem-16, n2d-standard-32. n1-standard-16 and n1-standard-32 are still available, but we recommend e2-standard-16 and e2-highmem-16 for cost efficiency. + "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # Optional. A description of resources that are dedicated to the DeployedIndex, and that need a higher degree of manual configuration. The field min_replica_count must be set to a value strictly greater than 0, or else validation will fail. We don't provide SLA when min_replica_count=1. If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. Available machine types for SMALL shard: e2-standard-2 and all machine types available for MEDIUM and LARGE shard. Available machine types for MEDIUM shard: e2-standard-16 and all machine types available for LARGE shard. Available machine types for LARGE shard: e2-highmem-16, n2d-standard-32. n1-standard-16 and n1-standard-32 are still available, but we recommend e2-standard-16 and e2-highmem-16 for cost efficiency. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], - "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine used by the prediction. + "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -160,9 +159,9 @@

Method Details

}, "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1"). }, - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). - "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. - "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial model deployment/mutation is desired. If set, the model deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). + "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. + "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "deployedIndexAuthConfig": { # Used to set up the auth on the DeployedIndex's private endpoint. # Optional. If set, the authentication is enabled for the private endpoint. @@ -306,22 +305,21 @@

Method Details

{ # Request message for IndexEndpointService.DeployIndex. "deployedIndex": { # A deployment of an Index. IndexEndpoints contain one or more DeployedIndexes. # Required. The DeployedIndex to be created within the IndexEndpoint. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # Optional. A description of resources that the DeployedIndex uses, which to large degree are decided by Vertex AI, and optionally allows only a modest additional configuration. If min_replica_count is not set, the default value is 2 (we don't provide SLA when min_replica_count=1). If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. - "minReplicaCount": 42, # Immutable. The minimum number of replicas this DeployedModel will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. + "minReplicaCount": 42, # Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. }, "createTime": "A String", # Output only. Timestamp when the DeployedIndex was created. - "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration. # Optional. A description of resources that are dedicated to the DeployedIndex, and that need a higher degree of manual configuration. The field min_replica_count must be set to a value strictly greater than 0, or else validation will fail. We don't provide SLA when min_replica_count=1. If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. Available machine types for SMALL shard: e2-standard-2 and all machine types available for MEDIUM and LARGE shard. Available machine types for MEDIUM shard: e2-standard-16 and all machine types available for LARGE shard. Available machine types for LARGE shard: e2-highmem-16, n2d-standard-32. n1-standard-16 and n1-standard-32 are still available, but we recommend e2-standard-16 and e2-highmem-16 for cost efficiency. + "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # Optional. A description of resources that are dedicated to the DeployedIndex, and that need a higher degree of manual configuration. The field min_replica_count must be set to a value strictly greater than 0, or else validation will fail. We don't provide SLA when min_replica_count=1. If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. Available machine types for SMALL shard: e2-standard-2 and all machine types available for MEDIUM and LARGE shard. Available machine types for MEDIUM shard: e2-standard-16 and all machine types available for LARGE shard. Available machine types for LARGE shard: e2-highmem-16, n2d-standard-32. n1-standard-16 and n1-standard-32 are still available, but we recommend e2-standard-16 and e2-highmem-16 for cost efficiency. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], - "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine used by the prediction. + "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -331,9 +329,9 @@

Method Details

}, "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1"). }, - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). - "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. - "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial model deployment/mutation is desired. If set, the model deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). + "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. + "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "deployedIndexAuthConfig": { # Used to set up the auth on the DeployedIndex's private endpoint. # Optional. If set, the authentication is enabled for the private endpoint. @@ -545,22 +543,21 @@

Method Details

"deployedIndexes": [ # Output only. The indexes deployed in this endpoint. { # A deployment of an Index. IndexEndpoints contain one or more DeployedIndexes. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # Optional. A description of resources that the DeployedIndex uses, which to large degree are decided by Vertex AI, and optionally allows only a modest additional configuration. If min_replica_count is not set, the default value is 2 (we don't provide SLA when min_replica_count=1). If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. - "minReplicaCount": 42, # Immutable. The minimum number of replicas this DeployedModel will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. + "minReplicaCount": 42, # Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. }, "createTime": "A String", # Output only. Timestamp when the DeployedIndex was created. - "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration. # Optional. A description of resources that are dedicated to the DeployedIndex, and that need a higher degree of manual configuration. The field min_replica_count must be set to a value strictly greater than 0, or else validation will fail. We don't provide SLA when min_replica_count=1. If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. Available machine types for SMALL shard: e2-standard-2 and all machine types available for MEDIUM and LARGE shard. Available machine types for MEDIUM shard: e2-standard-16 and all machine types available for LARGE shard. Available machine types for LARGE shard: e2-highmem-16, n2d-standard-32. n1-standard-16 and n1-standard-32 are still available, but we recommend e2-standard-16 and e2-highmem-16 for cost efficiency. + "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # Optional. A description of resources that are dedicated to the DeployedIndex, and that need a higher degree of manual configuration. The field min_replica_count must be set to a value strictly greater than 0, or else validation will fail. We don't provide SLA when min_replica_count=1. If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. Available machine types for SMALL shard: e2-standard-2 and all machine types available for MEDIUM and LARGE shard. Available machine types for MEDIUM shard: e2-standard-16 and all machine types available for LARGE shard. Available machine types for LARGE shard: e2-highmem-16, n2d-standard-32. n1-standard-16 and n1-standard-32 are still available, but we recommend e2-standard-16 and e2-highmem-16 for cost efficiency. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], - "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine used by the prediction. + "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -570,9 +567,9 @@

Method Details

}, "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1"). }, - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). - "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. - "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial model deployment/mutation is desired. If set, the model deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). + "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. + "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "deployedIndexAuthConfig": { # Used to set up the auth on the DeployedIndex's private endpoint. # Optional. If set, the authentication is enabled for the private endpoint. @@ -666,22 +663,21 @@

Method Details

"deployedIndexes": [ # Output only. The indexes deployed in this endpoint. { # A deployment of an Index. IndexEndpoints contain one or more DeployedIndexes. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # Optional. A description of resources that the DeployedIndex uses, which to large degree are decided by Vertex AI, and optionally allows only a modest additional configuration. If min_replica_count is not set, the default value is 2 (we don't provide SLA when min_replica_count=1). If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. - "minReplicaCount": 42, # Immutable. The minimum number of replicas this DeployedModel will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. + "minReplicaCount": 42, # Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. }, "createTime": "A String", # Output only. Timestamp when the DeployedIndex was created. - "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration. # Optional. A description of resources that are dedicated to the DeployedIndex, and that need a higher degree of manual configuration. The field min_replica_count must be set to a value strictly greater than 0, or else validation will fail. We don't provide SLA when min_replica_count=1. If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. Available machine types for SMALL shard: e2-standard-2 and all machine types available for MEDIUM and LARGE shard. Available machine types for MEDIUM shard: e2-standard-16 and all machine types available for LARGE shard. Available machine types for LARGE shard: e2-highmem-16, n2d-standard-32. n1-standard-16 and n1-standard-32 are still available, but we recommend e2-standard-16 and e2-highmem-16 for cost efficiency. + "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # Optional. A description of resources that are dedicated to the DeployedIndex, and that need a higher degree of manual configuration. The field min_replica_count must be set to a value strictly greater than 0, or else validation will fail. We don't provide SLA when min_replica_count=1. If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. Available machine types for SMALL shard: e2-standard-2 and all machine types available for MEDIUM and LARGE shard. Available machine types for MEDIUM shard: e2-standard-16 and all machine types available for LARGE shard. Available machine types for LARGE shard: e2-highmem-16, n2d-standard-32. n1-standard-16 and n1-standard-32 are still available, but we recommend e2-standard-16 and e2-highmem-16 for cost efficiency. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], - "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine used by the prediction. + "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -691,9 +687,9 @@

Method Details

}, "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1"). }, - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). - "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. - "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial model deployment/mutation is desired. If set, the model deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). + "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. + "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "deployedIndexAuthConfig": { # Used to set up the auth on the DeployedIndex's private endpoint. # Optional. If set, the authentication is enabled for the private endpoint. @@ -790,22 +786,21 @@

Method Details

{ # A deployment of an Index. IndexEndpoints contain one or more DeployedIndexes. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # Optional. A description of resources that the DeployedIndex uses, which to large degree are decided by Vertex AI, and optionally allows only a modest additional configuration. If min_replica_count is not set, the default value is 2 (we don't provide SLA when min_replica_count=1). If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. - "minReplicaCount": 42, # Immutable. The minimum number of replicas this DeployedModel will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. + "minReplicaCount": 42, # Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. }, "createTime": "A String", # Output only. Timestamp when the DeployedIndex was created. - "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration. # Optional. A description of resources that are dedicated to the DeployedIndex, and that need a higher degree of manual configuration. The field min_replica_count must be set to a value strictly greater than 0, or else validation will fail. We don't provide SLA when min_replica_count=1. If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. Available machine types for SMALL shard: e2-standard-2 and all machine types available for MEDIUM and LARGE shard. Available machine types for MEDIUM shard: e2-standard-16 and all machine types available for LARGE shard. Available machine types for LARGE shard: e2-highmem-16, n2d-standard-32. n1-standard-16 and n1-standard-32 are still available, but we recommend e2-standard-16 and e2-highmem-16 for cost efficiency. + "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # Optional. A description of resources that are dedicated to the DeployedIndex, and that need a higher degree of manual configuration. The field min_replica_count must be set to a value strictly greater than 0, or else validation will fail. We don't provide SLA when min_replica_count=1. If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. Available machine types for SMALL shard: e2-standard-2 and all machine types available for MEDIUM and LARGE shard. Available machine types for MEDIUM shard: e2-standard-16 and all machine types available for LARGE shard. Available machine types for LARGE shard: e2-highmem-16, n2d-standard-32. n1-standard-16 and n1-standard-32 are still available, but we recommend e2-standard-16 and e2-highmem-16 for cost efficiency. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], - "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine used by the prediction. + "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -815,9 +810,9 @@

Method Details

}, "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1"). }, - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). - "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. - "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial model deployment/mutation is desired. If set, the model deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). + "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. + "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "deployedIndexAuthConfig": { # Used to set up the auth on the DeployedIndex's private endpoint. # Optional. If set, the authentication is enabled for the private endpoint. @@ -901,22 +896,21 @@

Method Details

"deployedIndexes": [ # Output only. The indexes deployed in this endpoint. { # A deployment of an Index. IndexEndpoints contain one or more DeployedIndexes. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # Optional. A description of resources that the DeployedIndex uses, which to large degree are decided by Vertex AI, and optionally allows only a modest additional configuration. If min_replica_count is not set, the default value is 2 (we don't provide SLA when min_replica_count=1). If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. - "minReplicaCount": 42, # Immutable. The minimum number of replicas this DeployedModel will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. + "minReplicaCount": 42, # Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. }, "createTime": "A String", # Output only. Timestamp when the DeployedIndex was created. - "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration. # Optional. A description of resources that are dedicated to the DeployedIndex, and that need a higher degree of manual configuration. The field min_replica_count must be set to a value strictly greater than 0, or else validation will fail. We don't provide SLA when min_replica_count=1. If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. Available machine types for SMALL shard: e2-standard-2 and all machine types available for MEDIUM and LARGE shard. Available machine types for MEDIUM shard: e2-standard-16 and all machine types available for LARGE shard. Available machine types for LARGE shard: e2-highmem-16, n2d-standard-32. n1-standard-16 and n1-standard-32 are still available, but we recommend e2-standard-16 and e2-highmem-16 for cost efficiency. + "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # Optional. A description of resources that are dedicated to the DeployedIndex, and that need a higher degree of manual configuration. The field min_replica_count must be set to a value strictly greater than 0, or else validation will fail. We don't provide SLA when min_replica_count=1. If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. Available machine types for SMALL shard: e2-standard-2 and all machine types available for MEDIUM and LARGE shard. Available machine types for MEDIUM shard: e2-standard-16 and all machine types available for LARGE shard. Available machine types for LARGE shard: e2-highmem-16, n2d-standard-32. n1-standard-16 and n1-standard-32 are still available, but we recommend e2-standard-16 and e2-highmem-16 for cost efficiency. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], - "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine used by the prediction. + "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -926,9 +920,9 @@

Method Details

}, "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1"). }, - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). - "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. - "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial model deployment/mutation is desired. If set, the model deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). + "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. + "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "deployedIndexAuthConfig": { # Used to set up the auth on the DeployedIndex's private endpoint. # Optional. If set, the authentication is enabled for the private endpoint. @@ -1010,22 +1004,21 @@

Method Details

"deployedIndexes": [ # Output only. The indexes deployed in this endpoint. { # A deployment of an Index. IndexEndpoints contain one or more DeployedIndexes. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # Optional. A description of resources that the DeployedIndex uses, which to large degree are decided by Vertex AI, and optionally allows only a modest additional configuration. If min_replica_count is not set, the default value is 2 (we don't provide SLA when min_replica_count=1). If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. - "minReplicaCount": 42, # Immutable. The minimum number of replicas this DeployedModel will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. + "minReplicaCount": 42, # Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. }, "createTime": "A String", # Output only. Timestamp when the DeployedIndex was created. - "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration. # Optional. A description of resources that are dedicated to the DeployedIndex, and that need a higher degree of manual configuration. The field min_replica_count must be set to a value strictly greater than 0, or else validation will fail. We don't provide SLA when min_replica_count=1. If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. Available machine types for SMALL shard: e2-standard-2 and all machine types available for MEDIUM and LARGE shard. Available machine types for MEDIUM shard: e2-standard-16 and all machine types available for LARGE shard. Available machine types for LARGE shard: e2-highmem-16, n2d-standard-32. n1-standard-16 and n1-standard-32 are still available, but we recommend e2-standard-16 and e2-highmem-16 for cost efficiency. + "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # Optional. A description of resources that are dedicated to the DeployedIndex, and that need a higher degree of manual configuration. The field min_replica_count must be set to a value strictly greater than 0, or else validation will fail. We don't provide SLA when min_replica_count=1. If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. Available machine types for SMALL shard: e2-standard-2 and all machine types available for MEDIUM and LARGE shard. Available machine types for MEDIUM shard: e2-standard-16 and all machine types available for LARGE shard. Available machine types for LARGE shard: e2-highmem-16, n2d-standard-32. n1-standard-16 and n1-standard-32 are still available, but we recommend e2-standard-16 and e2-highmem-16 for cost efficiency. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], - "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine used by the prediction. + "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -1035,9 +1028,9 @@

Method Details

}, "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1"). }, - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). - "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. - "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial model deployment/mutation is desired. If set, the model deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). + "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. + "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "deployedIndexAuthConfig": { # Used to set up the auth on the DeployedIndex's private endpoint. # Optional. If set, the authentication is enabled for the private endpoint. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.modelMonitors.html b/docs/dyn/aiplatform_v1beta1.projects.locations.modelMonitors.html index 485f8635abc..15bd13ea4e4 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.modelMonitors.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.modelMonitors.html @@ -305,7 +305,6 @@

Method Details

"acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -653,7 +652,6 @@

Method Details

"acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -942,7 +940,6 @@

Method Details

"acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -1237,7 +1234,6 @@

Method Details

"acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.modelMonitors.modelMonitoringJobs.html b/docs/dyn/aiplatform_v1beta1.projects.locations.modelMonitors.modelMonitoringJobs.html index 7b02b178d7c..3b9c5b13f8a 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.modelMonitors.modelMonitoringJobs.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.modelMonitors.modelMonitoringJobs.html @@ -315,7 +315,6 @@

Method Details

"acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -638,7 +637,6 @@

Method Details

"acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -1002,7 +1000,6 @@

Method Details

"acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -1337,7 +1334,6 @@

Method Details

"acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.models.html b/docs/dyn/aiplatform_v1beta1.projects.locations.models.html index 3dacf672a0c..9ae055de18f 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.models.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.models.html @@ -1032,9 +1032,10 @@

Method Details

{ # Response message for ModelService.ListModelVersionCheckpoints "checkpoints": [ # List of Model Version checkpoints. - { # A proto representation of a Spanner-stored ModelVersionCheckpoint. The meaning of the fields is equivalent to their in-Spanner counterparts. + { # Describes the machine learning model version checkpoint. "checkpointId": "A String", # The ID of the checkpoint. "epoch": "A String", # The epoch of the checkpoint. + "name": "A String", # Identifier. The resource name of the ModelVersionCheckpoint. Format: `projects/{project}/locations/{location}/models/{model}/versions/{version}/checkpoints/{checkpoint}` "step": "A String", # The step of the checkpoint. }, ], diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.nasJobs.html b/docs/dyn/aiplatform_v1beta1.projects.locations.nasJobs.html index c4ef8732c11..c84e092b60e 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.nasJobs.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.nasJobs.html @@ -265,7 +265,6 @@

Method Details

"acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -360,7 +359,6 @@

Method Details

"acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -543,7 +541,6 @@

Method Details

"acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -638,7 +635,6 @@

Method Details

"acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -863,7 +859,6 @@

Method Details

"acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -958,7 +953,6 @@

Method Details

"acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -1154,7 +1148,6 @@

Method Details

"acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -1249,7 +1242,6 @@

Method Details

"acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.notebookExecutionJobs.html b/docs/dyn/aiplatform_v1beta1.projects.locations.notebookExecutionJobs.html index 52319e2db2f..5ad2591c1e8 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.notebookExecutionJobs.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.notebookExecutionJobs.html @@ -125,7 +125,6 @@

Method Details

"acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -306,7 +305,6 @@

Method Details

"acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -401,7 +399,6 @@

Method Details

"acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.notebookRuntimeTemplates.html b/docs/dyn/aiplatform_v1beta1.projects.locations.notebookRuntimeTemplates.html index c5a69e32218..4c9223bb732 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.notebookRuntimeTemplates.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.notebookRuntimeTemplates.html @@ -152,7 +152,6 @@

Method Details

"acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -299,7 +298,6 @@

Method Details

"acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -425,7 +423,6 @@

Method Details

"acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -519,7 +516,6 @@

Method Details

"acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -596,7 +592,6 @@

Method Details

"acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.notebookRuntimes.html b/docs/dyn/aiplatform_v1beta1.projects.locations.notebookRuntimes.html index 8cf9a4f8c58..58c807765b8 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.notebookRuntimes.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.notebookRuntimes.html @@ -152,7 +152,6 @@

Method Details

"acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -345,7 +344,6 @@

Method Details

"acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -446,7 +444,6 @@

Method Details

"acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.persistentResources.html b/docs/dyn/aiplatform_v1beta1.projects.locations.persistentResources.html index 694c523e10f..df42e5d22ca 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.persistentResources.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.persistentResources.html @@ -159,7 +159,6 @@

Method Details

"acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -332,7 +331,6 @@

Method Details

"acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -446,7 +444,6 @@

Method Details

"acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -566,7 +563,6 @@

Method Details

"acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html index 3fd106073fb..409642f49a3 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html @@ -322,9 +322,6 @@

Method Details

"A String", ], "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - }, "topK": 3.14, # Optional. If specified, top-k sampling will be used. "topP": 3.14, # Optional. If specified, nucleus sampling will be used. }, @@ -690,9 +687,6 @@

Method Details

"A String", ], "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - }, "topK": 3.14, # Optional. If specified, top-k sampling will be used. "topP": 3.14, # Optional. If specified, nucleus sampling will be used. }, @@ -1555,9 +1549,6 @@

Method Details

"A String", ], "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - }, "topK": 3.14, # Optional. If specified, top-k sampling will be used. "topP": 3.14, # Optional. If specified, nucleus sampling will be used. }, diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.schedules.html b/docs/dyn/aiplatform_v1beta1.projects.locations.schedules.html index 2e67d56f2ef..a3fa80d4588 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.schedules.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.schedules.html @@ -333,7 +333,6 @@

Method Details

"acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -449,7 +448,6 @@

Method Details

"acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -1030,7 +1028,6 @@

Method Details

"acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -1146,7 +1143,6 @@

Method Details

"acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -1769,7 +1765,6 @@

Method Details

"acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -1885,7 +1880,6 @@

Method Details

"acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -2480,7 +2474,6 @@

Method Details

"acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -2596,7 +2589,6 @@

Method Details

"acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -3195,7 +3187,6 @@

Method Details

"acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -3311,7 +3302,6 @@

Method Details

"acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -3893,7 +3883,6 @@

Method Details

"acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -4009,7 +3998,6 @@

Method Details

"acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. diff --git a/docs/dyn/aiplatform_v1beta1.publishers.models.html b/docs/dyn/aiplatform_v1beta1.publishers.models.html index 9e689d930d4..182f6c4cbc5 100644 --- a/docs/dyn/aiplatform_v1beta1.publishers.models.html +++ b/docs/dyn/aiplatform_v1beta1.publishers.models.html @@ -313,9 +313,6 @@

Method Details

"A String", ], "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - }, "topK": 3.14, # Optional. If specified, top-k sampling will be used. "topP": 3.14, # Optional. If specified, nucleus sampling will be used. }, @@ -639,9 +636,6 @@

Method Details

"A String", ], "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - }, "topK": 3.14, # Optional. If specified, top-k sampling will be used. "topP": 3.14, # Optional. If specified, nucleus sampling will be used. }, @@ -1100,8 +1094,8 @@

Method Details

"deploy": { # Model metadata that is needed for UploadModel or DeployModel/CreateEndpoint requests. # Optional. Deploy the PublisherModel to Vertex Endpoint. "artifactUri": "A String", # Optional. The path to the directory containing the Model artifact and any of its supporting files. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. - "minReplicaCount": 42, # Immutable. The minimum number of replicas this DeployedModel will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. + "minReplicaCount": 42, # Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. }, "containerSpec": { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # Optional. The specification of the container that is to be used when deploying this Model in Vertex AI. Not present for Large Models. "args": [ # Immutable. Specifies arguments for the command that runs when the container starts. This overrides the container's [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd). Specify this field as an array of executable and arguments, similar to a Docker `CMD`'s "default parameters" form. If you don't specify this field but do specify the command field, then the command from the `command` field runs without any additional arguments. See the [Kubernetes documentation about how the `command` and `args` fields interact with a container's `ENTRYPOINT` and `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). If you don't specify this field and don't specify the `command` field, then the container's [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#cmd) and `CMD` determine what runs based on their default behavior. See the Docker documentation about [how `CMD` and `ENTRYPOINT` interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). In this field, you can reference [environment variables set by Vertex AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to the `args` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). @@ -1228,18 +1222,17 @@

Method Details

"timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Must be greater or equal to period_seconds. Maps to Kubernetes probe argument 'timeoutSeconds'. }, }, - "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. + "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], - "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine used by the prediction. + "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -1249,9 +1242,9 @@

Method Details

}, "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1"). }, - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). - "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. - "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial model deployment/mutation is desired. If set, the model deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). + "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. + "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "deployMetadata": { # Metadata information about the deployment for managing deployment config. # Optional. Metadata information about this deployment config. @@ -1279,8 +1272,8 @@

Method Details

{ # Model metadata that is needed for UploadModel or DeployModel/CreateEndpoint requests. "artifactUri": "A String", # Optional. The path to the directory containing the Model artifact and any of its supporting files. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. - "minReplicaCount": 42, # Immutable. The minimum number of replicas this DeployedModel will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. + "minReplicaCount": 42, # Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. }, "containerSpec": { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # Optional. The specification of the container that is to be used when deploying this Model in Vertex AI. Not present for Large Models. "args": [ # Immutable. Specifies arguments for the command that runs when the container starts. This overrides the container's [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd). Specify this field as an array of executable and arguments, similar to a Docker `CMD`'s "default parameters" form. If you don't specify this field but do specify the command field, then the command from the `command` field runs without any additional arguments. See the [Kubernetes documentation about how the `command` and `args` fields interact with a container's `ENTRYPOINT` and `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). If you don't specify this field and don't specify the `command` field, then the container's [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#cmd) and `CMD` determine what runs based on their default behavior. See the Docker documentation about [how `CMD` and `ENTRYPOINT` interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). In this field, you can reference [environment variables set by Vertex AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to the `args` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). @@ -1407,18 +1400,17 @@

Method Details

"timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Must be greater or equal to period_seconds. Maps to Kubernetes probe argument 'timeoutSeconds'. }, }, - "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. + "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], - "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine used by the prediction. + "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -1428,9 +1420,9 @@

Method Details

}, "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1"). }, - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). - "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. - "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial model deployment/mutation is desired. If set, the model deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). + "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. + "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "deployMetadata": { # Metadata information about the deployment for managing deployment config. # Optional. Metadata information about this deployment config. @@ -1668,8 +1660,8 @@

Method Details

"deploy": { # Model metadata that is needed for UploadModel or DeployModel/CreateEndpoint requests. # Optional. Deploy the PublisherModel to Vertex Endpoint. "artifactUri": "A String", # Optional. The path to the directory containing the Model artifact and any of its supporting files. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. - "minReplicaCount": 42, # Immutable. The minimum number of replicas this DeployedModel will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. + "minReplicaCount": 42, # Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. }, "containerSpec": { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # Optional. The specification of the container that is to be used when deploying this Model in Vertex AI. Not present for Large Models. "args": [ # Immutable. Specifies arguments for the command that runs when the container starts. This overrides the container's [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd). Specify this field as an array of executable and arguments, similar to a Docker `CMD`'s "default parameters" form. If you don't specify this field but do specify the command field, then the command from the `command` field runs without any additional arguments. See the [Kubernetes documentation about how the `command` and `args` fields interact with a container's `ENTRYPOINT` and `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). If you don't specify this field and don't specify the `command` field, then the container's [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#cmd) and `CMD` determine what runs based on their default behavior. See the Docker documentation about [how `CMD` and `ENTRYPOINT` interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). In this field, you can reference [environment variables set by Vertex AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to the `args` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). @@ -1796,18 +1788,17 @@

Method Details

"timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Must be greater or equal to period_seconds. Maps to Kubernetes probe argument 'timeoutSeconds'. }, }, - "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. + "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], - "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine used by the prediction. + "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -1817,9 +1808,9 @@

Method Details

}, "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1"). }, - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). - "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. - "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial model deployment/mutation is desired. If set, the model deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). + "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. + "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "deployMetadata": { # Metadata information about the deployment for managing deployment config. # Optional. Metadata information about this deployment config. @@ -1847,8 +1838,8 @@

Method Details

{ # Model metadata that is needed for UploadModel or DeployModel/CreateEndpoint requests. "artifactUri": "A String", # Optional. The path to the directory containing the Model artifact and any of its supporting files. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. - "minReplicaCount": 42, # Immutable. The minimum number of replicas this DeployedModel will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. + "minReplicaCount": 42, # Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. }, "containerSpec": { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # Optional. The specification of the container that is to be used when deploying this Model in Vertex AI. Not present for Large Models. "args": [ # Immutable. Specifies arguments for the command that runs when the container starts. This overrides the container's [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd). Specify this field as an array of executable and arguments, similar to a Docker `CMD`'s "default parameters" form. If you don't specify this field but do specify the command field, then the command from the `command` field runs without any additional arguments. See the [Kubernetes documentation about how the `command` and `args` fields interact with a container's `ENTRYPOINT` and `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). If you don't specify this field and don't specify the `command` field, then the container's [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#cmd) and `CMD` determine what runs based on their default behavior. See the Docker documentation about [how `CMD` and `ENTRYPOINT` interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). In this field, you can reference [environment variables set by Vertex AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to the `args` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). @@ -1975,18 +1966,17 @@

Method Details

"timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Must be greater or equal to period_seconds. Maps to Kubernetes probe argument 'timeoutSeconds'. }, }, - "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. + "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], - "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine used by the prediction. + "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments. "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation. "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type. @@ -1996,9 +1986,9 @@

Method Details

}, "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1"). }, - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). - "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. - "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial model deployment/mutation is desired. If set, the model deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). + "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. + "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "deployMetadata": { # Metadata information about the deployment for managing deployment config. # Optional. Metadata information about this deployment config. @@ -2342,9 +2332,6 @@

Method Details

"A String", ], "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - }, "topK": 3.14, # Optional. If specified, top-k sampling will be used. "topP": 3.14, # Optional. If specified, nucleus sampling will be used. }, diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1.json index cc477607ce2..eb4fcee2085 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1.json @@ -983,6 +983,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"evaluateDataset": { +"description": "Evaluates a dataset based on a set of given metrics.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}:evaluateDataset", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.evaluateDataset", +"parameterOrder": [ +"location" +], +"parameters": { +"location": { +"description": "Required. The resource name of the Location to evaluate the dataset. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+location}:evaluateDataset", +"request": { +"$ref": "GoogleCloudAiplatformV1EvaluateDatasetRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "evaluateInstances": { "description": "Evaluates instances based on a given metric.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:evaluateInstances", @@ -19421,7 +19449,7 @@ } } }, -"revision": "20250205", +"revision": "20250212", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoResponse": { @@ -20261,12 +20289,12 @@ "id": "GoogleCloudAiplatformV1AutomaticResources", "properties": { "maxReplicaCount": { -"description": "Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number.", +"description": "Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number.", "format": "int32", "type": "integer" }, "minReplicaCount": { -"description": "Immutable. The minimum number of replicas this DeployedModel will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error.", +"description": "Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error.", "format": "int32", "type": "integer" } @@ -21137,7 +21165,7 @@ "type": "string" }, "model": { -"description": "Immutable. The name of the publisher model to use for cached content. Format: projects/{project}/locations/{location}/publishers/{publisher}/models/{model}", +"description": "Immutable. The name of the `Model` to use for cached content. Currently, only the published Gemini base models are supported, in form of projects/{PROJECT}/locations/{LOCATION}/publishers/google/models/{MODEL}", "type": "string" }, "name": { @@ -22929,7 +22957,7 @@ "type": "object" }, "GoogleCloudAiplatformV1DedicatedResources": { -"description": "A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration.", +"description": "A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration.", "id": "GoogleCloudAiplatformV1DedicatedResources", "properties": { "autoscalingMetricSpecs": { @@ -22941,20 +22969,20 @@ }, "machineSpec": { "$ref": "GoogleCloudAiplatformV1MachineSpec", -"description": "Required. Immutable. The specification of a single machine used by the prediction." +"description": "Required. Immutable. The specification of a single machine being used." }, "maxReplicaCount": { -"description": "Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type).", +"description": "Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type).", "format": "int32", "type": "integer" }, "minReplicaCount": { -"description": "Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed.", +"description": "Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed.", "format": "int32", "type": "integer" }, "requiredReplicaCount": { -"description": "Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial model deployment/mutation is desired. If set, the model deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count.", +"description": "Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count.", "format": "int32", "type": "integer" }, @@ -23871,6 +23899,32 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1EvaluateDatasetRequest": { +"description": "Request message for EvaluationService.EvaluateDataset.", +"id": "GoogleCloudAiplatformV1EvaluateDatasetRequest", +"properties": { +"autoraterConfig": { +"$ref": "GoogleCloudAiplatformV1AutoraterConfig", +"description": "Optional. Autorater config used for evaluation." +}, +"dataset": { +"$ref": "GoogleCloudAiplatformV1EvaluationDataset", +"description": "Required. The dataset used for evaluation." +}, +"metrics": { +"description": "Required. The metrics used for evaluation.", +"items": { +"$ref": "GoogleCloudAiplatformV1Metric" +}, +"type": "array" +}, +"outputConfig": { +"$ref": "GoogleCloudAiplatformV1OutputConfig", +"description": "Required. Config for evaluation output." +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1EvaluateInstancesRequest": { "description": "Request message for EvaluationService.EvaluateInstances.", "id": "GoogleCloudAiplatformV1EvaluateInstancesRequest", @@ -24216,6 +24270,21 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1EvaluationDataset": { +"description": "The dataset used for evaluation.", +"id": "GoogleCloudAiplatformV1EvaluationDataset", +"properties": { +"bigquerySource": { +"$ref": "GoogleCloudAiplatformV1BigQuerySource", +"description": "BigQuery source holds the dataset." +}, +"gcsSource": { +"$ref": "GoogleCloudAiplatformV1GcsSource", +"description": "Cloud storage source holds the dataset." +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1Event": { "description": "An edge describing the relationship between an Artifact and an Execution in a lineage graph.", "id": "GoogleCloudAiplatformV1Event", @@ -29815,6 +29884,66 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1Metric": { +"description": "The metric used for dataset level evaluation.", +"id": "GoogleCloudAiplatformV1Metric", +"properties": { +"aggregationMetrics": { +"description": "Optional. The aggregation metrics to use.", +"items": { +"enum": [ +"AGGREGATION_METRIC_UNSPECIFIED", +"AVERAGE", +"MODE", +"STANDARD_DEVIATION", +"VARIANCE", +"MINIMUM", +"MAXIMUM", +"MEDIAN", +"PERCENTILE_P90", +"PERCENTILE_P95", +"PERCENTILE_P99" +], +"enumDescriptions": [ +"Unspecified aggregation metric.", +"Average aggregation metric.", +"Mode aggregation metric.", +"Standard deviation aggregation metric.", +"Variance aggregation metric.", +"Minimum aggregation metric.", +"Maximum aggregation metric.", +"Median aggregation metric.", +"90th percentile aggregation metric.", +"95th percentile aggregation metric.", +"99th percentile aggregation metric." +], +"type": "string" +}, +"type": "array" +}, +"bleuSpec": { +"$ref": "GoogleCloudAiplatformV1BleuSpec", +"description": "Spec for bleu metric." +}, +"exactMatchSpec": { +"$ref": "GoogleCloudAiplatformV1ExactMatchSpec", +"description": "Spec for exact match metric." +}, +"pairwiseMetricSpec": { +"$ref": "GoogleCloudAiplatformV1PairwiseMetricSpec", +"description": "Spec for pairwise metric." +}, +"pointwiseMetricSpec": { +"$ref": "GoogleCloudAiplatformV1PointwiseMetricSpec", +"description": "Spec for pointwise metric." +}, +"rougeSpec": { +"$ref": "GoogleCloudAiplatformV1RougeSpec", +"description": "Spec for rouge metric." +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1MetricxInput": { "description": "Input for MetricX metric.", "id": "GoogleCloudAiplatformV1MetricxInput", @@ -31320,7 +31449,7 @@ false "type": "object" }, "GoogleCloudAiplatformV1ModelVersionCheckpoint": { -"description": "A proto representation of a Spanner-stored ModelVersionCheckpoint. The meaning of the fields is equivalent to their in-Spanner counterparts.", +"description": "Describes the machine learning model version checkpoint.", "id": "GoogleCloudAiplatformV1ModelVersionCheckpoint", "properties": { "checkpointId": { @@ -31332,6 +31461,10 @@ false "format": "int64", "type": "string" }, +"name": { +"description": "Identifier. The resource name of the ModelVersionCheckpoint. Format: `projects/{project}/locations/{location}/models/{model}/versions/{version}/checkpoints/{checkpoint}`", +"type": "string" +}, "step": { "description": "The step of the checkpoint.", "format": "int64", @@ -32656,6 +32789,17 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1OutputConfig": { +"description": "Config for evaluation output.", +"id": "GoogleCloudAiplatformV1OutputConfig", +"properties": { +"gcsDestination": { +"$ref": "GoogleCloudAiplatformV1GcsDestination", +"description": "Cloud storage destination for evaluation output." +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1PSCAutomationConfig": { "description": "PSC config that is used to automatically create forwarding rule via ServiceConnectionMap.", "id": "GoogleCloudAiplatformV1PSCAutomationConfig", @@ -38906,7 +39050,7 @@ false "id": "GoogleCloudAiplatformV1SchemaTextDataItem", "properties": { "gcsUri": { -"description": "Output only. Google Cloud Storage URI points to the original text in user's bucket. The text file is up to 10MB in size.", +"description": "Output only. Google Cloud Storage URI points to a copy of the original text in the Vertex-managed bucket in the user's project. The text file is up to 10MB in size.", "readOnly": true, "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json index 2ca5ca22099..8658f2525f4 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json @@ -1012,6 +1012,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"evaluateDataset": { +"description": "Evaluates a dataset based on a set of given metrics.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:evaluateDataset", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.evaluateDataset", +"parameterOrder": [ +"location" +], +"parameters": { +"location": { +"description": "Required. The resource name of the Location to evaluate the dataset. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+location}:evaluateDataset", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1EvaluateDatasetRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "evaluateInstances": { "description": "Evaluates instances based on a given metric.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:evaluateInstances", @@ -22092,7 +22120,7 @@ } } }, -"revision": "20250205", +"revision": "20250212", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoResponse": { @@ -23096,12 +23124,12 @@ "id": "GoogleCloudAiplatformV1beta1AutomaticResources", "properties": { "maxReplicaCount": { -"description": "Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number.", +"description": "Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number.", "format": "int32", "type": "integer" }, "minReplicaCount": { -"description": "Immutable. The minimum number of replicas this DeployedModel will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error.", +"description": "Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error.", "format": "int32", "type": "integer" } @@ -24016,7 +24044,7 @@ "type": "string" }, "model": { -"description": "Immutable. The name of the publisher model to use for cached content. Format: projects/{project}/locations/{location}/publishers/{publisher}/models/{model}", +"description": "Immutable. The name of the `Model` to use for cached content. Currently, only the published Gemini base models are supported, in form of projects/{PROJECT}/locations/{LOCATION}/publishers/google/models/{MODEL}", "type": "string" }, "name": { @@ -26000,7 +26028,7 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1DedicatedResources": { -"description": "A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration.", +"description": "A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration.", "id": "GoogleCloudAiplatformV1beta1DedicatedResources", "properties": { "autoscalingMetricSpecs": { @@ -26012,20 +26040,20 @@ }, "machineSpec": { "$ref": "GoogleCloudAiplatformV1beta1MachineSpec", -"description": "Required. Immutable. The specification of a single machine used by the prediction." +"description": "Required. Immutable. The specification of a single machine being used." }, "maxReplicaCount": { -"description": "Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type).", +"description": "Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type).", "format": "int32", "type": "integer" }, "minReplicaCount": { -"description": "Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed.", +"description": "Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed.", "format": "int32", "type": "integer" }, "requiredReplicaCount": { -"description": "Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial model deployment/mutation is desired. If set, the model deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count.", +"description": "Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count.", "format": "int32", "type": "integer" }, @@ -26267,7 +26295,7 @@ "type": "string" }, "model": { -"description": "Required. The name of the PublisherModel resource. Format: `publishers/{publisher}/models/{publisher_model}@{version_id}`, or `publishers/hf-{hugging-face-author}/models/{hugging-face-model-name}@001` or Hugging Face model ID like `google/gemma-2-2b-it`.", +"description": "Required. The model to deploy. Format: 1. `publishers/{publisher}/models/{publisher_model}@{version_id}`, or `publishers/hf-{hugging-face-author}/models/{hugging-face-model-name}@001`. 2. Hugging Face model ID like `google/gemma-2-2b-it`. 3. Custom model Google Cloud Storage URI like `gs://bucket`. 4. Custom model zip file like `https://abc.com/a.zip`.", "type": "string" }, "modelDisplayName": { @@ -27075,6 +27103,32 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1EvaluateDatasetRequest": { +"description": "Request message for EvaluationService.EvaluateDataset.", +"id": "GoogleCloudAiplatformV1beta1EvaluateDatasetRequest", +"properties": { +"autoraterConfig": { +"$ref": "GoogleCloudAiplatformV1beta1AutoraterConfig", +"description": "Optional. Autorater config used for evaluation." +}, +"dataset": { +"$ref": "GoogleCloudAiplatformV1beta1EvaluationDataset", +"description": "Required. The dataset used for evaluation." +}, +"metrics": { +"description": "Required. The metrics used for evaluation.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1Metric" +}, +"type": "array" +}, +"outputConfig": { +"$ref": "GoogleCloudAiplatformV1beta1OutputConfig", +"description": "Required. Config for evaluation output." +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1EvaluateInstancesRequest": { "description": "Request message for EvaluationService.EvaluateInstances.", "id": "GoogleCloudAiplatformV1beta1EvaluateInstancesRequest", @@ -27420,6 +27474,21 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1EvaluationDataset": { +"description": "The dataset used for evaluation.", +"id": "GoogleCloudAiplatformV1beta1EvaluationDataset", +"properties": { +"bigquerySource": { +"$ref": "GoogleCloudAiplatformV1beta1BigQuerySource", +"description": "BigQuery source holds the dataset." +}, +"gcsSource": { +"$ref": "GoogleCloudAiplatformV1beta1GcsSource", +"description": "Cloud storage source holds the dataset." +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1Event": { "description": "An edge describing the relationship between an Artifact and an Execution in a lineage graph.", "id": "GoogleCloudAiplatformV1beta1Event", @@ -31050,10 +31119,6 @@ "format": "float", "type": "number" }, -"thinkingConfig": { -"$ref": "GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig", -"description": "Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking." -}, "topK": { "description": "Optional. If specified, top-k sampling will be used.", "format": "float", @@ -31116,17 +31181,6 @@ }, "type": "object" }, -"GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig": { -"description": "Config for thinking features.", -"id": "GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig", -"properties": { -"includeThoughts": { -"description": "Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.", -"type": "boolean" -} -}, -"type": "object" -}, "GoogleCloudAiplatformV1beta1GenericOperationMetadata": { "description": "Generic Metadata shared by all operations.", "id": "GoogleCloudAiplatformV1beta1GenericOperationMetadata", @@ -33634,11 +33688,6 @@ false "description": "Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.", "type": "string" }, -"multihostGpuNodeCount": { -"description": "Optional. Immutable. The number of nodes per replica for multihost GPU deployments.", -"format": "int32", -"type": "integer" -}, "reservationAffinity": { "$ref": "GoogleCloudAiplatformV1beta1ReservationAffinity", "description": "Optional. Immutable. Configuration controlling how this resource pool consumes reservation." @@ -33831,6 +33880,66 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1beta1Metric": { +"description": "The metric used for dataset level evaluation.", +"id": "GoogleCloudAiplatformV1beta1Metric", +"properties": { +"aggregationMetrics": { +"description": "Optional. The aggregation metrics to use.", +"items": { +"enum": [ +"AGGREGATION_METRIC_UNSPECIFIED", +"AVERAGE", +"MODE", +"STANDARD_DEVIATION", +"VARIANCE", +"MINIMUM", +"MAXIMUM", +"MEDIAN", +"PERCENTILE_P90", +"PERCENTILE_P95", +"PERCENTILE_P99" +], +"enumDescriptions": [ +"Unspecified aggregation metric.", +"Average aggregation metric.", +"Mode aggregation metric.", +"Standard deviation aggregation metric.", +"Variance aggregation metric.", +"Minimum aggregation metric.", +"Maximum aggregation metric.", +"Median aggregation metric.", +"90th percentile aggregation metric.", +"95th percentile aggregation metric.", +"99th percentile aggregation metric." +], +"type": "string" +}, +"type": "array" +}, +"bleuSpec": { +"$ref": "GoogleCloudAiplatformV1beta1BleuSpec", +"description": "Spec for bleu metric." +}, +"exactMatchSpec": { +"$ref": "GoogleCloudAiplatformV1beta1ExactMatchSpec", +"description": "Spec for exact match metric." +}, +"pairwiseMetricSpec": { +"$ref": "GoogleCloudAiplatformV1beta1PairwiseMetricSpec", +"description": "Spec for pairwise metric." +}, +"pointwiseMetricSpec": { +"$ref": "GoogleCloudAiplatformV1beta1PointwiseMetricSpec", +"description": "Spec for pointwise metric." +}, +"rougeSpec": { +"$ref": "GoogleCloudAiplatformV1beta1RougeSpec", +"description": "Spec for rouge metric." +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1MetricxInput": { "description": "Input for MetricX metric.", "id": "GoogleCloudAiplatformV1beta1MetricxInput", @@ -36103,7 +36212,7 @@ false "type": "object" }, "GoogleCloudAiplatformV1beta1ModelVersionCheckpoint": { -"description": "A proto representation of a Spanner-stored ModelVersionCheckpoint. The meaning of the fields is equivalent to their in-Spanner counterparts.", +"description": "Describes the machine learning model version checkpoint.", "id": "GoogleCloudAiplatformV1beta1ModelVersionCheckpoint", "properties": { "checkpointId": { @@ -36115,6 +36224,10 @@ false "format": "int64", "type": "string" }, +"name": { +"description": "Identifier. The resource name of the ModelVersionCheckpoint. Format: `projects/{project}/locations/{location}/models/{model}/versions/{version}/checkpoints/{checkpoint}`", +"type": "string" +}, "step": { "description": "The step of the checkpoint.", "format": "int64", @@ -37439,6 +37552,17 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1beta1OutputConfig": { +"description": "Config for evaluation output.", +"id": "GoogleCloudAiplatformV1beta1OutputConfig", +"properties": { +"gcsDestination": { +"$ref": "GoogleCloudAiplatformV1beta1GcsDestination", +"description": "Cloud storage destination for evaluation output." +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1PSCAutomationConfig": { "description": "PSC config that is used to automatically create forwarding rule via ServiceConnectionMap.", "id": "GoogleCloudAiplatformV1beta1PSCAutomationConfig", @@ -44500,7 +44624,7 @@ false "id": "GoogleCloudAiplatformV1beta1SchemaTextDataItem", "properties": { "gcsUri": { -"description": "Output only. Google Cloud Storage URI points to the original text in user's bucket. The text file is up to 10MB in size.", +"description": "Output only. Google Cloud Storage URI points to a copy of the original text in the Vertex-managed bucket in the user's project. The text file is up to 10MB in size.", "readOnly": true, "type": "string" } From 8ba32ab2caa5d8428b0a3965ee9ad822566be30e Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 25 Feb 2025 07:08:16 +0000 Subject: [PATCH 02/36] feat(analyticshub): update the api #### analyticshub:v1 The following keys were added: - schemas.DataExchange.properties.logLinkedDatasetQueryUserEmail.type (Total Keys: 1) - schemas.Listing.properties.logLinkedDatasetQueryUserEmail.type (Total Keys: 1) - schemas.Subscription.properties.logLinkedDatasetQueryUserEmail (Total Keys: 2) #### analyticshub:v1beta1 The following keys were added: - schemas.Subscription.properties.logLinkedDatasetQueryUserEmail (Total Keys: 2) --- ...organizations.locations.dataExchanges.html | 1 + ...b_v1.projects.locations.dataExchanges.html | 7 ++++++ ...ects.locations.dataExchanges.listings.html | 16 +++++++++--- ...b_v1.projects.locations.subscriptions.html | 2 ++ .../documents/analyticshub.v1.json | 25 ++++++++++++++----- .../documents/analyticshub.v1beta1.json | 7 +++++- 6 files changed, 47 insertions(+), 11 deletions(-) diff --git a/docs/dyn/analyticshub_v1.organizations.locations.dataExchanges.html b/docs/dyn/analyticshub_v1.organizations.locations.dataExchanges.html index 25158a2ef08..a46a632eddc 100644 --- a/docs/dyn/analyticshub_v1.organizations.locations.dataExchanges.html +++ b/docs/dyn/analyticshub_v1.organizations.locations.dataExchanges.html @@ -114,6 +114,7 @@

Method Details

"documentation": "A String", # Optional. Documentation describing the data exchange. "icon": "A String", # Optional. Base64 encoded image representing the data exchange. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the content of the fields are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire. "listingCount": 42, # Output only. Number of listings contained in the data exchange. + "logLinkedDatasetQueryUserEmail": True or False, # Optional. By default, false. If true, the DataExchange has an email sharing mandate enabled. "name": "A String", # Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`. "primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes. "sharingEnvironmentConfig": { # Sharing environment is a behavior model for sharing data within a data exchange. This option is configurable for a data exchange. # Optional. Configurable data sharing environment option for a data exchange. diff --git a/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.html b/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.html index 492e1fea1ea..e29cf934ea0 100644 --- a/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.html +++ b/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.html @@ -140,6 +140,7 @@

Method Details

"documentation": "A String", # Optional. Documentation describing the data exchange. "icon": "A String", # Optional. Base64 encoded image representing the data exchange. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the content of the fields are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire. "listingCount": 42, # Output only. Number of listings contained in the data exchange. + "logLinkedDatasetQueryUserEmail": True or False, # Optional. By default, false. If true, the DataExchange has an email sharing mandate enabled. "name": "A String", # Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`. "primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes. "sharingEnvironmentConfig": { # Sharing environment is a behavior model for sharing data within a data exchange. This option is configurable for a data exchange. # Optional. Configurable data sharing environment option for a data exchange. @@ -168,6 +169,7 @@

Method Details

"documentation": "A String", # Optional. Documentation describing the data exchange. "icon": "A String", # Optional. Base64 encoded image representing the data exchange. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the content of the fields are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire. "listingCount": 42, # Output only. Number of listings contained in the data exchange. + "logLinkedDatasetQueryUserEmail": True or False, # Optional. By default, false. If true, the DataExchange has an email sharing mandate enabled. "name": "A String", # Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`. "primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes. "sharingEnvironmentConfig": { # Sharing environment is a behavior model for sharing data within a data exchange. This option is configurable for a data exchange. # Optional. Configurable data sharing environment option for a data exchange. @@ -220,6 +222,7 @@

Method Details

"documentation": "A String", # Optional. Documentation describing the data exchange. "icon": "A String", # Optional. Base64 encoded image representing the data exchange. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the content of the fields are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire. "listingCount": 42, # Output only. Number of listings contained in the data exchange. + "logLinkedDatasetQueryUserEmail": True or False, # Optional. By default, false. If true, the DataExchange has an email sharing mandate enabled. "name": "A String", # Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`. "primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes. "sharingEnvironmentConfig": { # Sharing environment is a behavior model for sharing data within a data exchange. This option is configurable for a data exchange. # Optional. Configurable data sharing environment option for a data exchange. @@ -314,6 +317,7 @@

Method Details

"documentation": "A String", # Optional. Documentation describing the data exchange. "icon": "A String", # Optional. Base64 encoded image representing the data exchange. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the content of the fields are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire. "listingCount": 42, # Output only. Number of listings contained in the data exchange. + "logLinkedDatasetQueryUserEmail": True or False, # Optional. By default, false. If true, the DataExchange has an email sharing mandate enabled. "name": "A String", # Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`. "primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes. "sharingEnvironmentConfig": { # Sharing environment is a behavior model for sharing data within a data exchange. This option is configurable for a data exchange. # Optional. Configurable data sharing environment option for a data exchange. @@ -374,6 +378,7 @@

Method Details

}, ], "listing": "A String", # Output only. Resource name of the source Listing. e.g. projects/123/locations/US/dataExchanges/456/listings/789 + "logLinkedDatasetQueryUserEmail": True or False, # Output only. By default, false. If true, the Subscriber agreed to the email sharing mandate that is enabled for DataExchange/Listing. "name": "A String", # Output only. The resource name of the subscription. e.g. `projects/myproject/locations/US/subscriptions/123`. "organizationDisplayName": "A String", # Output only. Display name of the project of this subscription. "organizationId": "A String", # Output only. Organization of the project this subscription belongs to. @@ -429,6 +434,7 @@

Method Details

"documentation": "A String", # Optional. Documentation describing the data exchange. "icon": "A String", # Optional. Base64 encoded image representing the data exchange. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the content of the fields are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire. "listingCount": 42, # Output only. Number of listings contained in the data exchange. + "logLinkedDatasetQueryUserEmail": True or False, # Optional. By default, false. If true, the DataExchange has an email sharing mandate enabled. "name": "A String", # Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`. "primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes. "sharingEnvironmentConfig": { # Sharing environment is a behavior model for sharing data within a data exchange. This option is configurable for a data exchange. # Optional. Configurable data sharing environment option for a data exchange. @@ -457,6 +463,7 @@

Method Details

"documentation": "A String", # Optional. Documentation describing the data exchange. "icon": "A String", # Optional. Base64 encoded image representing the data exchange. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the content of the fields are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire. "listingCount": 42, # Output only. Number of listings contained in the data exchange. + "logLinkedDatasetQueryUserEmail": True or False, # Optional. By default, false. If true, the DataExchange has an email sharing mandate enabled. "name": "A String", # Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`. "primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes. "sharingEnvironmentConfig": { # Sharing environment is a behavior model for sharing data within a data exchange. This option is configurable for a data exchange. # Optional. Configurable data sharing environment option for a data exchange. diff --git a/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.listings.html b/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.listings.html index 76064b4fab8..24454f49136 100644 --- a/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.listings.html +++ b/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.listings.html @@ -161,6 +161,7 @@

Method Details

"displayName": "A String", # Required. Human-readable display name of the listing. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and can't start or end with spaces. Default value is an empty string. Max length: 63 bytes. "documentation": "A String", # Optional. Documentation describing the listing. "icon": "A String", # Optional. Base64 encoded image representing the listing. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the contents of the field are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire. + "logLinkedDatasetQueryUserEmail": True or False, # Optional. By default, false. If true, the Listing has an email sharing mandate enabled. "name": "A String", # Output only. The resource name of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456` "primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the listing. Max Length: 1000 bytes. "publisher": { # Contains details of the listing publisher. # Optional. Details of the publisher who owns the listing and who can share the source data. @@ -225,6 +226,7 @@

Method Details

"displayName": "A String", # Required. Human-readable display name of the listing. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and can't start or end with spaces. Default value is an empty string. Max length: 63 bytes. "documentation": "A String", # Optional. Documentation describing the listing. "icon": "A String", # Optional. Base64 encoded image representing the listing. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the contents of the field are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire. + "logLinkedDatasetQueryUserEmail": True or False, # Optional. By default, false. If true, the Listing has an email sharing mandate enabled. "name": "A String", # Output only. The resource name of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456` "primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the listing. Max Length: 1000 bytes. "publisher": { # Contains details of the listing publisher. # Optional. Details of the publisher who owns the listing and who can share the source data. @@ -313,6 +315,7 @@

Method Details

"displayName": "A String", # Required. Human-readable display name of the listing. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and can't start or end with spaces. Default value is an empty string. Max length: 63 bytes. "documentation": "A String", # Optional. Documentation describing the listing. "icon": "A String", # Optional. Base64 encoded image representing the listing. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the contents of the field are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire. + "logLinkedDatasetQueryUserEmail": True or False, # Optional. By default, false. If true, the Listing has an email sharing mandate enabled. "name": "A String", # Output only. The resource name of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456` "primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the listing. Max Length: 1000 bytes. "publisher": { # Contains details of the listing publisher. # Optional. Details of the publisher who owns the listing and who can share the source data. @@ -443,6 +446,7 @@

Method Details

"displayName": "A String", # Required. Human-readable display name of the listing. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and can't start or end with spaces. Default value is an empty string. Max length: 63 bytes. "documentation": "A String", # Optional. Documentation describing the listing. "icon": "A String", # Optional. Base64 encoded image representing the listing. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the contents of the field are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire. + "logLinkedDatasetQueryUserEmail": True or False, # Optional. By default, false. If true, the Listing has an email sharing mandate enabled. "name": "A String", # Output only. The resource name of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456` "primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the listing. Max Length: 1000 bytes. "publisher": { # Contains details of the listing publisher. # Optional. Details of the publisher who owns the listing and who can share the source data. @@ -513,6 +517,7 @@

Method Details

}, ], "listing": "A String", # Output only. Resource name of the source Listing. e.g. projects/123/locations/US/dataExchanges/456/listings/789 + "logLinkedDatasetQueryUserEmail": True or False, # Output only. By default, false. If true, the Subscriber agreed to the email sharing mandate that is enabled for DataExchange/Listing. "name": "A String", # Output only. The resource name of the subscription. e.g. `projects/myproject/locations/US/subscriptions/123`. "organizationDisplayName": "A String", # Output only. Display name of the project of this subscription. "organizationId": "A String", # Output only. Organization of the project this subscription belongs to. @@ -594,6 +599,7 @@

Method Details

"displayName": "A String", # Required. Human-readable display name of the listing. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and can't start or end with spaces. Default value is an empty string. Max length: 63 bytes. "documentation": "A String", # Optional. Documentation describing the listing. "icon": "A String", # Optional. Base64 encoded image representing the listing. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the contents of the field are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire. + "logLinkedDatasetQueryUserEmail": True or False, # Optional. By default, false. If true, the Listing has an email sharing mandate enabled. "name": "A String", # Output only. The resource name of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456` "primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the listing. Max Length: 1000 bytes. "publisher": { # Contains details of the listing publisher. # Optional. Details of the publisher who owns the listing and who can share the source data. @@ -658,6 +664,7 @@

Method Details

"displayName": "A String", # Required. Human-readable display name of the listing. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and can't start or end with spaces. Default value is an empty string. Max length: 63 bytes. "documentation": "A String", # Optional. Documentation describing the listing. "icon": "A String", # Optional. Base64 encoded image representing the listing. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the contents of the field are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire. + "logLinkedDatasetQueryUserEmail": True or False, # Optional. By default, false. If true, the Listing has an email sharing mandate enabled. "name": "A String", # Output only. The resource name of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456` "primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the listing. Max Length: 1000 bytes. "publisher": { # Contains details of the listing publisher. # Optional. Details of the publisher who owns the listing and who can share the source data. @@ -814,7 +821,7 @@

Method Details

"filenamePrefix": "A String", # Optional. User-provided prefix for Cloud Storage filename. See the [object naming requirements](https://cloud.google.com/storage/docs/objects#naming). "filenameSuffix": "A String", # Optional. User-provided suffix for Cloud Storage filename. See the [object naming requirements](https://cloud.google.com/storage/docs/objects#naming). Must not end in "/". "maxBytes": "A String", # Optional. The maximum bytes that can be written to a Cloud Storage file before a new file is created. Min 1 KB, max 10 GiB. The max_bytes limit may be exceeded in cases where messages are larger than the limit. - "maxDuration": "A String", # Optional. The maximum duration that can elapse before a new Cloud Storage file is created. Min 1 minute, max 10 minutes, default 5 minutes. May not exceed the subscription's acknowledgement deadline. + "maxDuration": "A String", # Optional. The maximum duration that can elapse before a new Cloud Storage file is created. Min 1 minute, max 10 minutes, default 5 minutes. May not exceed the subscription's acknowledgment deadline. "maxMessages": "A String", # Optional. The maximum number of messages that can be written to a Cloud Storage file before a new file is created. Min 1000 messages. "serviceAccountEmail": "A String", # Optional. The service account to use to write to Cloud Storage. The subscription creator or updater that specifies this field must have `iam.serviceAccounts.actAs` permission on the service account. If not specified, the Pub/Sub [service agent](https://cloud.google.com/iam/docs/service-agents), service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used. "state": "A String", # Output only. An output-only field that indicates whether or not the subscription can receive messages. @@ -823,10 +830,10 @@

Method Details

}, "deadLetterPolicy": { # Dead lettering is done on a best effort basis. The same message might be dead lettered multiple times. If validation on any of the fields fails at subscription creation/updation, the create/update subscription request will fail. # Optional. A policy that specifies the conditions for dead lettering messages in this subscription. If dead_letter_policy is not set, dead lettering is disabled. The Pub/Sub service account associated with this subscriptions's parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Acknowledge() messages on this subscription. "deadLetterTopic": "A String", # Optional. The name of the topic to which dead letter messages should be published. Format is `projects/{project}/topics/{topic}`.The Pub/Sub service account associated with the enclosing subscription's parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Publish() to this topic. The operation will fail if the topic does not exist. Users should ensure that there is a subscription attached to this topic since messages published to a topic with no subscriptions are lost. - "maxDeliveryAttempts": 42, # Optional. The maximum number of delivery attempts for any message. The value must be between 5 and 100. The number of delivery attempts is defined as 1 + (the sum of number of NACKs and number of times the acknowledgement deadline has been exceeded for the message). A NACK is any call to ModifyAckDeadline with a 0 deadline. Note that client libraries may automatically extend ack_deadlines. This field will be honored on a best effort basis. If this parameter is 0, a default value of 5 is used. + "maxDeliveryAttempts": 42, # Optional. The maximum number of delivery attempts for any message. The value must be between 5 and 100. The number of delivery attempts is defined as 1 + (the sum of number of NACKs and number of times the acknowledgment deadline has been exceeded for the message). A NACK is any call to ModifyAckDeadline with a 0 deadline. Note that client libraries may automatically extend ack_deadlines. This field will be honored on a best effort basis. If this parameter is 0, a default value of 5 is used. }, "detached": True or False, # Optional. Indicates whether the subscription is detached from its topic. Detached subscriptions don't receive messages from their topic and don't retain any backlog. `Pull` and `StreamingPull` requests will return FAILED_PRECONDITION. If the subscription is a push subscription, pushes to the endpoint will not be made. - "enableExactlyOnceDelivery": True or False, # Optional. If true, Pub/Sub provides the following guarantees for the delivery of a message with a given value of `message_id` on this subscription: * The message sent to a subscriber is guaranteed not to be resent before the message's acknowledgement deadline expires. * An acknowledged message will not be resent to a subscriber. Note that subscribers may still receive multiple copies of a message when `enable_exactly_once_delivery` is true if the message was published multiple times by a publisher client. These copies are considered distinct by Pub/Sub and have distinct `message_id` values. + "enableExactlyOnceDelivery": True or False, # Optional. If true, Pub/Sub provides the following guarantees for the delivery of a message with a given value of `message_id` on this subscription: * The message sent to a subscriber is guaranteed not to be resent before the message's acknowledgment deadline expires. * An acknowledged message will not be resent to a subscriber. Note that subscribers may still receive multiple copies of a message when `enable_exactly_once_delivery` is true if the message was published multiple times by a publisher client. These copies are considered distinct by Pub/Sub and have distinct `message_id` values. "enableMessageOrdering": True or False, # Optional. If true, messages published with the same `ordering_key` in `PubsubMessage` will be delivered to the subscribers in the order in which they are received by the Pub/Sub system. Otherwise, they may be delivered in any order. "expirationPolicy": { # A policy that specifies the conditions for resource expiration (i.e., automatic resource deletion). # Optional. A policy that specifies the conditions for this subscription's expiration. A subscription is considered active as long as any connected subscriber is successfully consuming messages from the subscription or is issuing operations on the subscription. If `expiration_policy` is not set, a *default policy* with `ttl` of 31 days will be used. The minimum allowed value for `expiration_policy.ttl` is 1 day. If `expiration_policy` is set, but `expiration_policy.ttl` is not set, the subscription never expires. "ttl": "A String", # Optional. Specifies the "time-to-live" duration for an associated resource. The resource expires if it is not active for a period of `ttl`. The definition of "activity" depends on the type of the associated resource. The minimum and maximum allowed values for `ttl` depend on the type of the associated resource, as well. If `ttl` is not set, the associated resource never expires. @@ -862,7 +869,7 @@

Method Details

"pushEndpoint": "A String", # Optional. A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use `https://example.com/push`. }, "retainAckedMessages": True or False, # Optional. Indicates whether to retain acknowledged messages. If true, then messages are not expunged from the subscription's backlog, even if they are acknowledged, until they fall out of the `message_retention_duration` window. This must be true if you would like to [`Seek` to a timestamp] (https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) in the past to replay previously-acknowledged messages. - "retryPolicy": { # A policy that specifies how Pub/Sub retries message delivery. Retry delay will be exponential based on provided minimum and maximum backoffs. https://en.wikipedia.org/wiki/Exponential_backoff. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message. Retry Policy is implemented on a best effort basis. At times, the delay between consecutive deliveries may not match the configuration. That is, delay can be more or less than configured backoff. # Optional. A policy that specifies how Pub/Sub retries message delivery for this subscription. If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message. + "retryPolicy": { # A policy that specifies how Pub/Sub retries message delivery. Retry delay will be exponential based on provided minimum and maximum backoffs. https://en.wikipedia.org/wiki/Exponential_backoff. RetryPolicy will be triggered on NACKs or acknowledgment deadline exceeded events for a given message. Retry Policy is implemented on a best effort basis. At times, the delay between consecutive deliveries may not match the configuration. That is, delay can be more or less than configured backoff. # Optional. A policy that specifies how Pub/Sub retries message delivery for this subscription. If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. RetryPolicy will be triggered on NACKs or acknowledgment deadline exceeded events for a given message. "maximumBackoff": "A String", # Optional. The maximum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 600 seconds. "minimumBackoff": "A String", # Optional. The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds. }, @@ -905,6 +912,7 @@

Method Details

}, ], "listing": "A String", # Output only. Resource name of the source Listing. e.g. projects/123/locations/US/dataExchanges/456/listings/789 + "logLinkedDatasetQueryUserEmail": True or False, # Output only. By default, false. If true, the Subscriber agreed to the email sharing mandate that is enabled for DataExchange/Listing. "name": "A String", # Output only. The resource name of the subscription. e.g. `projects/myproject/locations/US/subscriptions/123`. "organizationDisplayName": "A String", # Output only. Display name of the project of this subscription. "organizationId": "A String", # Output only. Organization of the project this subscription belongs to. diff --git a/docs/dyn/analyticshub_v1.projects.locations.subscriptions.html b/docs/dyn/analyticshub_v1.projects.locations.subscriptions.html index 24cf8b7de75..0c59cde13df 100644 --- a/docs/dyn/analyticshub_v1.projects.locations.subscriptions.html +++ b/docs/dyn/analyticshub_v1.projects.locations.subscriptions.html @@ -180,6 +180,7 @@

Method Details

}, ], "listing": "A String", # Output only. Resource name of the source Listing. e.g. projects/123/locations/US/dataExchanges/456/listings/789 + "logLinkedDatasetQueryUserEmail": True or False, # Output only. By default, false. If true, the Subscriber agreed to the email sharing mandate that is enabled for DataExchange/Listing. "name": "A String", # Output only. The resource name of the subscription. e.g. `projects/myproject/locations/US/subscriptions/123`. "organizationDisplayName": "A String", # Output only. Display name of the project of this subscription. "organizationId": "A String", # Output only. Organization of the project this subscription belongs to. @@ -289,6 +290,7 @@

Method Details

}, ], "listing": "A String", # Output only. Resource name of the source Listing. e.g. projects/123/locations/US/dataExchanges/456/listings/789 + "logLinkedDatasetQueryUserEmail": True or False, # Output only. By default, false. If true, the Subscriber agreed to the email sharing mandate that is enabled for DataExchange/Listing. "name": "A String", # Output only. The resource name of the subscription. e.g. `projects/myproject/locations/US/subscriptions/123`. "organizationDisplayName": "A String", # Output only. Display name of the project of this subscription. "organizationId": "A String", # Output only. Organization of the project this subscription belongs to. diff --git a/googleapiclient/discovery_cache/documents/analyticshub.v1.json b/googleapiclient/discovery_cache/documents/analyticshub.v1.json index 8c311ab890c..83641be482f 100644 --- a/googleapiclient/discovery_cache/documents/analyticshub.v1.json +++ b/googleapiclient/discovery_cache/documents/analyticshub.v1.json @@ -1022,7 +1022,7 @@ } } }, -"revision": "20250203", +"revision": "20250217", "rootUrl": "https://analyticshub.googleapis.com/", "schemas": { "AnalyticsHubSubscriptionInfo": { @@ -1229,7 +1229,7 @@ "type": "string" }, "maxDuration": { -"description": "Optional. The maximum duration that can elapse before a new Cloud Storage file is created. Min 1 minute, max 10 minutes, default 5 minutes. May not exceed the subscription's acknowledgement deadline.", +"description": "Optional. The maximum duration that can elapse before a new Cloud Storage file is created. Min 1 minute, max 10 minutes, default 5 minutes. May not exceed the subscription's acknowledgment deadline.", "format": "google-duration", "type": "string" }, @@ -1311,6 +1311,10 @@ "readOnly": true, "type": "integer" }, +"logLinkedDatasetQueryUserEmail": { +"description": "Optional. By default, false. If true, the DataExchange has an email sharing mandate enabled.", +"type": "boolean" +}, "name": { "description": "Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`.", "readOnly": true, @@ -1368,7 +1372,7 @@ "type": "string" }, "maxDeliveryAttempts": { -"description": "Optional. The maximum number of delivery attempts for any message. The value must be between 5 and 100. The number of delivery attempts is defined as 1 + (the sum of number of NACKs and number of times the acknowledgement deadline has been exceeded for the message). A NACK is any call to ModifyAckDeadline with a 0 deadline. Note that client libraries may automatically extend ack_deadlines. This field will be honored on a best effort basis. If this parameter is 0, a default value of 5 is used.", +"description": "Optional. The maximum number of delivery attempts for any message. The value must be between 5 and 100. The number of delivery attempts is defined as 1 + (the sum of number of NACKs and number of times the acknowledgment deadline has been exceeded for the message). A NACK is any call to ModifyAckDeadline with a 0 deadline. Note that client libraries may automatically extend ack_deadlines. This field will be honored on a best effort basis. If this parameter is 0, a default value of 5 is used.", "format": "int32", "type": "integer" } @@ -1593,7 +1597,7 @@ "type": "boolean" }, "enableExactlyOnceDelivery": { -"description": "Optional. If true, Pub/Sub provides the following guarantees for the delivery of a message with a given value of `message_id` on this subscription: * The message sent to a subscriber is guaranteed not to be resent before the message's acknowledgement deadline expires. * An acknowledged message will not be resent to a subscriber. Note that subscribers may still receive multiple copies of a message when `enable_exactly_once_delivery` is true if the message was published multiple times by a publisher client. These copies are considered distinct by Pub/Sub and have distinct `message_id` values.", +"description": "Optional. If true, Pub/Sub provides the following guarantees for the delivery of a message with a given value of `message_id` on this subscription: * The message sent to a subscriber is guaranteed not to be resent before the message's acknowledgment deadline expires. * An acknowledged message will not be resent to a subscriber. Note that subscribers may still receive multiple copies of a message when `enable_exactly_once_delivery` is true if the message was published multiple times by a publisher client. These copies are considered distinct by Pub/Sub and have distinct `message_id` values.", "type": "boolean" }, "enableMessageOrdering": { @@ -1641,7 +1645,7 @@ }, "retryPolicy": { "$ref": "RetryPolicy", -"description": "Optional. A policy that specifies how Pub/Sub retries message delivery for this subscription. If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message." +"description": "Optional. A policy that specifies how Pub/Sub retries message delivery for this subscription. If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. RetryPolicy will be triggered on NACKs or acknowledgment deadline exceeded events for a given message." }, "state": { "description": "Output only. An output-only field indicating whether or not the subscription can receive messages.", @@ -1893,6 +1897,10 @@ "format": "byte", "type": "string" }, +"logLinkedDatasetQueryUserEmail": { +"description": "Optional. By default, false. If true, the Listing has an email sharing mandate enabled.", +"type": "boolean" +}, "name": { "description": "Output only. The resource name of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`", "readOnly": true, @@ -2226,7 +2234,7 @@ "type": "object" }, "RetryPolicy": { -"description": "A policy that specifies how Pub/Sub retries message delivery. Retry delay will be exponential based on provided minimum and maximum backoffs. https://en.wikipedia.org/wiki/Exponential_backoff. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message. Retry Policy is implemented on a best effort basis. At times, the delay between consecutive deliveries may not match the configuration. That is, delay can be more or less than configured backoff.", +"description": "A policy that specifies how Pub/Sub retries message delivery. Retry delay will be exponential based on provided minimum and maximum backoffs. https://en.wikipedia.org/wiki/Exponential_backoff. RetryPolicy will be triggered on NACKs or acknowledgment deadline exceeded events for a given message. Retry Policy is implemented on a best effort basis. At times, the delay between consecutive deliveries may not match the configuration. That is, delay can be more or less than configured backoff.", "id": "RetryPolicy", "properties": { "maximumBackoff": { @@ -2434,6 +2442,11 @@ "readOnly": true, "type": "string" }, +"logLinkedDatasetQueryUserEmail": { +"description": "Output only. By default, false. If true, the Subscriber agreed to the email sharing mandate that is enabled for DataExchange/Listing.", +"readOnly": true, +"type": "boolean" +}, "name": { "description": "Output only. The resource name of the subscription. e.g. `projects/myproject/locations/US/subscriptions/123`.", "readOnly": true, diff --git a/googleapiclient/discovery_cache/documents/analyticshub.v1beta1.json b/googleapiclient/discovery_cache/documents/analyticshub.v1beta1.json index aa060f16378..0537b74258c 100644 --- a/googleapiclient/discovery_cache/documents/analyticshub.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/analyticshub.v1beta1.json @@ -695,7 +695,7 @@ } } }, -"revision": "20250126", +"revision": "20250217", "rootUrl": "https://analyticshub.googleapis.com/", "schemas": { "AuditConfig": { @@ -1357,6 +1357,11 @@ "readOnly": true, "type": "string" }, +"logLinkedDatasetQueryUserEmail": { +"description": "Output only. By default, false. If true, the Subscriber agreed to the email sharing mandate that is enabled for DataExchange/Listing.", +"readOnly": true, +"type": "boolean" +}, "name": { "description": "Output only. The resource name of the subscription. e.g. `projects/myproject/locations/US/subscriptions/123`.", "readOnly": true, From 527fcb6f4a54737d6a5fd6c1e9809a1c98e70b21 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 25 Feb 2025 07:08:17 +0000 Subject: [PATCH 03/36] feat(bigquery): update the api #### bigquery:v2 The following keys were added: - schemas.ExternalDataConfiguration.properties.dateFormat.type (Total Keys: 1) - schemas.ExternalDataConfiguration.properties.datetimeFormat.type (Total Keys: 1) - schemas.ExternalDataConfiguration.properties.timeFormat.type (Total Keys: 1) - schemas.ExternalDataConfiguration.properties.timeZone.type (Total Keys: 1) - schemas.ExternalDataConfiguration.properties.timestampFormat.type (Total Keys: 1) - schemas.JobConfigurationLoad.properties.dateFormat.type (Total Keys: 1) - schemas.JobConfigurationLoad.properties.datetimeFormat.type (Total Keys: 1) - schemas.JobConfigurationLoad.properties.timeFormat.type (Total Keys: 1) - schemas.JobConfigurationLoad.properties.timeZone.type (Total Keys: 1) - schemas.JobConfigurationLoad.properties.timestampFormat.type (Total Keys: 1) - schemas.QueryRequest.properties.destinationEncryptionConfiguration.$ref (Total Keys: 1) - schemas.QueryRequest.properties.jobTimeoutMs (Total Keys: 2) --- docs/dyn/bigquery_v2.datasets.html | 2 +- docs/dyn/bigquery_v2.jobs.html | 124 +++++++++++++----- docs/dyn/bigquery_v2.models.html | 48 +++---- docs/dyn/bigquery_v2.tables.html | 65 ++++++--- .../documents/bigquery.v2.json | 75 +++++++++-- 5 files changed, 226 insertions(+), 88 deletions(-) diff --git a/docs/dyn/bigquery_v2.datasets.html b/docs/dyn/bigquery_v2.datasets.html index 7c091731bee..12461bad365 100644 --- a/docs/dyn/bigquery_v2.datasets.html +++ b/docs/dyn/bigquery_v2.datasets.html @@ -465,7 +465,7 @@

Method Details

Args: projectId: string, Required. Project ID of the datasets to be listed (required) all: boolean, Whether to list all datasets, including hidden ones - filter: string, An expression for filtering the results of the request by label. The syntax is `labels.[:]`. Multiple filters can be ANDed together by connecting with a space. Example: `labels.department:receiving labels.active`. See [Filtering datasets using labels](https://cloud.google.com/bigquery/docs/filtering-labels#filtering_datasets_using_labels) for details. + filter: string, An expression for filtering the results of the request by label. The syntax is `labels.[:]`. Multiple filters can be AND-ed together by connecting with a space. Example: `labels.department:receiving labels.active`. See [Filtering datasets using labels](https://cloud.google.com/bigquery/docs/filtering-labels#filtering_datasets_using_labels) for details. maxResults: integer, The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection. pageToken: string, Page token, returned by a previous call, to request the next page of results x__xgafv: string, V1 error format. diff --git a/docs/dyn/bigquery_v2.jobs.html b/docs/dyn/bigquery_v2.jobs.html index bb75284a32f..78696e09c44 100644 --- a/docs/dyn/bigquery_v2.jobs.html +++ b/docs/dyn/bigquery_v2.jobs.html @@ -199,7 +199,9 @@

Method Details

"copyFilesOnly": True or False, # Optional. [Experimental] Configures the load job to copy files directly to the destination BigLake managed table, bypassing file content reading and rewriting. Copying files only is supported when all the following are true: * `source_uris` are located in the same Cloud Storage location as the destination table's `storage_uri` location. * `source_format` is `PARQUET`. * `destination_table` is an existing BigLake managed table. The table's schema does not have flexible column names. The table's columns do not have type parameters other than precision and scale. * No options other than the above are specified. "createDisposition": "A String", # Optional. Specifies whether the job is allowed to create new tables. The following values are supported: * CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. * CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion. "createSession": True or False, # Optional. If this property is true, the job creates a new session using a randomly generated session_id. To continue using a created session with subsequent queries, pass the existing session identifier as a `ConnectionProperty` value. The session identifier is returned as part of the `SessionInfo` message within the query statistics. The new session's location will be set to `Job.JobReference.location` if it is present, otherwise it's set to the default location based on existing routing logic. - "decimalTargetTypes": [ # Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: * (38,9) -> NUMERIC; * (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats. + "dateFormat": "A String", # Optional. Date format used for parsing DATE values. + "datetimeFormat": "A String", # Optional. Date format used for parsing DATETIME values. + "decimalTargetTypes": [ # Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: * (38,9) -> NUMERIC; * (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if value exceeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats. "A String", ], "destinationEncryptionConfiguration": { # Configuration for Cloud KMS encryption settings. # Custom encryption configuration (e.g., Cloud KMS keys) @@ -303,12 +305,15 @@

Method Details

"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups: Exactly one URI can be specified. Also, the '*' wildcard character is not allowed. "A String", ], + "timeFormat": "A String", # Optional. Date format used for parsing TIME values. "timePartitioning": { # Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified. "expirationMs": "A String", # Optional. Number of milliseconds for which to keep the storage for a partition. A wrapper is used here because 0 is an invalid value. "field": "A String", # Optional. If not set, the table is partitioned by pseudo column '_PARTITIONTIME'; if set, the table is partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED. A wrapper is used here because an empty string is an invalid value. "requirePartitionFilter": false, # If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. This field is deprecated; please set the field with the same name on the table itself instead. This field needs a wrapper because we want to output the default value, false, if the user explicitly set it. "type": "A String", # Required. The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively. }, + "timeZone": "A String", # Optional. [Experimental] Default time zone that will apply when parsing timestamp values that have no specific time zone. + "timestampFormat": "A String", # Optional. Date format used for parsing TIMESTAMP values. "useAvroLogicalTypes": True or False, # Optional. If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER). "writeDisposition": "A String", # Optional. Specifies the action that occurs if the destination table already exists. The following values are supported: * WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the data, removes the constraints and uses the schema from the load job. * WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. * WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. }, @@ -454,7 +459,9 @@

Method Details

"quote": """, # Optional. The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ("). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. To include the specific quote character within a quoted value, precede it with an additional matching quote character. For example, if you want to escape the default character ' " ', use ' "" '. "skipLeadingRows": "A String", # Optional. The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema. }, - "decimalTargetTypes": [ # Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: * (38,9) -> NUMERIC; * (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats. + "dateFormat": "A String", # Optional. Format used to parse DATE values. Supports C-style and SQL-style values. + "datetimeFormat": "A String", # Optional. Format used to parse DATETIME values. Supports C-style and SQL-style values. + "decimalTargetTypes": [ # Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: * (38,9) -> NUMERIC; * (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if value exceeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats. "A String", ], "fileSetSpecType": "A String", # Optional. Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems. @@ -529,6 +536,9 @@

Method Details

"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the '*' wildcard character is not allowed. "A String", ], + "timeFormat": "A String", # Optional. Format used to parse TIME values. Supports C-style and SQL-style values. + "timeZone": "A String", # Optional. Time zone used when parsing timestamp values that do not have specific time zone information (e.g. 2024-04-20 12:34:56). The expected format is a IANA timezone string (e.g. America/Los_Angeles). + "timestampFormat": "A String", # Optional. Format used to parse TIMESTAMP values. Supports C-style and SQL-style values. }, }, "timePartitioning": { # Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified. @@ -705,7 +715,7 @@

Method Details

}, ], }, - "metadataCacheStatistics": { # Statistics for metadata caching in BigLake tables. # Output only. Statistics of metadata cache usage in a query for BigLake tables. + "metadataCacheStatistics": { # Statistics for metadata caching in queried tables. # Output only. Statistics of metadata cache usage in a query for BigLake tables. "tableMetadataCacheUsage": [ # Set for the Metadata caching eligible tables referenced in the query. { # Table level detail on the usage of metadata caching. Only set for Metadata caching eligible tables referenced in the query. "explanation": "A String", # Free form human-readable reason metadata caching was unused for the job. @@ -785,7 +795,7 @@

Method Details

"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier. "recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric. "rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric. - "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold. + "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classification models this is the confidence threshold. }, "binaryConfusionMatrixList": [ # Binary confusion matrix at multiple thresholds. { # Confusion matrix for binary classification models. @@ -838,7 +848,7 @@

Method Details

"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier. "recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric. "rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric. - "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold. + "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classification models this is the confidence threshold. }, "confusionMatrixList": [ # Confusion matrix at different thresholds. { # Confusion matrix for multi-class classification models. @@ -930,7 +940,7 @@

Method Details

"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier. "recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric. "rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric. - "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold. + "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classification models this is the confidence threshold. }, "binaryConfusionMatrixList": [ # Binary confusion matrix at multiple thresholds. { # Confusion matrix for binary classification models. @@ -983,7 +993,7 @@

Method Details

"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier. "recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric. "rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric. - "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold. + "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classification models this is the confidence threshold. }, "confusionMatrixList": [ # Confusion matrix at different thresholds. { # Confusion matrix for multi-class classification models. @@ -1641,7 +1651,9 @@

Method Details

"copyFilesOnly": True or False, # Optional. [Experimental] Configures the load job to copy files directly to the destination BigLake managed table, bypassing file content reading and rewriting. Copying files only is supported when all the following are true: * `source_uris` are located in the same Cloud Storage location as the destination table's `storage_uri` location. * `source_format` is `PARQUET`. * `destination_table` is an existing BigLake managed table. The table's schema does not have flexible column names. The table's columns do not have type parameters other than precision and scale. * No options other than the above are specified. "createDisposition": "A String", # Optional. Specifies whether the job is allowed to create new tables. The following values are supported: * CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. * CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion. "createSession": True or False, # Optional. If this property is true, the job creates a new session using a randomly generated session_id. To continue using a created session with subsequent queries, pass the existing session identifier as a `ConnectionProperty` value. The session identifier is returned as part of the `SessionInfo` message within the query statistics. The new session's location will be set to `Job.JobReference.location` if it is present, otherwise it's set to the default location based on existing routing logic. - "decimalTargetTypes": [ # Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: * (38,9) -> NUMERIC; * (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats. + "dateFormat": "A String", # Optional. Date format used for parsing DATE values. + "datetimeFormat": "A String", # Optional. Date format used for parsing DATETIME values. + "decimalTargetTypes": [ # Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: * (38,9) -> NUMERIC; * (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if value exceeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats. "A String", ], "destinationEncryptionConfiguration": { # Configuration for Cloud KMS encryption settings. # Custom encryption configuration (e.g., Cloud KMS keys) @@ -1745,12 +1757,15 @@

Method Details

"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups: Exactly one URI can be specified. Also, the '*' wildcard character is not allowed. "A String", ], + "timeFormat": "A String", # Optional. Date format used for parsing TIME values. "timePartitioning": { # Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified. "expirationMs": "A String", # Optional. Number of milliseconds for which to keep the storage for a partition. A wrapper is used here because 0 is an invalid value. "field": "A String", # Optional. If not set, the table is partitioned by pseudo column '_PARTITIONTIME'; if set, the table is partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED. A wrapper is used here because an empty string is an invalid value. "requirePartitionFilter": false, # If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. This field is deprecated; please set the field with the same name on the table itself instead. This field needs a wrapper because we want to output the default value, false, if the user explicitly set it. "type": "A String", # Required. The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively. }, + "timeZone": "A String", # Optional. [Experimental] Default time zone that will apply when parsing timestamp values that have no specific time zone. + "timestampFormat": "A String", # Optional. Date format used for parsing TIMESTAMP values. "useAvroLogicalTypes": True or False, # Optional. If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER). "writeDisposition": "A String", # Optional. Specifies the action that occurs if the destination table already exists. The following values are supported: * WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the data, removes the constraints and uses the schema from the load job. * WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. * WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. }, @@ -1896,7 +1911,9 @@

Method Details

"quote": """, # Optional. The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ("). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. To include the specific quote character within a quoted value, precede it with an additional matching quote character. For example, if you want to escape the default character ' " ', use ' "" '. "skipLeadingRows": "A String", # Optional. The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema. }, - "decimalTargetTypes": [ # Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: * (38,9) -> NUMERIC; * (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats. + "dateFormat": "A String", # Optional. Format used to parse DATE values. Supports C-style and SQL-style values. + "datetimeFormat": "A String", # Optional. Format used to parse DATETIME values. Supports C-style and SQL-style values. + "decimalTargetTypes": [ # Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: * (38,9) -> NUMERIC; * (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if value exceeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats. "A String", ], "fileSetSpecType": "A String", # Optional. Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems. @@ -1971,6 +1988,9 @@

Method Details

"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the '*' wildcard character is not allowed. "A String", ], + "timeFormat": "A String", # Optional. Format used to parse TIME values. Supports C-style and SQL-style values. + "timeZone": "A String", # Optional. Time zone used when parsing timestamp values that do not have specific time zone information (e.g. 2024-04-20 12:34:56). The expected format is a IANA timezone string (e.g. America/Los_Angeles). + "timestampFormat": "A String", # Optional. Format used to parse TIMESTAMP values. Supports C-style and SQL-style values. }, }, "timePartitioning": { # Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified. @@ -2147,7 +2167,7 @@

Method Details

}, ], }, - "metadataCacheStatistics": { # Statistics for metadata caching in BigLake tables. # Output only. Statistics of metadata cache usage in a query for BigLake tables. + "metadataCacheStatistics": { # Statistics for metadata caching in queried tables. # Output only. Statistics of metadata cache usage in a query for BigLake tables. "tableMetadataCacheUsage": [ # Set for the Metadata caching eligible tables referenced in the query. { # Table level detail on the usage of metadata caching. Only set for Metadata caching eligible tables referenced in the query. "explanation": "A String", # Free form human-readable reason metadata caching was unused for the job. @@ -2227,7 +2247,7 @@

Method Details

"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier. "recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric. "rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric. - "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold. + "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classification models this is the confidence threshold. }, "binaryConfusionMatrixList": [ # Binary confusion matrix at multiple thresholds. { # Confusion matrix for binary classification models. @@ -2280,7 +2300,7 @@

Method Details

"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier. "recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric. "rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric. - "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold. + "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classification models this is the confidence threshold. }, "confusionMatrixList": [ # Confusion matrix at different thresholds. { # Confusion matrix for multi-class classification models. @@ -2372,7 +2392,7 @@

Method Details

"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier. "recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric. "rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric. - "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold. + "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classification models this is the confidence threshold. }, "binaryConfusionMatrixList": [ # Binary confusion matrix at multiple thresholds. { # Confusion matrix for binary classification models. @@ -2425,7 +2445,7 @@

Method Details

"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier. "recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric. "rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric. - "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold. + "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classification models this is the confidence threshold. }, "confusionMatrixList": [ # Confusion matrix at different thresholds. { # Confusion matrix for multi-class classification models. @@ -3164,7 +3184,9 @@

Method Details

"copyFilesOnly": True or False, # Optional. [Experimental] Configures the load job to copy files directly to the destination BigLake managed table, bypassing file content reading and rewriting. Copying files only is supported when all the following are true: * `source_uris` are located in the same Cloud Storage location as the destination table's `storage_uri` location. * `source_format` is `PARQUET`. * `destination_table` is an existing BigLake managed table. The table's schema does not have flexible column names. The table's columns do not have type parameters other than precision and scale. * No options other than the above are specified. "createDisposition": "A String", # Optional. Specifies whether the job is allowed to create new tables. The following values are supported: * CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. * CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion. "createSession": True or False, # Optional. If this property is true, the job creates a new session using a randomly generated session_id. To continue using a created session with subsequent queries, pass the existing session identifier as a `ConnectionProperty` value. The session identifier is returned as part of the `SessionInfo` message within the query statistics. The new session's location will be set to `Job.JobReference.location` if it is present, otherwise it's set to the default location based on existing routing logic. - "decimalTargetTypes": [ # Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: * (38,9) -> NUMERIC; * (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats. + "dateFormat": "A String", # Optional. Date format used for parsing DATE values. + "datetimeFormat": "A String", # Optional. Date format used for parsing DATETIME values. + "decimalTargetTypes": [ # Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: * (38,9) -> NUMERIC; * (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if value exceeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats. "A String", ], "destinationEncryptionConfiguration": { # Configuration for Cloud KMS encryption settings. # Custom encryption configuration (e.g., Cloud KMS keys) @@ -3268,12 +3290,15 @@

Method Details

"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups: Exactly one URI can be specified. Also, the '*' wildcard character is not allowed. "A String", ], + "timeFormat": "A String", # Optional. Date format used for parsing TIME values. "timePartitioning": { # Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified. "expirationMs": "A String", # Optional. Number of milliseconds for which to keep the storage for a partition. A wrapper is used here because 0 is an invalid value. "field": "A String", # Optional. If not set, the table is partitioned by pseudo column '_PARTITIONTIME'; if set, the table is partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED. A wrapper is used here because an empty string is an invalid value. "requirePartitionFilter": false, # If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. This field is deprecated; please set the field with the same name on the table itself instead. This field needs a wrapper because we want to output the default value, false, if the user explicitly set it. "type": "A String", # Required. The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively. }, + "timeZone": "A String", # Optional. [Experimental] Default time zone that will apply when parsing timestamp values that have no specific time zone. + "timestampFormat": "A String", # Optional. Date format used for parsing TIMESTAMP values. "useAvroLogicalTypes": True or False, # Optional. If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER). "writeDisposition": "A String", # Optional. Specifies the action that occurs if the destination table already exists. The following values are supported: * WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the data, removes the constraints and uses the schema from the load job. * WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. * WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. }, @@ -3419,7 +3444,9 @@

Method Details

"quote": """, # Optional. The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ("). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. To include the specific quote character within a quoted value, precede it with an additional matching quote character. For example, if you want to escape the default character ' " ', use ' "" '. "skipLeadingRows": "A String", # Optional. The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema. }, - "decimalTargetTypes": [ # Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: * (38,9) -> NUMERIC; * (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats. + "dateFormat": "A String", # Optional. Format used to parse DATE values. Supports C-style and SQL-style values. + "datetimeFormat": "A String", # Optional. Format used to parse DATETIME values. Supports C-style and SQL-style values. + "decimalTargetTypes": [ # Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: * (38,9) -> NUMERIC; * (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if value exceeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats. "A String", ], "fileSetSpecType": "A String", # Optional. Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems. @@ -3494,6 +3521,9 @@

Method Details

"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the '*' wildcard character is not allowed. "A String", ], + "timeFormat": "A String", # Optional. Format used to parse TIME values. Supports C-style and SQL-style values. + "timeZone": "A String", # Optional. Time zone used when parsing timestamp values that do not have specific time zone information (e.g. 2024-04-20 12:34:56). The expected format is a IANA timezone string (e.g. America/Los_Angeles). + "timestampFormat": "A String", # Optional. Format used to parse TIMESTAMP values. Supports C-style and SQL-style values. }, }, "timePartitioning": { # Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified. @@ -3670,7 +3700,7 @@

Method Details

}, ], }, - "metadataCacheStatistics": { # Statistics for metadata caching in BigLake tables. # Output only. Statistics of metadata cache usage in a query for BigLake tables. + "metadataCacheStatistics": { # Statistics for metadata caching in queried tables. # Output only. Statistics of metadata cache usage in a query for BigLake tables. "tableMetadataCacheUsage": [ # Set for the Metadata caching eligible tables referenced in the query. { # Table level detail on the usage of metadata caching. Only set for Metadata caching eligible tables referenced in the query. "explanation": "A String", # Free form human-readable reason metadata caching was unused for the job. @@ -3750,7 +3780,7 @@

Method Details

"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier. "recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric. "rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric. - "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold. + "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classification models this is the confidence threshold. }, "binaryConfusionMatrixList": [ # Binary confusion matrix at multiple thresholds. { # Confusion matrix for binary classification models. @@ -3803,7 +3833,7 @@

Method Details

"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier. "recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric. "rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric. - "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold. + "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classification models this is the confidence threshold. }, "confusionMatrixList": [ # Confusion matrix at different thresholds. { # Confusion matrix for multi-class classification models. @@ -3895,7 +3925,7 @@

Method Details

"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier. "recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric. "rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric. - "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold. + "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classification models this is the confidence threshold. }, "binaryConfusionMatrixList": [ # Binary confusion matrix at multiple thresholds. { # Confusion matrix for binary classification models. @@ -3948,7 +3978,7 @@

Method Details

"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier. "recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric. "rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric. - "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold. + "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classification models this is the confidence threshold. }, "confusionMatrixList": [ # Confusion matrix at different thresholds. { # Confusion matrix for multi-class classification models. @@ -4577,7 +4607,9 @@

Method Details

"copyFilesOnly": True or False, # Optional. [Experimental] Configures the load job to copy files directly to the destination BigLake managed table, bypassing file content reading and rewriting. Copying files only is supported when all the following are true: * `source_uris` are located in the same Cloud Storage location as the destination table's `storage_uri` location. * `source_format` is `PARQUET`. * `destination_table` is an existing BigLake managed table. The table's schema does not have flexible column names. The table's columns do not have type parameters other than precision and scale. * No options other than the above are specified. "createDisposition": "A String", # Optional. Specifies whether the job is allowed to create new tables. The following values are supported: * CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. * CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion. "createSession": True or False, # Optional. If this property is true, the job creates a new session using a randomly generated session_id. To continue using a created session with subsequent queries, pass the existing session identifier as a `ConnectionProperty` value. The session identifier is returned as part of the `SessionInfo` message within the query statistics. The new session's location will be set to `Job.JobReference.location` if it is present, otherwise it's set to the default location based on existing routing logic. - "decimalTargetTypes": [ # Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: * (38,9) -> NUMERIC; * (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats. + "dateFormat": "A String", # Optional. Date format used for parsing DATE values. + "datetimeFormat": "A String", # Optional. Date format used for parsing DATETIME values. + "decimalTargetTypes": [ # Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: * (38,9) -> NUMERIC; * (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if value exceeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats. "A String", ], "destinationEncryptionConfiguration": { # Configuration for Cloud KMS encryption settings. # Custom encryption configuration (e.g., Cloud KMS keys) @@ -4681,12 +4713,15 @@

Method Details

"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups: Exactly one URI can be specified. Also, the '*' wildcard character is not allowed. "A String", ], + "timeFormat": "A String", # Optional. Date format used for parsing TIME values. "timePartitioning": { # Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified. "expirationMs": "A String", # Optional. Number of milliseconds for which to keep the storage for a partition. A wrapper is used here because 0 is an invalid value. "field": "A String", # Optional. If not set, the table is partitioned by pseudo column '_PARTITIONTIME'; if set, the table is partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED. A wrapper is used here because an empty string is an invalid value. "requirePartitionFilter": false, # If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. This field is deprecated; please set the field with the same name on the table itself instead. This field needs a wrapper because we want to output the default value, false, if the user explicitly set it. "type": "A String", # Required. The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively. }, + "timeZone": "A String", # Optional. [Experimental] Default time zone that will apply when parsing timestamp values that have no specific time zone. + "timestampFormat": "A String", # Optional. Date format used for parsing TIMESTAMP values. "useAvroLogicalTypes": True or False, # Optional. If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER). "writeDisposition": "A String", # Optional. Specifies the action that occurs if the destination table already exists. The following values are supported: * WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the data, removes the constraints and uses the schema from the load job. * WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. * WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. }, @@ -4832,7 +4867,9 @@

Method Details

"quote": """, # Optional. The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ("). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. To include the specific quote character within a quoted value, precede it with an additional matching quote character. For example, if you want to escape the default character ' " ', use ' "" '. "skipLeadingRows": "A String", # Optional. The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema. }, - "decimalTargetTypes": [ # Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: * (38,9) -> NUMERIC; * (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats. + "dateFormat": "A String", # Optional. Format used to parse DATE values. Supports C-style and SQL-style values. + "datetimeFormat": "A String", # Optional. Format used to parse DATETIME values. Supports C-style and SQL-style values. + "decimalTargetTypes": [ # Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: * (38,9) -> NUMERIC; * (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if value exceeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats. "A String", ], "fileSetSpecType": "A String", # Optional. Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems. @@ -4907,6 +4944,9 @@

Method Details

"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the '*' wildcard character is not allowed. "A String", ], + "timeFormat": "A String", # Optional. Format used to parse TIME values. Supports C-style and SQL-style values. + "timeZone": "A String", # Optional. Time zone used when parsing timestamp values that do not have specific time zone information (e.g. 2024-04-20 12:34:56). The expected format is a IANA timezone string (e.g. America/Los_Angeles). + "timestampFormat": "A String", # Optional. Format used to parse TIMESTAMP values. Supports C-style and SQL-style values. }, }, "timePartitioning": { # Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified. @@ -5083,7 +5123,7 @@

Method Details

}, ], }, - "metadataCacheStatistics": { # Statistics for metadata caching in BigLake tables. # Output only. Statistics of metadata cache usage in a query for BigLake tables. + "metadataCacheStatistics": { # Statistics for metadata caching in queried tables. # Output only. Statistics of metadata cache usage in a query for BigLake tables. "tableMetadataCacheUsage": [ # Set for the Metadata caching eligible tables referenced in the query. { # Table level detail on the usage of metadata caching. Only set for Metadata caching eligible tables referenced in the query. "explanation": "A String", # Free form human-readable reason metadata caching was unused for the job. @@ -5163,7 +5203,7 @@

Method Details

"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier. "recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric. "rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric. - "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold. + "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classification models this is the confidence threshold. }, "binaryConfusionMatrixList": [ # Binary confusion matrix at multiple thresholds. { # Confusion matrix for binary classification models. @@ -5216,7 +5256,7 @@

Method Details

"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier. "recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric. "rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric. - "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold. + "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classification models this is the confidence threshold. }, "confusionMatrixList": [ # Confusion matrix at different thresholds. { # Confusion matrix for multi-class classification models. @@ -5308,7 +5348,7 @@

Method Details

"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier. "recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric. "rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric. - "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold. + "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classification models this is the confidence threshold. }, "binaryConfusionMatrixList": [ # Binary confusion matrix at multiple thresholds. { # Confusion matrix for binary classification models. @@ -5361,7 +5401,7 @@

Method Details

"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier. "recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric. "rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric. - "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold. + "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classification models this is the confidence threshold. }, "confusionMatrixList": [ # Confusion matrix at different thresholds. { # Confusion matrix for multi-class classification models. @@ -6013,7 +6053,9 @@

Method Details

"copyFilesOnly": True or False, # Optional. [Experimental] Configures the load job to copy files directly to the destination BigLake managed table, bypassing file content reading and rewriting. Copying files only is supported when all the following are true: * `source_uris` are located in the same Cloud Storage location as the destination table's `storage_uri` location. * `source_format` is `PARQUET`. * `destination_table` is an existing BigLake managed table. The table's schema does not have flexible column names. The table's columns do not have type parameters other than precision and scale. * No options other than the above are specified. "createDisposition": "A String", # Optional. Specifies whether the job is allowed to create new tables. The following values are supported: * CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. * CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion. "createSession": True or False, # Optional. If this property is true, the job creates a new session using a randomly generated session_id. To continue using a created session with subsequent queries, pass the existing session identifier as a `ConnectionProperty` value. The session identifier is returned as part of the `SessionInfo` message within the query statistics. The new session's location will be set to `Job.JobReference.location` if it is present, otherwise it's set to the default location based on existing routing logic. - "decimalTargetTypes": [ # Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: * (38,9) -> NUMERIC; * (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats. + "dateFormat": "A String", # Optional. Date format used for parsing DATE values. + "datetimeFormat": "A String", # Optional. Date format used for parsing DATETIME values. + "decimalTargetTypes": [ # Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: * (38,9) -> NUMERIC; * (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if value exceeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats. "A String", ], "destinationEncryptionConfiguration": { # Configuration for Cloud KMS encryption settings. # Custom encryption configuration (e.g., Cloud KMS keys) @@ -6117,12 +6159,15 @@

Method Details

"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups: Exactly one URI can be specified. Also, the '*' wildcard character is not allowed. "A String", ], + "timeFormat": "A String", # Optional. Date format used for parsing TIME values. "timePartitioning": { # Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified. "expirationMs": "A String", # Optional. Number of milliseconds for which to keep the storage for a partition. A wrapper is used here because 0 is an invalid value. "field": "A String", # Optional. If not set, the table is partitioned by pseudo column '_PARTITIONTIME'; if set, the table is partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED. A wrapper is used here because an empty string is an invalid value. "requirePartitionFilter": false, # If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. This field is deprecated; please set the field with the same name on the table itself instead. This field needs a wrapper because we want to output the default value, false, if the user explicitly set it. "type": "A String", # Required. The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively. }, + "timeZone": "A String", # Optional. [Experimental] Default time zone that will apply when parsing timestamp values that have no specific time zone. + "timestampFormat": "A String", # Optional. Date format used for parsing TIMESTAMP values. "useAvroLogicalTypes": True or False, # Optional. If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER). "writeDisposition": "A String", # Optional. Specifies the action that occurs if the destination table already exists. The following values are supported: * WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the data, removes the constraints and uses the schema from the load job. * WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. * WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. }, @@ -6268,7 +6313,9 @@

Method Details

"quote": """, # Optional. The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ("). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. To include the specific quote character within a quoted value, precede it with an additional matching quote character. For example, if you want to escape the default character ' " ', use ' "" '. "skipLeadingRows": "A String", # Optional. The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema. }, - "decimalTargetTypes": [ # Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: * (38,9) -> NUMERIC; * (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats. + "dateFormat": "A String", # Optional. Format used to parse DATE values. Supports C-style and SQL-style values. + "datetimeFormat": "A String", # Optional. Format used to parse DATETIME values. Supports C-style and SQL-style values. + "decimalTargetTypes": [ # Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: * (38,9) -> NUMERIC; * (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if value exceeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats. "A String", ], "fileSetSpecType": "A String", # Optional. Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems. @@ -6343,6 +6390,9 @@

Method Details

"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the '*' wildcard character is not allowed. "A String", ], + "timeFormat": "A String", # Optional. Format used to parse TIME values. Supports C-style and SQL-style values. + "timeZone": "A String", # Optional. Time zone used when parsing timestamp values that do not have specific time zone information (e.g. 2024-04-20 12:34:56). The expected format is a IANA timezone string (e.g. America/Los_Angeles). + "timestampFormat": "A String", # Optional. Format used to parse TIMESTAMP values. Supports C-style and SQL-style values. }, }, "timePartitioning": { # Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified. @@ -6521,7 +6571,7 @@

Method Details

}, ], }, - "metadataCacheStatistics": { # Statistics for metadata caching in BigLake tables. # Output only. Statistics of metadata cache usage in a query for BigLake tables. + "metadataCacheStatistics": { # Statistics for metadata caching in queried tables. # Output only. Statistics of metadata cache usage in a query for BigLake tables. "tableMetadataCacheUsage": [ # Set for the Metadata caching eligible tables referenced in the query. { # Table level detail on the usage of metadata caching. Only set for Metadata caching eligible tables referenced in the query. "explanation": "A String", # Free form human-readable reason metadata caching was unused for the job. @@ -6601,7 +6651,7 @@

Method Details

"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier. "recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric. "rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric. - "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold. + "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classification models this is the confidence threshold. }, "binaryConfusionMatrixList": [ # Binary confusion matrix at multiple thresholds. { # Confusion matrix for binary classification models. @@ -6654,7 +6704,7 @@

Method Details

"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier. "recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric. "rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric. - "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold. + "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classification models this is the confidence threshold. }, "confusionMatrixList": [ # Confusion matrix at different thresholds. { # Confusion matrix for multi-class classification models. @@ -6746,7 +6796,7 @@

Method Details

"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier. "recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric. "rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric. - "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold. + "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classification models this is the confidence threshold. }, "binaryConfusionMatrixList": [ # Binary confusion matrix at multiple thresholds. { # Confusion matrix for binary classification models. @@ -6799,7 +6849,7 @@

Method Details

"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier. "recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric. "rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric. - "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold. + "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classification models this is the confidence threshold. }, "confusionMatrixList": [ # Confusion matrix at different thresholds. { # Confusion matrix for multi-class classification models. @@ -7385,11 +7435,15 @@

Method Details

"datasetId": "A String", # Required. A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. "projectId": "A String", # Optional. The ID of the project containing this dataset. }, + "destinationEncryptionConfiguration": { # Configuration for Cloud KMS encryption settings. # Optional. Custom encryption configuration (e.g., Cloud KMS keys) + "kmsKeyName": "A String", # Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key. + }, "dryRun": True or False, # Optional. If set to true, BigQuery doesn't run the job. Instead, if the query is valid, BigQuery returns statistics about the job such as how many bytes would be processed. If the query is invalid, an error returns. The default value is false. "formatOptions": { # Options for data format adjustments. # Optional. Output format adjustments. "useInt64Timestamp": True or False, # Optional. Output timestamp as usec int64. Default is false. }, "jobCreationMode": "A String", # Optional. If not set, jobs are always required. If set, the query request will follow the behavior described JobCreationMode. [Preview](https://cloud.google.com/products/#product-launch-stages) + "jobTimeoutMs": "A String", # Optional. Job timeout in milliseconds. If this time limit is exceeded, BigQuery will attempt to stop a longer job, but may not always succeed in canceling it before the job completes. For example, a job that takes more than 60 seconds to complete has a better chance of being stopped than a job that takes 10 seconds to complete. This timeout applies to the query even if a job does not need to be created. "kind": "bigquery#queryRequest", # The resource type of the request. "labels": { # Optional. The labels associated with this query. Labels can be used to organize and group query jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label keys must start with a letter and each label in the list must have a different key. "a_key": "A String", diff --git a/docs/dyn/bigquery_v2.models.html b/docs/dyn/bigquery_v2.models.html index c265f530b21..b65f4e47fdb 100644 --- a/docs/dyn/bigquery_v2.models.html +++ b/docs/dyn/bigquery_v2.models.html @@ -422,7 +422,7 @@

Method Details

"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier. "recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric. "rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric. - "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold. + "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classification models this is the confidence threshold. }, "binaryConfusionMatrixList": [ # Binary confusion matrix at multiple thresholds. { # Confusion matrix for binary classification models. @@ -475,7 +475,7 @@

Method Details

"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier. "recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric. "rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric. - "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold. + "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classification models this is the confidence threshold. }, "confusionMatrixList": [ # Confusion matrix at different thresholds. { # Confusion matrix for multi-class classification models. @@ -567,7 +567,7 @@

Method Details

"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier. "recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric. "rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric. - "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold. + "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classification models this is the confidence threshold. }, "binaryConfusionMatrixList": [ # Binary confusion matrix at multiple thresholds. { # Confusion matrix for binary classification models. @@ -620,7 +620,7 @@

Method Details

"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier. "recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric. "rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric. - "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold. + "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classification models this is the confidence threshold. }, "confusionMatrixList": [ # Confusion matrix at different thresholds. { # Confusion matrix for multi-class classification models. @@ -890,7 +890,7 @@

Method Details

"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier. "recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric. "rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric. - "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold. + "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classification models this is the confidence threshold. }, "binaryConfusionMatrixList": [ # Binary confusion matrix at multiple thresholds. { # Confusion matrix for binary classification models. @@ -943,7 +943,7 @@

Method Details

"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier. "recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric. "rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric. - "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold. + "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classification models this is the confidence threshold. }, "confusionMatrixList": [ # Confusion matrix at different thresholds. { # Confusion matrix for multi-class classification models. @@ -1502,7 +1502,7 @@

Method Details

"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier. "recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric. "rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric. - "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold. + "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classification models this is the confidence threshold. }, "binaryConfusionMatrixList": [ # Binary confusion matrix at multiple thresholds. { # Confusion matrix for binary classification models. @@ -1555,7 +1555,7 @@

Method Details

"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier. "recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric. "rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric. - "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold. + "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classification models this is the confidence threshold. }, "confusionMatrixList": [ # Confusion matrix at different thresholds. { # Confusion matrix for multi-class classification models. @@ -1647,7 +1647,7 @@

Method Details

"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier. "recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric. "rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric. - "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold. + "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classification models this is the confidence threshold. }, "binaryConfusionMatrixList": [ # Binary confusion matrix at multiple thresholds. { # Confusion matrix for binary classification models. @@ -1700,7 +1700,7 @@

Method Details

"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier. "recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric. "rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric. - "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold. + "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classification models this is the confidence threshold. }, "confusionMatrixList": [ # Confusion matrix at different thresholds. { # Confusion matrix for multi-class classification models. @@ -1970,7 +1970,7 @@

Method Details

"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier. "recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric. "rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric. - "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold. + "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classification models this is the confidence threshold. }, "binaryConfusionMatrixList": [ # Binary confusion matrix at multiple thresholds. { # Confusion matrix for binary classification models. @@ -2023,7 +2023,7 @@

Method Details

"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier. "recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric. "rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric. - "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold. + "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classification models this is the confidence threshold. }, "confusionMatrixList": [ # Confusion matrix at different thresholds. { # Confusion matrix for multi-class classification models. @@ -2591,7 +2591,7 @@

Method Details

"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier. "recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric. "rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric. - "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold. + "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classification models this is the confidence threshold. }, "binaryConfusionMatrixList": [ # Binary confusion matrix at multiple thresholds. { # Confusion matrix for binary classification models. @@ -2644,7 +2644,7 @@

Method Details

"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier. "recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric. "rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric. - "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold. + "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classification models this is the confidence threshold. }, "confusionMatrixList": [ # Confusion matrix at different thresholds. { # Confusion matrix for multi-class classification models. @@ -2736,7 +2736,7 @@

Method Details

"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier. "recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric. "rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric. - "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold. + "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classification models this is the confidence threshold. }, "binaryConfusionMatrixList": [ # Binary confusion matrix at multiple thresholds. { # Confusion matrix for binary classification models. @@ -2789,7 +2789,7 @@

Method Details

"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier. "recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric. "rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric. - "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold. + "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classification models this is the confidence threshold. }, "confusionMatrixList": [ # Confusion matrix at different thresholds. { # Confusion matrix for multi-class classification models. @@ -3059,7 +3059,7 @@

Method Details

"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier. "recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric. "rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric. - "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold. + "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classification models this is the confidence threshold. }, "binaryConfusionMatrixList": [ # Binary confusion matrix at multiple thresholds. { # Confusion matrix for binary classification models. @@ -3112,7 +3112,7 @@

Method Details

"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier. "recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric. "rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric. - "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold. + "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classification models this is the confidence threshold. }, "confusionMatrixList": [ # Confusion matrix at different thresholds. { # Confusion matrix for multi-class classification models. @@ -3659,7 +3659,7 @@

Method Details

"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier. "recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric. "rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric. - "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold. + "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classification models this is the confidence threshold. }, "binaryConfusionMatrixList": [ # Binary confusion matrix at multiple thresholds. { # Confusion matrix for binary classification models. @@ -3712,7 +3712,7 @@

Method Details

"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier. "recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric. "rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric. - "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold. + "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classification models this is the confidence threshold. }, "confusionMatrixList": [ # Confusion matrix at different thresholds. { # Confusion matrix for multi-class classification models. @@ -3804,7 +3804,7 @@

Method Details

"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier. "recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric. "rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric. - "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold. + "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classification models this is the confidence threshold. }, "binaryConfusionMatrixList": [ # Binary confusion matrix at multiple thresholds. { # Confusion matrix for binary classification models. @@ -3857,7 +3857,7 @@

Method Details

"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier. "recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric. "rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric. - "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold. + "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classification models this is the confidence threshold. }, "confusionMatrixList": [ # Confusion matrix at different thresholds. { # Confusion matrix for multi-class classification models. @@ -4127,7 +4127,7 @@

Method Details

"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier. "recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric. "rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric. - "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold. + "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classification models this is the confidence threshold. }, "binaryConfusionMatrixList": [ # Binary confusion matrix at multiple thresholds. { # Confusion matrix for binary classification models. @@ -4180,7 +4180,7 @@

Method Details

"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier. "recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric. "rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric. - "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold. + "threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classification models this is the confidence threshold. }, "confusionMatrixList": [ # Confusion matrix at different thresholds. { # Confusion matrix for multi-class classification models. diff --git a/docs/dyn/bigquery_v2.tables.html b/docs/dyn/bigquery_v2.tables.html index a69299c7055..76085132a08 100644 --- a/docs/dyn/bigquery_v2.tables.html +++ b/docs/dyn/bigquery_v2.tables.html @@ -238,7 +238,9 @@

Method Details

"quote": """, # Optional. The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ("). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. To include the specific quote character within a quoted value, precede it with an additional matching quote character. For example, if you want to escape the default character ' " ', use ' "" '. "skipLeadingRows": "A String", # Optional. The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema. }, - "decimalTargetTypes": [ # Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: * (38,9) -> NUMERIC; * (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats. + "dateFormat": "A String", # Optional. Format used to parse DATE values. Supports C-style and SQL-style values. + "datetimeFormat": "A String", # Optional. Format used to parse DATETIME values. Supports C-style and SQL-style values. + "decimalTargetTypes": [ # Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: * (38,9) -> NUMERIC; * (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if value exceeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats. "A String", ], "fileSetSpecType": "A String", # Optional. Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems. @@ -313,6 +315,9 @@

Method Details

"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the '*' wildcard character is not allowed. "A String", ], + "timeFormat": "A String", # Optional. Format used to parse TIME values. Supports C-style and SQL-style values. + "timeZone": "A String", # Optional. Time zone used when parsing timestamp values that do not have specific time zone information (e.g. 2024-04-20 12:34:56). The expected format is a IANA timezone string (e.g. America/Los_Angeles). + "timestampFormat": "A String", # Optional. Format used to parse TIMESTAMP values. Supports C-style and SQL-style values. }, "friendlyName": "A String", # Optional. A descriptive name for this table. "id": "A String", # Output only. An opaque ID uniquely identifying the table. @@ -531,7 +536,7 @@

Method Details

"query": "A String", # Required. The query that defines the view. }, ], - "privacyPolicy": { # Represents privacy policy that contains the privacy requirements specified by the data owner. Currently, this is only supported on views. # Optional. Specifices the privacy policy for the view. + "privacyPolicy": { # Represents privacy policy that contains the privacy requirements specified by the data owner. Currently, this is only supported on views. # Optional. Specifies the privacy policy for the view. "aggregationThresholdPolicy": { # Represents privacy policy associated with "aggregation threshold" method. # Optional. Policy used for aggregation thresholds. "privacyUnitColumns": [ # Optional. The privacy unit column(s) associated with this policy. For now, only one column per data source object (table, view) is allowed as a privacy unit column. Representing as a repeated field in metadata for extensibility to multiple columns in future. Duplicates and Repeated struct fields are not allowed. For nested fields, use dot notation ("outer.inner") "A String", @@ -721,7 +726,9 @@

Method Details

"quote": """, # Optional. The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ("). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. To include the specific quote character within a quoted value, precede it with an additional matching quote character. For example, if you want to escape the default character ' " ', use ' "" '. "skipLeadingRows": "A String", # Optional. The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema. }, - "decimalTargetTypes": [ # Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: * (38,9) -> NUMERIC; * (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats. + "dateFormat": "A String", # Optional. Format used to parse DATE values. Supports C-style and SQL-style values. + "datetimeFormat": "A String", # Optional. Format used to parse DATETIME values. Supports C-style and SQL-style values. + "decimalTargetTypes": [ # Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: * (38,9) -> NUMERIC; * (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if value exceeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats. "A String", ], "fileSetSpecType": "A String", # Optional. Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems. @@ -796,6 +803,9 @@

Method Details

"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the '*' wildcard character is not allowed. "A String", ], + "timeFormat": "A String", # Optional. Format used to parse TIME values. Supports C-style and SQL-style values. + "timeZone": "A String", # Optional. Time zone used when parsing timestamp values that do not have specific time zone information (e.g. 2024-04-20 12:34:56). The expected format is a IANA timezone string (e.g. America/Los_Angeles). + "timestampFormat": "A String", # Optional. Format used to parse TIMESTAMP values. Supports C-style and SQL-style values. }, "friendlyName": "A String", # Optional. A descriptive name for this table. "id": "A String", # Output only. An opaque ID uniquely identifying the table. @@ -1014,7 +1024,7 @@

Method Details

"query": "A String", # Required. The query that defines the view. }, ], - "privacyPolicy": { # Represents privacy policy that contains the privacy requirements specified by the data owner. Currently, this is only supported on views. # Optional. Specifices the privacy policy for the view. + "privacyPolicy": { # Represents privacy policy that contains the privacy requirements specified by the data owner. Currently, this is only supported on views. # Optional. Specifies the privacy policy for the view. "aggregationThresholdPolicy": { # Represents privacy policy associated with "aggregation threshold" method. # Optional. Policy used for aggregation thresholds. "privacyUnitColumns": [ # Optional. The privacy unit column(s) associated with this policy. For now, only one column per data source object (table, view) is allowed as a privacy unit column. Representing as a repeated field in metadata for extensibility to multiple columns in future. Duplicates and Repeated struct fields are not allowed. For nested fields, use dot notation ("outer.inner") "A String", @@ -1145,7 +1155,9 @@

Method Details

"quote": """, # Optional. The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ("). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. To include the specific quote character within a quoted value, precede it with an additional matching quote character. For example, if you want to escape the default character ' " ', use ' "" '. "skipLeadingRows": "A String", # Optional. The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema. }, - "decimalTargetTypes": [ # Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: * (38,9) -> NUMERIC; * (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats. + "dateFormat": "A String", # Optional. Format used to parse DATE values. Supports C-style and SQL-style values. + "datetimeFormat": "A String", # Optional. Format used to parse DATETIME values. Supports C-style and SQL-style values. + "decimalTargetTypes": [ # Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: * (38,9) -> NUMERIC; * (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if value exceeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats. "A String", ], "fileSetSpecType": "A String", # Optional. Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems. @@ -1220,6 +1232,9 @@

Method Details

"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the '*' wildcard character is not allowed. "A String", ], + "timeFormat": "A String", # Optional. Format used to parse TIME values. Supports C-style and SQL-style values. + "timeZone": "A String", # Optional. Time zone used when parsing timestamp values that do not have specific time zone information (e.g. 2024-04-20 12:34:56). The expected format is a IANA timezone string (e.g. America/Los_Angeles). + "timestampFormat": "A String", # Optional. Format used to parse TIMESTAMP values. Supports C-style and SQL-style values. }, "friendlyName": "A String", # Optional. A descriptive name for this table. "id": "A String", # Output only. An opaque ID uniquely identifying the table. @@ -1438,7 +1453,7 @@

Method Details

"query": "A String", # Required. The query that defines the view. }, ], - "privacyPolicy": { # Represents privacy policy that contains the privacy requirements specified by the data owner. Currently, this is only supported on views. # Optional. Specifices the privacy policy for the view. + "privacyPolicy": { # Represents privacy policy that contains the privacy requirements specified by the data owner. Currently, this is only supported on views. # Optional. Specifies the privacy policy for the view. "aggregationThresholdPolicy": { # Represents privacy policy associated with "aggregation threshold" method. # Optional. Policy used for aggregation thresholds. "privacyUnitColumns": [ # Optional. The privacy unit column(s) associated with this policy. For now, only one column per data source object (table, view) is allowed as a privacy unit column. Representing as a repeated field in metadata for extensibility to multiple columns in future. Duplicates and Repeated struct fields are not allowed. For nested fields, use dot notation ("outer.inner") "A String", @@ -1533,7 +1548,7 @@

Method Details

}, "type": "A String", # The type of table. "view": { # Information about a logical view. - "privacyPolicy": { # Represents privacy policy that contains the privacy requirements specified by the data owner. Currently, this is only supported on views. # Specifices the privacy policy for the view. + "privacyPolicy": { # Represents privacy policy that contains the privacy requirements specified by the data owner. Currently, this is only supported on views. # Specifies the privacy policy for the view. "aggregationThresholdPolicy": { # Represents privacy policy associated with "aggregation threshold" method. # Optional. Policy used for aggregation thresholds. "privacyUnitColumns": [ # Optional. The privacy unit column(s) associated with this policy. For now, only one column per data source object (table, view) is allowed as a privacy unit column. Representing as a repeated field in metadata for extensibility to multiple columns in future. Duplicates and Repeated struct fields are not allowed. For nested fields, use dot notation ("outer.inner") "A String", @@ -1677,7 +1692,9 @@

Method Details

"quote": """, # Optional. The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ("). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. To include the specific quote character within a quoted value, precede it with an additional matching quote character. For example, if you want to escape the default character ' " ', use ' "" '. "skipLeadingRows": "A String", # Optional. The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema. }, - "decimalTargetTypes": [ # Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: * (38,9) -> NUMERIC; * (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats. + "dateFormat": "A String", # Optional. Format used to parse DATE values. Supports C-style and SQL-style values. + "datetimeFormat": "A String", # Optional. Format used to parse DATETIME values. Supports C-style and SQL-style values. + "decimalTargetTypes": [ # Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: * (38,9) -> NUMERIC; * (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if value exceeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats. "A String", ], "fileSetSpecType": "A String", # Optional. Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems. @@ -1752,6 +1769,9 @@

Method Details

"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the '*' wildcard character is not allowed. "A String", ], + "timeFormat": "A String", # Optional. Format used to parse TIME values. Supports C-style and SQL-style values. + "timeZone": "A String", # Optional. Time zone used when parsing timestamp values that do not have specific time zone information (e.g. 2024-04-20 12:34:56). The expected format is a IANA timezone string (e.g. America/Los_Angeles). + "timestampFormat": "A String", # Optional. Format used to parse TIMESTAMP values. Supports C-style and SQL-style values. }, "friendlyName": "A String", # Optional. A descriptive name for this table. "id": "A String", # Output only. An opaque ID uniquely identifying the table. @@ -1970,7 +1990,7 @@

Method Details

"query": "A String", # Required. The query that defines the view. }, ], - "privacyPolicy": { # Represents privacy policy that contains the privacy requirements specified by the data owner. Currently, this is only supported on views. # Optional. Specifices the privacy policy for the view. + "privacyPolicy": { # Represents privacy policy that contains the privacy requirements specified by the data owner. Currently, this is only supported on views. # Optional. Specifies the privacy policy for the view. "aggregationThresholdPolicy": { # Represents privacy policy associated with "aggregation threshold" method. # Optional. Policy used for aggregation thresholds. "privacyUnitColumns": [ # Optional. The privacy unit column(s) associated with this policy. For now, only one column per data source object (table, view) is allowed as a privacy unit column. Representing as a repeated field in metadata for extensibility to multiple columns in future. Duplicates and Repeated struct fields are not allowed. For nested fields, use dot notation ("outer.inner") "A String", @@ -2102,7 +2122,9 @@

Method Details

"quote": """, # Optional. The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ("). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. To include the specific quote character within a quoted value, precede it with an additional matching quote character. For example, if you want to escape the default character ' " ', use ' "" '. "skipLeadingRows": "A String", # Optional. The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema. }, - "decimalTargetTypes": [ # Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: * (38,9) -> NUMERIC; * (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats. + "dateFormat": "A String", # Optional. Format used to parse DATE values. Supports C-style and SQL-style values. + "datetimeFormat": "A String", # Optional. Format used to parse DATETIME values. Supports C-style and SQL-style values. + "decimalTargetTypes": [ # Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: * (38,9) -> NUMERIC; * (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if value exceeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats. "A String", ], "fileSetSpecType": "A String", # Optional. Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems. @@ -2177,6 +2199,9 @@

Method Details

"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the '*' wildcard character is not allowed. "A String", ], + "timeFormat": "A String", # Optional. Format used to parse TIME values. Supports C-style and SQL-style values. + "timeZone": "A String", # Optional. Time zone used when parsing timestamp values that do not have specific time zone information (e.g. 2024-04-20 12:34:56). The expected format is a IANA timezone string (e.g. America/Los_Angeles). + "timestampFormat": "A String", # Optional. Format used to parse TIMESTAMP values. Supports C-style and SQL-style values. }, "friendlyName": "A String", # Optional. A descriptive name for this table. "id": "A String", # Output only. An opaque ID uniquely identifying the table. @@ -2395,7 +2420,7 @@

Method Details

"query": "A String", # Required. The query that defines the view. }, ], - "privacyPolicy": { # Represents privacy policy that contains the privacy requirements specified by the data owner. Currently, this is only supported on views. # Optional. Specifices the privacy policy for the view. + "privacyPolicy": { # Represents privacy policy that contains the privacy requirements specified by the data owner. Currently, this is only supported on views. # Optional. Specifies the privacy policy for the view. "aggregationThresholdPolicy": { # Represents privacy policy associated with "aggregation threshold" method. # Optional. Policy used for aggregation thresholds. "privacyUnitColumns": [ # Optional. The privacy unit column(s) associated with this policy. For now, only one column per data source object (table, view) is allowed as a privacy unit column. Representing as a repeated field in metadata for extensibility to multiple columns in future. Duplicates and Repeated struct fields are not allowed. For nested fields, use dot notation ("outer.inner") "A String", @@ -2645,7 +2670,9 @@

Method Details

"quote": """, # Optional. The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ("). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. To include the specific quote character within a quoted value, precede it with an additional matching quote character. For example, if you want to escape the default character ' " ', use ' "" '. "skipLeadingRows": "A String", # Optional. The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema. }, - "decimalTargetTypes": [ # Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: * (38,9) -> NUMERIC; * (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats. + "dateFormat": "A String", # Optional. Format used to parse DATE values. Supports C-style and SQL-style values. + "datetimeFormat": "A String", # Optional. Format used to parse DATETIME values. Supports C-style and SQL-style values. + "decimalTargetTypes": [ # Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: * (38,9) -> NUMERIC; * (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if value exceeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats. "A String", ], "fileSetSpecType": "A String", # Optional. Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems. @@ -2720,6 +2747,9 @@

Method Details

"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the '*' wildcard character is not allowed. "A String", ], + "timeFormat": "A String", # Optional. Format used to parse TIME values. Supports C-style and SQL-style values. + "timeZone": "A String", # Optional. Time zone used when parsing timestamp values that do not have specific time zone information (e.g. 2024-04-20 12:34:56). The expected format is a IANA timezone string (e.g. America/Los_Angeles). + "timestampFormat": "A String", # Optional. Format used to parse TIMESTAMP values. Supports C-style and SQL-style values. }, "friendlyName": "A String", # Optional. A descriptive name for this table. "id": "A String", # Output only. An opaque ID uniquely identifying the table. @@ -2938,7 +2968,7 @@

Method Details

"query": "A String", # Required. The query that defines the view. }, ], - "privacyPolicy": { # Represents privacy policy that contains the privacy requirements specified by the data owner. Currently, this is only supported on views. # Optional. Specifices the privacy policy for the view. + "privacyPolicy": { # Represents privacy policy that contains the privacy requirements specified by the data owner. Currently, this is only supported on views. # Optional. Specifies the privacy policy for the view. "aggregationThresholdPolicy": { # Represents privacy policy associated with "aggregation threshold" method. # Optional. Policy used for aggregation thresholds. "privacyUnitColumns": [ # Optional. The privacy unit column(s) associated with this policy. For now, only one column per data source object (table, view) is allowed as a privacy unit column. Representing as a repeated field in metadata for extensibility to multiple columns in future. Duplicates and Repeated struct fields are not allowed. For nested fields, use dot notation ("outer.inner") "A String", @@ -3070,7 +3100,9 @@

Method Details

"quote": """, # Optional. The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ("). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. To include the specific quote character within a quoted value, precede it with an additional matching quote character. For example, if you want to escape the default character ' " ', use ' "" '. "skipLeadingRows": "A String", # Optional. The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema. }, - "decimalTargetTypes": [ # Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: * (38,9) -> NUMERIC; * (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats. + "dateFormat": "A String", # Optional. Format used to parse DATE values. Supports C-style and SQL-style values. + "datetimeFormat": "A String", # Optional. Format used to parse DATETIME values. Supports C-style and SQL-style values. + "decimalTargetTypes": [ # Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: * (38,9) -> NUMERIC; * (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if value exceeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats. "A String", ], "fileSetSpecType": "A String", # Optional. Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems. @@ -3145,6 +3177,9 @@

Method Details

"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the '*' wildcard character is not allowed. "A String", ], + "timeFormat": "A String", # Optional. Format used to parse TIME values. Supports C-style and SQL-style values. + "timeZone": "A String", # Optional. Time zone used when parsing timestamp values that do not have specific time zone information (e.g. 2024-04-20 12:34:56). The expected format is a IANA timezone string (e.g. America/Los_Angeles). + "timestampFormat": "A String", # Optional. Format used to parse TIMESTAMP values. Supports C-style and SQL-style values. }, "friendlyName": "A String", # Optional. A descriptive name for this table. "id": "A String", # Output only. An opaque ID uniquely identifying the table. @@ -3363,7 +3398,7 @@

Method Details

"query": "A String", # Required. The query that defines the view. }, ], - "privacyPolicy": { # Represents privacy policy that contains the privacy requirements specified by the data owner. Currently, this is only supported on views. # Optional. Specifices the privacy policy for the view. + "privacyPolicy": { # Represents privacy policy that contains the privacy requirements specified by the data owner. Currently, this is only supported on views. # Optional. Specifies the privacy policy for the view. "aggregationThresholdPolicy": { # Represents privacy policy associated with "aggregation threshold" method. # Optional. Policy used for aggregation thresholds. "privacyUnitColumns": [ # Optional. The privacy unit column(s) associated with this policy. For now, only one column per data source object (table, view) is allowed as a privacy unit column. Representing as a repeated field in metadata for extensibility to multiple columns in future. Duplicates and Repeated struct fields are not allowed. For nested fields, use dot notation ("outer.inner") "A String", diff --git a/googleapiclient/discovery_cache/documents/bigquery.v2.json b/googleapiclient/discovery_cache/documents/bigquery.v2.json index cd50d37a65c..9019a73f148 100644 --- a/googleapiclient/discovery_cache/documents/bigquery.v2.json +++ b/googleapiclient/discovery_cache/documents/bigquery.v2.json @@ -351,7 +351,7 @@ "type": "boolean" }, "filter": { -"description": "An expression for filtering the results of the request by label. The syntax is `labels.[:]`. Multiple filters can be ANDed together by connecting with a space. Example: `labels.department:receiving labels.active`. See [Filtering datasets using labels](https://cloud.google.com/bigquery/docs/filtering-labels#filtering_datasets_using_labels) for details.", +"description": "An expression for filtering the results of the request by label. The syntax is `labels.[:]`. Multiple filters can be AND-ed together by connecting with a space. Example: `labels.department:receiving labels.active`. See [Filtering datasets using labels](https://cloud.google.com/bigquery/docs/filtering-labels#filtering_datasets_using_labels) for details.", "location": "query", "type": "string" }, @@ -2256,7 +2256,7 @@ } } }, -"revision": "20250128", +"revision": "20250216", "rootUrl": "https://bigquery.googleapis.com/", "schemas": { "AggregateClassificationMetrics": { @@ -2294,7 +2294,7 @@ "type": "number" }, "threshold": { -"description": "Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold.", +"description": "Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classification models this is the confidence threshold.", "format": "double", "type": "number" } @@ -4346,8 +4346,16 @@ "$ref": "CsvOptions", "description": "Optional. Additional properties to set if sourceFormat is set to CSV." }, +"dateFormat": { +"description": "Optional. Format used to parse DATE values. Supports C-style and SQL-style values.", +"type": "string" +}, +"datetimeFormat": { +"description": "Optional. Format used to parse DATETIME values. Supports C-style and SQL-style values.", +"type": "string" +}, "decimalTargetTypes": { -"description": "Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is [\"NUMERIC\", \"BIGNUMERIC\"]. If (precision,scale) is: * (38,9) -> NUMERIC; * (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, [\"BIGNUMERIC\", \"NUMERIC\"] is the same as [\"NUMERIC\", \"BIGNUMERIC\"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to [\"NUMERIC\", \"STRING\"] for ORC and [\"NUMERIC\"] for the other file formats.", +"description": "Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is [\"NUMERIC\", \"BIGNUMERIC\"]. If (precision,scale) is: * (38,9) -> NUMERIC; * (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if value exceeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, [\"BIGNUMERIC\", \"NUMERIC\"] is the same as [\"NUMERIC\", \"BIGNUMERIC\"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to [\"NUMERIC\", \"STRING\"] for ORC and [\"NUMERIC\"] for the other file formats.", "items": { "enum": [ "DECIMAL_TARGET_TYPE_UNSPECIFIED", @@ -4396,7 +4404,7 @@ "GEOJSON" ], "enumDescriptions": [ -"The default if provided value is not one included in the enum, or the value is not specified. The source formate is parsed without any modification.", +"The default if provided value is not one included in the enum, or the value is not specified. The source format is parsed without any modification.", "Use GeoJSON variant of JSON. See https://tools.ietf.org/html/rfc7946." ], "type": "string" @@ -4460,6 +4468,18 @@ "type": "string" }, "type": "array" +}, +"timeFormat": { +"description": "Optional. Format used to parse TIME values. Supports C-style and SQL-style values.", +"type": "string" +}, +"timeZone": { +"description": "Optional. Time zone used when parsing timestamp values that do not have specific time zone information (e.g. 2024-04-20 12:34:56). The expected format is a IANA timezone string (e.g. America/Los_Angeles).", +"type": "string" +}, +"timestampFormat": { +"description": "Optional. Format used to parse TIMESTAMP values. Supports C-style and SQL-style values.", +"type": "string" } }, "type": "object" @@ -5360,8 +5380,16 @@ "description": "Optional. If this property is true, the job creates a new session using a randomly generated session_id. To continue using a created session with subsequent queries, pass the existing session identifier as a `ConnectionProperty` value. The session identifier is returned as part of the `SessionInfo` message within the query statistics. The new session's location will be set to `Job.JobReference.location` if it is present, otherwise it's set to the default location based on existing routing logic.", "type": "boolean" }, +"dateFormat": { +"description": "Optional. Date format used for parsing DATE values.", +"type": "string" +}, +"datetimeFormat": { +"description": "Optional. Date format used for parsing DATETIME values.", +"type": "string" +}, "decimalTargetTypes": { -"description": "Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is [\"NUMERIC\", \"BIGNUMERIC\"]. If (precision,scale) is: * (38,9) -> NUMERIC; * (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, [\"BIGNUMERIC\", \"NUMERIC\"] is the same as [\"NUMERIC\", \"BIGNUMERIC\"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to [\"NUMERIC\", \"STRING\"] for ORC and [\"NUMERIC\"] for the other file formats.", +"description": "Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is [\"NUMERIC\", \"BIGNUMERIC\"]. If (precision,scale) is: * (38,9) -> NUMERIC; * (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if value exceeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, [\"BIGNUMERIC\", \"NUMERIC\"] is the same as [\"NUMERIC\", \"BIGNUMERIC\"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to [\"NUMERIC\", \"STRING\"] for ORC and [\"NUMERIC\"] for the other file formats.", "items": { "enum": [ "DECIMAL_TARGET_TYPE_UNSPECIFIED", @@ -5426,7 +5454,7 @@ "GEOJSON" ], "enumDescriptions": [ -"The default if provided value is not one included in the enum, or the value is not specified. The source formate is parsed without any modification.", +"The default if provided value is not one included in the enum, or the value is not specified. The source format is parsed without any modification.", "Use GeoJSON variant of JSON. See https://tools.ietf.org/html/rfc7946." ], "type": "string" @@ -5504,10 +5532,22 @@ }, "type": "array" }, +"timeFormat": { +"description": "Optional. Date format used for parsing TIME values.", +"type": "string" +}, "timePartitioning": { "$ref": "TimePartitioning", "description": "Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified." }, +"timeZone": { +"description": "Optional. [Experimental] Default time zone that will apply when parsing timestamp values that have no specific time zone.", +"type": "string" +}, +"timestampFormat": { +"description": "Optional. Date format used for parsing TIMESTAMP values.", +"type": "string" +}, "useAvroLogicalTypes": { "description": "Optional. If sourceFormat is set to \"AVRO\", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER).", "type": "boolean" @@ -6701,7 +6741,7 @@ "type": "object" }, "MetadataCacheStatistics": { -"description": "Statistics for metadata caching in BigLake tables.", +"description": "Statistics for metadata caching in queried tables.", "id": "MetadataCacheStatistics", "properties": { "tableMetadataCacheUsage": { @@ -7453,6 +7493,10 @@ "$ref": "DatasetReference", "description": "Optional. Specifies the default datasetId and projectId to assume for any unqualified table names in the query. If not set, all table names in the query string must be qualified in the format 'datasetId.tableId'." }, +"destinationEncryptionConfiguration": { +"$ref": "EncryptionConfiguration", +"description": "Optional. Custom encryption configuration (e.g., Cloud KMS keys)" +}, "dryRun": { "description": "Optional. If set to true, BigQuery doesn't run the job. Instead, if the query is valid, BigQuery returns statistics about the job such as how many bytes would be processed. If the query is invalid, an error returns. The default value is false.", "type": "boolean" @@ -7475,6 +7519,11 @@ ], "type": "string" }, +"jobTimeoutMs": { +"description": "Optional. Job timeout in milliseconds. If this time limit is exceeded, BigQuery will attempt to stop a longer job, but may not always succeed in canceling it before the job completes. For example, a job that takes more than 60 seconds to complete has a better chance of being stopped than a job that takes 10 seconds to complete. This timeout applies to the query even if a job does not need to be created.", +"format": "int64", +"type": "string" +}, "kind": { "default": "bigquery#queryRequest", "description": "The resource type of the request.", @@ -9470,7 +9519,7 @@ "properties": { "privacyPolicy": { "$ref": "PrivacyPolicy", -"description": "Specifices the privacy policy for the view." +"description": "Specifies the privacy policy for the view." }, "useLegacySql": { "description": "True if view is defined in legacy SQL dialect, false if in GoogleSQL.", @@ -10085,7 +10134,7 @@ "Ukraine", "United States", "Venezuela", -"Viet Nam", +"Vietnam", "South Africa" ], "type": "string" @@ -10232,7 +10281,7 @@ "Ukraine", "United States", "Venezuela", -"Viet Nam", +"Vietnam", "South Africa" ], "type": "string" @@ -10278,7 +10327,7 @@ "Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric.", "Accuracy is the fraction of predictions given the correct label. For multiclass this is a globally micro-averaged metric.", "The F1 score is an average of recall and precision. For multiclass this is a macro-averaged metric.", -"Logorithmic Loss. For multiclass this is a macro-averaged metric.", +"Logarithmic Loss. For multiclass this is a macro-averaged metric.", "Area Under an ROC Curve. For multiclass this is a macro-averaged metric.", "Davies-Bouldin Index.", "Mean Average Precision.", @@ -10799,7 +10848,7 @@ }, "privacyPolicy": { "$ref": "PrivacyPolicy", -"description": "Optional. Specifices the privacy policy for the view." +"description": "Optional. Specifies the privacy policy for the view." }, "query": { "description": "Required. A query that BigQuery executes when the view is referenced.", From 283d4b3bc010414e2c4104ab7c63ab8636019b90 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 25 Feb 2025 07:08:17 +0000 Subject: [PATCH 04/36] feat(cloudkms): update the api #### cloudkms:v1 The following keys were added: - resources.projects.resources.locations.resources.keyRings.resources.cryptoKeys.resources.cryptoKeyVersions.methods.getPublicKey.parameters.publicKeyFormat (Total Keys: 2) - schemas.ChecksummedData (Total Keys: 6) - schemas.PublicKey.properties.publicKey (Total Keys: 2) --- ...keyRings.cryptoKeys.cryptoKeyVersions.html | 16 +++- .../documents/cloudkms.v1.json | 86 ++++++++++++++++--- 2 files changed, 89 insertions(+), 13 deletions(-) diff --git a/docs/dyn/cloudkms_v1.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.html b/docs/dyn/cloudkms_v1.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.html index 06ffddfae84..8b24d66ffd8 100644 --- a/docs/dyn/cloudkms_v1.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.html +++ b/docs/dyn/cloudkms_v1.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.html @@ -93,7 +93,7 @@

Instance Methods

get(name, x__xgafv=None)

Returns metadata for a given CryptoKeyVersion.

- getPublicKey(name, x__xgafv=None)

+ getPublicKey(name, publicKeyFormat=None, x__xgafv=None)

Returns the public key for the given CryptoKeyVersion. The CryptoKey.purpose must be ASYMMETRIC_SIGN or ASYMMETRIC_DECRYPT.

import_(parent, body=None, x__xgafv=None)

@@ -395,11 +395,16 @@

Method Details

- getPublicKey(name, x__xgafv=None) + getPublicKey(name, publicKeyFormat=None, x__xgafv=None)
Returns the public key for the given CryptoKeyVersion. The CryptoKey.purpose must be ASYMMETRIC_SIGN or ASYMMETRIC_DECRYPT.
 
 Args:
   name: string, Required. The name of the CryptoKeyVersion public key to get. (required)
+  publicKeyFormat: string, Optional. The PublicKey format specified by the user. This field is required for PQC algorithms. If specified, the public key will be exported through the public_key field in the requested format. Otherwise, the pem field will be populated for non-PQC algorithms, and an error will be returned for PQC algorithms.
+    Allowed values
+      PUBLIC_KEY_FORMAT_UNSPECIFIED - If the public_key_format field is not specified: - For PQC algorithms, an error will be returned. - For non-PQC algorithms, the default format is PEM, and the field pem will be populated. Otherwise, the public key will be exported through the public_key field in the requested format.
+      PEM - The returned public key will be encoded in PEM format. See the [RFC7468](https://tools.ietf.org/html/rfc7468) sections for [General Considerations](https://tools.ietf.org/html/rfc7468#section-2) and [Textual Encoding of Subject Public Key Info] (https://tools.ietf.org/html/rfc7468#section-13) for more information.
+      NIST_PQC - This is supported only for PQC algorithms. The key material is returned in the format defined by NIST PQC standards (FIPS 203, FIPS 204, and FIPS 205).
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -412,8 +417,13 @@ 

Method Details

"algorithm": "A String", # The Algorithm associated with this key. "name": "A String", # The name of the CryptoKeyVersion public key. Provided here for verification. NOTE: This field is in Beta. "pem": "A String", # The public key, encoded in PEM format. For more information, see the [RFC 7468](https://tools.ietf.org/html/rfc7468) sections for [General Considerations](https://tools.ietf.org/html/rfc7468#section-2) and [Textual Encoding of Subject Public Key Info] (https://tools.ietf.org/html/rfc7468#section-13). - "pemCrc32c": "A String", # Integrity verification field. A CRC32C checksum of the returned PublicKey.pem. An integrity check of PublicKey.pem can be performed by computing the CRC32C checksum of PublicKey.pem and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type. NOTE: This field is in Beta. + "pemCrc32c": "A String", # Integrity verification field. A CRC32C checksum of the returned PublicKey.pem. An integrity check of PublicKey.pem can be performed by computing the CRC32C checksum of PublicKey.pem and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed `2^32-1`, and can be safely downconverted to uint32 in languages that support this type. NOTE: This field is in Beta. "protectionLevel": "A String", # The ProtectionLevel of the CryptoKeyVersion public key. + "publicKey": { # Data with integrity verification field. # This field contains the public key (with integrity verification), formatted according to the public_key_format field. + "crc32cChecksum": "A String", # Integrity verification field. A CRC32C checksum of the returned ChecksummedData.data. An integrity check of ChecksummedData.data can be performed by computing the CRC32C checksum of ChecksummedData.data and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed `2^32-1`, and can be safely downconverted to uint32 in languages that support this type. + "data": "A String", # Raw Data. + }, + "publicKeyFormat": "A String", # The PublicKey format specified by the customer through the public_key_format field. }
diff --git a/googleapiclient/discovery_cache/documents/cloudkms.v1.json b/googleapiclient/discovery_cache/documents/cloudkms.v1.json index 5d735cca1bf..ae2fc3d3f6e 100644 --- a/googleapiclient/discovery_cache/documents/cloudkms.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudkms.v1.json @@ -1615,6 +1615,21 @@ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$", "required": true, "type": "string" +}, +"publicKeyFormat": { +"description": "Optional. The PublicKey format specified by the user. This field is required for PQC algorithms. If specified, the public key will be exported through the public_key field in the requested format. Otherwise, the pem field will be populated for non-PQC algorithms, and an error will be returned for PQC algorithms.", +"enum": [ +"PUBLIC_KEY_FORMAT_UNSPECIFIED", +"PEM", +"NIST_PQC" +], +"enumDescriptions": [ +"If the public_key_format field is not specified: - For PQC algorithms, an error will be returned. - For non-PQC algorithms, the default format is PEM, and the field pem will be populated. Otherwise, the public key will be exported through the public_key field in the requested format.", +"The returned public key will be encoded in PEM format. See the [RFC7468](https://tools.ietf.org/html/rfc7468) sections for [General Considerations](https://tools.ietf.org/html/rfc7468#section-2) and [Textual Encoding of Subject Public Key Info] (https://tools.ietf.org/html/rfc7468#section-13) for more information.", +"This is supported only for PQC algorithms. The key material is returned in the format defined by NIST PQC standards (FIPS 203, FIPS 204, and FIPS 205)." +], +"location": "query", +"type": "string" } }, "path": "v1/{+name}/publicKey", @@ -2137,7 +2152,7 @@ } } }, -"revision": "20250102", +"revision": "20250213", "rootUrl": "https://cloudkms.googleapis.com/", "schemas": { "AsymmetricDecryptRequest": { @@ -2456,6 +2471,23 @@ }, "type": "object" }, +"ChecksummedData": { +"description": "Data with integrity verification field.", +"id": "ChecksummedData", +"properties": { +"crc32cChecksum": { +"description": "Integrity verification field. A CRC32C checksum of the returned ChecksummedData.data. An integrity check of ChecksummedData.data can be performed by computing the CRC32C checksum of ChecksummedData.data and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed `2^32-1`, and can be safely downconverted to uint32 in languages that support this type.", +"format": "int64", +"type": "string" +}, +"data": { +"description": "Raw Data.", +"format": "byte", +"type": "string" +} +}, +"type": "object" +}, "CryptoKey": { "description": "A CryptoKey represents a logical key that can be used for cryptographic operations. A CryptoKey is made up of zero or more versions, which represent the actual key material used in cryptographic operations.", "id": "CryptoKey", @@ -2579,7 +2611,9 @@ "HMAC_SHA384", "HMAC_SHA512", "HMAC_SHA224", -"EXTERNAL_SYMMETRIC_ENCRYPTION" +"EXTERNAL_SYMMETRIC_ENCRYPTION", +"PQ_SIGN_ML_DSA_65", +"PQ_SIGN_SLH_DSA_SHA2_128S" ], "enumDescriptions": [ "Not specified.", @@ -2617,7 +2651,9 @@ "HMAC-SHA384 signing with a 384 bit key.", "HMAC-SHA512 signing with a 512 bit key.", "HMAC-SHA224 signing with a 224 bit key.", -"Algorithm representing symmetric encryption by an external key manager." +"Algorithm representing symmetric encryption by an external key manager.", +"The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 3. Randomized version.", +"The post-quantum stateless hash-based digital signature algorithm, at security level 1. Randomized version." ], "readOnly": true, "type": "string" @@ -2785,7 +2821,9 @@ "HMAC_SHA384", "HMAC_SHA512", "HMAC_SHA224", -"EXTERNAL_SYMMETRIC_ENCRYPTION" +"EXTERNAL_SYMMETRIC_ENCRYPTION", +"PQ_SIGN_ML_DSA_65", +"PQ_SIGN_SLH_DSA_SHA2_128S" ], "enumDescriptions": [ "Not specified.", @@ -2823,7 +2861,9 @@ "HMAC-SHA384 signing with a 384 bit key.", "HMAC-SHA512 signing with a 512 bit key.", "HMAC-SHA224 signing with a 224 bit key.", -"Algorithm representing symmetric encryption by an external key manager." +"Algorithm representing symmetric encryption by an external key manager.", +"The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 3. Randomized version.", +"The post-quantum stateless hash-based digital signature algorithm, at security level 1. Randomized version." ], "type": "string" }, @@ -3206,7 +3246,9 @@ "HMAC_SHA384", "HMAC_SHA512", "HMAC_SHA224", -"EXTERNAL_SYMMETRIC_ENCRYPTION" +"EXTERNAL_SYMMETRIC_ENCRYPTION", +"PQ_SIGN_ML_DSA_65", +"PQ_SIGN_SLH_DSA_SHA2_128S" ], "enumDescriptions": [ "Not specified.", @@ -3244,7 +3286,9 @@ "HMAC-SHA384 signing with a 384 bit key.", "HMAC-SHA512 signing with a 512 bit key.", "HMAC-SHA224 signing with a 224 bit key.", -"Algorithm representing symmetric encryption by an external key manager." +"Algorithm representing symmetric encryption by an external key manager.", +"The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 3. Randomized version.", +"The post-quantum stateless hash-based digital signature algorithm, at security level 1. Randomized version." ], "type": "string" }, @@ -3925,7 +3969,9 @@ "HMAC_SHA384", "HMAC_SHA512", "HMAC_SHA224", -"EXTERNAL_SYMMETRIC_ENCRYPTION" +"EXTERNAL_SYMMETRIC_ENCRYPTION", +"PQ_SIGN_ML_DSA_65", +"PQ_SIGN_SLH_DSA_SHA2_128S" ], "enumDescriptions": [ "Not specified.", @@ -3963,7 +4009,9 @@ "HMAC-SHA384 signing with a 384 bit key.", "HMAC-SHA512 signing with a 512 bit key.", "HMAC-SHA224 signing with a 224 bit key.", -"Algorithm representing symmetric encryption by an external key manager." +"Algorithm representing symmetric encryption by an external key manager.", +"The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 3. Randomized version.", +"The post-quantum stateless hash-based digital signature algorithm, at security level 1. Randomized version." ], "type": "string" }, @@ -3976,7 +4024,7 @@ "type": "string" }, "pemCrc32c": { -"description": "Integrity verification field. A CRC32C checksum of the returned PublicKey.pem. An integrity check of PublicKey.pem can be performed by computing the CRC32C checksum of PublicKey.pem and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type. NOTE: This field is in Beta.", +"description": "Integrity verification field. A CRC32C checksum of the returned PublicKey.pem. An integrity check of PublicKey.pem can be performed by computing the CRC32C checksum of PublicKey.pem and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed `2^32-1`, and can be safely downconverted to uint32 in languages that support this type. NOTE: This field is in Beta.", "format": "int64", "type": "string" }, @@ -3997,6 +4045,24 @@ "Crypto operations are performed in an EKM-over-VPC backend." ], "type": "string" +}, +"publicKey": { +"$ref": "ChecksummedData", +"description": "This field contains the public key (with integrity verification), formatted according to the public_key_format field." +}, +"publicKeyFormat": { +"description": "The PublicKey format specified by the customer through the public_key_format field.", +"enum": [ +"PUBLIC_KEY_FORMAT_UNSPECIFIED", +"PEM", +"NIST_PQC" +], +"enumDescriptions": [ +"If the public_key_format field is not specified: - For PQC algorithms, an error will be returned. - For non-PQC algorithms, the default format is PEM, and the field pem will be populated. Otherwise, the public key will be exported through the public_key field in the requested format.", +"The returned public key will be encoded in PEM format. See the [RFC7468](https://tools.ietf.org/html/rfc7468) sections for [General Considerations](https://tools.ietf.org/html/rfc7468#section-2) and [Textual Encoding of Subject Public Key Info] (https://tools.ietf.org/html/rfc7468#section-13) for more information.", +"This is supported only for PQC algorithms. The key material is returned in the format defined by NIST PQC standards (FIPS 203, FIPS 204, and FIPS 205)." +], +"type": "string" } }, "type": "object" From c2c0fe994aba4a7078b915244ae35dd661425a37 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 25 Feb 2025 07:08:17 +0000 Subject: [PATCH 05/36] feat(compute): update the api #### compute:alpha The following keys were deleted: - schemas.InterconnectGroupsCreateMembersResponse (Total Keys: 3) - schemas.NetworkEndpoint.properties.zone.type (Total Keys: 1) The following keys were added: - resources.disks.methods.bulkSetLabels (Total Keys: 21) - resources.interconnectAttachmentGroups.methods.createMembers (Total Keys: 16) - resources.regionHealthSources.methods.aggregatedList (Total Keys: 29) - resources.regionHealthSources.methods.delete (Total Keys: 21) - resources.regionHealthSources.methods.get (Total Keys: 19) - resources.regionHealthSources.methods.insert (Total Keys: 18) - resources.regionHealthSources.methods.list (Total Keys: 28) - resources.regionHealthSources.methods.patch (Total Keys: 21) - resources.regionHealthSources.methods.testIamPermissions (Total Keys: 20) - resources.regionMultiMigMembers.methods.get (Total Keys: 23) - resources.regionMultiMigMembers.methods.list (Total Keys: 30) - schemas.AllocationResourceStatus.properties.aggregateAllocation.$ref (Total Keys: 1) - schemas.AllocationResourceStatusAggregateAllocation (Total Keys: 5) - schemas.BulkSetLabelsRequest (Total Keys: 6) - schemas.BulkZoneSetLabelsRequest (Total Keys: 4) - schemas.DiskSettingsAccessLocation.properties.policy.type (Total Keys: 1) - schemas.HealthSource (Total Keys: 65) - schemas.InstancesReportHostAsFaultyRequest.properties.disruptionSchedule.type (Total Keys: 1) - schemas.InterconnectAttachmentGroupsCreateMembers (Total Keys: 46) - schemas.MultiMigMember (Total Keys: 31) - schemas.RouterStatus.properties.nccGateway.type (Total Keys: 1) The following keys were changed: - resources.interconnectGroups.methods.createMembers.response.$ref (Total Keys: 1) #### compute:v1 The following keys were added: - resources.routers.methods.deleteRoutePolicy (Total Keys: 23) - resources.routers.methods.getRoutePolicy (Total Keys: 20) - resources.routers.methods.listBgpRoutes (Total Keys: 45) - resources.routers.methods.listRoutePolicies (Total Keys: 32) - resources.routers.methods.patchRoutePolicy (Total Keys: 22) - resources.routers.methods.updateRoutePolicy (Total Keys: 22) - schemas.BgpRoute (Total Keys: 21) - schemas.RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy.properties.priority (Total Keys: 2) - schemas.RoutePolicy (Total Keys: 15) - schemas.RoutersGetRoutePolicyResponse (Total Keys: 3) - schemas.RoutersListBgpRoutes (Total Keys: 18) - schemas.RoutersListRoutePolicies (Total Keys: 18) --- docs/dyn/compute_alpha.backendServices.html | 28 +- docs/dyn/compute_alpha.diskSettings.html | 2 + docs/dyn/compute_alpha.disks.html | 147 +- ...ute_alpha.globalNetworkEndpointGroups.html | 3 - docs/dyn/compute_alpha.html | 10 + docs/dyn/compute_alpha.instances.html | 1 + ...te_alpha.interconnectAttachmentGroups.html | 260 ++ .../dyn/compute_alpha.interconnectGroups.html | 149 +- .../compute_alpha.interconnectLocations.html | 12 +- .../compute_alpha.networkEndpointGroups.html | 4 - .../compute_alpha.regionBackendServices.html | 24 +- docs/dyn/compute_alpha.regionCommitments.html | 30 + .../dyn/compute_alpha.regionDiskSettings.html | 2 + docs/dyn/compute_alpha.regionDisks.html | 4 +- .../compute_alpha.regionHealthSources.html | 759 +++++ .../compute_alpha.regionMultiMigMembers.html | 195 ++ ...ute_alpha.regionNetworkEndpointGroups.html | 3 - docs/dyn/compute_alpha.regionSnapshots.html | 6 +- docs/dyn/compute_alpha.regionUrlMaps.html | 2 +- docs/dyn/compute_alpha.reservations.html | 25 + docs/dyn/compute_alpha.routers.html | 33 +- docs/dyn/compute_alpha.snapshots.html | 8 +- docs/dyn/compute_alpha.subnetworks.html | 12 +- docs/dyn/compute_alpha.urlMaps.html | 2 +- docs/dyn/compute_alpha.wireGroups.html | 32 +- docs/dyn/compute_v1.disks.html | 2 +- docs/dyn/compute_v1.regionDisks.html | 2 +- ...pute_v1.regionNetworkFirewallPolicies.html | 1 + docs/dyn/compute_v1.routers.html | 773 ++++- docs/dyn/compute_v1.snapshots.html | 6 +- docs/dyn/compute_v1.subnetworks.html | 12 +- .../documents/compute.alpha.json | 2546 ++++++++++++++--- .../discovery_cache/documents/compute.v1.json | 899 +++++- 33 files changed, 5327 insertions(+), 667 deletions(-) create mode 100644 docs/dyn/compute_alpha.regionHealthSources.html create mode 100644 docs/dyn/compute_alpha.regionMultiMigMembers.html diff --git a/docs/dyn/compute_alpha.backendServices.html b/docs/dyn/compute_alpha.backendServices.html index 44d8389109b..91d6ecc0208 100644 --- a/docs/dyn/compute_alpha.backendServices.html +++ b/docs/dyn/compute_alpha.backendServices.html @@ -307,7 +307,7 @@

Method Details

{ # Custom Metrics are used for CUSTOM_METRICS balancing_mode. "dryRun": True or False, # If true, the metric data is collected and reported to Cloud Monitoring, but is not used for load balancing. "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is [0.0, 1.0]. - "name": "A String", # Name of a custom utilization signal. The name must be 1-24 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. + "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. }, ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. @@ -401,7 +401,7 @@

Method Details

"customMetrics": [ # List of custom metrics that are used for the WEIGHTED_ROUND_ROBIN locality_lb_policy. { # Custom Metrics are used for WEIGHTED_ROUND_ROBIN locality_lb_policy. "dryRun": True or False, # If true, the metric data is not used for load balancing. - "name": "A String", # Name of a custom utilization signal. The name must be 1-24 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. + "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. }, ], "customRequestHeaders": [ # Headers that the load balancer adds to proxied requests. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers). @@ -1104,7 +1104,7 @@

Method Details

{ # Custom Metrics are used for CUSTOM_METRICS balancing_mode. "dryRun": True or False, # If true, the metric data is collected and reported to Cloud Monitoring, but is not used for load balancing. "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is [0.0, 1.0]. - "name": "A String", # Name of a custom utilization signal. The name must be 1-24 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. + "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. }, ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. @@ -1198,7 +1198,7 @@

Method Details

"customMetrics": [ # List of custom metrics that are used for the WEIGHTED_ROUND_ROBIN locality_lb_policy. { # Custom Metrics are used for WEIGHTED_ROUND_ROBIN locality_lb_policy. "dryRun": True or False, # If true, the metric data is not used for load balancing. - "name": "A String", # Name of a custom utilization signal. The name must be 1-24 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. + "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. }, ], "customRequestHeaders": [ # Headers that the load balancer adds to proxied requests. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers). @@ -1979,7 +1979,7 @@

Method Details

{ # Custom Metrics are used for CUSTOM_METRICS balancing_mode. "dryRun": True or False, # If true, the metric data is collected and reported to Cloud Monitoring, but is not used for load balancing. "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is [0.0, 1.0]. - "name": "A String", # Name of a custom utilization signal. The name must be 1-24 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. + "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. }, ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. @@ -2073,7 +2073,7 @@

Method Details

"customMetrics": [ # List of custom metrics that are used for the WEIGHTED_ROUND_ROBIN locality_lb_policy. { # Custom Metrics are used for WEIGHTED_ROUND_ROBIN locality_lb_policy. "dryRun": True or False, # If true, the metric data is not used for load balancing. - "name": "A String", # Name of a custom utilization signal. The name must be 1-24 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. + "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. }, ], "customRequestHeaders": [ # Headers that the load balancer adds to proxied requests. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers). @@ -2600,7 +2600,7 @@

Method Details

{ # Custom Metrics are used for CUSTOM_METRICS balancing_mode. "dryRun": True or False, # If true, the metric data is collected and reported to Cloud Monitoring, but is not used for load balancing. "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is [0.0, 1.0]. - "name": "A String", # Name of a custom utilization signal. The name must be 1-24 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. + "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. }, ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. @@ -2694,7 +2694,7 @@

Method Details

"customMetrics": [ # List of custom metrics that are used for the WEIGHTED_ROUND_ROBIN locality_lb_policy. { # Custom Metrics are used for WEIGHTED_ROUND_ROBIN locality_lb_policy. "dryRun": True or False, # If true, the metric data is not used for load balancing. - "name": "A String", # Name of a custom utilization signal. The name must be 1-24 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. + "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. }, ], "customRequestHeaders": [ # Headers that the load balancer adds to proxied requests. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers). @@ -3119,7 +3119,7 @@

Method Details

{ # Custom Metrics are used for CUSTOM_METRICS balancing_mode. "dryRun": True or False, # If true, the metric data is collected and reported to Cloud Monitoring, but is not used for load balancing. "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is [0.0, 1.0]. - "name": "A String", # Name of a custom utilization signal. The name must be 1-24 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. + "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. }, ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. @@ -3213,7 +3213,7 @@

Method Details

"customMetrics": [ # List of custom metrics that are used for the WEIGHTED_ROUND_ROBIN locality_lb_policy. { # Custom Metrics are used for WEIGHTED_ROUND_ROBIN locality_lb_policy. "dryRun": True or False, # If true, the metric data is not used for load balancing. - "name": "A String", # Name of a custom utilization signal. The name must be 1-24 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. + "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. }, ], "customRequestHeaders": [ # Headers that the load balancer adds to proxied requests. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers). @@ -3654,7 +3654,7 @@

Method Details

{ # Custom Metrics are used for CUSTOM_METRICS balancing_mode. "dryRun": True or False, # If true, the metric data is collected and reported to Cloud Monitoring, but is not used for load balancing. "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is [0.0, 1.0]. - "name": "A String", # Name of a custom utilization signal. The name must be 1-24 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. + "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. }, ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. @@ -3748,7 +3748,7 @@

Method Details

"customMetrics": [ # List of custom metrics that are used for the WEIGHTED_ROUND_ROBIN locality_lb_policy. { # Custom Metrics are used for WEIGHTED_ROUND_ROBIN locality_lb_policy. "dryRun": True or False, # If true, the metric data is not used for load balancing. - "name": "A String", # Name of a custom utilization signal. The name must be 1-24 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. + "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. }, ], "customRequestHeaders": [ # Headers that the load balancer adds to proxied requests. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers). @@ -4658,7 +4658,7 @@

Method Details

{ # Custom Metrics are used for CUSTOM_METRICS balancing_mode. "dryRun": True or False, # If true, the metric data is collected and reported to Cloud Monitoring, but is not used for load balancing. "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is [0.0, 1.0]. - "name": "A String", # Name of a custom utilization signal. The name must be 1-24 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. + "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. }, ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. @@ -4752,7 +4752,7 @@

Method Details

"customMetrics": [ # List of custom metrics that are used for the WEIGHTED_ROUND_ROBIN locality_lb_policy. { # Custom Metrics are used for WEIGHTED_ROUND_ROBIN locality_lb_policy. "dryRun": True or False, # If true, the metric data is not used for load balancing. - "name": "A String", # Name of a custom utilization signal. The name must be 1-24 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. + "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. }, ], "customRequestHeaders": [ # Headers that the load balancer adds to proxied requests. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers). diff --git a/docs/dyn/compute_alpha.diskSettings.html b/docs/dyn/compute_alpha.diskSettings.html index 91db0243534..1ac2af342d8 100644 --- a/docs/dyn/compute_alpha.diskSettings.html +++ b/docs/dyn/compute_alpha.diskSettings.html @@ -111,6 +111,7 @@

Method Details

"region": "A String", # Accessible region name }, }, + "policy": "A String", # Policy of which location is allowed to access snapshot. }, "defaultResourcePolicies": { # An optional parameter for storing the default resource policies that will be used for the Disks created in the given scope. The Key is a string type, provided by customers to uniquely identify the default Resource Policy entry. The Value is a Default ResourcePolicyDetails Object used to represent the detailed information of the Resource Policy entry. "a_key": { # This is the object for storing the detail information about the Resource Policy that will be set as default ones for the Disks that is using the DiskSettings. It contains: - one target Resource Policy referenced by its Fully-Qualified URL, - [output only] Disk Types that will be excluded from using this Resource Policy, - Other filtering support (e.g. Label filtering) for Default Resource Policy can be added here as well @@ -140,6 +141,7 @@

Method Details

"region": "A String", # Accessible region name }, }, + "policy": "A String", # Policy of which location is allowed to access snapshot. }, "defaultResourcePolicies": { # An optional parameter for storing the default resource policies that will be used for the Disks created in the given scope. The Key is a string type, provided by customers to uniquely identify the default Resource Policy entry. The Value is a Default ResourcePolicyDetails Object used to represent the detailed information of the Resource Policy entry. "a_key": { # This is the object for storing the detail information about the Resource Policy that will be set as default ones for the Disks that is using the DiskSettings. It contains: - one target Resource Policy referenced by its Fully-Qualified URL, - [output only] Disk Types that will be excluded from using this Resource Policy, - Other filtering support (e.g. Label filtering) for Default Resource Policy can be added here as well diff --git a/docs/dyn/compute_alpha.disks.html b/docs/dyn/compute_alpha.disks.html index 86208333e16..a4696e2aed0 100644 --- a/docs/dyn/compute_alpha.disks.html +++ b/docs/dyn/compute_alpha.disks.html @@ -86,6 +86,9 @@

Instance Methods

bulkInsert(project, zone, body=None, requestId=None, x__xgafv=None)

Bulk create a set of disks.

+

+ bulkSetLabels(project, zone, body=None, requestId=None, resource=None, x__xgafv=None)

+

Sets the labels on many disks at once. To learn more about labels, read the Labeling Resources documentation.

close()

Close httplib2 connections.

@@ -606,6 +609,146 @@

Method Details

} +
+ bulkSetLabels(project, zone, body=None, requestId=None, resource=None, x__xgafv=None) +
Sets the labels on many disks at once. To learn more about labels, read the Labeling Resources documentation.
+
+Args:
+  project: string, Project ID for this request. (required)
+  zone: string, The name of the zone for this request. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{
+  "requests": [
+    {
+      "labelFingerprint": "A String", # The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You may optionally provide an up-to-date fingerprint hash in order to update or change labels. Make a get() request to the resource to get the latest fingerprint.
+      "labels": { # The labels to set for this resource.
+        "a_key": "A String",
+      },
+    },
+  ],
+}
+
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
+  resource: string, Name or id of the resource for this request.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
+  "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "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). # [Output Only] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "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.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the disk that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
+}
+
+
close()
Close httplib2 connections.
@@ -687,7 +830,7 @@

Method Details

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. }, - "sourceInstantSnapshotId": "A String", # [Output Only] The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this persistent disk. For example, if you created the persistent disk from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used. + "sourceInstantSnapshotId": "A String", # [Output Only] The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this snapshot. For example, if you created the snapshot from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used. "sourceSnapshotSchedulePolicy": "A String", # [Output Only] URL of the resource policy which created this scheduled snapshot. "sourceSnapshotSchedulePolicyId": "A String", # [Output Only] ID of the resource policy which created this scheduled snapshot. "status": "A String", # [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING. @@ -1106,7 +1249,7 @@

Method Details

{ "asyncReplicationStatus": { "diskPairReplicationState": { - "dataReplicationState": "A String", # [Output Only] The status of disk creation. - ASYNC_REPLICATION_STATE_INITIALIZING: The device is doing the initial replication after starting the replication. - ASYNC_REPLICATION_STATE_REPLICATING_HEALTHY: The primary disk is healthily replicating to the secondary device i.e. last_replication_time is within RPO. - ASYNC_REPLICATION_STATE_REPLICATING_BEHIND_HIGH_CHURN: The replication is lagging above the SLO limit due to some internal issue. - ASYNC_REPLICATION_STATE_REPLICATING_BEHIND_SYSTEM_LAGGING: The replication is lagging, and the RPO is not being met due to some internal issue. - ASYNC_REPLICATION_STATE_REPLICATION_STUCK: The replication is completely stuck due to some internal error. - ASYNC_REPLICATION_STATE_STOPPING: The replication is under the process of being stopped. This is a transient state. - ASYNC_REPLICATION_STATE_STOPPED: The replication between the disk-pairs have stopped. + "dataReplicationState": "A String", # [Output Only] The status of disk creation. - ASYNC_REPLICATION_STATE_INITIALIZING: The device is doing the initial replication after starting the replication. - ASYNC_REPLICATION_STATE_REPLICATING_HEALTHY: The primary disk is healthily replicating to the secondary device i.e. last_replication_time is within RPO. - ASYNC_REPLICATION_STATE_REPLICATING_BEHIND_HIGH_CHURN: The replication is lagging above the SLO limit due to the disk's change rate being above the supported limit. - ASYNC_REPLICATION_STATE_REPLICATING_BEHIND_SYSTEM_LAGGING: The replication is lagging, and the RPO is not being met due to some internal issue. - ASYNC_REPLICATION_STATE_REPLICATION_STUCK: The replication is completely stuck due to some internal error. - ASYNC_REPLICATION_STATE_STOPPING: The replication is under the process of being stopped. This is a transient state. - ASYNC_REPLICATION_STATE_STOPPED: The replication between the disk-pairs have stopped. - ASYNC_REPLICATION_STATE_REPLICATING_BEHIND_CG_HIGH_CHURN: The replication is lagging above the SLO limit for the disk in the consistency group due to disk's change rate being above the supported limit. "replicationDiskPair": { "primaryDisk": "A String", # URL of the primary disk. "secondaryDisk": "A String", # URL of the secondary disk. diff --git a/docs/dyn/compute_alpha.globalNetworkEndpointGroups.html b/docs/dyn/compute_alpha.globalNetworkEndpointGroups.html index 8a587aa2bc9..1ba3f384886 100644 --- a/docs/dyn/compute_alpha.globalNetworkEndpointGroups.html +++ b/docs/dyn/compute_alpha.globalNetworkEndpointGroups.html @@ -127,7 +127,6 @@

Method Details

"ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. "ipv6Address": "A String", # Optional IPv6 address of network endpoint. "port": 42, # Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. This field can not be set for network endpoints of type GCE_VM_IP. - "zone": "A String", # The name of the zone where the instance hosting the network endpoint is located (valid only for regional GCE_VM_IP_PORT NEGs). It should comply with RFC1035. The zone must belong to the region of the Network Endpoint Group. }, ], } @@ -402,7 +401,6 @@

Method Details

"ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. "ipv6Address": "A String", # Optional IPv6 address of network endpoint. "port": 42, # Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. This field can not be set for network endpoints of type GCE_VM_IP. - "zone": "A String", # The name of the zone where the instance hosting the network endpoint is located (valid only for regional GCE_VM_IP_PORT NEGs). It should comply with RFC1035. The zone must belong to the region of the Network Endpoint Group. }, ], } @@ -920,7 +918,6 @@

Method Details

"ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. "ipv6Address": "A String", # Optional IPv6 address of network endpoint. "port": 42, # Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. This field can not be set for network endpoints of type GCE_VM_IP. - "zone": "A String", # The name of the zone where the instance hosting the network endpoint is located (valid only for regional GCE_VM_IP_PORT NEGs). It should comply with RFC1035. The zone must belong to the region of the Network Endpoint Group. }, }, ], diff --git a/docs/dyn/compute_alpha.html b/docs/dyn/compute_alpha.html index b00a1c8f2d9..94aa228f20e 100644 --- a/docs/dyn/compute_alpha.html +++ b/docs/dyn/compute_alpha.html @@ -404,6 +404,11 @@

Instance Methods

Returns the regionHealthChecks Resource.

+

+ regionHealthSources() +

+

Returns the regionHealthSources Resource.

+

regionInstanceGroupManagerResizeRequests()

@@ -439,6 +444,11 @@

Instance Methods

Returns the regionInstantSnapshots Resource.

+

+ regionMultiMigMembers() +

+

Returns the regionMultiMigMembers Resource.

+

regionMultiMigs()

diff --git a/docs/dyn/compute_alpha.instances.html b/docs/dyn/compute_alpha.instances.html index 11311bcbeef..4fa7b9ec937 100644 --- a/docs/dyn/compute_alpha.instances.html +++ b/docs/dyn/compute_alpha.instances.html @@ -5226,6 +5226,7 @@

Method Details

{ "actionHint": "A String", # The action hint to report the host as faulty. + "disruptionSchedule": "A String", # The disruption schedule for the VM. Default to IMMEDIATE. "faultReasons": [ { "behavior": "A String", diff --git a/docs/dyn/compute_alpha.interconnectAttachmentGroups.html b/docs/dyn/compute_alpha.interconnectAttachmentGroups.html index 8e34d472f86..fa2666a44e6 100644 --- a/docs/dyn/compute_alpha.interconnectAttachmentGroups.html +++ b/docs/dyn/compute_alpha.interconnectAttachmentGroups.html @@ -77,6 +77,9 @@

Instance Methods

close()

Close httplib2 connections.

+

+ createMembers(project, interconnectAttachmentGroup, body=None, x__xgafv=None)

+

Create Interconnect Attachments with redundancy by creating them in a specified interconnect attachment group.

delete(project, interconnectAttachmentGroup, requestId=None, x__xgafv=None)

Deletes the specified InterconnectAttachmentGroup in the given scope

@@ -113,6 +116,263 @@

Method Details

Close httplib2 connections.
+
+ createMembers(project, interconnectAttachmentGroup, body=None, x__xgafv=None) +
Create Interconnect Attachments with redundancy by creating them in a specified interconnect attachment group.
+
+Args:
+  project: string, Project ID for this request. (required)
+  interconnectAttachmentGroup: string, Name of the group resource to create members for. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{
+  "request": {
+    "attachments": [ # Parameters for the specific Attachments to create.
+      { # LINT.IfChange Parameters used to create an InterconnectAttachment. This is similar to InterconnectAttachment, but the region field used here is not output only and all other output only fields are excluded.
+        "adminEnabled": True or False, # Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER.
+        "bandwidth": "A String", # Provisioned bandwidth capacity for the interconnect attachment. For attachments of type DEDICATED, the user can set the bandwidth. For attachments of type PARTNER, the Google Partner that is operating the interconnect must set the bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED, and can take one of the following values: - BPS_50M: 50 Mbit/s - BPS_100M: 100 Mbit/s - BPS_200M: 200 Mbit/s - BPS_300M: 300 Mbit/s - BPS_400M: 400 Mbit/s - BPS_500M: 500 Mbit/s - BPS_1G: 1 Gbit/s - BPS_2G: 2 Gbit/s - BPS_5G: 5 Gbit/s - BPS_10G: 10 Gbit/s - BPS_20G: 20 Gbit/s - BPS_50G: 50 Gbit/s - BPS_100G: 100 Gbit/s
+        "candidateCloudRouterIpAddress": "A String", # Single IPv4 address + prefix length to be configured on the cloud router interface for this interconnect attachment. - Both candidate_cloud_router_ip_address and candidate_customer_router_ip_address fields must be set or both must be unset. - Prefix length of both candidate_cloud_router_ip_address and candidate_customer_router_ip_address must be the same. - Max prefix length is 31.
+        "candidateCloudRouterIpv6Address": "A String", # Single IPv6 address + prefix length to be configured on the cloud router interface for this interconnect attachment. - Both candidate_cloud_router_ipv6_address and candidate_customer_router_ipv6_address fields must be set or both must be unset. - Prefix length of both candidate_cloud_router_ipv6_address and candidate_customer_router_ipv6_address must be the same. - Max prefix length is 126.
+        "candidateCustomerRouterIpAddress": "A String", # Single IPv4 address + prefix length to be configured on the customer router interface for this interconnect attachment.
+        "candidateCustomerRouterIpv6Address": "A String", # Single IPv6 address + prefix length to be configured on the customer router interface for this interconnect attachment.
+        "candidateIpv6Subnets": [ # This field is not available.
+          "A String",
+        ],
+        "candidateSubnets": [ # Input only. Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google's edge. If not supplied, Google will randomly select an unused /29 from all of link-local space.
+          "A String",
+        ],
+        "cloudRouterIpv6InterfaceId": "A String", # This field is not available.
+        "customerRouterIpv6InterfaceId": "A String", # This field is not available.
+        "description": "A String", # An optional description of this resource.
+        "edgeAvailabilityDomain": "A String", # Input only. Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values: - AVAILABILITY_DOMAIN_ANY - AVAILABILITY_DOMAIN_1 - AVAILABILITY_DOMAIN_2 For improved reliability, customers should configure a pair of attachments, one per availability domain. The selected availability domain will be provided to the Partner via the pairing key, so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY.
+        "encryption": "A String", # Indicates the user-supplied encryption option of this VLAN attachment (interconnectAttachment). Can only be specified at attachment creation for PARTNER or DEDICATED attachments. Possible values are: - alpha - This is the default value, which means that the VLAN attachment carries unencrypted traffic. VMs are able to send traffic to, or receive traffic from, such a VLAN attachment. - IPSEC - The VLAN attachment carries only encrypted traffic that is encrypted by an IPsec device, such as an HA VPN gateway or third-party IPsec VPN. VMs cannot directly send traffic to, or receive traffic from, such a VLAN attachment. To use *HA VPN over Cloud Interconnect*, the VLAN attachment must be created with this option.
+        "interconnect": "A String", # URL of the underlying Interconnect object that this attachment's traffic will traverse through.
+        "ipsecInternalAddresses": [ # A list of URLs of addresses that have been reserved for the VLAN attachment. Used only for the VLAN attachment that has the encryption option as IPSEC. The addresses must be regional internal IP address ranges. When creating an HA VPN gateway over the VLAN attachment, if the attachment is configured to use a regional internal IP address, then the VPN gateway's IP address is allocated from the IP address range specified here. For example, if the HA VPN gateway's interface 0 is paired to this VLAN attachment, then a regional internal IP address for the VPN gateway interface 0 will be allocated from the IP address specified for this VLAN attachment. If this field is not specified when creating the VLAN attachment, then later on when creating an HA VPN gateway on this VLAN attachment, the HA VPN gateway's IP address is allocated from the regional external IP address pool.
+          "A String",
+        ],
+        "l2Forwarding": { # L2 Interconnect Attachment related configuration. # L2 Interconnect Attachment related config. This field is required if the type is L2_DEDICATED. The configuration specifies how VLAN tags (like dot1q, qinq, or dot1ad) within L2 packets are mapped to the destination appliances IP addresses. The packet is then encapsulated with the appliance IP address and sent to the edge appliance.
+          "applianceMappings": { # Optional. A map of VLAN tags to appliances and optional inner mapping rules. If VLANs are not explicitly mapped to any appliance, the defaultApplianceIpAddress is used. Each VLAN tag can be a single number or a range of numbers in the range of 1 to 4094, e.g., "1" or "4001-4094". Non-empty and non-overlapping VLAN tag ranges are enforced, and violating operations will be rejected. The VLAN tags in the Ethernet header must use an ethertype value of 0x88A8 or 0x8100.
+            "a_key": { # Two-level VLAN-to-Appliance mapping rule.
+              "applianceIpAddress": "A String", # Optional. A single IPv4 or IPv6 address used as the destination IP address for ingress packets that match on a VLAN tag, but do not match a more specific inner VLAN tag. Unset field (null-value) indicates both VLAN tags are required to be mapped. Otherwise, defaultApplianceIpAddress is used.
+              "innerVlanToApplianceMappings": [ # Optional. Used to match against the inner VLAN when the packet contains two VLAN tags. A list of mapping rules from inner VLAN tags to IP addresses. If the inner VLAN is not explicitly mapped to an IP address range, the applianceIpAddress is used.
+                { # The inner VLAN-to-Appliance mapping.
+                  "innerApplianceIpAddress": "A String", # Required in this object. A single IPv4 or IPv6 address used as the destination IP address for ingress packets that match on both VLAN tags.
+                  "innerVlanTags": [ # Required in this object. Used to match the inner VLAN tag on the packet. Each entry can be a single number or a range of numbers in the range of 1 to 4094, e.g., ["1", "4001-4094"] is valid. Non-empty and Non-overlapping VLAN tag ranges are enforced, and violating operations will be rejected. The inner VLAN tags must have an ethertype value of 0x8100.
+                    "A String",
+                  ],
+                },
+              ],
+              "name": "A String", # Optional. The name of this appliance mapping rule.
+            },
+          },
+          "defaultApplianceIpAddress": "A String", # Optional. A single IPv4 or IPv6 address used as the default destination IP when there is no VLAN mapping result found. Unset field (null-value) indicates the unmatched packet should be dropped.
+          "geneveHeader": { # GeneveHeader related configurations. # Optional. It represents the structure of a Geneve (Generic Network Virtualization Encapsulation) header, as defined in RFC8926. It encapsulates packets from various protocols (e.g., Ethernet, IPv4, IPv6) for use in network virtualization environments.
+            "vni": 42, # Optional. VNI is a 24-bit unique virtual network identifier, from 0 to 16,777,215.
+          },
+          "network": "A String", # Required. Resource URL of the network to which this attachment belongs.
+          "tunnelEndpointIpAddress": "A String", # Required. A single IPv4 or IPv6 address. This address will be used as the source IP address for packets sent to the appliances, and must be used as the destination IP address for packets that should be sent out through this attachment.
+        },
+        "mtu": 42, # Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Only 1440 and 1500 are allowed. If not specified, the value will default to 1440.
+        "multicastEnabled": True or False, # Whether or not to permit multicast traffic for this attachment. Multicast packets will be dropped if this is not enabled.
+        "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+        "pairingKey": "A String", # [Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not present for DEDICATED]. The opaque identifier of a PARTNER attachment used to initiate provisioning with a selected partner. Of the form "XXXXX/region/domain"
+        "partnerAsn": "A String", # Optional BGP ASN for the router supplied by a Layer 3 Partner if they configured BGP on behalf of the customer. Output only for PARTNER type, input only for PARTNER_PROVIDER, not available for DEDICATED.
+        "partnerMetadata": { # Informational metadata about Partner attachments from Partners to display to customers. These fields are propagated from PARTNER_PROVIDER attachments to their corresponding PARTNER attachments. # Informational metadata about Partner attachments from Partners to display to customers. Output only for PARTNER type, mutable for PARTNER_PROVIDER, not available for DEDICATED.
+          "interconnectName": "A String", # Plain text name of the Interconnect this attachment is connected to, as displayed in the Partner's portal. For instance "Chicago 1". This value may be validated to match approved Partner values.
+          "partnerName": "A String", # Plain text name of the Partner providing this attachment. This value may be validated to match approved Partner values.
+          "portalUrl": "A String", # URL of the Partner's portal for this Attachment. Partners may customise this to be a deep link to the specific resource on the Partner portal. This value may be validated to match approved Partner values.
+        },
+        "region": "A String", # The region that the Attachment is in.
+        "router": "A String", # URL of the Cloud Router to be used for dynamic routing. This router must be in the same region as this InterconnectAttachment. The InterconnectAttachment will automatically connect the Interconnect to the network & region within which the Cloud Router is configured.
+        "stackType": "A String", # The stack type for this interconnect attachment to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used. This field can be both set at interconnect attachments creation and update interconnect attachment operations.
+        "subnetLength": 42, # Input only. Length of the IPv4 subnet mask. Allowed values: - 29 (default) - 30 The default value is 29, except for Cross-Cloud Interconnect connections that use an InterconnectRemoteLocation with a constraints.subnetLengthRange.min equal to 30. For example, connections that use an Azure remote location fall into this category. In these cases, the default value is 30, and requesting 29 returns an error. Where both 29 and 30 are allowed, 29 is preferred, because it gives Google Cloud Support more debugging visibility.
+        "type": "A String", # The type of interconnect attachment this is, which can take one of the following values: - DEDICATED: an attachment to a Dedicated Interconnect. - PARTNER: an attachment to a Partner Interconnect, created by the customer. - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner.
+        "vlanTag8021q": 42, # The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4093. Only specified at creation time.
+      },
+    ],
+    "intentMismatchBehavior": "A String", # How to behave when configured.availabilitySLA.effectiveSLA would not equal intent.availabilitySLA after this call.
+    "templateAttachment": { # LINT.IfChange Parameters used to create an InterconnectAttachment. This is similar to InterconnectAttachment, but the region field used here is not output only and all other output only fields are excluded. # Default parameters for the Attachments to create in this call.
+      "adminEnabled": True or False, # Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER.
+      "bandwidth": "A String", # Provisioned bandwidth capacity for the interconnect attachment. For attachments of type DEDICATED, the user can set the bandwidth. For attachments of type PARTNER, the Google Partner that is operating the interconnect must set the bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED, and can take one of the following values: - BPS_50M: 50 Mbit/s - BPS_100M: 100 Mbit/s - BPS_200M: 200 Mbit/s - BPS_300M: 300 Mbit/s - BPS_400M: 400 Mbit/s - BPS_500M: 500 Mbit/s - BPS_1G: 1 Gbit/s - BPS_2G: 2 Gbit/s - BPS_5G: 5 Gbit/s - BPS_10G: 10 Gbit/s - BPS_20G: 20 Gbit/s - BPS_50G: 50 Gbit/s - BPS_100G: 100 Gbit/s
+      "candidateCloudRouterIpAddress": "A String", # Single IPv4 address + prefix length to be configured on the cloud router interface for this interconnect attachment. - Both candidate_cloud_router_ip_address and candidate_customer_router_ip_address fields must be set or both must be unset. - Prefix length of both candidate_cloud_router_ip_address and candidate_customer_router_ip_address must be the same. - Max prefix length is 31.
+      "candidateCloudRouterIpv6Address": "A String", # Single IPv6 address + prefix length to be configured on the cloud router interface for this interconnect attachment. - Both candidate_cloud_router_ipv6_address and candidate_customer_router_ipv6_address fields must be set or both must be unset. - Prefix length of both candidate_cloud_router_ipv6_address and candidate_customer_router_ipv6_address must be the same. - Max prefix length is 126.
+      "candidateCustomerRouterIpAddress": "A String", # Single IPv4 address + prefix length to be configured on the customer router interface for this interconnect attachment.
+      "candidateCustomerRouterIpv6Address": "A String", # Single IPv6 address + prefix length to be configured on the customer router interface for this interconnect attachment.
+      "candidateIpv6Subnets": [ # This field is not available.
+        "A String",
+      ],
+      "candidateSubnets": [ # Input only. Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google's edge. If not supplied, Google will randomly select an unused /29 from all of link-local space.
+        "A String",
+      ],
+      "cloudRouterIpv6InterfaceId": "A String", # This field is not available.
+      "customerRouterIpv6InterfaceId": "A String", # This field is not available.
+      "description": "A String", # An optional description of this resource.
+      "edgeAvailabilityDomain": "A String", # Input only. Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values: - AVAILABILITY_DOMAIN_ANY - AVAILABILITY_DOMAIN_1 - AVAILABILITY_DOMAIN_2 For improved reliability, customers should configure a pair of attachments, one per availability domain. The selected availability domain will be provided to the Partner via the pairing key, so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY.
+      "encryption": "A String", # Indicates the user-supplied encryption option of this VLAN attachment (interconnectAttachment). Can only be specified at attachment creation for PARTNER or DEDICATED attachments. Possible values are: - alpha - This is the default value, which means that the VLAN attachment carries unencrypted traffic. VMs are able to send traffic to, or receive traffic from, such a VLAN attachment. - IPSEC - The VLAN attachment carries only encrypted traffic that is encrypted by an IPsec device, such as an HA VPN gateway or third-party IPsec VPN. VMs cannot directly send traffic to, or receive traffic from, such a VLAN attachment. To use *HA VPN over Cloud Interconnect*, the VLAN attachment must be created with this option.
+      "interconnect": "A String", # URL of the underlying Interconnect object that this attachment's traffic will traverse through.
+      "ipsecInternalAddresses": [ # A list of URLs of addresses that have been reserved for the VLAN attachment. Used only for the VLAN attachment that has the encryption option as IPSEC. The addresses must be regional internal IP address ranges. When creating an HA VPN gateway over the VLAN attachment, if the attachment is configured to use a regional internal IP address, then the VPN gateway's IP address is allocated from the IP address range specified here. For example, if the HA VPN gateway's interface 0 is paired to this VLAN attachment, then a regional internal IP address for the VPN gateway interface 0 will be allocated from the IP address specified for this VLAN attachment. If this field is not specified when creating the VLAN attachment, then later on when creating an HA VPN gateway on this VLAN attachment, the HA VPN gateway's IP address is allocated from the regional external IP address pool.
+        "A String",
+      ],
+      "l2Forwarding": { # L2 Interconnect Attachment related configuration. # L2 Interconnect Attachment related config. This field is required if the type is L2_DEDICATED. The configuration specifies how VLAN tags (like dot1q, qinq, or dot1ad) within L2 packets are mapped to the destination appliances IP addresses. The packet is then encapsulated with the appliance IP address and sent to the edge appliance.
+        "applianceMappings": { # Optional. A map of VLAN tags to appliances and optional inner mapping rules. If VLANs are not explicitly mapped to any appliance, the defaultApplianceIpAddress is used. Each VLAN tag can be a single number or a range of numbers in the range of 1 to 4094, e.g., "1" or "4001-4094". Non-empty and non-overlapping VLAN tag ranges are enforced, and violating operations will be rejected. The VLAN tags in the Ethernet header must use an ethertype value of 0x88A8 or 0x8100.
+          "a_key": { # Two-level VLAN-to-Appliance mapping rule.
+            "applianceIpAddress": "A String", # Optional. A single IPv4 or IPv6 address used as the destination IP address for ingress packets that match on a VLAN tag, but do not match a more specific inner VLAN tag. Unset field (null-value) indicates both VLAN tags are required to be mapped. Otherwise, defaultApplianceIpAddress is used.
+            "innerVlanToApplianceMappings": [ # Optional. Used to match against the inner VLAN when the packet contains two VLAN tags. A list of mapping rules from inner VLAN tags to IP addresses. If the inner VLAN is not explicitly mapped to an IP address range, the applianceIpAddress is used.
+              { # The inner VLAN-to-Appliance mapping.
+                "innerApplianceIpAddress": "A String", # Required in this object. A single IPv4 or IPv6 address used as the destination IP address for ingress packets that match on both VLAN tags.
+                "innerVlanTags": [ # Required in this object. Used to match the inner VLAN tag on the packet. Each entry can be a single number or a range of numbers in the range of 1 to 4094, e.g., ["1", "4001-4094"] is valid. Non-empty and Non-overlapping VLAN tag ranges are enforced, and violating operations will be rejected. The inner VLAN tags must have an ethertype value of 0x8100.
+                  "A String",
+                ],
+              },
+            ],
+            "name": "A String", # Optional. The name of this appliance mapping rule.
+          },
+        },
+        "defaultApplianceIpAddress": "A String", # Optional. A single IPv4 or IPv6 address used as the default destination IP when there is no VLAN mapping result found. Unset field (null-value) indicates the unmatched packet should be dropped.
+        "geneveHeader": { # GeneveHeader related configurations. # Optional. It represents the structure of a Geneve (Generic Network Virtualization Encapsulation) header, as defined in RFC8926. It encapsulates packets from various protocols (e.g., Ethernet, IPv4, IPv6) for use in network virtualization environments.
+          "vni": 42, # Optional. VNI is a 24-bit unique virtual network identifier, from 0 to 16,777,215.
+        },
+        "network": "A String", # Required. Resource URL of the network to which this attachment belongs.
+        "tunnelEndpointIpAddress": "A String", # Required. A single IPv4 or IPv6 address. This address will be used as the source IP address for packets sent to the appliances, and must be used as the destination IP address for packets that should be sent out through this attachment.
+      },
+      "mtu": 42, # Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Only 1440 and 1500 are allowed. If not specified, the value will default to 1440.
+      "multicastEnabled": True or False, # Whether or not to permit multicast traffic for this attachment. Multicast packets will be dropped if this is not enabled.
+      "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+      "pairingKey": "A String", # [Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not present for DEDICATED]. The opaque identifier of a PARTNER attachment used to initiate provisioning with a selected partner. Of the form "XXXXX/region/domain"
+      "partnerAsn": "A String", # Optional BGP ASN for the router supplied by a Layer 3 Partner if they configured BGP on behalf of the customer. Output only for PARTNER type, input only for PARTNER_PROVIDER, not available for DEDICATED.
+      "partnerMetadata": { # Informational metadata about Partner attachments from Partners to display to customers. These fields are propagated from PARTNER_PROVIDER attachments to their corresponding PARTNER attachments. # Informational metadata about Partner attachments from Partners to display to customers. Output only for PARTNER type, mutable for PARTNER_PROVIDER, not available for DEDICATED.
+        "interconnectName": "A String", # Plain text name of the Interconnect this attachment is connected to, as displayed in the Partner's portal. For instance "Chicago 1". This value may be validated to match approved Partner values.
+        "partnerName": "A String", # Plain text name of the Partner providing this attachment. This value may be validated to match approved Partner values.
+        "portalUrl": "A String", # URL of the Partner's portal for this Attachment. Partners may customise this to be a deep link to the specific resource on the Partner portal. This value may be validated to match approved Partner values.
+      },
+      "region": "A String", # The region that the Attachment is in.
+      "router": "A String", # URL of the Cloud Router to be used for dynamic routing. This router must be in the same region as this InterconnectAttachment. The InterconnectAttachment will automatically connect the Interconnect to the network & region within which the Cloud Router is configured.
+      "stackType": "A String", # The stack type for this interconnect attachment to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used. This field can be both set at interconnect attachments creation and update interconnect attachment operations.
+      "subnetLength": 42, # Input only. Length of the IPv4 subnet mask. Allowed values: - 29 (default) - 30 The default value is 29, except for Cross-Cloud Interconnect connections that use an InterconnectRemoteLocation with a constraints.subnetLengthRange.min equal to 30. For example, connections that use an Azure remote location fall into this category. In these cases, the default value is 30, and requesting 29 returns an error. Where both 29 and 30 are allowed, 29 is preferred, because it gives Google Cloud Support more debugging visibility.
+      "type": "A String", # The type of interconnect attachment this is, which can take one of the following values: - DEDICATED: an attachment to a Dedicated Interconnect. - PARTNER: an attachment to a Partner Interconnect, created by the customer. - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner.
+      "vlanTag8021q": 42, # The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4093. Only specified at creation time.
+    },
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
+  "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "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). # [Output Only] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "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.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the disk that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
+}
+
+
delete(project, interconnectAttachmentGroup, requestId=None, x__xgafv=None)
Deletes the specified InterconnectAttachmentGroup in the given scope
diff --git a/docs/dyn/compute_alpha.interconnectGroups.html b/docs/dyn/compute_alpha.interconnectGroups.html
index 292f5be66f7..77eb558db33 100644
--- a/docs/dyn/compute_alpha.interconnectGroups.html
+++ b/docs/dyn/compute_alpha.interconnectGroups.html
@@ -172,69 +172,112 @@ 

Method Details

Returns: An object of the form: - { # Response for the InterconnectGroupsCreateMembersRequest. - "etag": "A String", - "result": { # An interconnect group resource allows customers to create, analyze, and expand their redundant connections. - "configured": { # [Output Only] The status of the group as configured. This has the same structure as the operational field reported by the OperationalStatus method, but does not take into account the operational status of each resource. - "topologyCapability": { # [Output Only] How reliable this topology is configured to be, and why this group does or does not meet the requirements for the intended capability. - "intendedCapabilityBlockers": [ - { # [Output Only] Reasons why configuration.topologyCapability.sla differs from intent.topologyCapability. This list is empty if and only if those are the same. - "blockerType": "A String", - "documentationLink": "A String", # [Output Only] The url of Google Cloud public documentation explaining this requirement. This is set for every type of requirement. - "explanation": "A String", # [Output Only] A human-readable explanation of this requirement and why it's not met. This is set for every type of requirement. - "facilities": [ # [Output Only] Facilities used to explain this blocker in more detail. Like physicalStructure.metros.facilities.facility, this is a numeric string like "5467". - "A String", - ], - "interconnects": [ # [Output Only] Interconnects used to explain this blocker in more detail. - "A String", - ], - "metros": [ # [Output Only] Metros used to explain this blocker in more detail. These are three-letter lowercase strings like "iad". A blocker like INCOMPATIBLE_METROS will specify the problematic metros in this field. - "A String", - ], - "zones": [ # [Output Only] Zones used to explain this blocker in more detail. Zone names are "zone1" and/or "zone2". - "A String", - ], + { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period. + "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. + "creationTimestamp": "A String", # [Deprecated] This field is deprecated. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. + "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. + "errors": [ # [Output Only] The array of errors encountered while processing this operation. + { + "code": "A String", # [Output Only] The error type identifier for this error. + "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. + { + "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } + "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". + "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. + "a_key": "A String", + }, + "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. + }, + "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. + "links": [ # URL(s) pointing to additional information on handling the current error. + { # Describes a URL link. + "description": "A String", # Describes what the link offers. + "url": "A String", # The URL of the link. + }, + ], + }, + "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. + "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" + "message": "A String", # The localized error message in the above locale. + }, + "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "dimensions": { # The map holding related quota dimensions. + "a_key": "A String", + }, + "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric. + "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric. + "limitName": "A String", # The name of the quota limit. + "metricName": "A String", # The Compute Engine quota metric name. + "rolloutStatus": "A String", # Rollout status of the future quota limit. + }, }, ], - "supportedSla": "A String", + "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. + "message": "A String", # [Output Only] An optional, human-readable error message. }, - }, - "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "description": "A String", # An optional description of this resource. Provide this property when you create the resource. - "etag": "A String", # Opaque system-generated token that uniquely identifies the configuration. If provided when patching a configuration in update mode, the provided token must match the current token or the update is rejected. This provides a reliable means of doing read-modify-write (optimistic locking) as described by API 154. - "id": "A String", # [Output Only] The unique identifier for the resource type. The server generates this identifier. - "intent": { # The user's intent for this group. This is the only required field besides the name that must be specified on group creation. - "topologyCapability": "A String", - }, - "interconnects": { # Interconnects in the InterconnectGroup. Keys are arbitrary user-specified strings. Users are encouraged, but not required, to use their preferred format for resource links as keys. Note that there are add-members and remove-members methods in gcloud. The size of this map is limited by an "Interconnects per group" quota. - "a_key": { # An Interconnect in this InterconnectGroup. - "interconnect": "A String", # The URL of an Interconnect in this group. All Interconnects in the group are unique. + ], + }, + "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. + "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found. + "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "instancesBulkInsertOperationMetadata": { + "perLocationStatus": { # Status information per location (location name is key). Example key: zones/us-central1-a + "a_key": { + "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. + "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. + "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. + "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. }, }, - "kind": "compute#InterconnectGroup", # [Output Only] Type of the resource. Always compute#InterconnectGroup - "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. - "physicalStructure": { # [Output Only] An analysis of the physical layout of Interconnects in this group. Every Interconnect in the group is shown once in this structure. - "metros": [ - { # [Output Only] The metros Interconnects in this group are in. - "facilities": [ - { # [Output Only] The facilities Interconnects in this metro are present in. - "facility": "A String", # [Output Only] The ID of this facility, as a numeric string like "5467". This is the third component of the location of Interconnects in this facility. - "zones": [ - { # [Output Only] The zones that Interconnects in this facility are present in. - "interconnects": [ # [Output Only] URLs of Interconnects in this redundancy group in the given metro, facility, and zone. - "A String", - ], - "zone": "A String", # [Output Only] The name of the zone, either "zone1" or "zone2". This is the second component of the location of Interconnects in this facility. - }, - ], + }, + "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "name": "A String", # [Output Only] Name of the operation. + "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. + "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. + "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. + "selfLink": "A String", # [Output Only] Server-defined URL for the resource. + "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. + "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state. + "clientOperationId": "A String", # [Output Only] The client operation id. + "perLocationOperations": { # [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a + "a_key": { + "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). # [Output Only] If state is `ABANDONED` or `FAILED`, this field is populated. + "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. }, ], - "metro": "A String", # [Output Only] The name of the metro, as a three-letter lowercase string like "iad". This is the first component of the location of Interconnects underneath this. + "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. }, - ], + "state": "A String", # [Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. + }, }, - "selfLink": "A String", # [Output Only] Server-defined URL for the resource. }, + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. + "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the disk that the snapshot was created from. + "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. + "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. + { + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } + { + "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). + "value": "A String", # [Output Only] A warning data value corresponding to the key. + }, + ], + "message": "A String", # [Output Only] A human-readable description of the warning code. + }, + ], + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. }
diff --git a/docs/dyn/compute_alpha.interconnectLocations.html b/docs/dyn/compute_alpha.interconnectLocations.html index 15af85ebff2..0f30b6e59e9 100644 --- a/docs/dyn/compute_alpha.interconnectLocations.html +++ b/docs/dyn/compute_alpha.interconnectLocations.html @@ -122,9 +122,9 @@

Method Details

"city": "A String", # [Output Only] Metropolitan area designator that indicates which city an interconnect is located. For example: "Chicago, IL", "Amsterdam, Netherlands". "continent": "A String", # [Output Only] Continent for this location, which can take one of the following values: - AFRICA - ASIA_PAC - EUROPE - NORTH_AMERICA - SOUTH_AMERICA "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "crossSiteInterconnectInfos": [ # [Output Only] A list of InterconnectLocation.CrossSiteInterconnectInfo objects, that describe parameters pertaining to the relation between this InterconnectLocation and various Interconnect metros. - { # Information about any potential WireGroups between an Interconnect at a specific InterconnectLocation, and an Interconnect in another metro. - "city": "A String", # Metropolitan area designator + "crossSiteInterconnectInfos": [ # [Output Only] A list of InterconnectLocation.CrossSiteInterconnectInfo objects, that describe where Cross-Site Interconnect wires may connect to from this location and associated connection parameters. Cross-Site Interconnect isn't allowed to locations which are not listed. + { # Information about Cross-Site Interconnect wires which may be created between the containing location and another remote location. + "city": "A String", # The remote location for Cross-Site Interconnect wires. This specifies an InterconnectLocation city (metropolitan area designator), which itself may match multiple InterconnectLocations. "maxSingleFlowGbps": 42, # The maximum gbps for a single flow to this metro. This limits the total bandwidth which may be configured per wire. }, ], @@ -183,9 +183,9 @@

Method Details

"city": "A String", # [Output Only] Metropolitan area designator that indicates which city an interconnect is located. For example: "Chicago, IL", "Amsterdam, Netherlands". "continent": "A String", # [Output Only] Continent for this location, which can take one of the following values: - AFRICA - ASIA_PAC - EUROPE - NORTH_AMERICA - SOUTH_AMERICA "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "crossSiteInterconnectInfos": [ # [Output Only] A list of InterconnectLocation.CrossSiteInterconnectInfo objects, that describe parameters pertaining to the relation between this InterconnectLocation and various Interconnect metros. - { # Information about any potential WireGroups between an Interconnect at a specific InterconnectLocation, and an Interconnect in another metro. - "city": "A String", # Metropolitan area designator + "crossSiteInterconnectInfos": [ # [Output Only] A list of InterconnectLocation.CrossSiteInterconnectInfo objects, that describe where Cross-Site Interconnect wires may connect to from this location and associated connection parameters. Cross-Site Interconnect isn't allowed to locations which are not listed. + { # Information about Cross-Site Interconnect wires which may be created between the containing location and another remote location. + "city": "A String", # The remote location for Cross-Site Interconnect wires. This specifies an InterconnectLocation city (metropolitan area designator), which itself may match multiple InterconnectLocations. "maxSingleFlowGbps": 42, # The maximum gbps for a single flow to this metro. This limits the total bandwidth which may be configured per wire. }, ], diff --git a/docs/dyn/compute_alpha.networkEndpointGroups.html b/docs/dyn/compute_alpha.networkEndpointGroups.html index c8edc4aa549..786d33da5b1 100644 --- a/docs/dyn/compute_alpha.networkEndpointGroups.html +++ b/docs/dyn/compute_alpha.networkEndpointGroups.html @@ -262,7 +262,6 @@

Method Details

"ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. "ipv6Address": "A String", # Optional IPv6 address of network endpoint. "port": 42, # Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. This field can not be set for network endpoints of type GCE_VM_IP. - "zone": "A String", # The name of the zone where the instance hosting the network endpoint is located (valid only for regional GCE_VM_IP_PORT NEGs). It should comply with RFC1035. The zone must belong to the region of the Network Endpoint Group. }, ], } @@ -539,7 +538,6 @@

Method Details

"ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. "ipv6Address": "A String", # Optional IPv6 address of network endpoint. "port": 42, # Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. This field can not be set for network endpoints of type GCE_VM_IP. - "zone": "A String", # The name of the zone where the instance hosting the network endpoint is located (valid only for regional GCE_VM_IP_PORT NEGs). It should comply with RFC1035. The zone must belong to the region of the Network Endpoint Group. }, ], } @@ -1032,7 +1030,6 @@

Method Details

"ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. "ipv6Address": "A String", # Optional IPv6 address of network endpoint. "port": 42, # Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. This field can not be set for network endpoints of type GCE_VM_IP. - "zone": "A String", # The name of the zone where the instance hosting the network endpoint is located (valid only for regional GCE_VM_IP_PORT NEGs). It should comply with RFC1035. The zone must belong to the region of the Network Endpoint Group. }, }, ], @@ -1084,7 +1081,6 @@

Method Details

"ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. "ipv6Address": "A String", # Optional IPv6 address of network endpoint. "port": 42, # Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. This field can not be set for network endpoints of type GCE_VM_IP. - "zone": "A String", # The name of the zone where the instance hosting the network endpoint is located (valid only for regional GCE_VM_IP_PORT NEGs). It should comply with RFC1035. The zone must belong to the region of the Network Endpoint Group. }, }, ], diff --git a/docs/dyn/compute_alpha.regionBackendServices.html b/docs/dyn/compute_alpha.regionBackendServices.html index dcc73808c6b..226bcf13fc4 100644 --- a/docs/dyn/compute_alpha.regionBackendServices.html +++ b/docs/dyn/compute_alpha.regionBackendServices.html @@ -277,7 +277,7 @@

Method Details

{ # Custom Metrics are used for CUSTOM_METRICS balancing_mode. "dryRun": True or False, # If true, the metric data is collected and reported to Cloud Monitoring, but is not used for load balancing. "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is [0.0, 1.0]. - "name": "A String", # Name of a custom utilization signal. The name must be 1-24 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. + "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. }, ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. @@ -371,7 +371,7 @@

Method Details

"customMetrics": [ # List of custom metrics that are used for the WEIGHTED_ROUND_ROBIN locality_lb_policy. { # Custom Metrics are used for WEIGHTED_ROUND_ROBIN locality_lb_policy. "dryRun": True or False, # If true, the metric data is not used for load balancing. - "name": "A String", # Name of a custom utilization signal. The name must be 1-24 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. + "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. }, ], "customRequestHeaders": [ # Headers that the load balancer adds to proxied requests. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers). @@ -867,7 +867,7 @@

Method Details

{ # Custom Metrics are used for CUSTOM_METRICS balancing_mode. "dryRun": True or False, # If true, the metric data is collected and reported to Cloud Monitoring, but is not used for load balancing. "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is [0.0, 1.0]. - "name": "A String", # Name of a custom utilization signal. The name must be 1-24 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. + "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. }, ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. @@ -961,7 +961,7 @@

Method Details

"customMetrics": [ # List of custom metrics that are used for the WEIGHTED_ROUND_ROBIN locality_lb_policy. { # Custom Metrics are used for WEIGHTED_ROUND_ROBIN locality_lb_policy. "dryRun": True or False, # If true, the metric data is not used for load balancing. - "name": "A String", # Name of a custom utilization signal. The name must be 1-24 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. + "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. }, ], "customRequestHeaders": [ # Headers that the load balancer adds to proxied requests. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers). @@ -1489,7 +1489,7 @@

Method Details

{ # Custom Metrics are used for CUSTOM_METRICS balancing_mode. "dryRun": True or False, # If true, the metric data is collected and reported to Cloud Monitoring, but is not used for load balancing. "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is [0.0, 1.0]. - "name": "A String", # Name of a custom utilization signal. The name must be 1-24 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. + "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. }, ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. @@ -1583,7 +1583,7 @@

Method Details

"customMetrics": [ # List of custom metrics that are used for the WEIGHTED_ROUND_ROBIN locality_lb_policy. { # Custom Metrics are used for WEIGHTED_ROUND_ROBIN locality_lb_policy. "dryRun": True or False, # If true, the metric data is not used for load balancing. - "name": "A String", # Name of a custom utilization signal. The name must be 1-24 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. + "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. }, ], "customRequestHeaders": [ # Headers that the load balancer adds to proxied requests. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers). @@ -2009,7 +2009,7 @@

Method Details

{ # Custom Metrics are used for CUSTOM_METRICS balancing_mode. "dryRun": True or False, # If true, the metric data is collected and reported to Cloud Monitoring, but is not used for load balancing. "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is [0.0, 1.0]. - "name": "A String", # Name of a custom utilization signal. The name must be 1-24 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. + "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. }, ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. @@ -2103,7 +2103,7 @@

Method Details

"customMetrics": [ # List of custom metrics that are used for the WEIGHTED_ROUND_ROBIN locality_lb_policy. { # Custom Metrics are used for WEIGHTED_ROUND_ROBIN locality_lb_policy. "dryRun": True or False, # If true, the metric data is not used for load balancing. - "name": "A String", # Name of a custom utilization signal. The name must be 1-24 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. + "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. }, ], "customRequestHeaders": [ # Headers that the load balancer adds to proxied requests. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers). @@ -2545,7 +2545,7 @@

Method Details

{ # Custom Metrics are used for CUSTOM_METRICS balancing_mode. "dryRun": True or False, # If true, the metric data is collected and reported to Cloud Monitoring, but is not used for load balancing. "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is [0.0, 1.0]. - "name": "A String", # Name of a custom utilization signal. The name must be 1-24 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. + "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. }, ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. @@ -2639,7 +2639,7 @@

Method Details

"customMetrics": [ # List of custom metrics that are used for the WEIGHTED_ROUND_ROBIN locality_lb_policy. { # Custom Metrics are used for WEIGHTED_ROUND_ROBIN locality_lb_policy. "dryRun": True or False, # If true, the metric data is not used for load balancing. - "name": "A String", # Name of a custom utilization signal. The name must be 1-24 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. + "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. }, ], "customRequestHeaders": [ # Headers that the load balancer adds to proxied requests. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers). @@ -3421,7 +3421,7 @@

Method Details

{ # Custom Metrics are used for CUSTOM_METRICS balancing_mode. "dryRun": True or False, # If true, the metric data is collected and reported to Cloud Monitoring, but is not used for load balancing. "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is [0.0, 1.0]. - "name": "A String", # Name of a custom utilization signal. The name must be 1-24 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. + "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. }, ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. @@ -3515,7 +3515,7 @@

Method Details

"customMetrics": [ # List of custom metrics that are used for the WEIGHTED_ROUND_ROBIN locality_lb_policy. { # Custom Metrics are used for WEIGHTED_ROUND_ROBIN locality_lb_policy. "dryRun": True or False, # If true, the metric data is not used for load balancing. - "name": "A String", # Name of a custom utilization signal. The name must be 1-24 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. + "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. }, ], "customRequestHeaders": [ # Headers that the load balancer adds to proxied requests. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers). diff --git a/docs/dyn/compute_alpha.regionCommitments.html b/docs/dyn/compute_alpha.regionCommitments.html index 33259eb9d7b..a5fe29950cf 100644 --- a/docs/dyn/compute_alpha.regionCommitments.html +++ b/docs/dyn/compute_alpha.regionCommitments.html @@ -201,6 +201,11 @@

Method Details

"a_key": "A String", }, "resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. + "aggregateAllocation": { # Contains Properties set for the aggregate reservation. # Properties of this aggregatereservation. + "utilizations": { # Per service utilization breakdown. The Key is the Google Cloud managed service name. + "a_key": "A String", + }, + }, "reservationBlockCount": 42, # The number of reservation blocks associated with this reservation. "reservationMaintenance": { # Maintenance Info for ReservationBlocks. # Maintenance information for this reservation "maintenanceOngoingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have ongoing maintenance. @@ -697,6 +702,11 @@

Method Details

"a_key": "A String", }, "resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. + "aggregateAllocation": { # Contains Properties set for the aggregate reservation. # Properties of this aggregatereservation. + "utilizations": { # Per service utilization breakdown. The Key is the Google Cloud managed service name. + "a_key": "A String", + }, + }, "reservationBlockCount": 42, # The number of reservation blocks associated with this reservation. "reservationMaintenance": { # Maintenance Info for ReservationBlocks. # Maintenance information for this reservation "maintenanceOngoingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have ongoing maintenance. @@ -886,6 +896,11 @@

Method Details

"a_key": "A String", }, "resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. + "aggregateAllocation": { # Contains Properties set for the aggregate reservation. # Properties of this aggregatereservation. + "utilizations": { # Per service utilization breakdown. The Key is the Google Cloud managed service name. + "a_key": "A String", + }, + }, "reservationBlockCount": 42, # The number of reservation blocks associated with this reservation. "reservationMaintenance": { # Maintenance Info for ReservationBlocks. # Maintenance information for this reservation "maintenanceOngoingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have ongoing maintenance. @@ -1205,6 +1220,11 @@

Method Details

"a_key": "A String", }, "resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. + "aggregateAllocation": { # Contains Properties set for the aggregate reservation. # Properties of this aggregatereservation. + "utilizations": { # Per service utilization breakdown. The Key is the Google Cloud managed service name. + "a_key": "A String", + }, + }, "reservationBlockCount": 42, # The number of reservation blocks associated with this reservation. "reservationMaintenance": { # Maintenance Info for ReservationBlocks. # Maintenance information for this reservation "maintenanceOngoingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have ongoing maintenance. @@ -1456,6 +1476,11 @@

Method Details

"a_key": "A String", }, "resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. + "aggregateAllocation": { # Contains Properties set for the aggregate reservation. # Properties of this aggregatereservation. + "utilizations": { # Per service utilization breakdown. The Key is the Google Cloud managed service name. + "a_key": "A String", + }, + }, "reservationBlockCount": 42, # The number of reservation blocks associated with this reservation. "reservationMaintenance": { # Maintenance Info for ReservationBlocks. # Maintenance information for this reservation "maintenanceOngoingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have ongoing maintenance. @@ -1743,6 +1768,11 @@

Method Details

"a_key": "A String", }, "resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. + "aggregateAllocation": { # Contains Properties set for the aggregate reservation. # Properties of this aggregatereservation. + "utilizations": { # Per service utilization breakdown. The Key is the Google Cloud managed service name. + "a_key": "A String", + }, + }, "reservationBlockCount": 42, # The number of reservation blocks associated with this reservation. "reservationMaintenance": { # Maintenance Info for ReservationBlocks. # Maintenance information for this reservation "maintenanceOngoingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have ongoing maintenance. diff --git a/docs/dyn/compute_alpha.regionDiskSettings.html b/docs/dyn/compute_alpha.regionDiskSettings.html index a102418e47c..ff1aaf739df 100644 --- a/docs/dyn/compute_alpha.regionDiskSettings.html +++ b/docs/dyn/compute_alpha.regionDiskSettings.html @@ -111,6 +111,7 @@

Method Details

"region": "A String", # Accessible region name }, }, + "policy": "A String", # Policy of which location is allowed to access snapshot. }, "defaultResourcePolicies": { # An optional parameter for storing the default resource policies that will be used for the Disks created in the given scope. The Key is a string type, provided by customers to uniquely identify the default Resource Policy entry. The Value is a Default ResourcePolicyDetails Object used to represent the detailed information of the Resource Policy entry. "a_key": { # This is the object for storing the detail information about the Resource Policy that will be set as default ones for the Disks that is using the DiskSettings. It contains: - one target Resource Policy referenced by its Fully-Qualified URL, - [output only] Disk Types that will be excluded from using this Resource Policy, - Other filtering support (e.g. Label filtering) for Default Resource Policy can be added here as well @@ -140,6 +141,7 @@

Method Details

"region": "A String", # Accessible region name }, }, + "policy": "A String", # Policy of which location is allowed to access snapshot. }, "defaultResourcePolicies": { # An optional parameter for storing the default resource policies that will be used for the Disks created in the given scope. The Key is a string type, provided by customers to uniquely identify the default Resource Policy entry. The Value is a Default ResourcePolicyDetails Object used to represent the detailed information of the Resource Policy entry. "a_key": { # This is the object for storing the detail information about the Resource Policy that will be set as default ones for the Disks that is using the DiskSettings. It contains: - one target Resource Policy referenced by its Fully-Qualified URL, - [output only] Disk Types that will be excluded from using this Resource Policy, - Other filtering support (e.g. Label filtering) for Default Resource Policy can be added here as well diff --git a/docs/dyn/compute_alpha.regionDisks.html b/docs/dyn/compute_alpha.regionDisks.html index a742ac52b06..0ca1bab0ce1 100644 --- a/docs/dyn/compute_alpha.regionDisks.html +++ b/docs/dyn/compute_alpha.regionDisks.html @@ -486,7 +486,7 @@

Method Details

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. }, - "sourceInstantSnapshotId": "A String", # [Output Only] The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this persistent disk. For example, if you created the persistent disk from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used. + "sourceInstantSnapshotId": "A String", # [Output Only] The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this snapshot. For example, if you created the snapshot from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used. "sourceSnapshotSchedulePolicy": "A String", # [Output Only] URL of the resource policy which created this scheduled snapshot. "sourceSnapshotSchedulePolicyId": "A String", # [Output Only] ID of the resource policy which created this scheduled snapshot. "status": "A String", # [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING. @@ -905,7 +905,7 @@

Method Details

{ "asyncReplicationStatus": { "diskPairReplicationState": { - "dataReplicationState": "A String", # [Output Only] The status of disk creation. - ASYNC_REPLICATION_STATE_INITIALIZING: The device is doing the initial replication after starting the replication. - ASYNC_REPLICATION_STATE_REPLICATING_HEALTHY: The primary disk is healthily replicating to the secondary device i.e. last_replication_time is within RPO. - ASYNC_REPLICATION_STATE_REPLICATING_BEHIND_HIGH_CHURN: The replication is lagging above the SLO limit due to some internal issue. - ASYNC_REPLICATION_STATE_REPLICATING_BEHIND_SYSTEM_LAGGING: The replication is lagging, and the RPO is not being met due to some internal issue. - ASYNC_REPLICATION_STATE_REPLICATION_STUCK: The replication is completely stuck due to some internal error. - ASYNC_REPLICATION_STATE_STOPPING: The replication is under the process of being stopped. This is a transient state. - ASYNC_REPLICATION_STATE_STOPPED: The replication between the disk-pairs have stopped. + "dataReplicationState": "A String", # [Output Only] The status of disk creation. - ASYNC_REPLICATION_STATE_INITIALIZING: The device is doing the initial replication after starting the replication. - ASYNC_REPLICATION_STATE_REPLICATING_HEALTHY: The primary disk is healthily replicating to the secondary device i.e. last_replication_time is within RPO. - ASYNC_REPLICATION_STATE_REPLICATING_BEHIND_HIGH_CHURN: The replication is lagging above the SLO limit due to the disk's change rate being above the supported limit. - ASYNC_REPLICATION_STATE_REPLICATING_BEHIND_SYSTEM_LAGGING: The replication is lagging, and the RPO is not being met due to some internal issue. - ASYNC_REPLICATION_STATE_REPLICATION_STUCK: The replication is completely stuck due to some internal error. - ASYNC_REPLICATION_STATE_STOPPING: The replication is under the process of being stopped. This is a transient state. - ASYNC_REPLICATION_STATE_STOPPED: The replication between the disk-pairs have stopped. - ASYNC_REPLICATION_STATE_REPLICATING_BEHIND_CG_HIGH_CHURN: The replication is lagging above the SLO limit for the disk in the consistency group due to disk's change rate being above the supported limit. "replicationDiskPair": { "primaryDisk": "A String", # URL of the primary disk. "secondaryDisk": "A String", # URL of the secondary disk. diff --git a/docs/dyn/compute_alpha.regionHealthSources.html b/docs/dyn/compute_alpha.regionHealthSources.html new file mode 100644 index 00000000000..d797ad60858 --- /dev/null +++ b/docs/dyn/compute_alpha.regionHealthSources.html @@ -0,0 +1,759 @@ + + + +

Compute Engine API . regionHealthSources

+

Instance Methods

+

+ aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)

+

Retrieves the list of all HealthSource resources (all regional) available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.

+

+ aggregatedList_next()

+

Retrieves the next page of results.

+

+ close()

+

Close httplib2 connections.

+

+ delete(project, region, healthSource, requestId=None, x__xgafv=None)

+

Deletes the specified HealthSource in the given region

+

+ get(project, region, healthSource, x__xgafv=None)

+

Returns the specified HealthSource resource in the given region.

+

+ insert(project, region, body=None, requestId=None, x__xgafv=None)

+

Create a HealthSource in the specified project in the given region using the parameters that are included in the request.

+

+ list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists the HealthSources for a project in the given region.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(project, region, healthSource, body=None, requestId=None, x__xgafv=None)

+

Updates the specified regional HealthSource resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

+

+ testIamPermissions(project, region, resource, body=None, x__xgafv=None)

+

Returns permissions that a caller has on the specified resource.

+

Method Details

+
+ aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None) +
Retrieves the list of all HealthSource resources (all regional) available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
+
+Args:
+  project: string, Name of the project scoping this request. (required)
+  filter: string, A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
+  includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
+  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
+  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
+  pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
+  returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.
+  serviceProjectNumber: string, The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Contains a list of HealthSourcesScopedList.
+  "etag": "A String",
+  "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+  "items": { # A list of HealthSourcesScopedList resources.
+    "a_key": { # Name of the scope containing this set of HealthSources.
+      "resources": [ # A list of HealthSources contained in this scope.
+        { # Represents a health source. A health source resource specifies the source resources and the health aggregation policy applied to the source resources to determine the aggregated health status.
+          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+          "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a HealthSource. An up-to-date fingerprint must be provided in order to patch the HealthSource; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the HealthSource.
+          "healthAggregationPolicy": "A String", # URL to the HealthAggregationPolicy resource. Must be set. Must be regional and in the same region as the HealthSource. Can be mutated.
+          "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
+          "kind": "compute#healthSource", # [Output Only] Type of the resource. Always compute#healthSource for health sources.
+          "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+          "region": "A String", # [Output Only] URL of the region where the health source resides. This field applies only to the regional resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+          "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+          "selfLinkWithId": "A String", # [Output Only] Server-defined URL with id for the resource.
+          "sourceType": "A String", # Specifies the type of the HealthSource. The only allowed value is BACKEND_SERVICE. Must be specified when the HealthSource is created, and cannot be mutated.
+          "sources": [ # URLs to the source resources. Must be size 1. Must be a BackendService if the sourceType is BACKEND_SERVICE. The BackendService must have load balancing scheme INTERNAL or INTERNAL_MANAGED and must be regional and in the same region as the HealthSource (cross-region deployment for INTERNAL_MANAGED is not supported). The BackendService may use only IGs, MIGs, or NEGs of type GCE_VM_IP or GCE_VM_IP_PORT. The BackendService may not use haPolicy. Can be mutated.
+            "A String",
+          ],
+        },
+      ],
+      "warning": { # Informational warning which replaces the list of health sources when the list is empty.
+        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+        "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+          {
+            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+            "value": "A String", # [Output Only] A warning data value corresponding to the key.
+          },
+        ],
+        "message": "A String", # [Output Only] A human-readable description of the warning code.
+      },
+    },
+  },
+  "kind": "compute#healthSourceAggregatedList", # Type of resource.
+  "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+  "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+  "unreachables": [ # [Output Only] Unreachable resources.
+    "A String",
+  ],
+  "warning": { # [Output Only] Informational warning message.
+    "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+    "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+      {
+        "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+        "value": "A String", # [Output Only] A warning data value corresponding to the key.
+      },
+    ],
+    "message": "A String", # [Output Only] A human-readable description of the warning code.
+  },
+}
+
+ +
+ aggregatedList_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.
+        
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ delete(project, region, healthSource, requestId=None, x__xgafv=None) +
Deletes the specified HealthSource in the given region
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region scoping this request. (required)
+  healthSource: string, Name of the HealthSource resource to delete. (required)
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
+  "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "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). # [Output Only] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "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.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the disk that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
+}
+
+ +
+ get(project, region, healthSource, x__xgafv=None) +
Returns the specified HealthSource resource in the given region.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region scoping this request. (required)
+  healthSource: string, Name of the HealthSource resource to return. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a health source. A health source resource specifies the source resources and the health aggregation policy applied to the source resources to determine the aggregated health status.
+  "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+  "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+  "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a HealthSource. An up-to-date fingerprint must be provided in order to patch the HealthSource; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the HealthSource.
+  "healthAggregationPolicy": "A String", # URL to the HealthAggregationPolicy resource. Must be set. Must be regional and in the same region as the HealthSource. Can be mutated.
+  "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
+  "kind": "compute#healthSource", # [Output Only] Type of the resource. Always compute#healthSource for health sources.
+  "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+  "region": "A String", # [Output Only] URL of the region where the health source resides. This field applies only to the regional resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # [Output Only] Server-defined URL with id for the resource.
+  "sourceType": "A String", # Specifies the type of the HealthSource. The only allowed value is BACKEND_SERVICE. Must be specified when the HealthSource is created, and cannot be mutated.
+  "sources": [ # URLs to the source resources. Must be size 1. Must be a BackendService if the sourceType is BACKEND_SERVICE. The BackendService must have load balancing scheme INTERNAL or INTERNAL_MANAGED and must be regional and in the same region as the HealthSource (cross-region deployment for INTERNAL_MANAGED is not supported). The BackendService may use only IGs, MIGs, or NEGs of type GCE_VM_IP or GCE_VM_IP_PORT. The BackendService may not use haPolicy. Can be mutated.
+    "A String",
+  ],
+}
+
+ +
+ insert(project, region, body=None, requestId=None, x__xgafv=None) +
Create a HealthSource in the specified project in the given region using the parameters that are included in the request.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region scoping this request. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a health source. A health source resource specifies the source resources and the health aggregation policy applied to the source resources to determine the aggregated health status.
+  "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+  "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+  "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a HealthSource. An up-to-date fingerprint must be provided in order to patch the HealthSource; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the HealthSource.
+  "healthAggregationPolicy": "A String", # URL to the HealthAggregationPolicy resource. Must be set. Must be regional and in the same region as the HealthSource. Can be mutated.
+  "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
+  "kind": "compute#healthSource", # [Output Only] Type of the resource. Always compute#healthSource for health sources.
+  "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+  "region": "A String", # [Output Only] URL of the region where the health source resides. This field applies only to the regional resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # [Output Only] Server-defined URL with id for the resource.
+  "sourceType": "A String", # Specifies the type of the HealthSource. The only allowed value is BACKEND_SERVICE. Must be specified when the HealthSource is created, and cannot be mutated.
+  "sources": [ # URLs to the source resources. Must be size 1. Must be a BackendService if the sourceType is BACKEND_SERVICE. The BackendService must have load balancing scheme INTERNAL or INTERNAL_MANAGED and must be regional and in the same region as the HealthSource (cross-region deployment for INTERNAL_MANAGED is not supported). The BackendService may use only IGs, MIGs, or NEGs of type GCE_VM_IP or GCE_VM_IP_PORT. The BackendService may not use haPolicy. Can be mutated.
+    "A String",
+  ],
+}
+
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
+  "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "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). # [Output Only] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "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.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the disk that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
+}
+
+ +
+ list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) +
Lists the HealthSources for a project in the given region.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region scoping this request. (required)
+  filter: string, A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
+  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
+  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
+  pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
+  returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "etag": "A String",
+  "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+  "items": [ # A list of HealthSource resources.
+    { # Represents a health source. A health source resource specifies the source resources and the health aggregation policy applied to the source resources to determine the aggregated health status.
+      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+      "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a HealthSource. An up-to-date fingerprint must be provided in order to patch the HealthSource; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the HealthSource.
+      "healthAggregationPolicy": "A String", # URL to the HealthAggregationPolicy resource. Must be set. Must be regional and in the same region as the HealthSource. Can be mutated.
+      "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
+      "kind": "compute#healthSource", # [Output Only] Type of the resource. Always compute#healthSource for health sources.
+      "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+      "region": "A String", # [Output Only] URL of the region where the health source resides. This field applies only to the regional resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+      "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+      "selfLinkWithId": "A String", # [Output Only] Server-defined URL with id for the resource.
+      "sourceType": "A String", # Specifies the type of the HealthSource. The only allowed value is BACKEND_SERVICE. Must be specified when the HealthSource is created, and cannot be mutated.
+      "sources": [ # URLs to the source resources. Must be size 1. Must be a BackendService if the sourceType is BACKEND_SERVICE. The BackendService must have load balancing scheme INTERNAL or INTERNAL_MANAGED and must be regional and in the same region as the HealthSource (cross-region deployment for INTERNAL_MANAGED is not supported). The BackendService may use only IGs, MIGs, or NEGs of type GCE_VM_IP or GCE_VM_IP_PORT. The BackendService may not use haPolicy. Can be mutated.
+        "A String",
+      ],
+    },
+  ],
+  "kind": "compute#healthSourceList", # [Output Only] Type of the resource. Always compute#healthSource for health sources.
+  "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+  "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+  "unreachables": [ # [Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder
+    "A String",
+  ],
+  "warning": { # [Output Only] Informational warning message.
+    "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+    "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+      {
+        "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+        "value": "A String", # [Output Only] A warning data value corresponding to the key.
+      },
+    ],
+    "message": "A String", # [Output Only] A human-readable description of the warning code.
+  },
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(project, region, healthSource, body=None, requestId=None, x__xgafv=None) +
Updates the specified regional HealthSource resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region scoping this request. (required)
+  healthSource: string, Name of the HealthSource to update. The name must be 1-63 characters long, and comply with RFC1035. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a health source. A health source resource specifies the source resources and the health aggregation policy applied to the source resources to determine the aggregated health status.
+  "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+  "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+  "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a HealthSource. An up-to-date fingerprint must be provided in order to patch the HealthSource; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the HealthSource.
+  "healthAggregationPolicy": "A String", # URL to the HealthAggregationPolicy resource. Must be set. Must be regional and in the same region as the HealthSource. Can be mutated.
+  "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
+  "kind": "compute#healthSource", # [Output Only] Type of the resource. Always compute#healthSource for health sources.
+  "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+  "region": "A String", # [Output Only] URL of the region where the health source resides. This field applies only to the regional resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # [Output Only] Server-defined URL with id for the resource.
+  "sourceType": "A String", # Specifies the type of the HealthSource. The only allowed value is BACKEND_SERVICE. Must be specified when the HealthSource is created, and cannot be mutated.
+  "sources": [ # URLs to the source resources. Must be size 1. Must be a BackendService if the sourceType is BACKEND_SERVICE. The BackendService must have load balancing scheme INTERNAL or INTERNAL_MANAGED and must be regional and in the same region as the HealthSource (cross-region deployment for INTERNAL_MANAGED is not supported). The BackendService may use only IGs, MIGs, or NEGs of type GCE_VM_IP or GCE_VM_IP_PORT. The BackendService may not use haPolicy. Can be mutated.
+    "A String",
+  ],
+}
+
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
+  "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "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). # [Output Only] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "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.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the disk that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
+}
+
+ +
+ testIamPermissions(project, region, resource, body=None, x__xgafv=None) +
Returns permissions that a caller has on the specified resource.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, The name of the region for this request. (required)
+  resource: string, Name or id of the resource for this request. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{
+  "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+    "A String",
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+    "A String",
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/compute_alpha.regionMultiMigMembers.html b/docs/dyn/compute_alpha.regionMultiMigMembers.html new file mode 100644 index 00000000000..7a5272f4318 --- /dev/null +++ b/docs/dyn/compute_alpha.regionMultiMigMembers.html @@ -0,0 +1,195 @@ + + + +

Compute Engine API . regionMultiMigMembers

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(project, region, multiMig, multiMigMember, x__xgafv=None)

+

Retrieves information about the specified multi-MIG member.

+

+ list(project, region, multiMig, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Retrieves a list of members of a specific multi-MIG.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(project, region, multiMig, multiMigMember, x__xgafv=None) +
Retrieves information about the specified multi-MIG member.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region for this request. Region name should conform to RFC1035. (required)
+  multiMig: string, The name of the multi-MIG. Name should conform to RFC1035 or be a resource ID. (required)
+  multiMigMember: string, The name of the multi-MIG member. Name should conform to RFC1035 or be a resource ID. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a Multi-MIG member resource.
+  "creationTimestamp": "A String", # [Output Only] Creation timestamp of this multi-MIG member in RFC3339 text format.
+  "description": "A String", # An optional description of this resource.
+  "id": "A String", # [Output only] The unique identifier for this resource type. The server generates this identifier.
+  "kind": "compute#multiMigMember", # Type of the resource. Always compute#multiMigMember for a list of multi-MIG members.
+  "name": "A String", # [Output Only] The name of this multi-MIG member generated by Google Compute Engine.
+  "region": "A String", # [Output Only] The URL of the region where the multi-MIG resides.
+  "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
+  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
+  "status": { # [Output Only] The status of this multi-MIG member
+    "instanceGroupManager": "A String", # [Output Only] URL of member instance group manager
+  },
+}
+
+ +
+ list(project, region, multiMig, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) +
Retrieves a list of members of a specific multi-MIG.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region for this request. Region name should conform to RFC1035. (required)
+  multiMig: string, The name of the multi-MIG. Name should conform to RFC1035 or be a resource ID. (required)
+  filter: string, A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
+  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
+  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
+  pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
+  returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "id": "A String", # Unique identifier for the resource; defined by the server.
+  "items": [ # A list of multi-MIG member resources.
+    { # Represents a Multi-MIG member resource.
+      "creationTimestamp": "A String", # [Output Only] Creation timestamp of this multi-MIG member in RFC3339 text format.
+      "description": "A String", # An optional description of this resource.
+      "id": "A String", # [Output only] The unique identifier for this resource type. The server generates this identifier.
+      "kind": "compute#multiMigMember", # Type of the resource. Always compute#multiMigMember for a list of multi-MIG members.
+      "name": "A String", # [Output Only] The name of this multi-MIG member generated by Google Compute Engine.
+      "region": "A String", # [Output Only] The URL of the region where the multi-MIG resides.
+      "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
+      "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
+      "status": { # [Output Only] The status of this multi-MIG member
+        "instanceGroupManager": "A String", # [Output Only] URL of member instance group manager
+      },
+    },
+  ],
+  "kind": "compute#multiMigMemberList", # Type of the resource. Always compute#multiMigMember for a list of multi-MIG members.
+  "nextPageToken": "A String", # This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+  "selfLink": "A String", # [Output only] Server-defined URL for this resource.
+  "warning": { # Informational warning message.
+    "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+    "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+      {
+        "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+        "value": "A String", # [Output Only] A warning data value corresponding to the key.
+      },
+    ],
+    "message": "A String", # [Output Only] A human-readable description of the warning code.
+  },
+}
+
+ +
+ 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/compute_alpha.regionNetworkEndpointGroups.html b/docs/dyn/compute_alpha.regionNetworkEndpointGroups.html index edb70d73cfc..8e27ea62cb6 100644 --- a/docs/dyn/compute_alpha.regionNetworkEndpointGroups.html +++ b/docs/dyn/compute_alpha.regionNetworkEndpointGroups.html @@ -128,7 +128,6 @@

Method Details

"ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. "ipv6Address": "A String", # Optional IPv6 address of network endpoint. "port": 42, # Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. This field can not be set for network endpoints of type GCE_VM_IP. - "zone": "A String", # The name of the zone where the instance hosting the network endpoint is located (valid only for regional GCE_VM_IP_PORT NEGs). It should comply with RFC1035. The zone must belong to the region of the Network Endpoint Group. }, ], } @@ -405,7 +404,6 @@

Method Details

"ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. "ipv6Address": "A String", # Optional IPv6 address of network endpoint. "port": 42, # Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. This field can not be set for network endpoints of type GCE_VM_IP. - "zone": "A String", # The name of the zone where the instance hosting the network endpoint is located (valid only for regional GCE_VM_IP_PORT NEGs). It should comply with RFC1035. The zone must belong to the region of the Network Endpoint Group. }, ], } @@ -927,7 +925,6 @@

Method Details

"ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. "ipv6Address": "A String", # Optional IPv6 address of network endpoint. "port": 42, # Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. This field can not be set for network endpoints of type GCE_VM_IP. - "zone": "A String", # The name of the zone where the instance hosting the network endpoint is located (valid only for regional GCE_VM_IP_PORT NEGs). It should comply with RFC1035. The zone must belong to the region of the Network Endpoint Group. }, }, ], diff --git a/docs/dyn/compute_alpha.regionSnapshots.html b/docs/dyn/compute_alpha.regionSnapshots.html index e421d7b88a6..32704b7f778 100644 --- a/docs/dyn/compute_alpha.regionSnapshots.html +++ b/docs/dyn/compute_alpha.regionSnapshots.html @@ -317,7 +317,7 @@

Method Details

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. }, - "sourceInstantSnapshotId": "A String", # [Output Only] The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this persistent disk. For example, if you created the persistent disk from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used. + "sourceInstantSnapshotId": "A String", # [Output Only] The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this snapshot. For example, if you created the snapshot from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used. "sourceSnapshotSchedulePolicy": "A String", # [Output Only] URL of the resource policy which created this scheduled snapshot. "sourceSnapshotSchedulePolicyId": "A String", # [Output Only] ID of the resource policy which created this scheduled snapshot. "status": "A String", # [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING. @@ -457,7 +457,7 @@

Method Details

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. }, - "sourceInstantSnapshotId": "A String", # [Output Only] The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this persistent disk. For example, if you created the persistent disk from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used. + "sourceInstantSnapshotId": "A String", # [Output Only] The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this snapshot. For example, if you created the snapshot from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used. "sourceSnapshotSchedulePolicy": "A String", # [Output Only] URL of the resource policy which created this scheduled snapshot. "sourceSnapshotSchedulePolicyId": "A String", # [Output Only] ID of the resource policy which created this scheduled snapshot. "status": "A String", # [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING. @@ -677,7 +677,7 @@

Method Details

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. }, - "sourceInstantSnapshotId": "A String", # [Output Only] The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this persistent disk. For example, if you created the persistent disk from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used. + "sourceInstantSnapshotId": "A String", # [Output Only] The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this snapshot. For example, if you created the snapshot from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used. "sourceSnapshotSchedulePolicy": "A String", # [Output Only] URL of the resource policy which created this scheduled snapshot. "sourceSnapshotSchedulePolicyId": "A String", # [Output Only] ID of the resource policy which created this scheduled snapshot. "status": "A String", # [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING. diff --git a/docs/dyn/compute_alpha.regionUrlMaps.html b/docs/dyn/compute_alpha.regionUrlMaps.html index c7d79de8b16..53f78d07b90 100644 --- a/docs/dyn/compute_alpha.regionUrlMaps.html +++ b/docs/dyn/compute_alpha.regionUrlMaps.html @@ -1644,7 +1644,7 @@

Method Details

The object takes the form of: { - "cacheTags": [ # Not implemented. + "cacheTags": [ # A list of cache tags used to identify cached objects. - Cache tags are specified when the response is first cached, by setting the `Cache-Tag` response header at the origin. - Multiple cache tags in the same invalidation request are treated as Boolean `OR` - for example, `tag1 OR tag2 OR tag3`. - If other fields are also specified, these are treated as Boolean `AND` with any tags. Up to 10 tags can be specified in a single invalidation request. "A String", ], "host": "A String", # If set, this invalidation rule will only apply to requests with a Host header matching host. diff --git a/docs/dyn/compute_alpha.reservations.html b/docs/dyn/compute_alpha.reservations.html index a7a1b393f85..48c35fdc094 100644 --- a/docs/dyn/compute_alpha.reservations.html +++ b/docs/dyn/compute_alpha.reservations.html @@ -183,6 +183,11 @@

Method Details

"a_key": "A String", }, "resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. + "aggregateAllocation": { # Contains Properties set for the aggregate reservation. # Properties of this aggregatereservation. + "utilizations": { # Per service utilization breakdown. The Key is the Google Cloud managed service name. + "a_key": "A String", + }, + }, "reservationBlockCount": 42, # The number of reservation blocks associated with this reservation. "reservationMaintenance": { # Maintenance Info for ReservationBlocks. # Maintenance information for this reservation "maintenanceOngoingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have ongoing maintenance. @@ -491,6 +496,11 @@

Method Details

"a_key": "A String", }, "resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. + "aggregateAllocation": { # Contains Properties set for the aggregate reservation. # Properties of this aggregatereservation. + "utilizations": { # Per service utilization breakdown. The Key is the Google Cloud managed service name. + "a_key": "A String", + }, + }, "reservationBlockCount": 42, # The number of reservation blocks associated with this reservation. "reservationMaintenance": { # Maintenance Info for ReservationBlocks. # Maintenance information for this reservation "maintenanceOngoingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have ongoing maintenance. @@ -668,6 +678,11 @@

Method Details

"a_key": "A String", }, "resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. + "aggregateAllocation": { # Contains Properties set for the aggregate reservation. # Properties of this aggregatereservation. + "utilizations": { # Per service utilization breakdown. The Key is the Google Cloud managed service name. + "a_key": "A String", + }, + }, "reservationBlockCount": 42, # The number of reservation blocks associated with this reservation. "reservationMaintenance": { # Maintenance Info for ReservationBlocks. # Maintenance information for this reservation "maintenanceOngoingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have ongoing maintenance. @@ -925,6 +940,11 @@

Method Details

"a_key": "A String", }, "resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. + "aggregateAllocation": { # Contains Properties set for the aggregate reservation. # Properties of this aggregatereservation. + "utilizations": { # Per service utilization breakdown. The Key is the Google Cloud managed service name. + "a_key": "A String", + }, + }, "reservationBlockCount": 42, # The number of reservation blocks associated with this reservation. "reservationMaintenance": { # Maintenance Info for ReservationBlocks. # Maintenance information for this reservation "maintenanceOngoingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have ongoing maintenance. @@ -1481,6 +1501,11 @@

Method Details

"a_key": "A String", }, "resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. + "aggregateAllocation": { # Contains Properties set for the aggregate reservation. # Properties of this aggregatereservation. + "utilizations": { # Per service utilization breakdown. The Key is the Google Cloud managed service name. + "a_key": "A String", + }, + }, "reservationBlockCount": 42, # The number of reservation blocks associated with this reservation. "reservationMaintenance": { # Maintenance Info for ReservationBlocks. # Maintenance information for this reservation "maintenanceOngoingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have ongoing maintenance. diff --git a/docs/dyn/compute_alpha.routers.html b/docs/dyn/compute_alpha.routers.html index 327b2fbc430..e6136160cf2 100644 --- a/docs/dyn/compute_alpha.routers.html +++ b/docs/dyn/compute_alpha.routers.html @@ -238,10 +238,10 @@

Method Details

"enable": "A String", # The status of the BGP peer connection. If set to FALSE, any active session with the peer is terminated and all associated routing information is removed. If set to TRUE, the peer connection can be established with routing information. The default is TRUE. "enableIpv4": True or False, # Enable IPv4 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 4. "enableIpv6": True or False, # Enable IPv6 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 6. - "exportPolicies": [ # List of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies. + "exportPolicies": [ # List of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type. "A String", ], - "importPolicies": [ # List of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies. + "importPolicies": [ # List of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type. "A String", ], "interfaceName": "A String", # Name of the interface the BGP peer is associated with. @@ -852,10 +852,10 @@

Method Details

"enable": "A String", # The status of the BGP peer connection. If set to FALSE, any active session with the peer is terminated and all associated routing information is removed. If set to TRUE, the peer connection can be established with routing information. The default is TRUE. "enableIpv4": True or False, # Enable IPv4 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 4. "enableIpv6": True or False, # Enable IPv6 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 6. - "exportPolicies": [ # List of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies. + "exportPolicies": [ # List of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type. "A String", ], - "importPolicies": [ # List of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies. + "importPolicies": [ # List of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type. "A String", ], "interfaceName": "A String", # Name of the interface the BGP peer is associated with. @@ -1488,6 +1488,7 @@

Method Details

], }, ], + "nccGateway": "A String", # URI of the ncc_gateway to which this router associated. "network": "A String", # URI of the network to which this router belongs. }, } @@ -1550,10 +1551,10 @@

Method Details

"enable": "A String", # The status of the BGP peer connection. If set to FALSE, any active session with the peer is terminated and all associated routing information is removed. If set to TRUE, the peer connection can be established with routing information. The default is TRUE. "enableIpv4": True or False, # Enable IPv4 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 4. "enableIpv6": True or False, # Enable IPv6 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 6. - "exportPolicies": [ # List of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies. + "exportPolicies": [ # List of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type. "A String", ], - "importPolicies": [ # List of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies. + "importPolicies": [ # List of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type. "A String", ], "interfaceName": "A String", # Name of the interface the BGP peer is associated with. @@ -1859,10 +1860,10 @@

Method Details

"enable": "A String", # The status of the BGP peer connection. If set to FALSE, any active session with the peer is terminated and all associated routing information is removed. If set to TRUE, the peer connection can be established with routing information. The default is TRUE. "enableIpv4": True or False, # Enable IPv4 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 4. "enableIpv6": True or False, # Enable IPv6 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 6. - "exportPolicies": [ # List of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies. + "exportPolicies": [ # List of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type. "A String", ], - "importPolicies": [ # List of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies. + "importPolicies": [ # List of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type. "A String", ], "interfaceName": "A String", # Name of the interface the BGP peer is associated with. @@ -2315,10 +2316,10 @@

Method Details

"enable": "A String", # The status of the BGP peer connection. If set to FALSE, any active session with the peer is terminated and all associated routing information is removed. If set to TRUE, the peer connection can be established with routing information. The default is TRUE. "enableIpv4": True or False, # Enable IPv4 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 4. "enableIpv6": True or False, # Enable IPv6 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 6. - "exportPolicies": [ # List of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies. + "exportPolicies": [ # List of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type. "A String", ], - "importPolicies": [ # List of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies. + "importPolicies": [ # List of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type. "A String", ], "interfaceName": "A String", # Name of the interface the BGP peer is associated with. @@ -2910,10 +2911,10 @@

Method Details

"enable": "A String", # The status of the BGP peer connection. If set to FALSE, any active session with the peer is terminated and all associated routing information is removed. If set to TRUE, the peer connection can be established with routing information. The default is TRUE. "enableIpv4": True or False, # Enable IPv4 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 4. "enableIpv6": True or False, # Enable IPv6 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 6. - "exportPolicies": [ # List of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies. + "exportPolicies": [ # List of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type. "A String", ], - "importPolicies": [ # List of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies. + "importPolicies": [ # List of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type. "A String", ], "interfaceName": "A String", # Name of the interface the BGP peer is associated with. @@ -3087,10 +3088,10 @@

Method Details

"enable": "A String", # The status of the BGP peer connection. If set to FALSE, any active session with the peer is terminated and all associated routing information is removed. If set to TRUE, the peer connection can be established with routing information. The default is TRUE. "enableIpv4": True or False, # Enable IPv4 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 4. "enableIpv6": True or False, # Enable IPv6 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 6. - "exportPolicies": [ # List of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies. + "exportPolicies": [ # List of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type. "A String", ], - "importPolicies": [ # List of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies. + "importPolicies": [ # List of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type. "A String", ], "interfaceName": "A String", # Name of the interface the BGP peer is associated with. @@ -3300,10 +3301,10 @@

Method Details

"enable": "A String", # The status of the BGP peer connection. If set to FALSE, any active session with the peer is terminated and all associated routing information is removed. If set to TRUE, the peer connection can be established with routing information. The default is TRUE. "enableIpv4": True or False, # Enable IPv4 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 4. "enableIpv6": True or False, # Enable IPv6 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 6. - "exportPolicies": [ # List of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies. + "exportPolicies": [ # List of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type. "A String", ], - "importPolicies": [ # List of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies. + "importPolicies": [ # List of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type. "A String", ], "interfaceName": "A String", # Name of the interface the BGP peer is associated with. diff --git a/docs/dyn/compute_alpha.snapshots.html b/docs/dyn/compute_alpha.snapshots.html index f6cb6c07ba3..953a8c88348 100644 --- a/docs/dyn/compute_alpha.snapshots.html +++ b/docs/dyn/compute_alpha.snapshots.html @@ -203,7 +203,7 @@

Method Details

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. }, - "sourceInstantSnapshotId": "A String", # [Output Only] The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this persistent disk. For example, if you created the persistent disk from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used. + "sourceInstantSnapshotId": "A String", # [Output Only] The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this snapshot. For example, if you created the snapshot from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used. "sourceSnapshotSchedulePolicy": "A String", # [Output Only] URL of the resource policy which created this scheduled snapshot. "sourceSnapshotSchedulePolicyId": "A String", # [Output Only] ID of the resource policy which created this scheduled snapshot. "status": "A String", # [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING. @@ -472,7 +472,7 @@

Method Details

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. }, - "sourceInstantSnapshotId": "A String", # [Output Only] The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this persistent disk. For example, if you created the persistent disk from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used. + "sourceInstantSnapshotId": "A String", # [Output Only] The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this snapshot. For example, if you created the snapshot from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used. "sourceSnapshotSchedulePolicy": "A String", # [Output Only] URL of the resource policy which created this scheduled snapshot. "sourceSnapshotSchedulePolicyId": "A String", # [Output Only] ID of the resource policy which created this scheduled snapshot. "status": "A String", # [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING. @@ -610,7 +610,7 @@

Method Details

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. }, - "sourceInstantSnapshotId": "A String", # [Output Only] The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this persistent disk. For example, if you created the persistent disk from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used. + "sourceInstantSnapshotId": "A String", # [Output Only] The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this snapshot. For example, if you created the snapshot from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used. "sourceSnapshotSchedulePolicy": "A String", # [Output Only] URL of the resource policy which created this scheduled snapshot. "sourceSnapshotSchedulePolicyId": "A String", # [Output Only] ID of the resource policy which created this scheduled snapshot. "status": "A String", # [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING. @@ -829,7 +829,7 @@

Method Details

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. }, - "sourceInstantSnapshotId": "A String", # [Output Only] The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this persistent disk. For example, if you created the persistent disk from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used. + "sourceInstantSnapshotId": "A String", # [Output Only] The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this snapshot. For example, if you created the snapshot from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used. "sourceSnapshotSchedulePolicy": "A String", # [Output Only] URL of the resource policy which created this scheduled snapshot. "sourceSnapshotSchedulePolicyId": "A String", # [Output Only] ID of the resource policy which created this scheduled snapshot. "status": "A String", # [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING. diff --git a/docs/dyn/compute_alpha.subnetworks.html b/docs/dyn/compute_alpha.subnetworks.html index d08b2bef280..c922dc7bac1 100644 --- a/docs/dyn/compute_alpha.subnetworks.html +++ b/docs/dyn/compute_alpha.subnetworks.html @@ -184,7 +184,7 @@

Method Details

"network": "A String", # The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. This field can be set only at resource creation time. "privateIpGoogleAccess": True or False, # Whether the VMs in this subnet can access Google services without assigned external IP addresses. This field can be both set at resource creation time and updated using setPrivateIpGoogleAccess. "privateIpv6GoogleAccess": "A String", # This field is for internal use. This field can be both set at resource creation time and updated using patch. - "purpose": "A String", # The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PEER_MIGRATION or PRIVATE_SERVICE_CONNECT. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to PEER_MIGRATION is used for subnet migration from one peered VPC to another. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. + "purpose": "A String", # The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PEER_MIGRATION, PRIVATE_SERVICE_CONNECT or PRIVATE_NAT. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to PEER_MIGRATION is used for subnet migration from one peered VPC to another. A subnet with purpose set to PRIVATE_NAT is used for Private NAT IP address by Private NAT Gateway. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. "region": "A String", # URL of the region where the Subnetwork resides. This field can be set only at resource creation time. "reservedInternalRange": "A String", # The URL of the reserved internal range. "role": "A String", # The role of subnetwork. Currently, this field is only used when purpose is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. The value can be set to ACTIVE or BACKUP. An ACTIVE subnetwork is one that is currently being used for Envoy-based load balancers in a region. A BACKUP subnetwork is one that is ready to be promoted to ACTIVE or is currently draining. This field can be updated with a patch request. @@ -564,7 +564,7 @@

Method Details

"network": "A String", # The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. This field can be set only at resource creation time. "privateIpGoogleAccess": True or False, # Whether the VMs in this subnet can access Google services without assigned external IP addresses. This field can be both set at resource creation time and updated using setPrivateIpGoogleAccess. "privateIpv6GoogleAccess": "A String", # This field is for internal use. This field can be both set at resource creation time and updated using patch. - "purpose": "A String", # The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PEER_MIGRATION or PRIVATE_SERVICE_CONNECT. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to PEER_MIGRATION is used for subnet migration from one peered VPC to another. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. + "purpose": "A String", # The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PEER_MIGRATION, PRIVATE_SERVICE_CONNECT or PRIVATE_NAT. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to PEER_MIGRATION is used for subnet migration from one peered VPC to another. A subnet with purpose set to PRIVATE_NAT is used for Private NAT IP address by Private NAT Gateway. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. "region": "A String", # URL of the region where the Subnetwork resides. This field can be set only at resource creation time. "reservedInternalRange": "A String", # The URL of the reserved internal range. "role": "A String", # The role of subnetwork. Currently, this field is only used when purpose is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. The value can be set to ACTIVE or BACKUP. An ACTIVE subnetwork is one that is currently being used for Envoy-based load balancers in a region. A BACKUP subnetwork is one that is ready to be promoted to ACTIVE or is currently draining. This field can be updated with a patch request. @@ -680,7 +680,7 @@

Method Details

"network": "A String", # The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. This field can be set only at resource creation time. "privateIpGoogleAccess": True or False, # Whether the VMs in this subnet can access Google services without assigned external IP addresses. This field can be both set at resource creation time and updated using setPrivateIpGoogleAccess. "privateIpv6GoogleAccess": "A String", # This field is for internal use. This field can be both set at resource creation time and updated using patch. - "purpose": "A String", # The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PEER_MIGRATION or PRIVATE_SERVICE_CONNECT. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to PEER_MIGRATION is used for subnet migration from one peered VPC to another. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. + "purpose": "A String", # The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PEER_MIGRATION, PRIVATE_SERVICE_CONNECT or PRIVATE_NAT. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to PEER_MIGRATION is used for subnet migration from one peered VPC to another. A subnet with purpose set to PRIVATE_NAT is used for Private NAT IP address by Private NAT Gateway. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. "region": "A String", # URL of the region where the Subnetwork resides. This field can be set only at resource creation time. "reservedInternalRange": "A String", # The URL of the reserved internal range. "role": "A String", # The role of subnetwork. Currently, this field is only used when purpose is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. The value can be set to ACTIVE or BACKUP. An ACTIVE subnetwork is one that is currently being used for Envoy-based load balancers in a region. A BACKUP subnetwork is one that is ready to be promoted to ACTIVE or is currently draining. This field can be updated with a patch request. @@ -876,7 +876,7 @@

Method Details

"network": "A String", # The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. This field can be set only at resource creation time. "privateIpGoogleAccess": True or False, # Whether the VMs in this subnet can access Google services without assigned external IP addresses. This field can be both set at resource creation time and updated using setPrivateIpGoogleAccess. "privateIpv6GoogleAccess": "A String", # This field is for internal use. This field can be both set at resource creation time and updated using patch. - "purpose": "A String", # The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PEER_MIGRATION or PRIVATE_SERVICE_CONNECT. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to PEER_MIGRATION is used for subnet migration from one peered VPC to another. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. + "purpose": "A String", # The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PEER_MIGRATION, PRIVATE_SERVICE_CONNECT or PRIVATE_NAT. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to PEER_MIGRATION is used for subnet migration from one peered VPC to another. A subnet with purpose set to PRIVATE_NAT is used for Private NAT IP address by Private NAT Gateway. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. "region": "A String", # URL of the region where the Subnetwork resides. This field can be set only at resource creation time. "reservedInternalRange": "A String", # The URL of the reserved internal range. "role": "A String", # The role of subnetwork. Currently, this field is only used when purpose is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. The value can be set to ACTIVE or BACKUP. An ACTIVE subnetwork is one that is currently being used for Envoy-based load balancers in a region. A BACKUP subnetwork is one that is ready to be promoted to ACTIVE or is currently draining. This field can be updated with a patch request. @@ -941,7 +941,7 @@

Method Details

"ipCidrRange": "A String", # The range of internal addresses that are owned by this subnetwork. "ipv6AccessType": "A String", # The access type of IPv6 address this subnet holds. It's immutable and can only be specified during creation or the first time the subnet is updated into IPV4_IPV6 dual stack. "network": "A String", # Network URL. - "purpose": "A String", # The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PEER_MIGRATION or PRIVATE_SERVICE_CONNECT. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to PEER_MIGRATION is used for subnet migration from one peered VPC to another. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. + "purpose": "A String", # The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PEER_MIGRATION, PRIVATE_SERVICE_CONNECT or PRIVATE_NAT. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to PEER_MIGRATION is used for subnet migration from one peered VPC to another. A subnet with purpose set to PRIVATE_NAT is used for Private NAT IP address by Private NAT Gateway. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. "role": "A String", # The role of subnetwork. Currently, this field is only used when purpose is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. The value can be set to ACTIVE or BACKUP. An ACTIVE subnetwork is one that is currently being used for Envoy-based load balancers in a region. A BACKUP subnetwork is one that is ready to be promoted to ACTIVE or is currently draining. This field can be updated with a patch request. "secondaryIpRanges": [ # Secondary IP ranges. { # Secondary IP range of a usable subnetwork. @@ -1061,7 +1061,7 @@

Method Details

"network": "A String", # The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. This field can be set only at resource creation time. "privateIpGoogleAccess": True or False, # Whether the VMs in this subnet can access Google services without assigned external IP addresses. This field can be both set at resource creation time and updated using setPrivateIpGoogleAccess. "privateIpv6GoogleAccess": "A String", # This field is for internal use. This field can be both set at resource creation time and updated using patch. - "purpose": "A String", # The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PEER_MIGRATION or PRIVATE_SERVICE_CONNECT. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to PEER_MIGRATION is used for subnet migration from one peered VPC to another. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. + "purpose": "A String", # The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PEER_MIGRATION, PRIVATE_SERVICE_CONNECT or PRIVATE_NAT. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to PEER_MIGRATION is used for subnet migration from one peered VPC to another. A subnet with purpose set to PRIVATE_NAT is used for Private NAT IP address by Private NAT Gateway. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. "region": "A String", # URL of the region where the Subnetwork resides. This field can be set only at resource creation time. "reservedInternalRange": "A String", # The URL of the reserved internal range. "role": "A String", # The role of subnetwork. Currently, this field is only used when purpose is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. The value can be set to ACTIVE or BACKUP. An ACTIVE subnetwork is one that is currently being used for Envoy-based load balancers in a region. A BACKUP subnetwork is one that is ready to be promoted to ACTIVE or is currently draining. This field can be updated with a patch request. diff --git a/docs/dyn/compute_alpha.urlMaps.html b/docs/dyn/compute_alpha.urlMaps.html index 3265de77725..4c897f54577 100644 --- a/docs/dyn/compute_alpha.urlMaps.html +++ b/docs/dyn/compute_alpha.urlMaps.html @@ -2341,7 +2341,7 @@

Method Details

The object takes the form of: { - "cacheTags": [ # Not implemented. + "cacheTags": [ # A list of cache tags used to identify cached objects. - Cache tags are specified when the response is first cached, by setting the `Cache-Tag` response header at the origin. - Multiple cache tags in the same invalidation request are treated as Boolean `OR` - for example, `tag1 OR tag2 OR tag3`. - If other fields are also specified, these are treated as Boolean `AND` with any tags. Up to 10 tags can be specified in a single invalidation request. "A String", ], "host": "A String", # If set, this invalidation rule will only apply to requests with a Host header matching host. diff --git a/docs/dyn/compute_alpha.wireGroups.html b/docs/dyn/compute_alpha.wireGroups.html index 5ae778358de..e306c205d14 100644 --- a/docs/dyn/compute_alpha.wireGroups.html +++ b/docs/dyn/compute_alpha.wireGroups.html @@ -252,7 +252,7 @@

Method Details

"interconnects": { # A map that contains the redundant Interconnect connections. Specify key-value pairs for the map as follows: - Key: an RFC1035 user-specified label. - Value: an Interconnect object. "a_key": { # The redundant Interconnect connections for this endpoint. "interconnect": "A String", # An Interconnect connection. You can specify the connection as a partial or full URL. If the connection is in a different project from the cross-site network, use a format that specifies the project. See the following examples of partial and full URLs: global/interconnects/NAME projects/PROJECT_ID/global/interconnects/NAME - https://compute.googleapis.com/compute/projects/PROJECT_ID /global/interconnects/NAME - "vlanTags": [ # To configure the wire group for VLAN mode, enter a VLAN tag, which is a number from `2` to `4093`. You can autoallocate a tag by entering `0`. To configure the wire group for port mode, enter `-1`. Review the following guidelines: - A VLAN tag must be unique for an Interconnect connection across all attachments and wire groups. - Both endpoints of a wire must use the same VLAN tag value. - Single wire and redundant type wire groups must have only one VLAN tag. - Box and cross type wire groups must have two VLAN tags. The first is for the same-zone pseudowire, and the second is for the cross-zone pseudowire. - Port mode pseudowires must configure a value of `-1` for both endpoints. + "vlanTags": [ # To configure the wire group for VLAN mode, enter a VLAN tag, which is a number from `2` to `4093`. You can autoallocate a tag by entering `0`. To configure the wire group for port mode, enter `-1`. Review the following guidelines: - A VLAN tag must be unique for an Interconnect connection across all attachments and wire groups. - Both endpoints of a wire must use the same VLAN tag value. - Single wire and redundant type wire groups must have only one VLAN tag. - Port mode pseudowires must have a single VLAN tag with a value of `-1` for both endpoints. - Box and cross type wire groups must have two VLAN tags. The first is for the same-zone pseudowire, and the second is for the cross-zone pseudowire. 42, ], }, @@ -284,7 +284,7 @@

Method Details

"wirePropertyOverrides": { # The properties of a wire. # The overridden properties for the wire. Any properties that are not overridden are omitted from the object. Review the following guidelines: - If you apply wire overrides to a wire and its wire group bandwidth configuration is set to `SHARED_WITH_WIRE_GROUP`, the `meteredBandwidth` and `unmeteredBandwidth` properties must not differ from the wire group. - Overrides generate a `configurationNotice`. Ensure that differences in wire configuration are temporary. An example use case for wire overrides is slowly rolling out configuration changes to individual wires in a wire group. "bandwidthAllocation": "A String", # The configuration of the bandwidth allocation, one of the following: - ALLOCATE_PER_WIRE: configures a separate unmetered bandwidth allocation (and associated charges) for each wire in the group. - SHARED_WITH_WIRE_GROUP: configures one unmetered bandwidth allocation for the wire group. The unmetered bandwidth is divided equally across each wire in the group, but dynamic throttling reallocates unused unmetered bandwidth from unused or underused wires to other wires in the group. For example, with a four-wire box-and-cross group, when one Interconnect connection is down, the unmetered bandwidth of the two down wires is reallocated to the remaining up wires. "bandwidthMetered": "A String", # The metered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. The default value is `0`. You can specify unlimited bandwidth by entering `-1`. However, actual data transfer is limited by the port speed. - "bandwidthUnmetered": "A String", # The unmetered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. Must be a multiple of 10. + "bandwidthUnmetered": "A String", # The unmetered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. "faultResponse": "A String", # Response when a fault is detected in a pseudowire: - NONE: default. - DISABLE_PORT: set the port line protocol down when inline probes detect a fault. This setting is only permitted on port mode pseudowires. "networkServiceClass": "A String", # The network service class. }, @@ -293,7 +293,7 @@

Method Details

"wireProperties": { # The properties of a wire. # Properties for all wires in the wire group. "bandwidthAllocation": "A String", # The configuration of the bandwidth allocation, one of the following: - ALLOCATE_PER_WIRE: configures a separate unmetered bandwidth allocation (and associated charges) for each wire in the group. - SHARED_WITH_WIRE_GROUP: configures one unmetered bandwidth allocation for the wire group. The unmetered bandwidth is divided equally across each wire in the group, but dynamic throttling reallocates unused unmetered bandwidth from unused or underused wires to other wires in the group. For example, with a four-wire box-and-cross group, when one Interconnect connection is down, the unmetered bandwidth of the two down wires is reallocated to the remaining up wires. "bandwidthMetered": "A String", # The metered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. The default value is `0`. You can specify unlimited bandwidth by entering `-1`. However, actual data transfer is limited by the port speed. - "bandwidthUnmetered": "A String", # The unmetered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. Must be a multiple of 10. + "bandwidthUnmetered": "A String", # The unmetered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. "faultResponse": "A String", # Response when a fault is detected in a pseudowire: - NONE: default. - DISABLE_PORT: set the port line protocol down when inline probes detect a fault. This setting is only permitted on port mode pseudowires. "networkServiceClass": "A String", # The network service class. }, @@ -310,7 +310,7 @@

Method Details

"wireProperties": { # The properties of a wire. # [Output Only] Properties of the wire. "bandwidthAllocation": "A String", # The configuration of the bandwidth allocation, one of the following: - ALLOCATE_PER_WIRE: configures a separate unmetered bandwidth allocation (and associated charges) for each wire in the group. - SHARED_WITH_WIRE_GROUP: configures one unmetered bandwidth allocation for the wire group. The unmetered bandwidth is divided equally across each wire in the group, but dynamic throttling reallocates unused unmetered bandwidth from unused or underused wires to other wires in the group. For example, with a four-wire box-and-cross group, when one Interconnect connection is down, the unmetered bandwidth of the two down wires is reallocated to the remaining up wires. "bandwidthMetered": "A String", # The metered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. The default value is `0`. You can specify unlimited bandwidth by entering `-1`. However, actual data transfer is limited by the port speed. - "bandwidthUnmetered": "A String", # The unmetered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. Must be a multiple of 10. + "bandwidthUnmetered": "A String", # The unmetered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. "faultResponse": "A String", # Response when a fault is detected in a pseudowire: - NONE: default. - DISABLE_PORT: set the port line protocol down when inline probes detect a fault. This setting is only permitted on port mode pseudowires. "networkServiceClass": "A String", # The network service class. }, @@ -338,7 +338,7 @@

Method Details

"interconnects": { # A map that contains the redundant Interconnect connections. Specify key-value pairs for the map as follows: - Key: an RFC1035 user-specified label. - Value: an Interconnect object. "a_key": { # The redundant Interconnect connections for this endpoint. "interconnect": "A String", # An Interconnect connection. You can specify the connection as a partial or full URL. If the connection is in a different project from the cross-site network, use a format that specifies the project. See the following examples of partial and full URLs: global/interconnects/NAME projects/PROJECT_ID/global/interconnects/NAME - https://compute.googleapis.com/compute/projects/PROJECT_ID /global/interconnects/NAME - "vlanTags": [ # To configure the wire group for VLAN mode, enter a VLAN tag, which is a number from `2` to `4093`. You can autoallocate a tag by entering `0`. To configure the wire group for port mode, enter `-1`. Review the following guidelines: - A VLAN tag must be unique for an Interconnect connection across all attachments and wire groups. - Both endpoints of a wire must use the same VLAN tag value. - Single wire and redundant type wire groups must have only one VLAN tag. - Box and cross type wire groups must have two VLAN tags. The first is for the same-zone pseudowire, and the second is for the cross-zone pseudowire. - Port mode pseudowires must configure a value of `-1` for both endpoints. + "vlanTags": [ # To configure the wire group for VLAN mode, enter a VLAN tag, which is a number from `2` to `4093`. You can autoallocate a tag by entering `0`. To configure the wire group for port mode, enter `-1`. Review the following guidelines: - A VLAN tag must be unique for an Interconnect connection across all attachments and wire groups. - Both endpoints of a wire must use the same VLAN tag value. - Single wire and redundant type wire groups must have only one VLAN tag. - Port mode pseudowires must have a single VLAN tag with a value of `-1` for both endpoints. - Box and cross type wire groups must have two VLAN tags. The first is for the same-zone pseudowire, and the second is for the cross-zone pseudowire. 42, ], }, @@ -370,7 +370,7 @@

Method Details

"wirePropertyOverrides": { # The properties of a wire. # The overridden properties for the wire. Any properties that are not overridden are omitted from the object. Review the following guidelines: - If you apply wire overrides to a wire and its wire group bandwidth configuration is set to `SHARED_WITH_WIRE_GROUP`, the `meteredBandwidth` and `unmeteredBandwidth` properties must not differ from the wire group. - Overrides generate a `configurationNotice`. Ensure that differences in wire configuration are temporary. An example use case for wire overrides is slowly rolling out configuration changes to individual wires in a wire group. "bandwidthAllocation": "A String", # The configuration of the bandwidth allocation, one of the following: - ALLOCATE_PER_WIRE: configures a separate unmetered bandwidth allocation (and associated charges) for each wire in the group. - SHARED_WITH_WIRE_GROUP: configures one unmetered bandwidth allocation for the wire group. The unmetered bandwidth is divided equally across each wire in the group, but dynamic throttling reallocates unused unmetered bandwidth from unused or underused wires to other wires in the group. For example, with a four-wire box-and-cross group, when one Interconnect connection is down, the unmetered bandwidth of the two down wires is reallocated to the remaining up wires. "bandwidthMetered": "A String", # The metered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. The default value is `0`. You can specify unlimited bandwidth by entering `-1`. However, actual data transfer is limited by the port speed. - "bandwidthUnmetered": "A String", # The unmetered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. Must be a multiple of 10. + "bandwidthUnmetered": "A String", # The unmetered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. "faultResponse": "A String", # Response when a fault is detected in a pseudowire: - NONE: default. - DISABLE_PORT: set the port line protocol down when inline probes detect a fault. This setting is only permitted on port mode pseudowires. "networkServiceClass": "A String", # The network service class. }, @@ -379,7 +379,7 @@

Method Details

"wireProperties": { # The properties of a wire. # Properties for all wires in the wire group. "bandwidthAllocation": "A String", # The configuration of the bandwidth allocation, one of the following: - ALLOCATE_PER_WIRE: configures a separate unmetered bandwidth allocation (and associated charges) for each wire in the group. - SHARED_WITH_WIRE_GROUP: configures one unmetered bandwidth allocation for the wire group. The unmetered bandwidth is divided equally across each wire in the group, but dynamic throttling reallocates unused unmetered bandwidth from unused or underused wires to other wires in the group. For example, with a four-wire box-and-cross group, when one Interconnect connection is down, the unmetered bandwidth of the two down wires is reallocated to the remaining up wires. "bandwidthMetered": "A String", # The metered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. The default value is `0`. You can specify unlimited bandwidth by entering `-1`. However, actual data transfer is limited by the port speed. - "bandwidthUnmetered": "A String", # The unmetered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. Must be a multiple of 10. + "bandwidthUnmetered": "A String", # The unmetered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. "faultResponse": "A String", # Response when a fault is detected in a pseudowire: - NONE: default. - DISABLE_PORT: set the port line protocol down when inline probes detect a fault. This setting is only permitted on port mode pseudowires. "networkServiceClass": "A String", # The network service class. }, @@ -396,7 +396,7 @@

Method Details

"wireProperties": { # The properties of a wire. # [Output Only] Properties of the wire. "bandwidthAllocation": "A String", # The configuration of the bandwidth allocation, one of the following: - ALLOCATE_PER_WIRE: configures a separate unmetered bandwidth allocation (and associated charges) for each wire in the group. - SHARED_WITH_WIRE_GROUP: configures one unmetered bandwidth allocation for the wire group. The unmetered bandwidth is divided equally across each wire in the group, but dynamic throttling reallocates unused unmetered bandwidth from unused or underused wires to other wires in the group. For example, with a four-wire box-and-cross group, when one Interconnect connection is down, the unmetered bandwidth of the two down wires is reallocated to the remaining up wires. "bandwidthMetered": "A String", # The metered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. The default value is `0`. You can specify unlimited bandwidth by entering `-1`. However, actual data transfer is limited by the port speed. - "bandwidthUnmetered": "A String", # The unmetered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. Must be a multiple of 10. + "bandwidthUnmetered": "A String", # The unmetered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. "faultResponse": "A String", # Response when a fault is detected in a pseudowire: - NONE: default. - DISABLE_PORT: set the port line protocol down when inline probes detect a fault. This setting is only permitted on port mode pseudowires. "networkServiceClass": "A String", # The network service class. }, @@ -556,7 +556,7 @@

Method Details

"interconnects": { # A map that contains the redundant Interconnect connections. Specify key-value pairs for the map as follows: - Key: an RFC1035 user-specified label. - Value: an Interconnect object. "a_key": { # The redundant Interconnect connections for this endpoint. "interconnect": "A String", # An Interconnect connection. You can specify the connection as a partial or full URL. If the connection is in a different project from the cross-site network, use a format that specifies the project. See the following examples of partial and full URLs: global/interconnects/NAME projects/PROJECT_ID/global/interconnects/NAME - https://compute.googleapis.com/compute/projects/PROJECT_ID /global/interconnects/NAME - "vlanTags": [ # To configure the wire group for VLAN mode, enter a VLAN tag, which is a number from `2` to `4093`. You can autoallocate a tag by entering `0`. To configure the wire group for port mode, enter `-1`. Review the following guidelines: - A VLAN tag must be unique for an Interconnect connection across all attachments and wire groups. - Both endpoints of a wire must use the same VLAN tag value. - Single wire and redundant type wire groups must have only one VLAN tag. - Box and cross type wire groups must have two VLAN tags. The first is for the same-zone pseudowire, and the second is for the cross-zone pseudowire. - Port mode pseudowires must configure a value of `-1` for both endpoints. + "vlanTags": [ # To configure the wire group for VLAN mode, enter a VLAN tag, which is a number from `2` to `4093`. You can autoallocate a tag by entering `0`. To configure the wire group for port mode, enter `-1`. Review the following guidelines: - A VLAN tag must be unique for an Interconnect connection across all attachments and wire groups. - Both endpoints of a wire must use the same VLAN tag value. - Single wire and redundant type wire groups must have only one VLAN tag. - Port mode pseudowires must have a single VLAN tag with a value of `-1` for both endpoints. - Box and cross type wire groups must have two VLAN tags. The first is for the same-zone pseudowire, and the second is for the cross-zone pseudowire. 42, ], }, @@ -588,7 +588,7 @@

Method Details

"wirePropertyOverrides": { # The properties of a wire. # The overridden properties for the wire. Any properties that are not overridden are omitted from the object. Review the following guidelines: - If you apply wire overrides to a wire and its wire group bandwidth configuration is set to `SHARED_WITH_WIRE_GROUP`, the `meteredBandwidth` and `unmeteredBandwidth` properties must not differ from the wire group. - Overrides generate a `configurationNotice`. Ensure that differences in wire configuration are temporary. An example use case for wire overrides is slowly rolling out configuration changes to individual wires in a wire group. "bandwidthAllocation": "A String", # The configuration of the bandwidth allocation, one of the following: - ALLOCATE_PER_WIRE: configures a separate unmetered bandwidth allocation (and associated charges) for each wire in the group. - SHARED_WITH_WIRE_GROUP: configures one unmetered bandwidth allocation for the wire group. The unmetered bandwidth is divided equally across each wire in the group, but dynamic throttling reallocates unused unmetered bandwidth from unused or underused wires to other wires in the group. For example, with a four-wire box-and-cross group, when one Interconnect connection is down, the unmetered bandwidth of the two down wires is reallocated to the remaining up wires. "bandwidthMetered": "A String", # The metered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. The default value is `0`. You can specify unlimited bandwidth by entering `-1`. However, actual data transfer is limited by the port speed. - "bandwidthUnmetered": "A String", # The unmetered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. Must be a multiple of 10. + "bandwidthUnmetered": "A String", # The unmetered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. "faultResponse": "A String", # Response when a fault is detected in a pseudowire: - NONE: default. - DISABLE_PORT: set the port line protocol down when inline probes detect a fault. This setting is only permitted on port mode pseudowires. "networkServiceClass": "A String", # The network service class. }, @@ -597,7 +597,7 @@

Method Details

"wireProperties": { # The properties of a wire. # Properties for all wires in the wire group. "bandwidthAllocation": "A String", # The configuration of the bandwidth allocation, one of the following: - ALLOCATE_PER_WIRE: configures a separate unmetered bandwidth allocation (and associated charges) for each wire in the group. - SHARED_WITH_WIRE_GROUP: configures one unmetered bandwidth allocation for the wire group. The unmetered bandwidth is divided equally across each wire in the group, but dynamic throttling reallocates unused unmetered bandwidth from unused or underused wires to other wires in the group. For example, with a four-wire box-and-cross group, when one Interconnect connection is down, the unmetered bandwidth of the two down wires is reallocated to the remaining up wires. "bandwidthMetered": "A String", # The metered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. The default value is `0`. You can specify unlimited bandwidth by entering `-1`. However, actual data transfer is limited by the port speed. - "bandwidthUnmetered": "A String", # The unmetered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. Must be a multiple of 10. + "bandwidthUnmetered": "A String", # The unmetered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. "faultResponse": "A String", # Response when a fault is detected in a pseudowire: - NONE: default. - DISABLE_PORT: set the port line protocol down when inline probes detect a fault. This setting is only permitted on port mode pseudowires. "networkServiceClass": "A String", # The network service class. }, @@ -614,7 +614,7 @@

Method Details

"wireProperties": { # The properties of a wire. # [Output Only] Properties of the wire. "bandwidthAllocation": "A String", # The configuration of the bandwidth allocation, one of the following: - ALLOCATE_PER_WIRE: configures a separate unmetered bandwidth allocation (and associated charges) for each wire in the group. - SHARED_WITH_WIRE_GROUP: configures one unmetered bandwidth allocation for the wire group. The unmetered bandwidth is divided equally across each wire in the group, but dynamic throttling reallocates unused unmetered bandwidth from unused or underused wires to other wires in the group. For example, with a four-wire box-and-cross group, when one Interconnect connection is down, the unmetered bandwidth of the two down wires is reallocated to the remaining up wires. "bandwidthMetered": "A String", # The metered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. The default value is `0`. You can specify unlimited bandwidth by entering `-1`. However, actual data transfer is limited by the port speed. - "bandwidthUnmetered": "A String", # The unmetered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. Must be a multiple of 10. + "bandwidthUnmetered": "A String", # The unmetered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. "faultResponse": "A String", # Response when a fault is detected in a pseudowire: - NONE: default. - DISABLE_PORT: set the port line protocol down when inline probes detect a fault. This setting is only permitted on port mode pseudowires. "networkServiceClass": "A String", # The network service class. }, @@ -675,7 +675,7 @@

Method Details

"interconnects": { # A map that contains the redundant Interconnect connections. Specify key-value pairs for the map as follows: - Key: an RFC1035 user-specified label. - Value: an Interconnect object. "a_key": { # The redundant Interconnect connections for this endpoint. "interconnect": "A String", # An Interconnect connection. You can specify the connection as a partial or full URL. If the connection is in a different project from the cross-site network, use a format that specifies the project. See the following examples of partial and full URLs: global/interconnects/NAME projects/PROJECT_ID/global/interconnects/NAME - https://compute.googleapis.com/compute/projects/PROJECT_ID /global/interconnects/NAME - "vlanTags": [ # To configure the wire group for VLAN mode, enter a VLAN tag, which is a number from `2` to `4093`. You can autoallocate a tag by entering `0`. To configure the wire group for port mode, enter `-1`. Review the following guidelines: - A VLAN tag must be unique for an Interconnect connection across all attachments and wire groups. - Both endpoints of a wire must use the same VLAN tag value. - Single wire and redundant type wire groups must have only one VLAN tag. - Box and cross type wire groups must have two VLAN tags. The first is for the same-zone pseudowire, and the second is for the cross-zone pseudowire. - Port mode pseudowires must configure a value of `-1` for both endpoints. + "vlanTags": [ # To configure the wire group for VLAN mode, enter a VLAN tag, which is a number from `2` to `4093`. You can autoallocate a tag by entering `0`. To configure the wire group for port mode, enter `-1`. Review the following guidelines: - A VLAN tag must be unique for an Interconnect connection across all attachments and wire groups. - Both endpoints of a wire must use the same VLAN tag value. - Single wire and redundant type wire groups must have only one VLAN tag. - Port mode pseudowires must have a single VLAN tag with a value of `-1` for both endpoints. - Box and cross type wire groups must have two VLAN tags. The first is for the same-zone pseudowire, and the second is for the cross-zone pseudowire. 42, ], }, @@ -707,7 +707,7 @@

Method Details

"wirePropertyOverrides": { # The properties of a wire. # The overridden properties for the wire. Any properties that are not overridden are omitted from the object. Review the following guidelines: - If you apply wire overrides to a wire and its wire group bandwidth configuration is set to `SHARED_WITH_WIRE_GROUP`, the `meteredBandwidth` and `unmeteredBandwidth` properties must not differ from the wire group. - Overrides generate a `configurationNotice`. Ensure that differences in wire configuration are temporary. An example use case for wire overrides is slowly rolling out configuration changes to individual wires in a wire group. "bandwidthAllocation": "A String", # The configuration of the bandwidth allocation, one of the following: - ALLOCATE_PER_WIRE: configures a separate unmetered bandwidth allocation (and associated charges) for each wire in the group. - SHARED_WITH_WIRE_GROUP: configures one unmetered bandwidth allocation for the wire group. The unmetered bandwidth is divided equally across each wire in the group, but dynamic throttling reallocates unused unmetered bandwidth from unused or underused wires to other wires in the group. For example, with a four-wire box-and-cross group, when one Interconnect connection is down, the unmetered bandwidth of the two down wires is reallocated to the remaining up wires. "bandwidthMetered": "A String", # The metered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. The default value is `0`. You can specify unlimited bandwidth by entering `-1`. However, actual data transfer is limited by the port speed. - "bandwidthUnmetered": "A String", # The unmetered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. Must be a multiple of 10. + "bandwidthUnmetered": "A String", # The unmetered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. "faultResponse": "A String", # Response when a fault is detected in a pseudowire: - NONE: default. - DISABLE_PORT: set the port line protocol down when inline probes detect a fault. This setting is only permitted on port mode pseudowires. "networkServiceClass": "A String", # The network service class. }, @@ -716,7 +716,7 @@

Method Details

"wireProperties": { # The properties of a wire. # Properties for all wires in the wire group. "bandwidthAllocation": "A String", # The configuration of the bandwidth allocation, one of the following: - ALLOCATE_PER_WIRE: configures a separate unmetered bandwidth allocation (and associated charges) for each wire in the group. - SHARED_WITH_WIRE_GROUP: configures one unmetered bandwidth allocation for the wire group. The unmetered bandwidth is divided equally across each wire in the group, but dynamic throttling reallocates unused unmetered bandwidth from unused or underused wires to other wires in the group. For example, with a four-wire box-and-cross group, when one Interconnect connection is down, the unmetered bandwidth of the two down wires is reallocated to the remaining up wires. "bandwidthMetered": "A String", # The metered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. The default value is `0`. You can specify unlimited bandwidth by entering `-1`. However, actual data transfer is limited by the port speed. - "bandwidthUnmetered": "A String", # The unmetered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. Must be a multiple of 10. + "bandwidthUnmetered": "A String", # The unmetered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. "faultResponse": "A String", # Response when a fault is detected in a pseudowire: - NONE: default. - DISABLE_PORT: set the port line protocol down when inline probes detect a fault. This setting is only permitted on port mode pseudowires. "networkServiceClass": "A String", # The network service class. }, @@ -733,7 +733,7 @@

Method Details

"wireProperties": { # The properties of a wire. # [Output Only] Properties of the wire. "bandwidthAllocation": "A String", # The configuration of the bandwidth allocation, one of the following: - ALLOCATE_PER_WIRE: configures a separate unmetered bandwidth allocation (and associated charges) for each wire in the group. - SHARED_WITH_WIRE_GROUP: configures one unmetered bandwidth allocation for the wire group. The unmetered bandwidth is divided equally across each wire in the group, but dynamic throttling reallocates unused unmetered bandwidth from unused or underused wires to other wires in the group. For example, with a four-wire box-and-cross group, when one Interconnect connection is down, the unmetered bandwidth of the two down wires is reallocated to the remaining up wires. "bandwidthMetered": "A String", # The metered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. The default value is `0`. You can specify unlimited bandwidth by entering `-1`. However, actual data transfer is limited by the port speed. - "bandwidthUnmetered": "A String", # The unmetered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. Must be a multiple of 10. + "bandwidthUnmetered": "A String", # The unmetered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. "faultResponse": "A String", # Response when a fault is detected in a pseudowire: - NONE: default. - DISABLE_PORT: set the port line protocol down when inline probes detect a fault. This setting is only permitted on port mode pseudowires. "networkServiceClass": "A String", # The network service class. }, diff --git a/docs/dyn/compute_v1.disks.html b/docs/dyn/compute_v1.disks.html index 8eeb024d184..b095d501106 100644 --- a/docs/dyn/compute_v1.disks.html +++ b/docs/dyn/compute_v1.disks.html @@ -662,7 +662,7 @@

Method Details

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. }, - "sourceInstantSnapshotId": "A String", # [Output Only] The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this persistent disk. For example, if you created the persistent disk from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used. + "sourceInstantSnapshotId": "A String", # [Output Only] The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this snapshot. For example, if you created the snapshot from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used. "sourceSnapshotSchedulePolicy": "A String", # [Output Only] URL of the resource policy which created this scheduled snapshot. "sourceSnapshotSchedulePolicyId": "A String", # [Output Only] ID of the resource policy which created this scheduled snapshot. "status": "A String", # [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING. diff --git a/docs/dyn/compute_v1.regionDisks.html b/docs/dyn/compute_v1.regionDisks.html index 53fd2d96692..0968e9f1482 100644 --- a/docs/dyn/compute_v1.regionDisks.html +++ b/docs/dyn/compute_v1.regionDisks.html @@ -471,7 +471,7 @@

Method Details

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. }, - "sourceInstantSnapshotId": "A String", # [Output Only] The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this persistent disk. For example, if you created the persistent disk from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used. + "sourceInstantSnapshotId": "A String", # [Output Only] The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this snapshot. For example, if you created the snapshot from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used. "sourceSnapshotSchedulePolicy": "A String", # [Output Only] URL of the resource policy which created this scheduled snapshot. "sourceSnapshotSchedulePolicyId": "A String", # [Output Only] ID of the resource policy which created this scheduled snapshot. "status": "A String", # [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING. diff --git a/docs/dyn/compute_v1.regionNetworkFirewallPolicies.html b/docs/dyn/compute_v1.regionNetworkFirewallPolicies.html index ed22cf35f79..3e74104e9c4 100644 --- a/docs/dyn/compute_v1.regionNetworkFirewallPolicies.html +++ b/docs/dyn/compute_v1.regionNetworkFirewallPolicies.html @@ -1035,6 +1035,7 @@

Method Details

"tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions. }, ], + "priority": 42, # [Output only] Priority of firewall policy association. Not applicable for type=HIERARCHY. "rules": [ # [Output only] The rules that apply to the network. { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions for firewall rules are: "allow", "deny", "apply_security_profile_group" and "goto_next". Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" and "goto_next". diff --git a/docs/dyn/compute_v1.routers.html b/docs/dyn/compute_v1.routers.html index d196a614abe..3a9560834c6 100644 --- a/docs/dyn/compute_v1.routers.html +++ b/docs/dyn/compute_v1.routers.html @@ -86,6 +86,9 @@

Instance Methods

delete(project, region, router, requestId=None, x__xgafv=None)

Deletes the specified Router resource.

+

+ deleteRoutePolicy(project, region, router, policy=None, requestId=None, x__xgafv=None)

+

Deletes Route Policy

get(project, region, router, x__xgafv=None)

Returns the specified Router resource.

@@ -98,6 +101,9 @@

Instance Methods

getNatMappingInfo_next()

Retrieves the next page of results.

+

+ getRoutePolicy(project, region, router, policy=None, x__xgafv=None)

+

Returns specified Route Policy

getRouterStatus(project, region, router, x__xgafv=None)

Retrieves runtime information of the specified router.

@@ -107,18 +113,36 @@

Instance Methods

list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

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

+

+ listBgpRoutes(project, region, router, addressFamily=None, destinationPrefix=None, filter=None, maxResults=None, orderBy=None, pageToken=None, peer=None, policyApplied=None, returnPartialSuccess=None, routeType=None, x__xgafv=None)

+

Retrieves a list of router bgp routes available to the specified project.

+

+ listBgpRoutes_next()

+

Retrieves the next page of results.

+

+ listRoutePolicies(project, region, router, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Retrieves a list of router route policy subresources available to the specified project.

+

+ listRoutePolicies_next()

+

Retrieves the next page of results.

list_next()

Retrieves the next page of results.

patch(project, region, router, body=None, requestId=None, x__xgafv=None)

Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.

+

+ patchRoutePolicy(project, region, router, body=None, requestId=None, x__xgafv=None)

+

Patches Route Policy

preview(project, region, router, body=None, x__xgafv=None)

Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router.

update(project, region, router, body=None, requestId=None, x__xgafv=None)

Updates the specified Router resource with the data included in the request. This method conforms to PUT semantics, which requests that the state of the target resource be created or replaced with the state defined by the representation enclosed in the request message payload.

+

+ updateRoutePolicy(project, region, router, body=None, requestId=None, x__xgafv=None)

+

Updates or creates new Route Policy

Method Details

aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None) @@ -190,10 +214,10 @@

Method Details

"enable": "A String", # The status of the BGP peer connection. If set to FALSE, any active session with the peer is terminated and all associated routing information is removed. If set to TRUE, the peer connection can be established with routing information. The default is TRUE. "enableIpv4": True or False, # Enable IPv4 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 4. "enableIpv6": True or False, # Enable IPv6 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 6. - "exportPolicies": [ # List of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies. + "exportPolicies": [ # List of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type. "A String", ], - "importPolicies": [ # List of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies. + "importPolicies": [ # List of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type. "A String", ], "interfaceName": "A String", # Name of the interface the BGP peer is associated with. @@ -478,6 +502,132 @@

Method Details

}
+
+ deleteRoutePolicy(project, region, router, policy=None, requestId=None, x__xgafv=None) +
Deletes Route Policy
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region for this request. (required)
+  router: string, Name of the Router resource where Route Policy is defined. (required)
+  policy: string, The Policy name for this request. Name must conform to RFC1035
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "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). # [Output Only] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "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.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the disk that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
+}
+
+
get(project, region, router, x__xgafv=None)
Returns the specified Router resource.
@@ -538,10 +688,10 @@ 

Method Details

"enable": "A String", # The status of the BGP peer connection. If set to FALSE, any active session with the peer is terminated and all associated routing information is removed. If set to TRUE, the peer connection can be established with routing information. The default is TRUE. "enableIpv4": True or False, # Enable IPv4 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 4. "enableIpv6": True or False, # Enable IPv6 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 6. - "exportPolicies": [ # List of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies. + "exportPolicies": [ # List of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type. "A String", ], - "importPolicies": [ # List of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies. + "importPolicies": [ # List of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type. "A String", ], "interfaceName": "A String", # Name of the interface the BGP peer is associated with. @@ -771,6 +921,52 @@

Method Details

+
+ getRoutePolicy(project, region, router, policy=None, x__xgafv=None) +
Returns specified Route Policy
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region for this request. (required)
+  router: string, Name of the Router resource to query for the route policy. The name should conform to RFC1035. (required)
+  policy: string, The Policy name for this request. Name must conform to RFC1035
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "resource": {
+    "description": "A String", # An optional description of route policy.
+    "fingerprint": "A String", # A fingerprint for the Route Policy being applied to this Router, which is essentially a hash of the Route Policy used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update Route Policy. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make a getRoutePolicy() request to retrieve a Route Policy.
+    "name": "A String", # Route Policy name, which must be a resource ID segment and unique within all the router's Route Policies. Name should conform to RFC1035.
+    "terms": [ # List of terms (the order in the list is not important, they are evaluated in order of priority). Order of policies is not retained and might change when getting policy later.
+      {
+        "actions": [ # CEL expressions to evaluate to modify a route when this term matches.
+          { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
+            "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+            "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+            "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+            "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+          },
+        ],
+        "match": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # CEL expression evaluated against a route to determine if this term applies. When not set, the term applies to all routes.
+          "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+          "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+          "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+          "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+        },
+        "priority": 42, # The evaluation priority for this term, which must be between 0 (inclusive) and 2^31 (exclusive), and unique within the list.
+      },
+    ],
+    "type": "A String",
+  },
+}
+
+
getRouterStatus(project, region, router, x__xgafv=None)
Retrieves runtime information of the specified router.
@@ -1113,10 +1309,10 @@ 

Method Details

"enable": "A String", # The status of the BGP peer connection. If set to FALSE, any active session with the peer is terminated and all associated routing information is removed. If set to TRUE, the peer connection can be established with routing information. The default is TRUE. "enableIpv4": True or False, # Enable IPv4 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 4. "enableIpv6": True or False, # Enable IPv6 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 6. - "exportPolicies": [ # List of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies. + "exportPolicies": [ # List of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type. "A String", ], - "importPolicies": [ # List of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies. + "importPolicies": [ # List of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type. "A String", ], "interfaceName": "A String", # Name of the interface the BGP peer is associated with. @@ -1410,10 +1606,10 @@

Method Details

"enable": "A String", # The status of the BGP peer connection. If set to FALSE, any active session with the peer is terminated and all associated routing information is removed. If set to TRUE, the peer connection can be established with routing information. The default is TRUE. "enableIpv4": True or False, # Enable IPv4 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 4. "enableIpv6": True or False, # Enable IPv6 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 6. - "exportPolicies": [ # List of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies. + "exportPolicies": [ # List of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type. "A String", ], - "importPolicies": [ # List of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies. + "importPolicies": [ # List of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type. "A String", ], "interfaceName": "A String", # Name of the interface the BGP peer is associated with. @@ -1540,7 +1736,84 @@

Method Details

- list_next() + listBgpRoutes(project, region, router, addressFamily=None, destinationPrefix=None, filter=None, maxResults=None, orderBy=None, pageToken=None, peer=None, policyApplied=None, returnPartialSuccess=None, routeType=None, x__xgafv=None) +
Retrieves a list of router bgp routes available to the specified project.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region for this request. (required)
+  router: string, Name or id of the resource for this request. Name should conform to RFC1035. (required)
+  addressFamily: string, (Required) limit results to this address family (either IPv4 or IPv6)
+    Allowed values
+      IPV4 - 
+      IPV6 - 
+      UNSPECIFIED_IP_VERSION - 
+  destinationPrefix: string, Limit results to destinations that are subnets of this CIDR range
+  filter: string, A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
+  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
+  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
+  pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
+  peer: string, (Required) limit results to the BGP peer with the given name. Name should conform to RFC1035.
+  policyApplied: boolean, When true, the method returns post-policy routes. Otherwise, it returns pre-policy routes.
+  returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.
+  routeType: string, (Required) limit results to this type of route (either LEARNED or ADVERTISED)
+    Allowed values
+      ADVERTISED - 
+      LEARNED - 
+      UNSPECIFIED_ROUTE_TYPE - 
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "etag": "A String",
+  "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+  "kind": "compute#routersListBgpRoutes", # [Output Only] Type of resource. Always compute#routersListBgpRoutes for lists of bgp routes.
+  "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+  "result": [ # [Output Only] A list of bgp routes.
+    {
+      "asPaths": [ # [Output only] AS-PATH for the route
+        {
+          "asns": [ # [Output only] ASNs in the path segment. When type is SEQUENCE, these are ordered.
+            42,
+          ],
+          "type": "A String", # [Output only] Type of AS-PATH segment (SEQUENCE or SET)
+        },
+      ],
+      "communities": [ # [Output only] BGP communities in human-readable A:B format.
+        "A String",
+      ],
+      "destination": { # Network Layer Reachability Information (NLRI) for a route. # [Output only] Destination IP range for the route, in human-readable CIDR format
+        "pathId": 42, # If the BGP session supports multiple paths (RFC 7911), the path identifier for this route.
+        "prefix": "A String", # Human readable CIDR notation for a prefix. E.g. 10.42.0.0/16.
+      },
+      "med": 42, # [Output only] BGP multi-exit discriminator
+      "origin": "A String", # [Output only] BGP origin (EGP, IGP or INCOMPLETE)
+    },
+  ],
+  "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+  "unreachables": [ # [Output Only] Unreachable resources.
+    "A String",
+  ],
+  "warning": { # [Output Only] Informational warning message.
+    "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+    "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+      {
+        "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+        "value": "A String", # [Output Only] A warning data value corresponding to the key.
+      },
+    ],
+    "message": "A String", # [Output Only] A human-readable description of the warning code.
+  },
+}
+
+ +
+ listBgpRoutes_next()
Retrieves the next page of results.
 
         Args:
@@ -1554,42 +1827,140 @@ 

Method Details

- patch(project, region, router, body=None, requestId=None, x__xgafv=None) -
Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.
+    listRoutePolicies(project, region, router, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
+  
Retrieves a list of router route policy subresources available to the specified project.
 
 Args:
   project: string, Project ID for this request. (required)
   region: string, Name of the region for this request. (required)
-  router: string, Name of the Router resource to patch. (required)
-  body: object, The request body.
-    The object takes the form of:
+  router: string, Name or id of the resource for this request. Name should conform to RFC1035. (required)
+  filter: string, A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
+  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
+  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
+  pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
+  returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
 
-{ # Represents a Cloud Router resource. For more information about Cloud Router, read the Cloud Router overview.
-  "bgp": { # BGP information specific to this router.
-    "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM.
-    "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These groups will be advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups.
-      "A String",
-    ],
-    "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These IP ranges will be advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.
-      { # Description-tagged IP ranges for the router to advertise.
-        "description": "A String", # User-specified description for the IP range.
-        "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.
-      },
-    ],
-    "asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
-    "identifierRange": "A String", # Explicitly specifies a range of valid BGP Identifiers for this Router. It is provided as a link-local IPv4 range (from 169.254.0.0/16), of size at least /30, even if the BGP sessions are over IPv6. It must not overlap with any IPv4 BGP session ranges. Other vendors commonly call this "router ID".
-    "keepaliveInterval": 42, # The interval in seconds between BGP keepalive messages that are sent to the peer. Hold time is three times the interval at which keepalive messages are sent, and the hold time is the maximum number of seconds allowed to elapse between successive keepalive messages that BGP receives from a peer. BGP will use the smaller of either the local hold time value or the peer's hold time value as the hold time for the BGP connection between the two peers. If set, this value must be between 20 and 60. The default is 20.
-  },
-  "bgpPeers": [ # BGP information that must be configured into the routing stack to establish BGP peering. This information must specify the peer ASN and either the interface name, IP address, or peer IP address. Please refer to RFC4273.
     {
-      "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement.
-      "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode, which currently supports the following option: - ALL_SUBNETS: Advertises all of the router's own VPC subnets. This excludes any routes learned for subnets that use VPC Network Peering. Note that this field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the "bgp" message). These groups are advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups.
-        "A String",
-      ],
-      "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the "bgp" message). These IP ranges are advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.
-        { # Description-tagged IP ranges for the router to advertise.
-          "description": "A String", # User-specified description for the IP range.
-          "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.
+  "etag": "A String",
+  "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+  "kind": "compute#routersListRoutePolicies", # [Output Only] Type of resource. Always compute#routersListRoutePolicies for lists of route policies.
+  "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+  "result": [ # [Output Only] A list of route policies.
+    {
+      "description": "A String", # An optional description of route policy.
+      "fingerprint": "A String", # A fingerprint for the Route Policy being applied to this Router, which is essentially a hash of the Route Policy used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update Route Policy. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make a getRoutePolicy() request to retrieve a Route Policy.
+      "name": "A String", # Route Policy name, which must be a resource ID segment and unique within all the router's Route Policies. Name should conform to RFC1035.
+      "terms": [ # List of terms (the order in the list is not important, they are evaluated in order of priority). Order of policies is not retained and might change when getting policy later.
+        {
+          "actions": [ # CEL expressions to evaluate to modify a route when this term matches.
+            { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
+              "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+              "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+              "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+              "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+            },
+          ],
+          "match": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # CEL expression evaluated against a route to determine if this term applies. When not set, the term applies to all routes.
+            "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+            "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+            "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+            "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+          },
+          "priority": 42, # The evaluation priority for this term, which must be between 0 (inclusive) and 2^31 (exclusive), and unique within the list.
+        },
+      ],
+      "type": "A String",
+    },
+  ],
+  "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+  "unreachables": [ # [Output Only] Unreachable resources.
+    "A String",
+  ],
+  "warning": { # [Output Only] Informational warning message.
+    "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+    "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+      {
+        "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+        "value": "A String", # [Output Only] A warning data value corresponding to the key.
+      },
+    ],
+    "message": "A String", # [Output Only] A human-readable description of the warning code.
+  },
+}
+
+ +
+ listRoutePolicies_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.
+        
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(project, region, router, body=None, requestId=None, x__xgafv=None) +
Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region for this request. (required)
+  router: string, Name of the Router resource to patch. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a Cloud Router resource. For more information about Cloud Router, read the Cloud Router overview.
+  "bgp": { # BGP information specific to this router.
+    "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM.
+    "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These groups will be advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups.
+      "A String",
+    ],
+    "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These IP ranges will be advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.
+      { # Description-tagged IP ranges for the router to advertise.
+        "description": "A String", # User-specified description for the IP range.
+        "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.
+      },
+    ],
+    "asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
+    "identifierRange": "A String", # Explicitly specifies a range of valid BGP Identifiers for this Router. It is provided as a link-local IPv4 range (from 169.254.0.0/16), of size at least /30, even if the BGP sessions are over IPv6. It must not overlap with any IPv4 BGP session ranges. Other vendors commonly call this "router ID".
+    "keepaliveInterval": 42, # The interval in seconds between BGP keepalive messages that are sent to the peer. Hold time is three times the interval at which keepalive messages are sent, and the hold time is the maximum number of seconds allowed to elapse between successive keepalive messages that BGP receives from a peer. BGP will use the smaller of either the local hold time value or the peer's hold time value as the hold time for the BGP connection between the two peers. If set, this value must be between 20 and 60. The default is 20.
+  },
+  "bgpPeers": [ # BGP information that must be configured into the routing stack to establish BGP peering. This information must specify the peer ASN and either the interface name, IP address, or peer IP address. Please refer to RFC4273.
+    {
+      "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement.
+      "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode, which currently supports the following option: - ALL_SUBNETS: Advertises all of the router's own VPC subnets. This excludes any routes learned for subnets that use VPC Network Peering. Note that this field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the "bgp" message). These groups are advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups.
+        "A String",
+      ],
+      "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the "bgp" message). These IP ranges are advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.
+        { # Description-tagged IP ranges for the router to advertise.
+          "description": "A String", # User-specified description for the IP range.
+          "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.
         },
       ],
       "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. Where there is more than one matching route of maximum length, the routes with the lowest priority value win.
@@ -1608,10 +1979,10 @@ 

Method Details

"enable": "A String", # The status of the BGP peer connection. If set to FALSE, any active session with the peer is terminated and all associated routing information is removed. If set to TRUE, the peer connection can be established with routing information. The default is TRUE. "enableIpv4": True or False, # Enable IPv4 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 4. "enableIpv6": True or False, # Enable IPv6 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 6. - "exportPolicies": [ # List of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies. + "exportPolicies": [ # List of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type. "A String", ], - "importPolicies": [ # List of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies. + "importPolicies": [ # List of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type. "A String", ], "interfaceName": "A String", # Name of the interface the BGP peer is associated with. @@ -1838,6 +2209,160 @@

Method Details

}
+
+ patchRoutePolicy(project, region, router, body=None, requestId=None, x__xgafv=None) +
Patches Route Policy
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region for this request. (required)
+  router: string, Name of the Router resource where Route Policy is defined. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{
+  "description": "A String", # An optional description of route policy.
+  "fingerprint": "A String", # A fingerprint for the Route Policy being applied to this Router, which is essentially a hash of the Route Policy used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update Route Policy. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make a getRoutePolicy() request to retrieve a Route Policy.
+  "name": "A String", # Route Policy name, which must be a resource ID segment and unique within all the router's Route Policies. Name should conform to RFC1035.
+  "terms": [ # List of terms (the order in the list is not important, they are evaluated in order of priority). Order of policies is not retained and might change when getting policy later.
+    {
+      "actions": [ # CEL expressions to evaluate to modify a route when this term matches.
+        { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
+          "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+          "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+          "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+          "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+        },
+      ],
+      "match": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # CEL expression evaluated against a route to determine if this term applies. When not set, the term applies to all routes.
+        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+      },
+      "priority": 42, # The evaluation priority for this term, which must be between 0 (inclusive) and 2^31 (exclusive), and unique within the list.
+    },
+  ],
+  "type": "A String",
+}
+
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "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). # [Output Only] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "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.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the disk that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
+}
+
+
preview(project, region, router, body=None, x__xgafv=None)
Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router.
@@ -1893,10 +2418,10 @@ 

Method Details

"enable": "A String", # The status of the BGP peer connection. If set to FALSE, any active session with the peer is terminated and all associated routing information is removed. If set to TRUE, the peer connection can be established with routing information. The default is TRUE. "enableIpv4": True or False, # Enable IPv4 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 4. "enableIpv6": True or False, # Enable IPv6 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 6. - "exportPolicies": [ # List of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies. + "exportPolicies": [ # List of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type. "A String", ], - "importPolicies": [ # List of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies. + "importPolicies": [ # List of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type. "A String", ], "interfaceName": "A String", # Name of the interface the BGP peer is associated with. @@ -2059,10 +2584,10 @@

Method Details

"enable": "A String", # The status of the BGP peer connection. If set to FALSE, any active session with the peer is terminated and all associated routing information is removed. If set to TRUE, the peer connection can be established with routing information. The default is TRUE. "enableIpv4": True or False, # Enable IPv4 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 4. "enableIpv6": True or False, # Enable IPv6 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 6. - "exportPolicies": [ # List of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies. + "exportPolicies": [ # List of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type. "A String", ], - "importPolicies": [ # List of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies. + "importPolicies": [ # List of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type. "A String", ], "interfaceName": "A String", # Name of the interface the BGP peer is associated with. @@ -2229,10 +2754,10 @@

Method Details

"enable": "A String", # The status of the BGP peer connection. If set to FALSE, any active session with the peer is terminated and all associated routing information is removed. If set to TRUE, the peer connection can be established with routing information. The default is TRUE. "enableIpv4": True or False, # Enable IPv4 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 4. "enableIpv6": True or False, # Enable IPv6 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 6. - "exportPolicies": [ # List of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies. + "exportPolicies": [ # List of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type. "A String", ], - "importPolicies": [ # List of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies. + "importPolicies": [ # List of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type. "A String", ], "interfaceName": "A String", # Name of the interface the BGP peer is associated with. @@ -2459,4 +2984,158 @@

Method Details

}
+
+ updateRoutePolicy(project, region, router, body=None, requestId=None, x__xgafv=None) +
Updates or creates new Route Policy
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region for this request. (required)
+  router: string, Name of the Router resource where Route Policy is defined. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{
+  "description": "A String", # An optional description of route policy.
+  "fingerprint": "A String", # A fingerprint for the Route Policy being applied to this Router, which is essentially a hash of the Route Policy used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update Route Policy. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make a getRoutePolicy() request to retrieve a Route Policy.
+  "name": "A String", # Route Policy name, which must be a resource ID segment and unique within all the router's Route Policies. Name should conform to RFC1035.
+  "terms": [ # List of terms (the order in the list is not important, they are evaluated in order of priority). Order of policies is not retained and might change when getting policy later.
+    {
+      "actions": [ # CEL expressions to evaluate to modify a route when this term matches.
+        { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
+          "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+          "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+          "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+          "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+        },
+      ],
+      "match": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # CEL expression evaluated against a route to determine if this term applies. When not set, the term applies to all routes.
+        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+      },
+      "priority": 42, # The evaluation priority for this term, which must be between 0 (inclusive) and 2^31 (exclusive), and unique within the list.
+    },
+  ],
+  "type": "A String",
+}
+
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "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). # [Output Only] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "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.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the disk that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/compute_v1.snapshots.html b/docs/dyn/compute_v1.snapshots.html index 6f2b86a9c32..ee3d5ade428 100644 --- a/docs/dyn/compute_v1.snapshots.html +++ b/docs/dyn/compute_v1.snapshots.html @@ -307,7 +307,7 @@

Method Details

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. }, - "sourceInstantSnapshotId": "A String", # [Output Only] The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this persistent disk. For example, if you created the persistent disk from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used. + "sourceInstantSnapshotId": "A String", # [Output Only] The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this snapshot. For example, if you created the snapshot from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used. "sourceSnapshotSchedulePolicy": "A String", # [Output Only] URL of the resource policy which created this scheduled snapshot. "sourceSnapshotSchedulePolicyId": "A String", # [Output Only] ID of the resource policy which created this scheduled snapshot. "status": "A String", # [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING. @@ -435,7 +435,7 @@

Method Details

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. }, - "sourceInstantSnapshotId": "A String", # [Output Only] The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this persistent disk. For example, if you created the persistent disk from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used. + "sourceInstantSnapshotId": "A String", # [Output Only] The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this snapshot. For example, if you created the snapshot from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used. "sourceSnapshotSchedulePolicy": "A String", # [Output Only] URL of the resource policy which created this scheduled snapshot. "sourceSnapshotSchedulePolicyId": "A String", # [Output Only] ID of the resource policy which created this scheduled snapshot. "status": "A String", # [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING. @@ -643,7 +643,7 @@

Method Details

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. }, - "sourceInstantSnapshotId": "A String", # [Output Only] The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this persistent disk. For example, if you created the persistent disk from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used. + "sourceInstantSnapshotId": "A String", # [Output Only] The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this snapshot. For example, if you created the snapshot from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used. "sourceSnapshotSchedulePolicy": "A String", # [Output Only] URL of the resource policy which created this scheduled snapshot. "sourceSnapshotSchedulePolicyId": "A String", # [Output Only] ID of the resource policy which created this scheduled snapshot. "status": "A String", # [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING. diff --git a/docs/dyn/compute_v1.subnetworks.html b/docs/dyn/compute_v1.subnetworks.html index 1168795f43a..00017ceeb81 100644 --- a/docs/dyn/compute_v1.subnetworks.html +++ b/docs/dyn/compute_v1.subnetworks.html @@ -176,7 +176,7 @@

Method Details

"network": "A String", # The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. This field can be set only at resource creation time. "privateIpGoogleAccess": True or False, # Whether the VMs in this subnet can access Google services without assigned external IP addresses. This field can be both set at resource creation time and updated using setPrivateIpGoogleAccess. "privateIpv6GoogleAccess": "A String", # This field is for internal use. This field can be both set at resource creation time and updated using patch. - "purpose": "A String", # The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PEER_MIGRATION or PRIVATE_SERVICE_CONNECT. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to PEER_MIGRATION is used for subnet migration from one peered VPC to another. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. + "purpose": "A String", # The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PEER_MIGRATION, PRIVATE_SERVICE_CONNECT or PRIVATE_NAT. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to PEER_MIGRATION is used for subnet migration from one peered VPC to another. A subnet with purpose set to PRIVATE_NAT is used for Private NAT IP address by Private NAT Gateway. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. "region": "A String", # URL of the region where the Subnetwork resides. This field can be set only at resource creation time. "reservedInternalRange": "A String", # The URL of the reserved internal range. "role": "A String", # The role of subnetwork. Currently, this field is only used when purpose is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. The value can be set to ACTIVE or BACKUP. An ACTIVE subnetwork is one that is currently being used for Envoy-based load balancers in a region. A BACKUP subnetwork is one that is ready to be promoted to ACTIVE or is currently draining. This field can be updated with a patch request. @@ -542,7 +542,7 @@

Method Details

"network": "A String", # The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. This field can be set only at resource creation time. "privateIpGoogleAccess": True or False, # Whether the VMs in this subnet can access Google services without assigned external IP addresses. This field can be both set at resource creation time and updated using setPrivateIpGoogleAccess. "privateIpv6GoogleAccess": "A String", # This field is for internal use. This field can be both set at resource creation time and updated using patch. - "purpose": "A String", # The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PEER_MIGRATION or PRIVATE_SERVICE_CONNECT. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to PEER_MIGRATION is used for subnet migration from one peered VPC to another. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. + "purpose": "A String", # The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PEER_MIGRATION, PRIVATE_SERVICE_CONNECT or PRIVATE_NAT. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to PEER_MIGRATION is used for subnet migration from one peered VPC to another. A subnet with purpose set to PRIVATE_NAT is used for Private NAT IP address by Private NAT Gateway. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. "region": "A String", # URL of the region where the Subnetwork resides. This field can be set only at resource creation time. "reservedInternalRange": "A String", # The URL of the reserved internal range. "role": "A String", # The role of subnetwork. Currently, this field is only used when purpose is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. The value can be set to ACTIVE or BACKUP. An ACTIVE subnetwork is one that is currently being used for Envoy-based load balancers in a region. A BACKUP subnetwork is one that is ready to be promoted to ACTIVE or is currently draining. This field can be updated with a patch request. @@ -646,7 +646,7 @@

Method Details

"network": "A String", # The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. This field can be set only at resource creation time. "privateIpGoogleAccess": True or False, # Whether the VMs in this subnet can access Google services without assigned external IP addresses. This field can be both set at resource creation time and updated using setPrivateIpGoogleAccess. "privateIpv6GoogleAccess": "A String", # This field is for internal use. This field can be both set at resource creation time and updated using patch. - "purpose": "A String", # The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PEER_MIGRATION or PRIVATE_SERVICE_CONNECT. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to PEER_MIGRATION is used for subnet migration from one peered VPC to another. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. + "purpose": "A String", # The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PEER_MIGRATION, PRIVATE_SERVICE_CONNECT or PRIVATE_NAT. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to PEER_MIGRATION is used for subnet migration from one peered VPC to another. A subnet with purpose set to PRIVATE_NAT is used for Private NAT IP address by Private NAT Gateway. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. "region": "A String", # URL of the region where the Subnetwork resides. This field can be set only at resource creation time. "reservedInternalRange": "A String", # The URL of the reserved internal range. "role": "A String", # The role of subnetwork. Currently, this field is only used when purpose is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. The value can be set to ACTIVE or BACKUP. An ACTIVE subnetwork is one that is currently being used for Envoy-based load balancers in a region. A BACKUP subnetwork is one that is ready to be promoted to ACTIVE or is currently draining. This field can be updated with a patch request. @@ -829,7 +829,7 @@

Method Details

"network": "A String", # The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. This field can be set only at resource creation time. "privateIpGoogleAccess": True or False, # Whether the VMs in this subnet can access Google services without assigned external IP addresses. This field can be both set at resource creation time and updated using setPrivateIpGoogleAccess. "privateIpv6GoogleAccess": "A String", # This field is for internal use. This field can be both set at resource creation time and updated using patch. - "purpose": "A String", # The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PEER_MIGRATION or PRIVATE_SERVICE_CONNECT. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to PEER_MIGRATION is used for subnet migration from one peered VPC to another. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. + "purpose": "A String", # The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PEER_MIGRATION, PRIVATE_SERVICE_CONNECT or PRIVATE_NAT. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to PEER_MIGRATION is used for subnet migration from one peered VPC to another. A subnet with purpose set to PRIVATE_NAT is used for Private NAT IP address by Private NAT Gateway. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. "region": "A String", # URL of the region where the Subnetwork resides. This field can be set only at resource creation time. "reservedInternalRange": "A String", # The URL of the reserved internal range. "role": "A String", # The role of subnetwork. Currently, this field is only used when purpose is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. The value can be set to ACTIVE or BACKUP. An ACTIVE subnetwork is one that is currently being used for Envoy-based load balancers in a region. A BACKUP subnetwork is one that is ready to be promoted to ACTIVE or is currently draining. This field can be updated with a patch request. @@ -889,7 +889,7 @@

Method Details

"ipCidrRange": "A String", # The range of internal addresses that are owned by this subnetwork. "ipv6AccessType": "A String", # The access type of IPv6 address this subnet holds. It's immutable and can only be specified during creation or the first time the subnet is updated into IPV4_IPV6 dual stack. "network": "A String", # Network URL. - "purpose": "A String", # The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PEER_MIGRATION or PRIVATE_SERVICE_CONNECT. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to PEER_MIGRATION is used for subnet migration from one peered VPC to another. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. + "purpose": "A String", # The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PEER_MIGRATION, PRIVATE_SERVICE_CONNECT or PRIVATE_NAT. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to PEER_MIGRATION is used for subnet migration from one peered VPC to another. A subnet with purpose set to PRIVATE_NAT is used for Private NAT IP address by Private NAT Gateway. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. "role": "A String", # The role of subnetwork. Currently, this field is only used when purpose is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. The value can be set to ACTIVE or BACKUP. An ACTIVE subnetwork is one that is currently being used for Envoy-based load balancers in a region. A BACKUP subnetwork is one that is ready to be promoted to ACTIVE or is currently draining. This field can be updated with a patch request. "secondaryIpRanges": [ # Secondary IP ranges. { # Secondary IP range of a usable subnetwork. @@ -983,7 +983,7 @@

Method Details

"network": "A String", # The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. This field can be set only at resource creation time. "privateIpGoogleAccess": True or False, # Whether the VMs in this subnet can access Google services without assigned external IP addresses. This field can be both set at resource creation time and updated using setPrivateIpGoogleAccess. "privateIpv6GoogleAccess": "A String", # This field is for internal use. This field can be both set at resource creation time and updated using patch. - "purpose": "A String", # The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PEER_MIGRATION or PRIVATE_SERVICE_CONNECT. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to PEER_MIGRATION is used for subnet migration from one peered VPC to another. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. + "purpose": "A String", # The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PEER_MIGRATION, PRIVATE_SERVICE_CONNECT or PRIVATE_NAT. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to PEER_MIGRATION is used for subnet migration from one peered VPC to another. A subnet with purpose set to PRIVATE_NAT is used for Private NAT IP address by Private NAT Gateway. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. "region": "A String", # URL of the region where the Subnetwork resides. This field can be set only at resource creation time. "reservedInternalRange": "A String", # The URL of the reserved internal range. "role": "A String", # The role of subnetwork. Currently, this field is only used when purpose is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. The value can be set to ACTIVE or BACKUP. An ACTIVE subnetwork is one that is currently being used for Envoy-based load balancers in a region. A BACKUP subnetwork is one that is ready to be promoted to ACTIVE or is currently draining. This field can be updated with a patch request. diff --git a/googleapiclient/discovery_cache/documents/compute.alpha.json b/googleapiclient/discovery_cache/documents/compute.alpha.json index 282de2221c0..17e146a7fd4 100644 --- a/googleapiclient/discovery_cache/documents/compute.alpha.json +++ b/googleapiclient/discovery_cache/documents/compute.alpha.json @@ -3083,6 +3083,54 @@ "https://www.googleapis.com/auth/compute" ] }, +"bulkSetLabels": { +"description": "Sets the labels on many disks at once. To learn more about labels, read the Labeling Resources documentation.", +"flatPath": "projects/{project}/zones/{zone}/disks/bulkSetLabels", +"httpMethod": "POST", +"id": "compute.disks.bulkSetLabels", +"parameterOrder": [ +"project", +"zone" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"resource": { +"description": "Name or id of the resource for this request.", +"location": "query", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"type": "string" +}, +"zone": { +"description": "The name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/disks/bulkSetLabels", +"request": { +"$ref": "BulkZoneSetLabelsRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, "createSnapshot": { "description": "Creates a snapshot of a specified persistent disk. For regular snapshot creation, consider using snapshots.insert instead, as that method supports more features, such as creating snapshots in a project different from the source disk project.", "flatPath": "projects/{project}/zones/{zone}/disks/{disk}/createSnapshot", @@ -15382,6 +15430,43 @@ }, "interconnectAttachmentGroups": { "methods": { +"createMembers": { +"description": "Create Interconnect Attachments with redundancy by creating them in a specified interconnect attachment group.", +"flatPath": "projects/{project}/global/interconnectAttachmentGroups/{interconnectAttachmentGroup}/createMembers", +"httpMethod": "POST", +"id": "compute.interconnectAttachmentGroups.createMembers", +"parameterOrder": [ +"project", +"interconnectAttachmentGroup" +], +"parameters": { +"interconnectAttachmentGroup": { +"description": "Name of the group resource to create members for.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/global/interconnectAttachmentGroups/{interconnectAttachmentGroup}/createMembers", +"request": { +"$ref": "InterconnectAttachmentGroupsCreateMembersRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, "delete": { "description": "Deletes the specified InterconnectAttachmentGroup in the given scope", "flatPath": "projects/{project}/global/interconnectAttachmentGroups/{interconnectAttachmentGroup}", @@ -16288,7 +16373,7 @@ "$ref": "InterconnectGroupsCreateMembersRequest" }, "response": { -"$ref": "InterconnectGroupsCreateMembersResponse" +"$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -28075,23 +28160,89 @@ } } }, -"regionInstanceGroupManagerResizeRequests": { +"regionHealthSources": { "methods": { -"cancel": { -"description": "Cancels the specified resize request. Cancelled resize request no longer waits for the resources to be provisioned. Cancel is only possible for requests that are in accepted state.", -"flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}/cancel", -"httpMethod": "POST", -"id": "compute.regionInstanceGroupManagerResizeRequests.cancel", +"aggregatedList": { +"description": "Retrieves the list of all HealthSource resources (all regional) available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", +"flatPath": "projects/{project}/aggregated/healthSources", +"httpMethod": "GET", +"id": "compute.regionHealthSources.aggregatedList", +"parameterOrder": [ +"project" +], +"parameters": { +"filter": { +"description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", +"location": "query", +"type": "string" +}, +"includeAllScopes": { +"description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", +"location": "query", +"type": "boolean" +}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", +"location": "query", +"type": "string" +}, +"project": { +"description": "Name of the project scoping this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", +"location": "query", +"type": "boolean" +}, +"serviceProjectNumber": { +"description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", +"format": "int64", +"location": "query", +"type": "string" +} +}, +"path": "projects/{project}/aggregated/healthSources", +"response": { +"$ref": "HealthSourceAggregatedList" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"delete": { +"description": "Deletes the specified HealthSource in the given region", +"flatPath": "projects/{project}/regions/{region}/healthSources/{healthSource}", +"httpMethod": "DELETE", +"id": "compute.regionHealthSources.delete", "parameterOrder": [ "project", "region", -"instanceGroupManager", -"resizeRequest" +"healthSource" ], "parameters": { -"instanceGroupManager": { -"description": "The name of the managed instance group. Name should conform to RFC1035 or be a resource ID.", +"healthSource": { +"description": "Name of the HealthSource resource to delete.", "location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" }, @@ -28103,8 +28254,9 @@ "type": "string" }, "region": { -"description": "The name of the region scoping this request. Name should conform to RFC1035.", +"description": "Name of the region scoping this request.", "location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, @@ -28112,15 +28264,94 @@ "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" +} }, -"resizeRequest": { -"description": "The name of the resize request to cancel. Name should conform to RFC1035 or be a resource ID.", +"path": "projects/{project}/regions/{region}/healthSources/{healthSource}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"get": { +"description": "Returns the specified HealthSource resource in the given region.", +"flatPath": "projects/{project}/regions/{region}/healthSources/{healthSource}", +"httpMethod": "GET", +"id": "compute.regionHealthSources.get", +"parameterOrder": [ +"project", +"region", +"healthSource" +], +"parameters": { +"healthSource": { +"description": "Name of the HealthSource resource to return.", "location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "Name of the region scoping this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" } }, -"path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}/cancel", +"path": "projects/{project}/regions/{region}/healthSources/{healthSource}", +"response": { +"$ref": "HealthSource" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"insert": { +"description": "Create a HealthSource in the specified project in the given region using the parameters that are included in the request.", +"flatPath": "projects/{project}/regions/{region}/healthSources", +"httpMethod": "POST", +"id": "compute.regionHealthSources.insert", +"parameterOrder": [ +"project", +"region" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "Name of the region scoping this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/healthSources", +"request": { +"$ref": "HealthSource" +}, "response": { "$ref": "Operation" }, @@ -28129,20 +28360,82 @@ "https://www.googleapis.com/auth/compute" ] }, -"delete": { -"description": "Deletes the specified, inactive resize request. Requests that are still active cannot be deleted. Deleting request does not delete instances that were provisioned previously.", -"flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}", -"httpMethod": "DELETE", -"id": "compute.regionInstanceGroupManagerResizeRequests.delete", +"list": { +"description": "Lists the HealthSources for a project in the given region.", +"flatPath": "projects/{project}/regions/{region}/healthSources", +"httpMethod": "GET", +"id": "compute.regionHealthSources.list", +"parameterOrder": [ +"project", +"region" +], +"parameters": { +"filter": { +"description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", +"location": "query", +"type": "string" +}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", +"location": "query", +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "Name of the region scoping this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", +"location": "query", +"type": "boolean" +} +}, +"path": "projects/{project}/regions/{region}/healthSources", +"response": { +"$ref": "HealthSourceList" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"patch": { +"description": "Updates the specified regional HealthSource resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.", +"flatPath": "projects/{project}/regions/{region}/healthSources/{healthSource}", +"httpMethod": "PATCH", +"id": "compute.regionHealthSources.patch", "parameterOrder": [ "project", "region", -"instanceGroupManager", -"resizeRequest" +"healthSource" ], "parameters": { -"instanceGroupManager": { -"description": "The name of the managed instance group. Name should conform to RFC1035 or be a resource ID.", +"healthSource": { +"description": "Name of the HealthSource to update. The name must be 1-63 characters long, and comply with RFC1035.", "location": "path", "required": true, "type": "string" @@ -28155,8 +28448,9 @@ "type": "string" }, "region": { -"description": "The name of the region scoping this request. Name should conform to RFC1035.", +"description": "Name of the region scoping this request.", "location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, @@ -28164,28 +28458,179 @@ "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" +} }, -"resizeRequest": { -"description": "The name of the resize request to delete. Name should conform to RFC1035 or be a resource ID.", +"path": "projects/{project}/regions/{region}/healthSources/{healthSource}", +"request": { +"$ref": "HealthSource" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"testIamPermissions": { +"description": "Returns permissions that a caller has on the specified resource.", +"flatPath": "projects/{project}/regions/{region}/healthSources/{resource}/testIamPermissions", +"httpMethod": "POST", +"id": "compute.regionHealthSources.testIamPermissions", +"parameterOrder": [ +"project", +"region", +"resource" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "The name of the region for this request.", "location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"resource": { +"description": "Name or id of the resource for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, -"path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}", +"path": "projects/{project}/regions/{region}/healthSources/{resource}/testIamPermissions", +"request": { +"$ref": "TestPermissionsRequest" +}, "response": { -"$ref": "Operation" +"$ref": "TestPermissionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute" +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" ] +} +} }, -"get": { -"description": "Returns all of the details about the specified resize request.", -"flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}", -"httpMethod": "GET", -"id": "compute.regionInstanceGroupManagerResizeRequests.get", +"regionInstanceGroupManagerResizeRequests": { +"methods": { +"cancel": { +"description": "Cancels the specified resize request. Cancelled resize request no longer waits for the resources to be provisioned. Cancel is only possible for requests that are in accepted state.", +"flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}/cancel", +"httpMethod": "POST", +"id": "compute.regionInstanceGroupManagerResizeRequests.cancel", +"parameterOrder": [ +"project", +"region", +"instanceGroupManager", +"resizeRequest" +], +"parameters": { +"instanceGroupManager": { +"description": "The name of the managed instance group. Name should conform to RFC1035 or be a resource ID.", +"location": "path", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "The name of the region scoping this request. Name should conform to RFC1035.", +"location": "path", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"resizeRequest": { +"description": "The name of the resize request to cancel. Name should conform to RFC1035 or be a resource ID.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}/cancel", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"delete": { +"description": "Deletes the specified, inactive resize request. Requests that are still active cannot be deleted. Deleting request does not delete instances that were provisioned previously.", +"flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}", +"httpMethod": "DELETE", +"id": "compute.regionInstanceGroupManagerResizeRequests.delete", +"parameterOrder": [ +"project", +"region", +"instanceGroupManager", +"resizeRequest" +], +"parameters": { +"instanceGroupManager": { +"description": "The name of the managed instance group. Name should conform to RFC1035 or be a resource ID.", +"location": "path", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "The name of the region scoping this request. Name should conform to RFC1035.", +"location": "path", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"resizeRequest": { +"description": "The name of the resize request to delete. Name should conform to RFC1035 or be a resource ID.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"get": { +"description": "Returns all of the details about the specified resize request.", +"flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}", +"httpMethod": "GET", +"id": "compute.regionInstanceGroupManagerResizeRequests.get", "parameterOrder": [ "project", "region", @@ -30984,6 +31429,130 @@ } } }, +"regionMultiMigMembers": { +"methods": { +"get": { +"description": "Retrieves information about the specified multi-MIG member.", +"flatPath": "projects/{project}/regions/{region}/multiMigs/{multiMig}/multiMigMembers/{multiMigMember}", +"httpMethod": "GET", +"id": "compute.regionMultiMigMembers.get", +"parameterOrder": [ +"project", +"region", +"multiMig", +"multiMigMember" +], +"parameters": { +"multiMig": { +"description": "The name of the multi-MIG. Name should conform to RFC1035 or be a resource ID.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"multiMigMember": { +"description": "The name of the multi-MIG member. Name should conform to RFC1035 or be a resource ID.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "Name of the region for this request. Region name should conform to RFC1035.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/multiMigs/{multiMig}/multiMigMembers/{multiMigMember}", +"response": { +"$ref": "MultiMigMember" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"list": { +"description": "Retrieves a list of members of a specific multi-MIG.", +"flatPath": "projects/{project}/regions/{region}/multiMigs/{multiMig}/multiMigMembers", +"httpMethod": "GET", +"id": "compute.regionMultiMigMembers.list", +"parameterOrder": [ +"project", +"region", +"multiMig" +], +"parameters": { +"filter": { +"description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", +"location": "query", +"type": "string" +}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"multiMig": { +"description": "The name of the multi-MIG. Name should conform to RFC1035 or be a resource ID.", +"location": "path", +"required": true, +"type": "string" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", +"location": "query", +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"required": true, +"type": "string" +}, +"region": { +"description": "Name of the region for this request. Region name should conform to RFC1035.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", +"location": "query", +"type": "boolean" +} +}, +"path": "projects/{project}/regions/{region}/multiMigs/{multiMig}/multiMigMembers", +"response": { +"$ref": "MultiMigMemberList" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +} +} +}, "regionMultiMigs": { "methods": { "delete": { @@ -47636,7 +48205,7 @@ } } }, -"revision": "20250126", +"revision": "20250211", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -48992,14 +49561,18 @@ false "VM_FAMILY_CLOUD_TPU_DEVICE_CT3", "VM_FAMILY_CLOUD_TPU_LITE_DEVICE_CT5L", "VM_FAMILY_CLOUD_TPU_LITE_POD_SLICE_CT5LP", +"VM_FAMILY_CLOUD_TPU_LITE_POD_SLICE_CT6E", "VM_FAMILY_CLOUD_TPU_POD_SLICE_CT3P", -"VM_FAMILY_CLOUD_TPU_POD_SLICE_CT4P" +"VM_FAMILY_CLOUD_TPU_POD_SLICE_CT4P", +"VM_FAMILY_CLOUD_TPU_POD_SLICE_CT5P" ], "enumDescriptions": [ "", "", "", "", +"", +"", "" ], "type": "string" @@ -49070,6 +49643,10 @@ false "description": "[Output Only] Contains output only fields.", "id": "AllocationResourceStatus", "properties": { +"aggregateAllocation": { +"$ref": "AllocationResourceStatusAggregateAllocation", +"description": "Properties of this aggregatereservation." +}, "reservationBlockCount": { "description": "The number of reservation blocks associated with this reservation.", "format": "int32", @@ -49086,6 +49663,21 @@ false }, "type": "object" }, +"AllocationResourceStatusAggregateAllocation": { +"description": "Contains Properties set for the aggregate reservation.", +"id": "AllocationResourceStatusAggregateAllocation", +"properties": { +"utilizations": { +"additionalProperties": { +"format": "int64", +"type": "string" +}, +"description": "Per service utilization breakdown. The Key is the Google Cloud managed service name.", +"type": "object" +} +}, +"type": "object" +}, "AllocationResourceStatusSpecificSKUAllocation": { "description": "Contains Properties set for the reservation.", "id": "AllocationResourceStatusSpecificSKUAllocation", @@ -51092,7 +51684,7 @@ false "type": "number" }, "name": { -"description": "Name of a custom utilization signal. The name must be 1-24 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED.", +"description": "Name of a custom utilization signal. The name must be 1-64 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED.", "type": "string" } }, @@ -51797,7 +52389,7 @@ false "type": "boolean" }, "name": { -"description": "Name of a custom utilization signal. The name must be 1-24 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED.", +"description": "Name of a custom utilization signal. The name must be 1-64 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED.", "type": "string" } }, @@ -53125,6 +53717,36 @@ false }, "type": "object" }, +"BulkSetLabelsRequest": { +"id": "BulkSetLabelsRequest", +"properties": { +"labelFingerprint": { +"description": "The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You may optionally provide an up-to-date fingerprint hash in order to update or change labels. Make a get() request to the resource to get the latest fingerprint.", +"format": "byte", +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "The labels to set for this resource.", +"type": "object" +} +}, +"type": "object" +}, +"BulkZoneSetLabelsRequest": { +"id": "BulkZoneSetLabelsRequest", +"properties": { +"requests": { +"items": { +"$ref": "BulkSetLabelsRequest" +}, +"type": "array" +} +}, +"type": "object" +}, "BundledLocalSsds": { "id": "BundledLocalSsds", "properties": { @@ -53144,7 +53766,7 @@ false "id": "CacheInvalidationRule", "properties": { "cacheTags": { -"description": "Not implemented.", +"description": "A list of cache tags used to identify cached objects. - Cache tags are specified when the response is first cached, by setting the `Cache-Tag` response header at the origin. - Multiple cache tags in the same invalidation request are treated as Boolean `OR` - for example, `tag1 OR tag2 OR tag3`. - If other fields are also specified, these are treated as Boolean `AND` with any tags. Up to 10 tags can be specified in a single invalidation request.", "items": { "type": "string" }, @@ -55280,9 +55902,10 @@ false "id": "DiskPairReplicationState", "properties": { "dataReplicationState": { -"description": "[Output Only] The status of disk creation. - ASYNC_REPLICATION_STATE_INITIALIZING: The device is doing the initial replication after starting the replication. - ASYNC_REPLICATION_STATE_REPLICATING_HEALTHY: The primary disk is healthily replicating to the secondary device i.e. last_replication_time is within RPO. - ASYNC_REPLICATION_STATE_REPLICATING_BEHIND_HIGH_CHURN: The replication is lagging above the SLO limit due to some internal issue. - ASYNC_REPLICATION_STATE_REPLICATING_BEHIND_SYSTEM_LAGGING: The replication is lagging, and the RPO is not being met due to some internal issue. - ASYNC_REPLICATION_STATE_REPLICATION_STUCK: The replication is completely stuck due to some internal error. - ASYNC_REPLICATION_STATE_STOPPING: The replication is under the process of being stopped. This is a transient state. - ASYNC_REPLICATION_STATE_STOPPED: The replication between the disk-pairs have stopped. ", +"description": "[Output Only] The status of disk creation. - ASYNC_REPLICATION_STATE_INITIALIZING: The device is doing the initial replication after starting the replication. - ASYNC_REPLICATION_STATE_REPLICATING_HEALTHY: The primary disk is healthily replicating to the secondary device i.e. last_replication_time is within RPO. - ASYNC_REPLICATION_STATE_REPLICATING_BEHIND_HIGH_CHURN: The replication is lagging above the SLO limit due to the disk's change rate being above the supported limit. - ASYNC_REPLICATION_STATE_REPLICATING_BEHIND_SYSTEM_LAGGING: The replication is lagging, and the RPO is not being met due to some internal issue. - ASYNC_REPLICATION_STATE_REPLICATION_STUCK: The replication is completely stuck due to some internal error. - ASYNC_REPLICATION_STATE_STOPPING: The replication is under the process of being stopped. This is a transient state. - ASYNC_REPLICATION_STATE_STOPPED: The replication between the disk-pairs have stopped. - ASYNC_REPLICATION_STATE_REPLICATING_BEHIND_CG_HIGH_CHURN: The replication is lagging above the SLO limit for the disk in the consistency group due to disk's change rate being above the supported limit. ", "enum": [ "ASYNC_REPLICATION_STATE_INITIALIZING", +"ASYNC_REPLICATION_STATE_REPLICATING_BEHIND_CG_HIGH_CHURN", "ASYNC_REPLICATION_STATE_REPLICATING_BEHIND_HIGH_CHURN", "ASYNC_REPLICATION_STATE_REPLICATING_BEHIND_SYSTEM_LAGGING", "ASYNC_REPLICATION_STATE_REPLICATING_HEALTHY", @@ -55293,6 +55916,7 @@ false ], "enumDescriptions": [ "The device is doing the initial replication after starting the replication.", +"The replication is lagging behind (last_replication_time > RPO) for the disk in a consistency group because some other disk is writing the data at a rate above the supported limit.", "The replication is lagging behind (last_replication_time > RPO), because the disk's change rate is above the supported limit.", "The replication is lagging, and the RPO is not being met due to some internal issue.", "The primary disk is healthily replicating to the secondary device i.e. last_replication_time is within RPO.", @@ -55396,6 +56020,20 @@ false }, "description": "List of regions that can create a regional snapshot from the current region", "type": "object" +}, +"policy": { +"description": "Policy of which location is allowed to access snapshot.", +"enum": [ +"ALL_REGIONS", +"POLICY_UNSPECIFIED", +"SPECIFIC_REGIONS" +], +"enumDescriptions": [ +"Any regions will be able to access the source location.", +"", +"Only allowlisted regions will be able to create region scoped snapshots" +], +"type": "string" } }, "type": "object" @@ -59558,14 +60196,18 @@ false "VM_FAMILY_CLOUD_TPU_DEVICE_CT3", "VM_FAMILY_CLOUD_TPU_LITE_DEVICE_CT5L", "VM_FAMILY_CLOUD_TPU_LITE_POD_SLICE_CT5LP", +"VM_FAMILY_CLOUD_TPU_LITE_POD_SLICE_CT6E", "VM_FAMILY_CLOUD_TPU_POD_SLICE_CT3P", -"VM_FAMILY_CLOUD_TPU_POD_SLICE_CT4P" +"VM_FAMILY_CLOUD_TPU_POD_SLICE_CT4P", +"VM_FAMILY_CLOUD_TPU_POD_SLICE_CT5P" ], "enumDescriptions": [ "", "", "", "", +"", +"", "" ], "type": "string" @@ -61386,359 +62028,10 @@ false }, "type": "object" }, -"HealthStatus": { -"id": "HealthStatus", -"properties": { -"annotations": { -"additionalProperties": { -"type": "string" -}, -"description": "Metadata defined as annotations for network endpoint.", -"type": "object" -}, -"forwardingRule": { -"description": "URL of the forwarding rule associated with the health status of the instance.", -"type": "string" -}, -"forwardingRuleIp": { -"description": "A forwarding rule IP address assigned to this instance.", -"type": "string" -}, -"healthState": { -"description": "Health state of the IPv4 address of the instance.", -"enum": [ -"HEALTHY", -"UNHEALTHY" -], -"enumDescriptions": [ -"", -"" -], -"type": "string" -}, -"instance": { -"description": "URL of the instance resource.", -"type": "string" -}, -"ipAddress": { -"description": "For target pool based Network Load Balancing, it indicates the forwarding rule's IP address assigned to this instance. For other types of load balancing, the field indicates VM internal ip.", -"type": "string" -}, -"ipv6Address": { -"type": "string" -}, -"ipv6HealthState": { -"description": "Health state of the IPv6 address of the instance.", -"enum": [ -"HEALTHY", -"UNHEALTHY" -], -"enumDescriptions": [ -"", -"" -], -"type": "string" -}, -"port": { -"description": "The named port of the instance group, not necessarily the port that is health-checked.", -"format": "int32", -"type": "integer" -}, -"weight": { -"type": "string" -}, -"weightError": { -"enum": [ -"INVALID_WEIGHT", -"MISSING_WEIGHT", -"UNAVAILABLE_WEIGHT", -"WEIGHT_NONE" -], -"enumDescriptions": [ -"The response to a Health Check probe had the HTTP response header field X-Load-Balancing-Endpoint-Weight, but its content was invalid (i.e., not a non-negative single-precision floating-point number in decimal string representation).", -"The response to a Health Check probe did not have the HTTP response header field X-Load-Balancing-Endpoint-Weight.", -"This is the value when the accompanied health status is either TIMEOUT (i.e.,the Health Check probe was not able to get a response in time) or UNKNOWN. For the latter, it should be typically because there has not been sufficient time to parse and report the weight for a new backend (which is with 0.0.0.0 ip address). However, it can be also due to an outage case for which the health status is explicitly reset to UNKNOWN.", -"This is the default value when WeightReportMode is DISABLE, and is also the initial value when WeightReportMode has just updated to ENABLE or DRY_RUN and there has not been sufficient time to parse and report the backend weight." -], -"type": "string" -} -}, -"type": "object" -}, -"HealthStatusForNetworkEndpoint": { -"id": "HealthStatusForNetworkEndpoint", -"properties": { -"backendService": { -"$ref": "BackendServiceReference", -"description": "URL of the backend service associated with the health state of the network endpoint." -}, -"forwardingRule": { -"$ref": "ForwardingRuleReference", -"description": "URL of the forwarding rule associated with the health state of the network endpoint." -}, -"healthCheck": { -"$ref": "HealthCheckReference", -"description": "URL of the health check associated with the health state of the network endpoint." -}, -"healthCheckService": { -"$ref": "HealthCheckServiceReference", -"description": "URL of the health check service associated with the health state of the network endpoint." -}, -"healthState": { -"description": "Health state of the network endpoint determined based on the health checks configured.", -"enum": [ -"DRAINING", -"HEALTHY", -"UNHEALTHY", -"UNKNOWN" -], -"enumDescriptions": [ -"Endpoint is being drained.", -"Endpoint is healthy.", -"Endpoint is unhealthy.", -"Health status of the endpoint is unknown." -], -"type": "string" -}, -"ipv6HealthState": { -"description": "Health state of the ipv6 network endpoint determined based on the health checks configured.", -"enum": [ -"DRAINING", -"HEALTHY", -"UNHEALTHY", -"UNKNOWN" -], -"enumDescriptions": [ -"Endpoint is being drained.", -"Endpoint is healthy.", -"Endpoint is unhealthy.", -"Health status of the endpoint is unknown." -], -"type": "string" -} -}, -"type": "object" -}, -"Help": { -"description": "Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.", -"id": "Help", -"properties": { -"links": { -"description": "URL(s) pointing to additional information on handling the current error.", -"items": { -"$ref": "HelpLink" -}, -"type": "array" -} -}, -"type": "object" -}, -"HelpLink": { -"description": "Describes a URL link.", -"id": "HelpLink", -"properties": { -"description": { -"description": "Describes what the link offers.", -"type": "string" -}, -"url": { -"description": "The URL of the link.", -"type": "string" -} -}, -"type": "object" -}, -"HostRule": { -"description": "UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.", -"id": "HostRule", -"properties": { -"description": { -"description": "An optional description of this resource. Provide this property when you create the resource.", -"type": "string" -}, -"hosts": { -"description": "The list of host patterns to match. They must be valid hostnames with optional port numbers in the format host:port. * matches any string of ([a-z0-9-.]*). In that case, * must be the first character, and if followed by anything, the immediate following character must be either - or .. * based matching is not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.", -"items": { -"type": "string" -}, -"type": "array" -}, -"pathMatcher": { -"description": "The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.", -"type": "string" -} -}, -"type": "object" -}, -"HttpFaultAbort": { -"description": "Specification for how requests are aborted as part of fault injection.", -"id": "HttpFaultAbort", -"properties": { -"httpStatus": { -"description": "The HTTP status code used to abort the request. The value must be from 200 to 599 inclusive. For gRPC protocol, the gRPC status code is mapped to HTTP status code according to this mapping table. HTTP status 200 is mapped to gRPC status UNKNOWN. Injecting an OK status is currently not supported by Traffic Director.", -"format": "uint32", -"type": "integer" -}, -"percentage": { -"description": "The percentage of traffic for connections, operations, or requests that is aborted as part of fault injection. The value must be from 0.0 to 100.0 inclusive.", -"format": "double", -"type": "number" -} -}, -"type": "object" -}, -"HttpFaultDelay": { -"description": "Specifies the delay introduced by the load balancer before forwarding the request to the backend service as part of fault injection.", -"id": "HttpFaultDelay", -"properties": { -"fixedDelay": { -"$ref": "Duration", -"description": "Specifies the value of the fixed delay interval." -}, -"percentage": { -"description": "The percentage of traffic for connections, operations, or requests for which a delay is introduced as part of fault injection. The value must be from 0.0 to 100.0 inclusive.", -"format": "double", -"type": "number" -} -}, -"type": "object" -}, -"HttpFaultInjection": { -"description": "The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by the load balancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the load balancer for a percentage of requests.", -"id": "HttpFaultInjection", -"properties": { -"abort": { -"$ref": "HttpFaultAbort", -"description": "The specification for how client requests are aborted as part of fault injection." -}, -"delay": { -"$ref": "HttpFaultDelay", -"description": "The specification for how client requests are delayed as part of fault injection, before being sent to a backend service." -} -}, -"type": "object" -}, -"HttpFilterConfig": { -"description": "HttpFilterConfiguration supplies additional contextual settings for networkservices.HttpFilter resources enabled by Traffic Director.", -"id": "HttpFilterConfig", -"properties": { -"config": { -"description": "The configuration needed to enable the networkservices.HttpFilter resource. The configuration must be YAML formatted and only contain fields defined in the protobuf identified in configTypeUrl", -"type": "string" -}, -"configTypeUrl": { -"description": "The fully qualified versioned proto3 type url of the protobuf that the filter expects for its contextual settings, for example: type.googleapis.com/google.protobuf.Struct", -"type": "string" -}, -"filterName": { -"description": "Name of the networkservices.HttpFilter resource this configuration belongs to. This name must be known to the xDS client. Example: envoy.wasm", -"type": "string" -} -}, -"type": "object" -}, -"HttpHeaderAction": { -"description": "The request and response header transformations that take effect before the request is passed along to the selected backendService.", -"id": "HttpHeaderAction", -"properties": { -"requestHeadersToAdd": { -"description": "Headers to add to a matching request before forwarding the request to the backendService.", -"items": { -"$ref": "HttpHeaderOption" -}, -"type": "array" -}, -"requestHeadersToRemove": { -"description": "A list of header names for headers that need to be removed from the request before forwarding the request to the backendService.", -"items": { -"type": "string" -}, -"type": "array" -}, -"responseHeadersToAdd": { -"description": "Headers to add the response before sending the response back to the client.", -"items": { -"$ref": "HttpHeaderOption" -}, -"type": "array" -}, -"responseHeadersToRemove": { -"description": "A list of header names for headers that need to be removed from the response before sending the response back to the client.", -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, -"HttpHeaderMatch": { -"description": "matchRule criteria for request header matches.", -"id": "HttpHeaderMatch", -"properties": { -"exactMatch": { -"description": "The value should exactly match contents of exactMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.", -"type": "string" -}, -"headerName": { -"description": "The name of the HTTP header to match. For matching against the HTTP request's authority, use a headerMatch with the header name \":authority\". For matching a request's method, use the headerName \":method\". When the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true, only non-binary user-specified custom metadata and the `content-type` header are supported. The following transport-level headers cannot be used in header matching rules: `:authority`, `:method`, `:path`, `:scheme`, `user-agent`, `accept-encoding`, `content-encoding`, `grpc-accept-encoding`, `grpc-encoding`, `grpc-previous-rpc-attempts`, `grpc-tags-bin`, `grpc-timeout` and `grpc-trace-bin`.", -"type": "string" -}, -"invertMatch": { -"description": "If set to false, the headerMatch is considered a match if the preceding match criteria are met. If set to true, the headerMatch is considered a match if the preceding match criteria are NOT met. The default setting is false. ", -"type": "boolean" -}, -"prefixMatch": { -"description": "The value of the header must start with the contents of prefixMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.", -"type": "string" -}, -"presentMatch": { -"description": "A header with the contents of headerName must exist. The match takes place whether or not the request's header has a value. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.", -"type": "boolean" -}, -"rangeMatch": { -"$ref": "Int64RangeMatch", -"description": "The header value must be an integer and its value must be in the range specified in rangeMatch. If the header does not contain an integer, number or is empty, the match fails. For example for a range [-5, 0] - -3 will match. - 0 will not match. - 0.25 will not match. - -3someString will not match. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. rangeMatch is not supported for load balancers that have loadBalancingScheme set to EXTERNAL." -}, -"regexMatch": { -"description": "The value of the header must match the regular expression specified in regexMatch. For more information about regular expression syntax, see Syntax. For matching against a port specified in the HTTP request, use a headerMatch with headerName set to PORT and a regular expression that satisfies the RFC2616 Host header's port specifier. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. Regular expressions can only be used when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.", -"type": "string" -}, -"suffixMatch": { -"description": "The value of the header must end with the contents of suffixMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.", -"type": "string" -} -}, -"type": "object" -}, -"HttpHeaderOption": { -"description": "Specification determining how headers are added to requests or responses.", -"id": "HttpHeaderOption", -"properties": { -"headerName": { -"description": "The name of the header.", -"type": "string" -}, -"headerValue": { -"description": "The value of the header to add.", -"type": "string" -}, -"replace": { -"description": "If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false. ", -"type": "boolean" -} -}, -"type": "object" -}, -"HttpHealthCheck": { -"description": "Represents a legacy HTTP Health Check resource. Legacy HTTP health checks are now only required by target pool-based network load balancers. For all other load balancers, including backend service-based network load balancers, and for managed instance group auto-healing, you must use modern (non-legacy) health checks. For more information, see Health checks overview .", -"id": "HttpHealthCheck", +"HealthSource": { +"description": "Represents a health source. A health source resource specifies the source resources and the health aggregation policy applied to the source resources to determine the aggregated health status.", +"id": "HealthSource", "properties": { -"checkIntervalSec": { -"description": "How often (in seconds) to send a health check. The default value is 5 seconds.", -"format": "int32", -"type": "integer" -}, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" @@ -61747,23 +62040,23 @@ false "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, -"healthyThreshold": { -"description": "A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.", -"format": "int32", -"type": "integer" +"fingerprint": { +"description": "Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a HealthSource. An up-to-date fingerprint must be provided in order to patch the HealthSource; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the HealthSource.", +"format": "byte", +"type": "string" }, -"host": { -"description": "The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.", +"healthAggregationPolicy": { +"description": "URL to the HealthAggregationPolicy resource. Must be set. Must be regional and in the same region as the HealthSource. Can be mutated.", "type": "string" }, "id": { -"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", +"description": "[Output Only] A unique identifier for this resource type. The server generates this identifier.", "format": "uint64", "type": "string" }, "kind": { -"default": "compute#httpHealthCheck", -"description": "[Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.", +"default": "compute#healthSource", +"description": "[Output Only] Type of the resource. Always compute#healthSource for health sources.", "type": "string" }, "name": { @@ -61771,13 +62064,8 @@ false "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, -"port": { -"description": "The TCP port number for the HTTP health check request. The default value is 80.", -"format": "int32", -"type": "integer" -}, -"requestPath": { -"description": "The request path of the HTTP health check request. The default value is /. This field does not support query parameters. Must comply with RFC3986.", +"region": { +"description": "[Output Only] URL of the region where the health source resides. This field applies only to the regional resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", "type": "string" }, "selfLink": { @@ -61785,39 +62073,928 @@ false "type": "string" }, "selfLinkWithId": { -"description": "[Output Only] Server-defined URL for this resource with the resource id.", +"description": "[Output Only] Server-defined URL with id for the resource.", "type": "string" }, -"timeoutSec": { -"description": "How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.", -"format": "int32", -"type": "integer" +"sourceType": { +"description": "Specifies the type of the HealthSource. The only allowed value is BACKEND_SERVICE. Must be specified when the HealthSource is created, and cannot be mutated.", +"enum": [ +"BACKEND_SERVICE" +], +"enumDescriptions": [ +"" +], +"type": "string" }, -"unhealthyThreshold": { -"description": "A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.", -"format": "int32", -"type": "integer" +"sources": { +"description": "URLs to the source resources. Must be size 1. Must be a BackendService if the sourceType is BACKEND_SERVICE. The BackendService must have load balancing scheme INTERNAL or INTERNAL_MANAGED and must be regional and in the same region as the HealthSource (cross-region deployment for INTERNAL_MANAGED is not supported). The BackendService may use only IGs, MIGs, or NEGs of type GCE_VM_IP or GCE_VM_IP_PORT. The BackendService may not use haPolicy. Can be mutated.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" }, -"HttpHealthCheckList": { -"description": "Contains a list of HttpHealthCheck resources.", -"id": "HttpHealthCheckList", +"HealthSourceAggregatedList": { +"description": "Contains a list of HealthSourcesScopedList.", +"id": "HealthSourceAggregatedList", "properties": { +"etag": { +"type": "string" +}, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { -"description": "A list of HttpHealthCheck resources.", -"items": { -"$ref": "HttpHealthCheck" +"additionalProperties": { +"$ref": "HealthSourcesScopedList", +"description": "Name of the scope containing this set of HealthSources." }, -"type": "array" +"description": "A list of HealthSourcesScopedList resources.", +"type": "object" }, "kind": { -"default": "compute#httpHealthCheckList", +"default": "compute#healthSourceAggregatedList", +"description": "Type of resource.", +"type": "string" +}, +"nextPageToken": { +"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", +"type": "string" +}, +"selfLink": { +"description": "[Output Only] Server-defined URL for this resource.", +"type": "string" +}, +"unreachables": { +"description": "[Output Only] Unreachable resources.", +"items": { +"type": "string" +}, +"type": "array" +}, +"warning": { +"description": "[Output Only] Informational warning message.", +"properties": { +"code": { +"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", +"enum": [ +"CLEANUP_FAILED", +"DEPRECATED_RESOURCE_USED", +"DEPRECATED_TYPE_USED", +"DISK_SIZE_LARGER_THAN_IMAGE_SIZE", +"EXPERIMENTAL_TYPE_USED", +"EXTERNAL_API_WARNING", +"FIELD_VALUE_OVERRIDEN", +"INJECTED_KERNELS_DEPRECATED", +"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", +"LARGE_DEPLOYMENT_WARNING", +"LIST_OVERHEAD_QUOTA_EXCEED", +"MISSING_TYPE_DEPENDENCY", +"NEXT_HOP_ADDRESS_NOT_ASSIGNED", +"NEXT_HOP_CANNOT_IP_FORWARD", +"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", +"NEXT_HOP_INSTANCE_NOT_FOUND", +"NEXT_HOP_INSTANCE_NOT_ON_NETWORK", +"NEXT_HOP_NOT_RUNNING", +"NOT_CRITICAL_ERROR", +"NO_RESULTS_ON_PAGE", +"PARTIAL_SUCCESS", +"QUOTA_INFO_UNAVAILABLE", +"REQUIRED_TOS_AGREEMENT", +"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", +"RESOURCE_NOT_DELETED", +"SCHEMA_VALIDATION_IGNORED", +"SINGLE_INSTANCE_PROPERTY_TEMPLATE", +"UNDECLARED_PROPERTIES", +"UNREACHABLE" +], +"enumDeprecated": [ +false, +false, +false, +false, +false, +false, +true, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false +], +"enumDescriptions": [ +"Warning about failed cleanup of transient changes made by a failed operation.", +"A link to a deprecated resource was created.", +"When deploying and at least one of the resources has a type marked as deprecated", +"The user created a boot disk that is larger than image size.", +"When deploying and at least one of the resources has a type marked as experimental", +"Warning that is present in an external api call", +"Warning that value of a field has been overridden. Deprecated unused field.", +"The operation involved use of an injected kernel, which is deprecated.", +"A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", +"When deploying a deployment with a exceedingly large number of resources", +"Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", +"A resource depends on a missing type", +"The route's nextHopIp address is not assigned to an instance on the network.", +"The route's next hop instance cannot ip forward.", +"The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", +"The route's nextHopInstance URL refers to an instance that does not exist.", +"The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", +"The route's next hop instance does not have a status of RUNNING.", +"Error which is not critical. We decided to continue the process despite the mentioned error.", +"No results are present on a particular list page.", +"Success is reported, but some results may be missing due to errors", +"Quota information is not available to client requests (e.g: regions.list).", +"The user attempted to use a resource that requires a TOS they have not accepted.", +"Warning that a resource is in use.", +"One or more of the resources set to auto-delete could not be deleted because they were in use.", +"When a resource schema validation is ignored.", +"Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", +"When undeclared properties in the schema are present", +"A given scope cannot be reached." +], +"type": "string" +}, +"data": { +"description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", +"items": { +"properties": { +"key": { +"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", +"type": "string" +}, +"value": { +"description": "[Output Only] A warning data value corresponding to the key.", +"type": "string" +} +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "[Output Only] A human-readable description of the warning code.", +"type": "string" +} +}, +"type": "object" +} +}, +"type": "object" +}, +"HealthSourceList": { +"id": "HealthSourceList", +"properties": { +"etag": { +"type": "string" +}, +"id": { +"description": "[Output Only] Unique identifier for the resource; defined by the server.", +"type": "string" +}, +"items": { +"description": "A list of HealthSource resources.", +"items": { +"$ref": "HealthSource" +}, +"type": "array" +}, +"kind": { +"default": "compute#healthSourceList", +"description": "[Output Only] Type of the resource. Always compute#healthSource for health sources.", +"type": "string" +}, +"nextPageToken": { +"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", +"type": "string" +}, +"selfLink": { +"description": "[Output Only] Server-defined URL for this resource.", +"type": "string" +}, +"unreachables": { +"description": "[Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder", +"items": { +"type": "string" +}, +"type": "array" +}, +"warning": { +"description": "[Output Only] Informational warning message.", +"properties": { +"code": { +"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", +"enum": [ +"CLEANUP_FAILED", +"DEPRECATED_RESOURCE_USED", +"DEPRECATED_TYPE_USED", +"DISK_SIZE_LARGER_THAN_IMAGE_SIZE", +"EXPERIMENTAL_TYPE_USED", +"EXTERNAL_API_WARNING", +"FIELD_VALUE_OVERRIDEN", +"INJECTED_KERNELS_DEPRECATED", +"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", +"LARGE_DEPLOYMENT_WARNING", +"LIST_OVERHEAD_QUOTA_EXCEED", +"MISSING_TYPE_DEPENDENCY", +"NEXT_HOP_ADDRESS_NOT_ASSIGNED", +"NEXT_HOP_CANNOT_IP_FORWARD", +"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", +"NEXT_HOP_INSTANCE_NOT_FOUND", +"NEXT_HOP_INSTANCE_NOT_ON_NETWORK", +"NEXT_HOP_NOT_RUNNING", +"NOT_CRITICAL_ERROR", +"NO_RESULTS_ON_PAGE", +"PARTIAL_SUCCESS", +"QUOTA_INFO_UNAVAILABLE", +"REQUIRED_TOS_AGREEMENT", +"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", +"RESOURCE_NOT_DELETED", +"SCHEMA_VALIDATION_IGNORED", +"SINGLE_INSTANCE_PROPERTY_TEMPLATE", +"UNDECLARED_PROPERTIES", +"UNREACHABLE" +], +"enumDeprecated": [ +false, +false, +false, +false, +false, +false, +true, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false +], +"enumDescriptions": [ +"Warning about failed cleanup of transient changes made by a failed operation.", +"A link to a deprecated resource was created.", +"When deploying and at least one of the resources has a type marked as deprecated", +"The user created a boot disk that is larger than image size.", +"When deploying and at least one of the resources has a type marked as experimental", +"Warning that is present in an external api call", +"Warning that value of a field has been overridden. Deprecated unused field.", +"The operation involved use of an injected kernel, which is deprecated.", +"A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", +"When deploying a deployment with a exceedingly large number of resources", +"Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", +"A resource depends on a missing type", +"The route's nextHopIp address is not assigned to an instance on the network.", +"The route's next hop instance cannot ip forward.", +"The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", +"The route's nextHopInstance URL refers to an instance that does not exist.", +"The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", +"The route's next hop instance does not have a status of RUNNING.", +"Error which is not critical. We decided to continue the process despite the mentioned error.", +"No results are present on a particular list page.", +"Success is reported, but some results may be missing due to errors", +"Quota information is not available to client requests (e.g: regions.list).", +"The user attempted to use a resource that requires a TOS they have not accepted.", +"Warning that a resource is in use.", +"One or more of the resources set to auto-delete could not be deleted because they were in use.", +"When a resource schema validation is ignored.", +"Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", +"When undeclared properties in the schema are present", +"A given scope cannot be reached." +], +"type": "string" +}, +"data": { +"description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", +"items": { +"properties": { +"key": { +"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", +"type": "string" +}, +"value": { +"description": "[Output Only] A warning data value corresponding to the key.", +"type": "string" +} +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "[Output Only] A human-readable description of the warning code.", +"type": "string" +} +}, +"type": "object" +} +}, +"type": "object" +}, +"HealthSourcesScopedList": { +"id": "HealthSourcesScopedList", +"properties": { +"resources": { +"description": "A list of HealthSources contained in this scope.", +"items": { +"$ref": "HealthSource" +}, +"type": "array" +}, +"warning": { +"description": "Informational warning which replaces the list of health sources when the list is empty.", +"properties": { +"code": { +"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", +"enum": [ +"CLEANUP_FAILED", +"DEPRECATED_RESOURCE_USED", +"DEPRECATED_TYPE_USED", +"DISK_SIZE_LARGER_THAN_IMAGE_SIZE", +"EXPERIMENTAL_TYPE_USED", +"EXTERNAL_API_WARNING", +"FIELD_VALUE_OVERRIDEN", +"INJECTED_KERNELS_DEPRECATED", +"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", +"LARGE_DEPLOYMENT_WARNING", +"LIST_OVERHEAD_QUOTA_EXCEED", +"MISSING_TYPE_DEPENDENCY", +"NEXT_HOP_ADDRESS_NOT_ASSIGNED", +"NEXT_HOP_CANNOT_IP_FORWARD", +"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", +"NEXT_HOP_INSTANCE_NOT_FOUND", +"NEXT_HOP_INSTANCE_NOT_ON_NETWORK", +"NEXT_HOP_NOT_RUNNING", +"NOT_CRITICAL_ERROR", +"NO_RESULTS_ON_PAGE", +"PARTIAL_SUCCESS", +"QUOTA_INFO_UNAVAILABLE", +"REQUIRED_TOS_AGREEMENT", +"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", +"RESOURCE_NOT_DELETED", +"SCHEMA_VALIDATION_IGNORED", +"SINGLE_INSTANCE_PROPERTY_TEMPLATE", +"UNDECLARED_PROPERTIES", +"UNREACHABLE" +], +"enumDeprecated": [ +false, +false, +false, +false, +false, +false, +true, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false +], +"enumDescriptions": [ +"Warning about failed cleanup of transient changes made by a failed operation.", +"A link to a deprecated resource was created.", +"When deploying and at least one of the resources has a type marked as deprecated", +"The user created a boot disk that is larger than image size.", +"When deploying and at least one of the resources has a type marked as experimental", +"Warning that is present in an external api call", +"Warning that value of a field has been overridden. Deprecated unused field.", +"The operation involved use of an injected kernel, which is deprecated.", +"A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", +"When deploying a deployment with a exceedingly large number of resources", +"Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", +"A resource depends on a missing type", +"The route's nextHopIp address is not assigned to an instance on the network.", +"The route's next hop instance cannot ip forward.", +"The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", +"The route's nextHopInstance URL refers to an instance that does not exist.", +"The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", +"The route's next hop instance does not have a status of RUNNING.", +"Error which is not critical. We decided to continue the process despite the mentioned error.", +"No results are present on a particular list page.", +"Success is reported, but some results may be missing due to errors", +"Quota information is not available to client requests (e.g: regions.list).", +"The user attempted to use a resource that requires a TOS they have not accepted.", +"Warning that a resource is in use.", +"One or more of the resources set to auto-delete could not be deleted because they were in use.", +"When a resource schema validation is ignored.", +"Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", +"When undeclared properties in the schema are present", +"A given scope cannot be reached." +], +"type": "string" +}, +"data": { +"description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", +"items": { +"properties": { +"key": { +"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", +"type": "string" +}, +"value": { +"description": "[Output Only] A warning data value corresponding to the key.", +"type": "string" +} +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "[Output Only] A human-readable description of the warning code.", +"type": "string" +} +}, +"type": "object" +} +}, +"type": "object" +}, +"HealthStatus": { +"id": "HealthStatus", +"properties": { +"annotations": { +"additionalProperties": { +"type": "string" +}, +"description": "Metadata defined as annotations for network endpoint.", +"type": "object" +}, +"forwardingRule": { +"description": "URL of the forwarding rule associated with the health status of the instance.", +"type": "string" +}, +"forwardingRuleIp": { +"description": "A forwarding rule IP address assigned to this instance.", +"type": "string" +}, +"healthState": { +"description": "Health state of the IPv4 address of the instance.", +"enum": [ +"HEALTHY", +"UNHEALTHY" +], +"enumDescriptions": [ +"", +"" +], +"type": "string" +}, +"instance": { +"description": "URL of the instance resource.", +"type": "string" +}, +"ipAddress": { +"description": "For target pool based Network Load Balancing, it indicates the forwarding rule's IP address assigned to this instance. For other types of load balancing, the field indicates VM internal ip.", +"type": "string" +}, +"ipv6Address": { +"type": "string" +}, +"ipv6HealthState": { +"description": "Health state of the IPv6 address of the instance.", +"enum": [ +"HEALTHY", +"UNHEALTHY" +], +"enumDescriptions": [ +"", +"" +], +"type": "string" +}, +"port": { +"description": "The named port of the instance group, not necessarily the port that is health-checked.", +"format": "int32", +"type": "integer" +}, +"weight": { +"type": "string" +}, +"weightError": { +"enum": [ +"INVALID_WEIGHT", +"MISSING_WEIGHT", +"UNAVAILABLE_WEIGHT", +"WEIGHT_NONE" +], +"enumDescriptions": [ +"The response to a Health Check probe had the HTTP response header field X-Load-Balancing-Endpoint-Weight, but its content was invalid (i.e., not a non-negative single-precision floating-point number in decimal string representation).", +"The response to a Health Check probe did not have the HTTP response header field X-Load-Balancing-Endpoint-Weight.", +"This is the value when the accompanied health status is either TIMEOUT (i.e.,the Health Check probe was not able to get a response in time) or UNKNOWN. For the latter, it should be typically because there has not been sufficient time to parse and report the weight for a new backend (which is with 0.0.0.0 ip address). However, it can be also due to an outage case for which the health status is explicitly reset to UNKNOWN.", +"This is the default value when WeightReportMode is DISABLE, and is also the initial value when WeightReportMode has just updated to ENABLE or DRY_RUN and there has not been sufficient time to parse and report the backend weight." +], +"type": "string" +} +}, +"type": "object" +}, +"HealthStatusForNetworkEndpoint": { +"id": "HealthStatusForNetworkEndpoint", +"properties": { +"backendService": { +"$ref": "BackendServiceReference", +"description": "URL of the backend service associated with the health state of the network endpoint." +}, +"forwardingRule": { +"$ref": "ForwardingRuleReference", +"description": "URL of the forwarding rule associated with the health state of the network endpoint." +}, +"healthCheck": { +"$ref": "HealthCheckReference", +"description": "URL of the health check associated with the health state of the network endpoint." +}, +"healthCheckService": { +"$ref": "HealthCheckServiceReference", +"description": "URL of the health check service associated with the health state of the network endpoint." +}, +"healthState": { +"description": "Health state of the network endpoint determined based on the health checks configured.", +"enum": [ +"DRAINING", +"HEALTHY", +"UNHEALTHY", +"UNKNOWN" +], +"enumDescriptions": [ +"Endpoint is being drained.", +"Endpoint is healthy.", +"Endpoint is unhealthy.", +"Health status of the endpoint is unknown." +], +"type": "string" +}, +"ipv6HealthState": { +"description": "Health state of the ipv6 network endpoint determined based on the health checks configured.", +"enum": [ +"DRAINING", +"HEALTHY", +"UNHEALTHY", +"UNKNOWN" +], +"enumDescriptions": [ +"Endpoint is being drained.", +"Endpoint is healthy.", +"Endpoint is unhealthy.", +"Health status of the endpoint is unknown." +], +"type": "string" +} +}, +"type": "object" +}, +"Help": { +"description": "Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.", +"id": "Help", +"properties": { +"links": { +"description": "URL(s) pointing to additional information on handling the current error.", +"items": { +"$ref": "HelpLink" +}, +"type": "array" +} +}, +"type": "object" +}, +"HelpLink": { +"description": "Describes a URL link.", +"id": "HelpLink", +"properties": { +"description": { +"description": "Describes what the link offers.", +"type": "string" +}, +"url": { +"description": "The URL of the link.", +"type": "string" +} +}, +"type": "object" +}, +"HostRule": { +"description": "UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.", +"id": "HostRule", +"properties": { +"description": { +"description": "An optional description of this resource. Provide this property when you create the resource.", +"type": "string" +}, +"hosts": { +"description": "The list of host patterns to match. They must be valid hostnames with optional port numbers in the format host:port. * matches any string of ([a-z0-9-.]*). In that case, * must be the first character, and if followed by anything, the immediate following character must be either - or .. * based matching is not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.", +"items": { +"type": "string" +}, +"type": "array" +}, +"pathMatcher": { +"description": "The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.", +"type": "string" +} +}, +"type": "object" +}, +"HttpFaultAbort": { +"description": "Specification for how requests are aborted as part of fault injection.", +"id": "HttpFaultAbort", +"properties": { +"httpStatus": { +"description": "The HTTP status code used to abort the request. The value must be from 200 to 599 inclusive. For gRPC protocol, the gRPC status code is mapped to HTTP status code according to this mapping table. HTTP status 200 is mapped to gRPC status UNKNOWN. Injecting an OK status is currently not supported by Traffic Director.", +"format": "uint32", +"type": "integer" +}, +"percentage": { +"description": "The percentage of traffic for connections, operations, or requests that is aborted as part of fault injection. The value must be from 0.0 to 100.0 inclusive.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"HttpFaultDelay": { +"description": "Specifies the delay introduced by the load balancer before forwarding the request to the backend service as part of fault injection.", +"id": "HttpFaultDelay", +"properties": { +"fixedDelay": { +"$ref": "Duration", +"description": "Specifies the value of the fixed delay interval." +}, +"percentage": { +"description": "The percentage of traffic for connections, operations, or requests for which a delay is introduced as part of fault injection. The value must be from 0.0 to 100.0 inclusive.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"HttpFaultInjection": { +"description": "The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by the load balancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the load balancer for a percentage of requests.", +"id": "HttpFaultInjection", +"properties": { +"abort": { +"$ref": "HttpFaultAbort", +"description": "The specification for how client requests are aborted as part of fault injection." +}, +"delay": { +"$ref": "HttpFaultDelay", +"description": "The specification for how client requests are delayed as part of fault injection, before being sent to a backend service." +} +}, +"type": "object" +}, +"HttpFilterConfig": { +"description": "HttpFilterConfiguration supplies additional contextual settings for networkservices.HttpFilter resources enabled by Traffic Director.", +"id": "HttpFilterConfig", +"properties": { +"config": { +"description": "The configuration needed to enable the networkservices.HttpFilter resource. The configuration must be YAML formatted and only contain fields defined in the protobuf identified in configTypeUrl", +"type": "string" +}, +"configTypeUrl": { +"description": "The fully qualified versioned proto3 type url of the protobuf that the filter expects for its contextual settings, for example: type.googleapis.com/google.protobuf.Struct", +"type": "string" +}, +"filterName": { +"description": "Name of the networkservices.HttpFilter resource this configuration belongs to. This name must be known to the xDS client. Example: envoy.wasm", +"type": "string" +} +}, +"type": "object" +}, +"HttpHeaderAction": { +"description": "The request and response header transformations that take effect before the request is passed along to the selected backendService.", +"id": "HttpHeaderAction", +"properties": { +"requestHeadersToAdd": { +"description": "Headers to add to a matching request before forwarding the request to the backendService.", +"items": { +"$ref": "HttpHeaderOption" +}, +"type": "array" +}, +"requestHeadersToRemove": { +"description": "A list of header names for headers that need to be removed from the request before forwarding the request to the backendService.", +"items": { +"type": "string" +}, +"type": "array" +}, +"responseHeadersToAdd": { +"description": "Headers to add the response before sending the response back to the client.", +"items": { +"$ref": "HttpHeaderOption" +}, +"type": "array" +}, +"responseHeadersToRemove": { +"description": "A list of header names for headers that need to be removed from the response before sending the response back to the client.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"HttpHeaderMatch": { +"description": "matchRule criteria for request header matches.", +"id": "HttpHeaderMatch", +"properties": { +"exactMatch": { +"description": "The value should exactly match contents of exactMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.", +"type": "string" +}, +"headerName": { +"description": "The name of the HTTP header to match. For matching against the HTTP request's authority, use a headerMatch with the header name \":authority\". For matching a request's method, use the headerName \":method\". When the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true, only non-binary user-specified custom metadata and the `content-type` header are supported. The following transport-level headers cannot be used in header matching rules: `:authority`, `:method`, `:path`, `:scheme`, `user-agent`, `accept-encoding`, `content-encoding`, `grpc-accept-encoding`, `grpc-encoding`, `grpc-previous-rpc-attempts`, `grpc-tags-bin`, `grpc-timeout` and `grpc-trace-bin`.", +"type": "string" +}, +"invertMatch": { +"description": "If set to false, the headerMatch is considered a match if the preceding match criteria are met. If set to true, the headerMatch is considered a match if the preceding match criteria are NOT met. The default setting is false. ", +"type": "boolean" +}, +"prefixMatch": { +"description": "The value of the header must start with the contents of prefixMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.", +"type": "string" +}, +"presentMatch": { +"description": "A header with the contents of headerName must exist. The match takes place whether or not the request's header has a value. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.", +"type": "boolean" +}, +"rangeMatch": { +"$ref": "Int64RangeMatch", +"description": "The header value must be an integer and its value must be in the range specified in rangeMatch. If the header does not contain an integer, number or is empty, the match fails. For example for a range [-5, 0] - -3 will match. - 0 will not match. - 0.25 will not match. - -3someString will not match. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. rangeMatch is not supported for load balancers that have loadBalancingScheme set to EXTERNAL." +}, +"regexMatch": { +"description": "The value of the header must match the regular expression specified in regexMatch. For more information about regular expression syntax, see Syntax. For matching against a port specified in the HTTP request, use a headerMatch with headerName set to PORT and a regular expression that satisfies the RFC2616 Host header's port specifier. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. Regular expressions can only be used when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.", +"type": "string" +}, +"suffixMatch": { +"description": "The value of the header must end with the contents of suffixMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.", +"type": "string" +} +}, +"type": "object" +}, +"HttpHeaderOption": { +"description": "Specification determining how headers are added to requests or responses.", +"id": "HttpHeaderOption", +"properties": { +"headerName": { +"description": "The name of the header.", +"type": "string" +}, +"headerValue": { +"description": "The value of the header to add.", +"type": "string" +}, +"replace": { +"description": "If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false. ", +"type": "boolean" +} +}, +"type": "object" +}, +"HttpHealthCheck": { +"description": "Represents a legacy HTTP Health Check resource. Legacy HTTP health checks are now only required by target pool-based network load balancers. For all other load balancers, including backend service-based network load balancers, and for managed instance group auto-healing, you must use modern (non-legacy) health checks. For more information, see Health checks overview .", +"id": "HttpHealthCheck", +"properties": { +"checkIntervalSec": { +"description": "How often (in seconds) to send a health check. The default value is 5 seconds.", +"format": "int32", +"type": "integer" +}, +"creationTimestamp": { +"description": "[Output Only] Creation timestamp in RFC3339 text format.", +"type": "string" +}, +"description": { +"description": "An optional description of this resource. Provide this property when you create the resource.", +"type": "string" +}, +"healthyThreshold": { +"description": "A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.", +"format": "int32", +"type": "integer" +}, +"host": { +"description": "The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.", +"type": "string" +}, +"id": { +"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", +"format": "uint64", +"type": "string" +}, +"kind": { +"default": "compute#httpHealthCheck", +"description": "[Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.", +"type": "string" +}, +"name": { +"description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"type": "string" +}, +"port": { +"description": "The TCP port number for the HTTP health check request. The default value is 80.", +"format": "int32", +"type": "integer" +}, +"requestPath": { +"description": "The request path of the HTTP health check request. The default value is /. This field does not support query parameters. Must comply with RFC3986.", +"type": "string" +}, +"selfLink": { +"description": "[Output Only] Server-defined URL for the resource.", +"type": "string" +}, +"selfLinkWithId": { +"description": "[Output Only] Server-defined URL for this resource with the resource id.", +"type": "string" +}, +"timeoutSec": { +"description": "How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.", +"format": "int32", +"type": "integer" +}, +"unhealthyThreshold": { +"description": "A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"HttpHealthCheckList": { +"description": "Contains a list of HttpHealthCheck resources.", +"id": "HttpHealthCheckList", +"properties": { +"id": { +"description": "[Output Only] Unique identifier for the resource; defined by the server.", +"type": "string" +}, +"items": { +"description": "A list of HttpHealthCheck resources.", +"items": { +"$ref": "HttpHealthCheck" +}, +"type": "array" +}, +"kind": { +"default": "compute#httpHealthCheckList", "description": "Type of resource.", "type": "string" }, @@ -67626,6 +68803,20 @@ false ], "type": "string" }, +"disruptionSchedule": { +"description": "The disruption schedule for the VM. Default to IMMEDIATE.", +"enum": [ +"DISRUPTION_SCHEDULE_UNSPECIFIED", +"FUTURE", +"IMMEDIATE" +], +"enumDescriptions": [ +"Not used. Required as per aip/126.", +"Delay disruption for caller control. Will be default soon.", +"Default value. Disrupt the VM immediately." +], +"type": "string" +}, "faultReasons": { "items": { "$ref": "InstancesReportHostAsFaultyRequestFaultReason" @@ -69736,6 +70927,247 @@ false }, "type": "object" }, +"InterconnectAttachmentGroupsCreateMembers": { +"id": "InterconnectAttachmentGroupsCreateMembers", +"properties": { +"attachments": { +"description": "Parameters for the specific Attachments to create.", +"items": { +"$ref": "InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput" +}, +"type": "array" +}, +"intentMismatchBehavior": { +"description": "How to behave when configured.availabilitySLA.effectiveSLA would not equal intent.availabilitySLA after this call.", +"enum": [ +"CREATE", +"REJECT", +"UNSPECIFIED" +], +"enumDescriptions": [ +"", +"", +"" +], +"type": "string" +}, +"templateAttachment": { +"$ref": "InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput", +"description": "Default parameters for the Attachments to create in this call." +} +}, +"type": "object" +}, +"InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput": { +"description": "LINT.IfChange Parameters used to create an InterconnectAttachment. This is similar to InterconnectAttachment, but the region field used here is not output only and all other output only fields are excluded.", +"id": "InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput", +"properties": { +"adminEnabled": { +"description": "Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER.", +"type": "boolean" +}, +"bandwidth": { +"description": "Provisioned bandwidth capacity for the interconnect attachment. For attachments of type DEDICATED, the user can set the bandwidth. For attachments of type PARTNER, the Google Partner that is operating the interconnect must set the bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED, and can take one of the following values: - BPS_50M: 50 Mbit/s - BPS_100M: 100 Mbit/s - BPS_200M: 200 Mbit/s - BPS_300M: 300 Mbit/s - BPS_400M: 400 Mbit/s - BPS_500M: 500 Mbit/s - BPS_1G: 1 Gbit/s - BPS_2G: 2 Gbit/s - BPS_5G: 5 Gbit/s - BPS_10G: 10 Gbit/s - BPS_20G: 20 Gbit/s - BPS_50G: 50 Gbit/s - BPS_100G: 100 Gbit/s ", +"enum": [ +"BPS_100G", +"BPS_100M", +"BPS_10G", +"BPS_1G", +"BPS_200M", +"BPS_20G", +"BPS_2G", +"BPS_300M", +"BPS_400M", +"BPS_500M", +"BPS_50G", +"BPS_50M", +"BPS_5G" +], +"enumDescriptions": [ +"100 Gbit/s", +"100 Mbit/s", +"10 Gbit/s", +"1 Gbit/s", +"200 Mbit/s", +"20 Gbit/s", +"2 Gbit/s", +"300 Mbit/s", +"400 Mbit/s", +"500 Mbit/s", +"50 Gbit/s", +"50 Mbit/s", +"5 Gbit/s" +], +"type": "string" +}, +"candidateCloudRouterIpAddress": { +"description": "Single IPv4 address + prefix length to be configured on the cloud router interface for this interconnect attachment. - Both candidate_cloud_router_ip_address and candidate_customer_router_ip_address fields must be set or both must be unset. - Prefix length of both candidate_cloud_router_ip_address and candidate_customer_router_ip_address must be the same. - Max prefix length is 31. ", +"type": "string" +}, +"candidateCloudRouterIpv6Address": { +"description": "Single IPv6 address + prefix length to be configured on the cloud router interface for this interconnect attachment. - Both candidate_cloud_router_ipv6_address and candidate_customer_router_ipv6_address fields must be set or both must be unset. - Prefix length of both candidate_cloud_router_ipv6_address and candidate_customer_router_ipv6_address must be the same. - Max prefix length is 126. ", +"type": "string" +}, +"candidateCustomerRouterIpAddress": { +"description": "Single IPv4 address + prefix length to be configured on the customer router interface for this interconnect attachment.", +"type": "string" +}, +"candidateCustomerRouterIpv6Address": { +"description": "Single IPv6 address + prefix length to be configured on the customer router interface for this interconnect attachment.", +"type": "string" +}, +"candidateIpv6Subnets": { +"description": "This field is not available.", +"items": { +"type": "string" +}, +"type": "array" +}, +"candidateSubnets": { +"description": "Input only. Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google's edge. If not supplied, Google will randomly select an unused /29 from all of link-local space.", +"items": { +"type": "string" +}, +"type": "array" +}, +"cloudRouterIpv6InterfaceId": { +"description": "This field is not available.", +"type": "string" +}, +"customerRouterIpv6InterfaceId": { +"description": "This field is not available.", +"type": "string" +}, +"description": { +"description": "An optional description of this resource.", +"type": "string" +}, +"edgeAvailabilityDomain": { +"description": "Input only. Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values: - AVAILABILITY_DOMAIN_ANY - AVAILABILITY_DOMAIN_1 - AVAILABILITY_DOMAIN_2 For improved reliability, customers should configure a pair of attachments, one per availability domain. The selected availability domain will be provided to the Partner via the pairing key, so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY.", +"enum": [ +"AVAILABILITY_DOMAIN_1", +"AVAILABILITY_DOMAIN_2", +"AVAILABILITY_DOMAIN_ANY" +], +"enumDescriptions": [ +"", +"", +"" +], +"type": "string" +}, +"encryption": { +"description": "Indicates the user-supplied encryption option of this VLAN attachment (interconnectAttachment). Can only be specified at attachment creation for PARTNER or DEDICATED attachments. Possible values are: - alpha - This is the default value, which means that the VLAN attachment carries unencrypted traffic. VMs are able to send traffic to, or receive traffic from, such a VLAN attachment. - IPSEC - The VLAN attachment carries only encrypted traffic that is encrypted by an IPsec device, such as an HA VPN gateway or third-party IPsec VPN. VMs cannot directly send traffic to, or receive traffic from, such a VLAN attachment. To use *HA VPN over Cloud Interconnect*, the VLAN attachment must be created with this option. ", +"enum": [ +"IPSEC", +"NONE" +], +"enumDescriptions": [ +"The interconnect attachment will carry only encrypted traffic that is encrypted by an IPsec device such as HA VPN gateway; VMs cannot directly send traffic to or receive traffic from such an interconnect attachment. To use HA VPN over Cloud Interconnect, the interconnect attachment must be created with this option.", +"This is the default value, which means the Interconnect Attachment will carry unencrypted traffic. VMs will be able to send traffic to or receive traffic from such interconnect attachment." +], +"type": "string" +}, +"interconnect": { +"description": "URL of the underlying Interconnect object that this attachment's traffic will traverse through.", +"type": "string" +}, +"ipsecInternalAddresses": { +"description": "A list of URLs of addresses that have been reserved for the VLAN attachment. Used only for the VLAN attachment that has the encryption option as IPSEC. The addresses must be regional internal IP address ranges. When creating an HA VPN gateway over the VLAN attachment, if the attachment is configured to use a regional internal IP address, then the VPN gateway's IP address is allocated from the IP address range specified here. For example, if the HA VPN gateway's interface 0 is paired to this VLAN attachment, then a regional internal IP address for the VPN gateway interface 0 will be allocated from the IP address specified for this VLAN attachment. If this field is not specified when creating the VLAN attachment, then later on when creating an HA VPN gateway on this VLAN attachment, the HA VPN gateway's IP address is allocated from the regional external IP address pool.", +"items": { +"type": "string" +}, +"type": "array" +}, +"l2Forwarding": { +"$ref": "InterconnectAttachmentL2Forwarding", +"description": "L2 Interconnect Attachment related config. This field is required if the type is L2_DEDICATED. The configuration specifies how VLAN tags (like dot1q, qinq, or dot1ad) within L2 packets are mapped to the destination appliances IP addresses. The packet is then encapsulated with the appliance IP address and sent to the edge appliance." +}, +"mtu": { +"description": "Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Only 1440 and 1500 are allowed. If not specified, the value will default to 1440.", +"format": "int32", +"type": "integer" +}, +"multicastEnabled": { +"description": "Whether or not to permit multicast traffic for this attachment. Multicast packets will be dropped if this is not enabled.", +"type": "boolean" +}, +"name": { +"description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"type": "string" +}, +"pairingKey": { +"description": "[Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not present for DEDICATED]. The opaque identifier of a PARTNER attachment used to initiate provisioning with a selected partner. Of the form \"XXXXX/region/domain\"", +"type": "string" +}, +"partnerAsn": { +"description": "Optional BGP ASN for the router supplied by a Layer 3 Partner if they configured BGP on behalf of the customer. Output only for PARTNER type, input only for PARTNER_PROVIDER, not available for DEDICATED.", +"format": "int64", +"type": "string" +}, +"partnerMetadata": { +"$ref": "InterconnectAttachmentPartnerMetadata", +"description": "Informational metadata about Partner attachments from Partners to display to customers. Output only for PARTNER type, mutable for PARTNER_PROVIDER, not available for DEDICATED." +}, +"region": { +"description": "The region that the Attachment is in.", +"type": "string" +}, +"router": { +"description": "URL of the Cloud Router to be used for dynamic routing. This router must be in the same region as this InterconnectAttachment. The InterconnectAttachment will automatically connect the Interconnect to the network & region within which the Cloud Router is configured.", +"type": "string" +}, +"stackType": { +"description": "The stack type for this interconnect attachment to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used. This field can be both set at interconnect attachments creation and update interconnect attachment operations.", +"enum": [ +"IPV4_IPV6", +"IPV4_ONLY" +], +"enumDescriptions": [ +"The interconnect attachment can have both IPv4 and IPv6 addresses.", +"The interconnect attachment will only be assigned IPv4 addresses." +], +"type": "string" +}, +"subnetLength": { +"description": "Input only. Length of the IPv4 subnet mask. Allowed values: - 29 (default) - 30 The default value is 29, except for Cross-Cloud Interconnect connections that use an InterconnectRemoteLocation with a constraints.subnetLengthRange.min equal to 30. For example, connections that use an Azure remote location fall into this category. In these cases, the default value is 30, and requesting 29 returns an error. Where both 29 and 30 are allowed, 29 is preferred, because it gives Google Cloud Support more debugging visibility. ", +"format": "int32", +"type": "integer" +}, +"type": { +"description": "The type of interconnect attachment this is, which can take one of the following values: - DEDICATED: an attachment to a Dedicated Interconnect. - PARTNER: an attachment to a Partner Interconnect, created by the customer. - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner. ", +"enum": [ +"DEDICATED", +"L2_DEDICATED", +"PARTNER", +"PARTNER_PROVIDER" +], +"enumDescriptions": [ +"Attachment to a dedicated interconnect.", +"Attachment to a L2 interconnect, created by the customer.", +"Attachment to a partner interconnect, created by the customer.", +"Attachment to a partner interconnect, created by the partner." +], +"type": "string" +}, +"vlanTag8021q": { +"description": "The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4093. Only specified at creation time.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"InterconnectAttachmentGroupsCreateMembersRequest": { +"id": "InterconnectAttachmentGroupsCreateMembersRequest", +"properties": { +"request": { +"$ref": "InterconnectAttachmentGroupsCreateMembers" +} +}, +"type": "object" +}, "InterconnectAttachmentGroupsGetOperationalStatusResponse": { "description": "Response for the InterconnectAttachmentGroupsGetOperationalStatusResponse.", "id": "InterconnectAttachmentGroupsGetOperationalStatusResponse", @@ -71006,19 +72438,6 @@ false }, "type": "object" }, -"InterconnectGroupsCreateMembersResponse": { -"description": "Response for the InterconnectGroupsCreateMembersRequest.", -"id": "InterconnectGroupsCreateMembersResponse", -"properties": { -"etag": { -"type": "string" -}, -"result": { -"$ref": "InterconnectGroup" -} -}, -"type": "object" -}, "InterconnectGroupsGetOperationalStatusResponse": { "description": "Response for the InterconnectGroupsGetOperationalStatusResponse.", "id": "InterconnectGroupsGetOperationalStatusResponse", @@ -71503,7 +72922,7 @@ false "type": "string" }, "crossSiteInterconnectInfos": { -"description": "[Output Only] A list of InterconnectLocation.CrossSiteInterconnectInfo objects, that describe parameters pertaining to the relation between this InterconnectLocation and various Interconnect metros.", +"description": "[Output Only] A list of InterconnectLocation.CrossSiteInterconnectInfo objects, that describe where Cross-Site Interconnect wires may connect to from this location and associated connection parameters. Cross-Site Interconnect isn't allowed to locations which are not listed.", "items": { "$ref": "InterconnectLocationCrossSiteInterconnectInfo" }, @@ -71574,11 +72993,11 @@ false "type": "object" }, "InterconnectLocationCrossSiteInterconnectInfo": { -"description": "Information about any potential WireGroups between an Interconnect at a specific InterconnectLocation, and an Interconnect in another metro.", +"description": "Information about Cross-Site Interconnect wires which may be created between the containing location and another remote location.", "id": "InterconnectLocationCrossSiteInterconnectInfo", "properties": { "city": { -"description": "Metropolitan area designator", +"description": "The remote location for Cross-Site Interconnect wires. This specifies an InterconnectLocation city (metropolitan area designator), which itself may match multiple InterconnectLocations.", "type": "string" }, "maxSingleFlowGbps": { @@ -74485,11 +75904,13 @@ false "provisioningModel": { "description": "The provisioning model to be used for this instance.", "enum": [ +"FLEX_START", "RESERVATION_BOUND", "SPOT", "STANDARD" ], "enumDescriptions": [ +"Instance is provisioned with DWS Flex Start and have limited max run duration.", "Bound to the lifecycle of the reservation in which it is provisioned.", "Heavily discounted, no guaranteed runtime.", "Standard provisioning with user controlled runtime, no discounts." @@ -74604,11 +76025,13 @@ false "provisioningModel": { "description": "The provisioning model to be used for this instance.", "enum": [ +"FLEX_START", "RESERVATION_BOUND", "SPOT", "STANDARD" ], "enumDescriptions": [ +"Instance is provisioned with DWS Flex Start and have limited max run duration.", "Bound to the lifecycle of the reservation in which it is provisioned.", "Heavily discounted, no guaranteed runtime.", "Standard provisioning with user controlled runtime, no discounts." @@ -74808,6 +76231,215 @@ false }, "type": "object" }, +"MultiMigMember": { +"description": "Represents a Multi-MIG member resource.", +"id": "MultiMigMember", +"properties": { +"creationTimestamp": { +"description": "[Output Only] Creation timestamp of this multi-MIG member in RFC3339 text format.", +"type": "string" +}, +"description": { +"description": "An optional description of this resource.", +"type": "string" +}, +"id": { +"description": "[Output only] The unique identifier for this resource type. The server generates this identifier.", +"format": "uint64", +"type": "string" +}, +"kind": { +"default": "compute#multiMigMember", +"description": "Type of the resource. Always compute#multiMigMember for a list of multi-MIG members.", +"type": "string" +}, +"name": { +"description": "[Output Only] The name of this multi-MIG member generated by Google Compute Engine.", +"type": "string" +}, +"region": { +"description": "[Output Only] The URL of the region where the multi-MIG resides.", +"type": "string" +}, +"selfLink": { +"description": "[Output Only] Server-defined fully-qualified URL for this resource.", +"type": "string" +}, +"selfLinkWithId": { +"description": "[Output Only] Server-defined URL for this resource with the resource id.", +"type": "string" +}, +"status": { +"$ref": "MultiMigMemberStatus", +"description": "[Output Only] The status of this multi-MIG member" +} +}, +"type": "object" +}, +"MultiMigMemberList": { +"id": "MultiMigMemberList", +"properties": { +"id": { +"description": "Unique identifier for the resource; defined by the server.", +"type": "string" +}, +"items": { +"description": "A list of multi-MIG member resources.", +"items": { +"$ref": "MultiMigMember" +}, +"type": "array" +}, +"kind": { +"default": "compute#multiMigMemberList", +"description": "Type of the resource. Always compute#multiMigMember for a list of multi-MIG members.", +"type": "string" +}, +"nextPageToken": { +"description": "This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", +"type": "string" +}, +"selfLink": { +"description": "[Output only] Server-defined URL for this resource.", +"type": "string" +}, +"warning": { +"description": "Informational warning message.", +"properties": { +"code": { +"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", +"enum": [ +"CLEANUP_FAILED", +"DEPRECATED_RESOURCE_USED", +"DEPRECATED_TYPE_USED", +"DISK_SIZE_LARGER_THAN_IMAGE_SIZE", +"EXPERIMENTAL_TYPE_USED", +"EXTERNAL_API_WARNING", +"FIELD_VALUE_OVERRIDEN", +"INJECTED_KERNELS_DEPRECATED", +"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", +"LARGE_DEPLOYMENT_WARNING", +"LIST_OVERHEAD_QUOTA_EXCEED", +"MISSING_TYPE_DEPENDENCY", +"NEXT_HOP_ADDRESS_NOT_ASSIGNED", +"NEXT_HOP_CANNOT_IP_FORWARD", +"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", +"NEXT_HOP_INSTANCE_NOT_FOUND", +"NEXT_HOP_INSTANCE_NOT_ON_NETWORK", +"NEXT_HOP_NOT_RUNNING", +"NOT_CRITICAL_ERROR", +"NO_RESULTS_ON_PAGE", +"PARTIAL_SUCCESS", +"QUOTA_INFO_UNAVAILABLE", +"REQUIRED_TOS_AGREEMENT", +"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", +"RESOURCE_NOT_DELETED", +"SCHEMA_VALIDATION_IGNORED", +"SINGLE_INSTANCE_PROPERTY_TEMPLATE", +"UNDECLARED_PROPERTIES", +"UNREACHABLE" +], +"enumDeprecated": [ +false, +false, +false, +false, +false, +false, +true, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false +], +"enumDescriptions": [ +"Warning about failed cleanup of transient changes made by a failed operation.", +"A link to a deprecated resource was created.", +"When deploying and at least one of the resources has a type marked as deprecated", +"The user created a boot disk that is larger than image size.", +"When deploying and at least one of the resources has a type marked as experimental", +"Warning that is present in an external api call", +"Warning that value of a field has been overridden. Deprecated unused field.", +"The operation involved use of an injected kernel, which is deprecated.", +"A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", +"When deploying a deployment with a exceedingly large number of resources", +"Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", +"A resource depends on a missing type", +"The route's nextHopIp address is not assigned to an instance on the network.", +"The route's next hop instance cannot ip forward.", +"The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", +"The route's nextHopInstance URL refers to an instance that does not exist.", +"The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", +"The route's next hop instance does not have a status of RUNNING.", +"Error which is not critical. We decided to continue the process despite the mentioned error.", +"No results are present on a particular list page.", +"Success is reported, but some results may be missing due to errors", +"Quota information is not available to client requests (e.g: regions.list).", +"The user attempted to use a resource that requires a TOS they have not accepted.", +"Warning that a resource is in use.", +"One or more of the resources set to auto-delete could not be deleted because they were in use.", +"When a resource schema validation is ignored.", +"Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", +"When undeclared properties in the schema are present", +"A given scope cannot be reached." +], +"type": "string" +}, +"data": { +"description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", +"items": { +"properties": { +"key": { +"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", +"type": "string" +}, +"value": { +"description": "[Output Only] A warning data value corresponding to the key.", +"type": "string" +} +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "[Output Only] A human-readable description of the warning code.", +"type": "string" +} +}, +"type": "object" +} +}, +"type": "object" +}, +"MultiMigMemberStatus": { +"id": "MultiMigMemberStatus", +"properties": { +"instanceGroupManager": { +"description": "[Output Only] URL of member instance group manager", +"type": "string" +} +}, +"type": "object" +}, "MultiMigResourcePolicies": { "description": "Resource policies message for a multi-MIG. Specifies the workload policy configuration of the multi-MIG.", "id": "MultiMigResourcePolicies", @@ -76230,10 +77862,6 @@ false "description": "Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. This field can not be set for network endpoints of type GCE_VM_IP.", "format": "int32", "type": "integer" -}, -"zone": { -"description": "The name of the zone where the instance hosting the network endpoint is located (valid only for regional GCE_VM_IP_PORT NEGs). It should comply with RFC1035. The zone must belong to the region of the Network Endpoint Group.", -"type": "string" } }, "type": "object" @@ -90665,14 +92293,14 @@ false "type": "boolean" }, "exportPolicies": { -"description": "List of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies.", +"description": "List of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type.", "items": { "type": "string" }, "type": "array" }, "importPolicies": { -"description": "List of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies.", +"description": "List of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type.", "items": { "type": "string" }, @@ -91405,6 +93033,10 @@ false }, "type": "array" }, +"nccGateway": { +"description": "URI of the ncc_gateway to which this router associated.", +"type": "string" +}, "network": { "description": "URI of the network to which this router belongs.", "type": "string" @@ -92656,11 +94288,13 @@ false "provisioningModel": { "description": "Specifies the provisioning model of the instance.", "enum": [ +"FLEX_START", "RESERVATION_BOUND", "SPOT", "STANDARD" ], "enumDescriptions": [ +"Instance is provisioned with DWS Flex Start and have limited max run duration.", "Bound to the lifecycle of the reservation in which it is provisioned.", "Heavily discounted, no guaranteed runtime.", "Standard provisioning with user controlled runtime, no discounts." @@ -95671,7 +97305,7 @@ false "description": "Customer provided encryption key when creating Snapshot from Instant Snapshot." }, "sourceInstantSnapshotId": { -"description": "[Output Only] The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this persistent disk. For example, if you created the persistent disk from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used.", +"description": "[Output Only] The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this snapshot. For example, if you created the snapshot from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used.", "type": "string" }, "sourceSnapshotSchedulePolicy": { @@ -99491,7 +101125,7 @@ false "type": "string" }, "purpose": { -"description": "The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PEER_MIGRATION or PRIVATE_SERVICE_CONNECT. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to PEER_MIGRATION is used for subnet migration from one peered VPC to another. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY.", +"description": "The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PEER_MIGRATION, PRIVATE_SERVICE_CONNECT or PRIVATE_NAT. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to PEER_MIGRATION is used for subnet migration from one peered VPC to another. A subnet with purpose set to PRIVATE_NAT is used for Private NAT IP address by Private NAT Gateway. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY.", "enum": [ "AGGREGATE", "CLOUD_EXTENSION", @@ -105231,7 +106865,7 @@ false "type": "string" }, "purpose": { -"description": "The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PEER_MIGRATION or PRIVATE_SERVICE_CONNECT. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to PEER_MIGRATION is used for subnet migration from one peered VPC to another. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY.", +"description": "The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PEER_MIGRATION, PRIVATE_SERVICE_CONNECT or PRIVATE_NAT. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to PEER_MIGRATION is used for subnet migration from one peered VPC to another. A subnet with purpose set to PRIVATE_NAT is used for Private NAT IP address by Private NAT Gateway. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY.", "enum": [ "AGGREGATE", "CLOUD_EXTENSION", @@ -107313,7 +108947,7 @@ false "type": "string" }, "vlanTags": { -"description": "To configure the wire group for VLAN mode, enter a VLAN tag, which is a number from `2` to `4093`. You can autoallocate a tag by entering `0`. To configure the wire group for port mode, enter `-1`. Review the following guidelines: - A VLAN tag must be unique for an Interconnect connection across all attachments and wire groups. - Both endpoints of a wire must use the same VLAN tag value. - Single wire and redundant type wire groups must have only one VLAN tag. - Box and cross type wire groups must have two VLAN tags. The first is for the same-zone pseudowire, and the second is for the cross-zone pseudowire. - Port mode pseudowires must configure a value of `-1` for both endpoints. ", +"description": "To configure the wire group for VLAN mode, enter a VLAN tag, which is a number from `2` to `4093`. You can autoallocate a tag by entering `0`. To configure the wire group for port mode, enter `-1`. Review the following guidelines: - A VLAN tag must be unique for an Interconnect connection across all attachments and wire groups. - Both endpoints of a wire must use the same VLAN tag value. - Single wire and redundant type wire groups must have only one VLAN tag. - Port mode pseudowires must have a single VLAN tag with a value of `-1` for both endpoints. - Box and cross type wire groups must have two VLAN tags. The first is for the same-zone pseudowire, and the second is for the cross-zone pseudowire. ", "items": { "format": "int32", "type": "integer" @@ -107598,7 +109232,7 @@ false "type": "string" }, "bandwidthUnmetered": { -"description": "The unmetered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. Must be a multiple of 10.", +"description": "The unmetered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps.", "format": "int64", "type": "string" }, @@ -107621,8 +109255,8 @@ false "GOLD" ], "enumDescriptions": [ -"The default service class.", -"A higher service class." +"The lowest service class.", +"The highest service class." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/compute.v1.json b/googleapiclient/discovery_cache/documents/compute.v1.json index 7ae09675f95..6baacb45323 100644 --- a/googleapiclient/discovery_cache/documents/compute.v1.json +++ b/googleapiclient/discovery_cache/documents/compute.v1.json @@ -29945,6 +29945,58 @@ "https://www.googleapis.com/auth/compute" ] }, +"deleteRoutePolicy": { +"description": "Deletes Route Policy", +"flatPath": "projects/{project}/regions/{region}/routers/{router}/deleteRoutePolicy", +"httpMethod": "POST", +"id": "compute.routers.deleteRoutePolicy", +"parameterOrder": [ +"project", +"region", +"router" +], +"parameters": { +"policy": { +"description": "The Policy name for this request. Name must conform to RFC1035", +"location": "query", +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "Name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"router": { +"description": "Name of the Router resource where Route Policy is defined.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/routers/{router}/deleteRoutePolicy", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, "get": { "description": "Returns the specified Router resource.", "flatPath": "projects/{project}/regions/{region}/routers/{router}", @@ -30111,6 +30163,53 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, +"getRoutePolicy": { +"description": "Returns specified Route Policy", +"flatPath": "projects/{project}/regions/{region}/routers/{router}/getRoutePolicy", +"httpMethod": "GET", +"id": "compute.routers.getRoutePolicy", +"parameterOrder": [ +"project", +"region", +"router" +], +"parameters": { +"policy": { +"description": "The Policy name for this request. Name must conform to RFC1035", +"location": "query", +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "Name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"router": { +"description": "Name of the Router resource to query for the route policy. The name should conform to RFC1035.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/routers/{router}/getRoutePolicy", +"response": { +"$ref": "RoutersGetRoutePolicyResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, "getRouterStatus": { "description": "Retrieves runtime information of the specified router.", "flatPath": "projects/{project}/regions/{region}/routers/{router}/getRouterStatus", @@ -30259,6 +30358,196 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, +"listBgpRoutes": { +"description": "Retrieves a list of router bgp routes available to the specified project.", +"flatPath": "projects/{project}/regions/{region}/routers/{router}/listBgpRoutes", +"httpMethod": "GET", +"id": "compute.routers.listBgpRoutes", +"parameterOrder": [ +"project", +"region", +"router" +], +"parameters": { +"addressFamily": { +"default": "UNSPECIFIED_IP_VERSION", +"description": "(Required) limit results to this address family (either IPv4 or IPv6)", +"enum": [ +"IPV4", +"IPV6", +"UNSPECIFIED_IP_VERSION" +], +"enumDescriptions": [ +"", +"", +"" +], +"location": "query", +"type": "string" +}, +"destinationPrefix": { +"description": "Limit results to destinations that are subnets of this CIDR range", +"location": "query", +"type": "string" +}, +"filter": { +"description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", +"location": "query", +"type": "string" +}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", +"location": "query", +"type": "string" +}, +"peer": { +"description": "(Required) limit results to the BGP peer with the given name. Name should conform to RFC1035.", +"location": "query", +"type": "string" +}, +"policyApplied": { +"default": "true", +"description": "When true, the method returns post-policy routes. Otherwise, it returns pre-policy routes.", +"location": "query", +"type": "boolean" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "Name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", +"location": "query", +"type": "boolean" +}, +"routeType": { +"default": "UNSPECIFIED_ROUTE_TYPE", +"description": "(Required) limit results to this type of route (either LEARNED or ADVERTISED)", +"enum": [ +"ADVERTISED", +"LEARNED", +"UNSPECIFIED_ROUTE_TYPE" +], +"enumDescriptions": [ +"", +"", +"" +], +"location": "query", +"type": "string" +}, +"router": { +"description": "Name or id of the resource for this request. Name should conform to RFC1035.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/routers/{router}/listBgpRoutes", +"response": { +"$ref": "RoutersListBgpRoutes" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"listRoutePolicies": { +"description": "Retrieves a list of router route policy subresources available to the specified project.", +"flatPath": "projects/{project}/regions/{region}/routers/{router}/listRoutePolicies", +"httpMethod": "GET", +"id": "compute.routers.listRoutePolicies", +"parameterOrder": [ +"project", +"region", +"router" +], +"parameters": { +"filter": { +"description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", +"location": "query", +"type": "string" +}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", +"location": "query", +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "Name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", +"location": "query", +"type": "boolean" +}, +"router": { +"description": "Name or id of the resource for this request. Name should conform to RFC1035.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/routers/{router}/listRoutePolicies", +"response": { +"$ref": "RoutersListRoutePolicies" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, "patch": { "description": "Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.", "flatPath": "projects/{project}/regions/{region}/routers/{router}", @@ -30309,6 +30598,56 @@ "https://www.googleapis.com/auth/compute" ] }, +"patchRoutePolicy": { +"description": "Patches Route Policy", +"flatPath": "projects/{project}/regions/{region}/routers/{router}/patchRoutePolicy", +"httpMethod": "POST", +"id": "compute.routers.patchRoutePolicy", +"parameterOrder": [ +"project", +"region", +"router" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "Name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"router": { +"description": "Name of the Router resource where Route Policy is defined.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/routers/{router}/patchRoutePolicy", +"request": { +"$ref": "RoutePolicy" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, "preview": { "description": "Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router.", "flatPath": "projects/{project}/regions/{region}/routers/{router}/preview", @@ -30404,6 +30743,56 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] +}, +"updateRoutePolicy": { +"description": "Updates or creates new Route Policy", +"flatPath": "projects/{project}/regions/{region}/routers/{router}/updateRoutePolicy", +"httpMethod": "POST", +"id": "compute.routers.updateRoutePolicy", +"parameterOrder": [ +"project", +"region", +"router" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "Name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"router": { +"description": "Name of the Router resource where Route Policy is defined.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/routers/{router}/updateRoutePolicy", +"request": { +"$ref": "RoutePolicy" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] } } }, @@ -38203,7 +38592,7 @@ } } }, -"revision": "20250126", +"revision": "20250211", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -39526,14 +39915,18 @@ false "VM_FAMILY_CLOUD_TPU_DEVICE_CT3", "VM_FAMILY_CLOUD_TPU_LITE_DEVICE_CT5L", "VM_FAMILY_CLOUD_TPU_LITE_POD_SLICE_CT5LP", +"VM_FAMILY_CLOUD_TPU_LITE_POD_SLICE_CT6E", "VM_FAMILY_CLOUD_TPU_POD_SLICE_CT3P", -"VM_FAMILY_CLOUD_TPU_POD_SLICE_CT4P" +"VM_FAMILY_CLOUD_TPU_POD_SLICE_CT4P", +"VM_FAMILY_CLOUD_TPU_POD_SLICE_CT5P" ], "enumDescriptions": [ "", "", "", "", +"", +"", "" ], "type": "string" @@ -42752,6 +43145,91 @@ false }, "type": "object" }, +"BgpRoute": { +"id": "BgpRoute", +"properties": { +"asPaths": { +"description": "[Output only] AS-PATH for the route", +"items": { +"$ref": "BgpRouteAsPath" +}, +"type": "array" +}, +"communities": { +"description": "[Output only] BGP communities in human-readable A:B format.", +"items": { +"type": "string" +}, +"type": "array" +}, +"destination": { +"$ref": "BgpRouteNetworkLayerReachabilityInformation", +"description": "[Output only] Destination IP range for the route, in human-readable CIDR format" +}, +"med": { +"description": "[Output only] BGP multi-exit discriminator", +"format": "uint32", +"type": "integer" +}, +"origin": { +"description": "[Output only] BGP origin (EGP, IGP or INCOMPLETE)", +"enum": [ +"BGP_ORIGIN_EGP", +"BGP_ORIGIN_IGP", +"BGP_ORIGIN_INCOMPLETE" +], +"enumDescriptions": [ +"", +"", +"" +], +"type": "string" +} +}, +"type": "object" +}, +"BgpRouteAsPath": { +"id": "BgpRouteAsPath", +"properties": { +"asns": { +"description": "[Output only] ASNs in the path segment. When type is SEQUENCE, these are ordered.", +"items": { +"format": "int32", +"type": "integer" +}, +"type": "array" +}, +"type": { +"description": "[Output only] Type of AS-PATH segment (SEQUENCE or SET)", +"enum": [ +"AS_PATH_TYPE_SEQUENCE", +"AS_PATH_TYPE_SET" +], +"enumDescriptions": [ +"", +"" +], +"type": "string" +} +}, +"type": "object" +}, +"BgpRouteNetworkLayerReachabilityInformation": { +"description": "Network Layer Reachability Information (NLRI) for a route.", +"id": "BgpRouteNetworkLayerReachabilityInformation", +"properties": { +"pathId": { +"description": "If the BGP session supports multiple paths (RFC 7911), the path identifier for this route.", +"format": "uint32", +"type": "integer" +}, +"prefix": { +"description": "Human readable CIDR notation for a prefix. E.g. 10.42.0.0/16.", +"type": "string" +} +}, +"type": "object" +}, "Binding": { "description": "Associates `members`, or principals, with a `role`.", "id": "Binding", @@ -69678,6 +70156,11 @@ false }, "type": "array" }, +"priority": { +"description": "[Output only] Priority of firewall policy association. Not applicable for type=HIERARCHY.", +"format": "int32", +"type": "integer" +}, "rules": { "description": "[Output only] The rules that apply to the network.", "items": { @@ -69691,12 +70174,16 @@ false "HIERARCHY", "NETWORK", "NETWORK_REGIONAL", +"SYSTEM_GLOBAL", +"SYSTEM_REGIONAL", "UNSPECIFIED" ], "enumDescriptions": [ "", "", "", +"", +"", "" ], "type": "string" @@ -71750,6 +72237,65 @@ false }, "type": "object" }, +"RoutePolicy": { +"id": "RoutePolicy", +"properties": { +"description": { +"description": "An optional description of route policy.", +"type": "string" +}, +"fingerprint": { +"description": "A fingerprint for the Route Policy being applied to this Router, which is essentially a hash of the Route Policy used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update Route Policy. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make a getRoutePolicy() request to retrieve a Route Policy.", +"format": "byte", +"type": "string" +}, +"name": { +"description": "Route Policy name, which must be a resource ID segment and unique within all the router's Route Policies. Name should conform to RFC1035.", +"type": "string" +}, +"terms": { +"description": "List of terms (the order in the list is not important, they are evaluated in order of priority). Order of policies is not retained and might change when getting policy later.", +"items": { +"$ref": "RoutePolicyPolicyTerm" +}, +"type": "array" +}, +"type": { +"enum": [ +"ROUTE_POLICY_TYPE_EXPORT", +"ROUTE_POLICY_TYPE_IMPORT" +], +"enumDescriptions": [ +"The Route Policy is an Export Policy.", +"The Route Policy is an Import Policy." +], +"type": "string" +} +}, +"type": "object" +}, +"RoutePolicyPolicyTerm": { +"id": "RoutePolicyPolicyTerm", +"properties": { +"actions": { +"description": "CEL expressions to evaluate to modify a route when this term matches.", +"items": { +"$ref": "Expr" +}, +"type": "array" +}, +"match": { +"$ref": "Expr", +"description": "CEL expression evaluated against a route to determine if this term applies. When not set, the term applies to all routes." +}, +"priority": { +"description": "The evaluation priority for this term, which must be between 0 (inclusive) and 2^31 (exclusive), and unique within the list.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "Router": { "description": "Represents a Cloud Router resource. For more information about Cloud Router, read the Cloud Router overview.", "id": "Router", @@ -72146,14 +72692,14 @@ false "type": "boolean" }, "exportPolicies": { -"description": "List of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies.", +"description": "List of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type.", "items": { "type": "string" }, "type": "array" }, "importPolicies": { -"description": "List of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies.", +"description": "List of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type.", "items": { "type": "string" }, @@ -73054,6 +73600,343 @@ false }, "type": "object" }, +"RoutersGetRoutePolicyResponse": { +"id": "RoutersGetRoutePolicyResponse", +"properties": { +"resource": { +"$ref": "RoutePolicy" +} +}, +"type": "object" +}, +"RoutersListBgpRoutes": { +"id": "RoutersListBgpRoutes", +"properties": { +"etag": { +"type": "string" +}, +"id": { +"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", +"type": "string" +}, +"kind": { +"default": "compute#routersListBgpRoutes", +"description": "[Output Only] Type of resource. Always compute#routersListBgpRoutes for lists of bgp routes.", +"type": "string" +}, +"nextPageToken": { +"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", +"type": "string" +}, +"result": { +"description": "[Output Only] A list of bgp routes.", +"items": { +"$ref": "BgpRoute" +}, +"type": "array" +}, +"selfLink": { +"description": "[Output Only] Server-defined URL for this resource.", +"type": "string" +}, +"unreachables": { +"description": "[Output Only] Unreachable resources.", +"items": { +"type": "string" +}, +"type": "array" +}, +"warning": { +"description": "[Output Only] Informational warning message.", +"properties": { +"code": { +"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", +"enum": [ +"CLEANUP_FAILED", +"DEPRECATED_RESOURCE_USED", +"DEPRECATED_TYPE_USED", +"DISK_SIZE_LARGER_THAN_IMAGE_SIZE", +"EXPERIMENTAL_TYPE_USED", +"EXTERNAL_API_WARNING", +"FIELD_VALUE_OVERRIDEN", +"INJECTED_KERNELS_DEPRECATED", +"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", +"LARGE_DEPLOYMENT_WARNING", +"LIST_OVERHEAD_QUOTA_EXCEED", +"MISSING_TYPE_DEPENDENCY", +"NEXT_HOP_ADDRESS_NOT_ASSIGNED", +"NEXT_HOP_CANNOT_IP_FORWARD", +"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", +"NEXT_HOP_INSTANCE_NOT_FOUND", +"NEXT_HOP_INSTANCE_NOT_ON_NETWORK", +"NEXT_HOP_NOT_RUNNING", +"NOT_CRITICAL_ERROR", +"NO_RESULTS_ON_PAGE", +"PARTIAL_SUCCESS", +"QUOTA_INFO_UNAVAILABLE", +"REQUIRED_TOS_AGREEMENT", +"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", +"RESOURCE_NOT_DELETED", +"SCHEMA_VALIDATION_IGNORED", +"SINGLE_INSTANCE_PROPERTY_TEMPLATE", +"UNDECLARED_PROPERTIES", +"UNREACHABLE" +], +"enumDeprecated": [ +false, +false, +false, +false, +false, +false, +true, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false +], +"enumDescriptions": [ +"Warning about failed cleanup of transient changes made by a failed operation.", +"A link to a deprecated resource was created.", +"When deploying and at least one of the resources has a type marked as deprecated", +"The user created a boot disk that is larger than image size.", +"When deploying and at least one of the resources has a type marked as experimental", +"Warning that is present in an external api call", +"Warning that value of a field has been overridden. Deprecated unused field.", +"The operation involved use of an injected kernel, which is deprecated.", +"A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", +"When deploying a deployment with a exceedingly large number of resources", +"Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", +"A resource depends on a missing type", +"The route's nextHopIp address is not assigned to an instance on the network.", +"The route's next hop instance cannot ip forward.", +"The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", +"The route's nextHopInstance URL refers to an instance that does not exist.", +"The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", +"The route's next hop instance does not have a status of RUNNING.", +"Error which is not critical. We decided to continue the process despite the mentioned error.", +"No results are present on a particular list page.", +"Success is reported, but some results may be missing due to errors", +"Quota information is not available to client requests (e.g: regions.list).", +"The user attempted to use a resource that requires a TOS they have not accepted.", +"Warning that a resource is in use.", +"One or more of the resources set to auto-delete could not be deleted because they were in use.", +"When a resource schema validation is ignored.", +"Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", +"When undeclared properties in the schema are present", +"A given scope cannot be reached." +], +"type": "string" +}, +"data": { +"description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", +"items": { +"properties": { +"key": { +"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", +"type": "string" +}, +"value": { +"description": "[Output Only] A warning data value corresponding to the key.", +"type": "string" +} +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "[Output Only] A human-readable description of the warning code.", +"type": "string" +} +}, +"type": "object" +} +}, +"type": "object" +}, +"RoutersListRoutePolicies": { +"id": "RoutersListRoutePolicies", +"properties": { +"etag": { +"type": "string" +}, +"id": { +"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", +"type": "string" +}, +"kind": { +"default": "compute#routersListRoutePolicies", +"description": "[Output Only] Type of resource. Always compute#routersListRoutePolicies for lists of route policies.", +"type": "string" +}, +"nextPageToken": { +"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", +"type": "string" +}, +"result": { +"description": "[Output Only] A list of route policies.", +"items": { +"$ref": "RoutePolicy" +}, +"type": "array" +}, +"selfLink": { +"description": "[Output Only] Server-defined URL for this resource.", +"type": "string" +}, +"unreachables": { +"description": "[Output Only] Unreachable resources.", +"items": { +"type": "string" +}, +"type": "array" +}, +"warning": { +"description": "[Output Only] Informational warning message.", +"properties": { +"code": { +"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", +"enum": [ +"CLEANUP_FAILED", +"DEPRECATED_RESOURCE_USED", +"DEPRECATED_TYPE_USED", +"DISK_SIZE_LARGER_THAN_IMAGE_SIZE", +"EXPERIMENTAL_TYPE_USED", +"EXTERNAL_API_WARNING", +"FIELD_VALUE_OVERRIDEN", +"INJECTED_KERNELS_DEPRECATED", +"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", +"LARGE_DEPLOYMENT_WARNING", +"LIST_OVERHEAD_QUOTA_EXCEED", +"MISSING_TYPE_DEPENDENCY", +"NEXT_HOP_ADDRESS_NOT_ASSIGNED", +"NEXT_HOP_CANNOT_IP_FORWARD", +"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", +"NEXT_HOP_INSTANCE_NOT_FOUND", +"NEXT_HOP_INSTANCE_NOT_ON_NETWORK", +"NEXT_HOP_NOT_RUNNING", +"NOT_CRITICAL_ERROR", +"NO_RESULTS_ON_PAGE", +"PARTIAL_SUCCESS", +"QUOTA_INFO_UNAVAILABLE", +"REQUIRED_TOS_AGREEMENT", +"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", +"RESOURCE_NOT_DELETED", +"SCHEMA_VALIDATION_IGNORED", +"SINGLE_INSTANCE_PROPERTY_TEMPLATE", +"UNDECLARED_PROPERTIES", +"UNREACHABLE" +], +"enumDeprecated": [ +false, +false, +false, +false, +false, +false, +true, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false +], +"enumDescriptions": [ +"Warning about failed cleanup of transient changes made by a failed operation.", +"A link to a deprecated resource was created.", +"When deploying and at least one of the resources has a type marked as deprecated", +"The user created a boot disk that is larger than image size.", +"When deploying and at least one of the resources has a type marked as experimental", +"Warning that is present in an external api call", +"Warning that value of a field has been overridden. Deprecated unused field.", +"The operation involved use of an injected kernel, which is deprecated.", +"A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", +"When deploying a deployment with a exceedingly large number of resources", +"Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", +"A resource depends on a missing type", +"The route's nextHopIp address is not assigned to an instance on the network.", +"The route's next hop instance cannot ip forward.", +"The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", +"The route's nextHopInstance URL refers to an instance that does not exist.", +"The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", +"The route's next hop instance does not have a status of RUNNING.", +"Error which is not critical. We decided to continue the process despite the mentioned error.", +"No results are present on a particular list page.", +"Success is reported, but some results may be missing due to errors", +"Quota information is not available to client requests (e.g: regions.list).", +"The user attempted to use a resource that requires a TOS they have not accepted.", +"Warning that a resource is in use.", +"One or more of the resources set to auto-delete could not be deleted because they were in use.", +"When a resource schema validation is ignored.", +"Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", +"When undeclared properties in the schema are present", +"A given scope cannot be reached." +], +"type": "string" +}, +"data": { +"description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", +"items": { +"properties": { +"key": { +"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", +"type": "string" +}, +"value": { +"description": "[Output Only] A warning data value corresponding to the key.", +"type": "string" +} +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "[Output Only] A human-readable description of the warning code.", +"type": "string" +} +}, +"type": "object" +} +}, +"type": "object" +}, "RoutersPreviewResponse": { "id": "RoutersPreviewResponse", "properties": { @@ -74184,10 +75067,12 @@ false "ddosProtection": { "enum": [ "ADVANCED", +"ADVANCED_PREVIEW", "STANDARD" ], "enumDescriptions": [ "", +"", "" ], "type": "string" @@ -75938,7 +76823,7 @@ false "description": "Customer provided encryption key when creating Snapshot from Instant Snapshot." }, "sourceInstantSnapshotId": { -"description": "[Output Only] The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this persistent disk. For example, if you created the persistent disk from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used.", +"description": "[Output Only] The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this snapshot. For example, if you created the snapshot from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used.", "type": "string" }, "sourceSnapshotSchedulePolicy": { @@ -79241,7 +80126,7 @@ false "type": "string" }, "purpose": { -"description": "The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PEER_MIGRATION or PRIVATE_SERVICE_CONNECT. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to PEER_MIGRATION is used for subnet migration from one peered VPC to another. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY.", +"description": "The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PEER_MIGRATION, PRIVATE_SERVICE_CONNECT or PRIVATE_NAT. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to PEER_MIGRATION is used for subnet migration from one peered VPC to another. A subnet with purpose set to PRIVATE_NAT is used for Private NAT IP address by Private NAT Gateway. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY.", "enum": [ "GLOBAL_MANAGED_PROXY", "INTERNAL_HTTPS_LOAD_BALANCER", @@ -84515,7 +85400,7 @@ false "type": "string" }, "purpose": { -"description": "The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PEER_MIGRATION or PRIVATE_SERVICE_CONNECT. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to PEER_MIGRATION is used for subnet migration from one peered VPC to another. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY.", +"description": "The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PEER_MIGRATION, PRIVATE_SERVICE_CONNECT or PRIVATE_NAT. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to PEER_MIGRATION is used for subnet migration from one peered VPC to another. A subnet with purpose set to PRIVATE_NAT is used for Private NAT IP address by Private NAT Gateway. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY.", "enum": [ "GLOBAL_MANAGED_PROXY", "INTERNAL_HTTPS_LOAD_BALANCER", From 0cfb93bba42a1ba16f209bd8f0cd1d449a8624ff Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 25 Feb 2025 07:08:17 +0000 Subject: [PATCH 06/36] feat(connectors): update the api #### connectors:v1 The following keys were added: - schemas.JsonSchema.properties.additionalDetails (Total Keys: 2) --- ....connections.connectionSchemaMetadata.html | 18 ++++++++ ...ors_v1.projects.locations.connections.html | 18 ++++++++ ...ions.connections.runtimeActionSchemas.html | 12 +++++ ...ions.connections.runtimeEntitySchemas.html | 6 +++ ...tomConnectors.customConnectorVersions.html | 6 +-- ...cations.providers.connectors.versions.html | 44 +++++++++---------- .../documents/connectors.v1.json | 14 ++++-- 7 files changed, 90 insertions(+), 28 deletions(-) diff --git a/docs/dyn/connectors_v1.projects.locations.connections.connectionSchemaMetadata.html b/docs/dyn/connectors_v1.projects.locations.connections.connectionSchemaMetadata.html index 6883116aad8..f109d3f3a64 100644 --- a/docs/dyn/connectors_v1.projects.locations.connections.connectionSchemaMetadata.html +++ b/docs/dyn/connectors_v1.projects.locations.connections.connectionSchemaMetadata.html @@ -204,6 +204,9 @@

Method Details

"description": "A String", # Output only. Brief Description of action "displayName": "A String", # Output only. Display Name of action to be shown on client side "inputJsonSchema": { # JsonSchema representation of schema metadata # Output only. JsonSchema representation of this action's input metadata + "additionalDetails": { # Additional details apart from standard json schema fields, this gives flexibility to store metadata about the schema + "a_key": "", # Properties of the object. + }, "default": "", # The default value of the field or object described by this schema. "description": "A String", # A description of this schema. "enum": [ # Possible values for an enumeration. This works in conjunction with `type` to represent types with a fixed set of legal values @@ -228,6 +231,9 @@

Method Details

"defaultValue": "", # The following field specifies the default value of the Parameter provided by the external system if a value is not provided. "description": "A String", # A brief description of the Parameter. "jsonSchema": { # JsonSchema representation of schema metadata # JsonSchema representation of this action's parameter + "additionalDetails": { # Additional details apart from standard json schema fields, this gives flexibility to store metadata about the schema + "a_key": "", # Properties of the object. + }, "default": "", # The default value of the field or object described by this schema. "description": "A String", # A description of this schema. "enum": [ # Possible values for an enumeration. This works in conjunction with `type` to represent types with a fixed set of legal values @@ -252,6 +258,9 @@

Method Details

], "inputSchemaAsString": "A String", # Output only. Input schema as string. "resultJsonSchema": { # JsonSchema representation of schema metadata # Output only. JsonSchema representation of this action's result metadata + "additionalDetails": { # Additional details apart from standard json schema fields, this gives flexibility to store metadata about the schema + "a_key": "", # Properties of the object. + }, "default": "", # The default value of the field or object described by this schema. "description": "A String", # A description of this schema. "enum": [ # Possible values for an enumeration. This works in conjunction with `type` to represent types with a fixed set of legal values @@ -277,6 +286,9 @@

Method Details

"description": "A String", # A brief description of the field. "field": "A String", # Name of the result field. "jsonSchema": { # JsonSchema representation of schema metadata # JsonSchema representation of this action's result + "additionalDetails": { # Additional details apart from standard json schema fields, this gives flexibility to store metadata about the schema + "a_key": "", # Properties of the object. + }, "default": "", # The default value of the field or object described by this schema. "description": "A String", # A description of this schema. "enum": [ # Possible values for an enumeration. This works in conjunction with `type` to represent types with a fixed set of legal values @@ -354,6 +366,9 @@

Method Details

"description": "A String", # A brief description of the Field. "field": "A String", # Name of the Field. "jsonSchema": { # JsonSchema representation of schema metadata # JsonSchema representation of this entity's schema + "additionalDetails": { # Additional details apart from standard json schema fields, this gives flexibility to store metadata about the schema + "a_key": "", # Properties of the object. + }, "default": "", # The default value of the field or object described by this schema. "description": "A String", # A description of this schema. "enum": [ # Possible values for an enumeration. This works in conjunction with `type` to represent types with a fixed set of legal values @@ -378,6 +393,9 @@

Method Details

}, ], "jsonSchema": { # JsonSchema representation of schema metadata # Output only. JsonSchema representation of this entity's metadata + "additionalDetails": { # Additional details apart from standard json schema fields, this gives flexibility to store metadata about the schema + "a_key": "", # Properties of the object. + }, "default": "", # The default value of the field or object described by this schema. "description": "A String", # A description of this schema. "enum": [ # Possible values for an enumeration. This works in conjunction with `type` to represent types with a fixed set of legal values diff --git a/docs/dyn/connectors_v1.projects.locations.connections.html b/docs/dyn/connectors_v1.projects.locations.connections.html index 20c0f5ac15a..25d23d582d1 100644 --- a/docs/dyn/connectors_v1.projects.locations.connections.html +++ b/docs/dyn/connectors_v1.projects.locations.connections.html @@ -2282,6 +2282,9 @@

Method Details

"description": "A String", # Output only. Brief Description of action "displayName": "A String", # Output only. Display Name of action to be shown on client side "inputJsonSchema": { # JsonSchema representation of schema metadata # Output only. JsonSchema representation of this action's input metadata + "additionalDetails": { # Additional details apart from standard json schema fields, this gives flexibility to store metadata about the schema + "a_key": "", # Properties of the object. + }, "default": "", # The default value of the field or object described by this schema. "description": "A String", # A description of this schema. "enum": [ # Possible values for an enumeration. This works in conjunction with `type` to represent types with a fixed set of legal values @@ -2306,6 +2309,9 @@

Method Details

"defaultValue": "", # The following field specifies the default value of the Parameter provided by the external system if a value is not provided. "description": "A String", # A brief description of the Parameter. "jsonSchema": { # JsonSchema representation of schema metadata # JsonSchema representation of this action's parameter + "additionalDetails": { # Additional details apart from standard json schema fields, this gives flexibility to store metadata about the schema + "a_key": "", # Properties of the object. + }, "default": "", # The default value of the field or object described by this schema. "description": "A String", # A description of this schema. "enum": [ # Possible values for an enumeration. This works in conjunction with `type` to represent types with a fixed set of legal values @@ -2330,6 +2336,9 @@

Method Details

], "inputSchemaAsString": "A String", # Output only. Input schema as string. "resultJsonSchema": { # JsonSchema representation of schema metadata # Output only. JsonSchema representation of this action's result metadata + "additionalDetails": { # Additional details apart from standard json schema fields, this gives flexibility to store metadata about the schema + "a_key": "", # Properties of the object. + }, "default": "", # The default value of the field or object described by this schema. "description": "A String", # A description of this schema. "enum": [ # Possible values for an enumeration. This works in conjunction with `type` to represent types with a fixed set of legal values @@ -2355,6 +2364,9 @@

Method Details

"description": "A String", # A brief description of the field. "field": "A String", # Name of the result field. "jsonSchema": { # JsonSchema representation of schema metadata # JsonSchema representation of this action's result + "additionalDetails": { # Additional details apart from standard json schema fields, this gives flexibility to store metadata about the schema + "a_key": "", # Properties of the object. + }, "default": "", # The default value of the field or object described by this schema. "description": "A String", # A description of this schema. "enum": [ # Possible values for an enumeration. This works in conjunction with `type` to represent types with a fixed set of legal values @@ -2836,6 +2848,9 @@

Method Details

"description": "A String", # A brief description of the Field. "field": "A String", # Name of the Field. "jsonSchema": { # JsonSchema representation of schema metadata # JsonSchema representation of this entity's schema + "additionalDetails": { # Additional details apart from standard json schema fields, this gives flexibility to store metadata about the schema + "a_key": "", # Properties of the object. + }, "default": "", # The default value of the field or object described by this schema. "description": "A String", # A description of this schema. "enum": [ # Possible values for an enumeration. This works in conjunction with `type` to represent types with a fixed set of legal values @@ -2860,6 +2875,9 @@

Method Details

}, ], "jsonSchema": { # JsonSchema representation of schema metadata # Output only. JsonSchema representation of this entity's metadata + "additionalDetails": { # Additional details apart from standard json schema fields, this gives flexibility to store metadata about the schema + "a_key": "", # Properties of the object. + }, "default": "", # The default value of the field or object described by this schema. "description": "A String", # A description of this schema. "enum": [ # Possible values for an enumeration. This works in conjunction with `type` to represent types with a fixed set of legal values diff --git a/docs/dyn/connectors_v1.projects.locations.connections.runtimeActionSchemas.html b/docs/dyn/connectors_v1.projects.locations.connections.runtimeActionSchemas.html index c3a6e21a253..016ae2ef2ad 100644 --- a/docs/dyn/connectors_v1.projects.locations.connections.runtimeActionSchemas.html +++ b/docs/dyn/connectors_v1.projects.locations.connections.runtimeActionSchemas.html @@ -115,6 +115,9 @@

Method Details

"description": "A String", # Output only. Brief Description of action "displayName": "A String", # Output only. Display Name of action to be shown on client side "inputJsonSchema": { # JsonSchema representation of schema metadata # Output only. JsonSchema representation of this action's input metadata + "additionalDetails": { # Additional details apart from standard json schema fields, this gives flexibility to store metadata about the schema + "a_key": "", # Properties of the object. + }, "default": "", # The default value of the field or object described by this schema. "description": "A String", # A description of this schema. "enum": [ # Possible values for an enumeration. This works in conjunction with `type` to represent types with a fixed set of legal values @@ -139,6 +142,9 @@

Method Details

"defaultValue": "", # The following field specifies the default value of the Parameter provided by the external system if a value is not provided. "description": "A String", # A brief description of the Parameter. "jsonSchema": { # JsonSchema representation of schema metadata # JsonSchema representation of this action's parameter + "additionalDetails": { # Additional details apart from standard json schema fields, this gives flexibility to store metadata about the schema + "a_key": "", # Properties of the object. + }, "default": "", # The default value of the field or object described by this schema. "description": "A String", # A description of this schema. "enum": [ # Possible values for an enumeration. This works in conjunction with `type` to represent types with a fixed set of legal values @@ -163,6 +169,9 @@

Method Details

], "inputSchemaAsString": "A String", # Output only. Input schema as string. "resultJsonSchema": { # JsonSchema representation of schema metadata # Output only. JsonSchema representation of this action's result metadata + "additionalDetails": { # Additional details apart from standard json schema fields, this gives flexibility to store metadata about the schema + "a_key": "", # Properties of the object. + }, "default": "", # The default value of the field or object described by this schema. "description": "A String", # A description of this schema. "enum": [ # Possible values for an enumeration. This works in conjunction with `type` to represent types with a fixed set of legal values @@ -188,6 +197,9 @@

Method Details

"description": "A String", # A brief description of the field. "field": "A String", # Name of the result field. "jsonSchema": { # JsonSchema representation of schema metadata # JsonSchema representation of this action's result + "additionalDetails": { # Additional details apart from standard json schema fields, this gives flexibility to store metadata about the schema + "a_key": "", # Properties of the object. + }, "default": "", # The default value of the field or object described by this schema. "description": "A String", # A description of this schema. "enum": [ # Possible values for an enumeration. This works in conjunction with `type` to represent types with a fixed set of legal values diff --git a/docs/dyn/connectors_v1.projects.locations.connections.runtimeEntitySchemas.html b/docs/dyn/connectors_v1.projects.locations.connections.runtimeEntitySchemas.html index 8bc396e7cd4..58814213222 100644 --- a/docs/dyn/connectors_v1.projects.locations.connections.runtimeEntitySchemas.html +++ b/docs/dyn/connectors_v1.projects.locations.connections.runtimeEntitySchemas.html @@ -121,6 +121,9 @@

Method Details

"description": "A String", # A brief description of the Field. "field": "A String", # Name of the Field. "jsonSchema": { # JsonSchema representation of schema metadata # JsonSchema representation of this entity's schema + "additionalDetails": { # Additional details apart from standard json schema fields, this gives flexibility to store metadata about the schema + "a_key": "", # Properties of the object. + }, "default": "", # The default value of the field or object described by this schema. "description": "A String", # A description of this schema. "enum": [ # Possible values for an enumeration. This works in conjunction with `type` to represent types with a fixed set of legal values @@ -145,6 +148,9 @@

Method Details

}, ], "jsonSchema": { # JsonSchema representation of schema metadata # Output only. JsonSchema representation of this entity's metadata + "additionalDetails": { # Additional details apart from standard json schema fields, this gives flexibility to store metadata about the schema + "a_key": "", # Properties of the object. + }, "default": "", # The default value of the field or object described by this schema. "description": "A String", # A description of this schema. "enum": [ # Possible values for an enumeration. This works in conjunction with `type` to represent types with a fixed set of legal values diff --git a/docs/dyn/connectors_v1.projects.locations.global_.customConnectors.customConnectorVersions.html b/docs/dyn/connectors_v1.projects.locations.global_.customConnectors.customConnectorVersions.html index 0e9c0349929..6f08b1b4bca 100644 --- a/docs/dyn/connectors_v1.projects.locations.global_.customConnectors.customConnectorVersions.html +++ b/docs/dyn/connectors_v1.projects.locations.global_.customConnectors.customConnectorVersions.html @@ -233,7 +233,7 @@

Method Details

}, "roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular Google Cloud resource for the selected principal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user. # Optional. Role grant configuration for the config variable. "helperTextTemplate": "A String", # Optional. Template that UI can use to provide helper text to customers. - "principal": "A String", # Optional. Prinicipal/Identity for whom the role need to assigned. + "principal": "A String", # Optional. Principal/Identity for whom the role need to assigned. "resource": { # Resource definition # Optional. Resource on which the roles needs to be granted for the principal. "pathTemplate": "A String", # Optional. Template to uniquely represent a Google Cloud resource in a format IAM expects This is a template that can have references to other values provided in the config variable template. "type": "A String", # Optional. Different types of resource supported. @@ -472,7 +472,7 @@

Method Details

}, "roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular Google Cloud resource for the selected principal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user. # Optional. Role grant configuration for the config variable. "helperTextTemplate": "A String", # Optional. Template that UI can use to provide helper text to customers. - "principal": "A String", # Optional. Prinicipal/Identity for whom the role need to assigned. + "principal": "A String", # Optional. Principal/Identity for whom the role need to assigned. "resource": { # Resource definition # Optional. Resource on which the roles needs to be granted for the principal. "pathTemplate": "A String", # Optional. Template to uniquely represent a Google Cloud resource in a format IAM expects This is a template that can have references to other values provided in the config variable template. "type": "A String", # Optional. Different types of resource supported. @@ -686,7 +686,7 @@

Method Details

}, "roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular Google Cloud resource for the selected principal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user. # Optional. Role grant configuration for the config variable. "helperTextTemplate": "A String", # Optional. Template that UI can use to provide helper text to customers. - "principal": "A String", # Optional. Prinicipal/Identity for whom the role need to assigned. + "principal": "A String", # Optional. Principal/Identity for whom the role need to assigned. "resource": { # Resource definition # Optional. Resource on which the roles needs to be granted for the principal. "pathTemplate": "A String", # Optional. Template to uniquely represent a Google Cloud resource in a format IAM expects This is a template that can have references to other values provided in the config variable template. "type": "A String", # Optional. Different types of resource supported. diff --git a/docs/dyn/connectors_v1.projects.locations.providers.connectors.versions.html b/docs/dyn/connectors_v1.projects.locations.providers.connectors.versions.html index 8552d88fe49..6dcfad8e928 100644 --- a/docs/dyn/connectors_v1.projects.locations.providers.connectors.versions.html +++ b/docs/dyn/connectors_v1.projects.locations.providers.connectors.versions.html @@ -239,7 +239,7 @@

Method Details

}, "roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular Google Cloud resource for the selected principal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user. # Optional. Role grant configuration for the config variable. "helperTextTemplate": "A String", # Optional. Template that UI can use to provide helper text to customers. - "principal": "A String", # Optional. Prinicipal/Identity for whom the role need to assigned. + "principal": "A String", # Optional. Principal/Identity for whom the role need to assigned. "resource": { # Resource definition # Optional. Resource on which the roles needs to be granted for the principal. "pathTemplate": "A String", # Optional. Template to uniquely represent a Google Cloud resource in a format IAM expects This is a template that can have references to other values provided in the config variable template. "type": "A String", # Optional. Different types of resource supported. @@ -315,7 +315,7 @@

Method Details

}, "roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular Google Cloud resource for the selected principal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user. # Optional. Role grant configuration for the config variable. "helperTextTemplate": "A String", # Optional. Template that UI can use to provide helper text to customers. - "principal": "A String", # Optional. Prinicipal/Identity for whom the role need to assigned. + "principal": "A String", # Optional. Principal/Identity for whom the role need to assigned. "resource": { # Resource definition # Optional. Resource on which the roles needs to be granted for the principal. "pathTemplate": "A String", # Optional. Template to uniquely represent a Google Cloud resource in a format IAM expects This is a template that can have references to other values provided in the config variable template. "type": "A String", # Optional. Different types of resource supported. @@ -379,7 +379,7 @@

Method Details

{ # Extraction Rule. "extractionRegex": "A String", # Regex used to extract backend details from source. If empty, whole source value will be used. "source": { # Source to extract the backend from. # Source on which the rule is applied. - "fieldId": "A String", # Field identifier. For example config vaiable name. + "fieldId": "A String", # Field identifier. For example config variable name. "sourceType": "A String", # Type of the source. }, }, @@ -443,7 +443,7 @@

Method Details

}, "roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular Google Cloud resource for the selected principal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user. # Optional. Role grant configuration for the config variable. "helperTextTemplate": "A String", # Optional. Template that UI can use to provide helper text to customers. - "principal": "A String", # Optional. Prinicipal/Identity for whom the role need to assigned. + "principal": "A String", # Optional. Principal/Identity for whom the role need to assigned. "resource": { # Resource definition # Optional. Resource on which the roles needs to be granted for the principal. "pathTemplate": "A String", # Optional. Template to uniquely represent a Google Cloud resource in a format IAM expects This is a template that can have references to other values provided in the config variable template. "type": "A String", # Optional. Different types of resource supported. @@ -517,7 +517,7 @@

Method Details

}, "roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular Google Cloud resource for the selected principal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user. # Optional. Role grant configuration for the config variable. "helperTextTemplate": "A String", # Optional. Template that UI can use to provide helper text to customers. - "principal": "A String", # Optional. Prinicipal/Identity for whom the role need to assigned. + "principal": "A String", # Optional. Principal/Identity for whom the role need to assigned. "resource": { # Resource definition # Optional. Resource on which the roles needs to be granted for the principal. "pathTemplate": "A String", # Optional. Template to uniquely represent a Google Cloud resource in a format IAM expects This is a template that can have references to other values provided in the config variable template. "type": "A String", # Optional. Different types of resource supported. @@ -593,7 +593,7 @@

Method Details

}, "roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular Google Cloud resource for the selected principal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user. # Optional. Role grant configuration for the config variable. "helperTextTemplate": "A String", # Optional. Template that UI can use to provide helper text to customers. - "principal": "A String", # Optional. Prinicipal/Identity for whom the role need to assigned. + "principal": "A String", # Optional. Principal/Identity for whom the role need to assigned. "resource": { # Resource definition # Optional. Resource on which the roles needs to be granted for the principal. "pathTemplate": "A String", # Optional. Template to uniquely represent a Google Cloud resource in a format IAM expects This is a template that can have references to other values provided in the config variable template. "type": "A String", # Optional. Different types of resource supported. @@ -669,7 +669,7 @@

Method Details

}, "roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular Google Cloud resource for the selected principal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user. # Optional. Role grant configuration for the config variable. "helperTextTemplate": "A String", # Optional. Template that UI can use to provide helper text to customers. - "principal": "A String", # Optional. Prinicipal/Identity for whom the role need to assigned. + "principal": "A String", # Optional. Principal/Identity for whom the role need to assigned. "resource": { # Resource definition # Optional. Resource on which the roles needs to be granted for the principal. "pathTemplate": "A String", # Optional. Template to uniquely represent a Google Cloud resource in a format IAM expects This is a template that can have references to other values provided in the config variable template. "type": "A String", # Optional. Different types of resource supported. @@ -772,7 +772,7 @@

Method Details

}, "roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular Google Cloud resource for the selected principal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user. # Optional. Role grant configuration for the config variable. "helperTextTemplate": "A String", # Optional. Template that UI can use to provide helper text to customers. - "principal": "A String", # Optional. Prinicipal/Identity for whom the role need to assigned. + "principal": "A String", # Optional. Principal/Identity for whom the role need to assigned. "resource": { # Resource definition # Optional. Resource on which the roles needs to be granted for the principal. "pathTemplate": "A String", # Optional. Template to uniquely represent a Google Cloud resource in a format IAM expects This is a template that can have references to other values provided in the config variable template. "type": "A String", # Optional. Different types of resource supported. @@ -798,7 +798,7 @@

Method Details

"releaseVersion": "A String", # Output only. ReleaseVersion of the connector, for example: "1.0.1-alpha". "roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular Google Cloud resource for the selected principal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user. # Output only. Role grant configuration for this config variable. It will be DEPRECATED soon. "helperTextTemplate": "A String", # Optional. Template that UI can use to provide helper text to customers. - "principal": "A String", # Optional. Prinicipal/Identity for whom the role need to assigned. + "principal": "A String", # Optional. Principal/Identity for whom the role need to assigned. "resource": { # Resource definition # Optional. Resource on which the roles needs to be granted for the principal. "pathTemplate": "A String", # Optional. Template to uniquely represent a Google Cloud resource in a format IAM expects This is a template that can have references to other values provided in the config variable template. "type": "A String", # Optional. Different types of resource supported. @@ -810,7 +810,7 @@

Method Details

"roleGrants": [ # Output only. Role grant configurations for this connector version. { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular Google Cloud resource for the selected principal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user. "helperTextTemplate": "A String", # Optional. Template that UI can use to provide helper text to customers. - "principal": "A String", # Optional. Prinicipal/Identity for whom the role need to assigned. + "principal": "A String", # Optional. Principal/Identity for whom the role need to assigned. "resource": { # Resource definition # Optional. Resource on which the roles needs to be granted for the principal. "pathTemplate": "A String", # Optional. Template to uniquely represent a Google Cloud resource in a format IAM expects This is a template that can have references to other values provided in the config variable template. "type": "A String", # Optional. Different types of resource supported. @@ -881,7 +881,7 @@

Method Details

}, "roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular Google Cloud resource for the selected principal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user. # Optional. Role grant configuration for the config variable. "helperTextTemplate": "A String", # Optional. Template that UI can use to provide helper text to customers. - "principal": "A String", # Optional. Prinicipal/Identity for whom the role need to assigned. + "principal": "A String", # Optional. Principal/Identity for whom the role need to assigned. "resource": { # Resource definition # Optional. Resource on which the roles needs to be granted for the principal. "pathTemplate": "A String", # Optional. Template to uniquely represent a Google Cloud resource in a format IAM expects This is a template that can have references to other values provided in the config variable template. "type": "A String", # Optional. Different types of resource supported. @@ -1010,7 +1010,7 @@

Method Details

}, "roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular Google Cloud resource for the selected principal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user. # Optional. Role grant configuration for the config variable. "helperTextTemplate": "A String", # Optional. Template that UI can use to provide helper text to customers. - "principal": "A String", # Optional. Prinicipal/Identity for whom the role need to assigned. + "principal": "A String", # Optional. Principal/Identity for whom the role need to assigned. "resource": { # Resource definition # Optional. Resource on which the roles needs to be granted for the principal. "pathTemplate": "A String", # Optional. Template to uniquely represent a Google Cloud resource in a format IAM expects This is a template that can have references to other values provided in the config variable template. "type": "A String", # Optional. Different types of resource supported. @@ -1086,7 +1086,7 @@

Method Details

}, "roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular Google Cloud resource for the selected principal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user. # Optional. Role grant configuration for the config variable. "helperTextTemplate": "A String", # Optional. Template that UI can use to provide helper text to customers. - "principal": "A String", # Optional. Prinicipal/Identity for whom the role need to assigned. + "principal": "A String", # Optional. Principal/Identity for whom the role need to assigned. "resource": { # Resource definition # Optional. Resource on which the roles needs to be granted for the principal. "pathTemplate": "A String", # Optional. Template to uniquely represent a Google Cloud resource in a format IAM expects This is a template that can have references to other values provided in the config variable template. "type": "A String", # Optional. Different types of resource supported. @@ -1150,7 +1150,7 @@

Method Details

{ # Extraction Rule. "extractionRegex": "A String", # Regex used to extract backend details from source. If empty, whole source value will be used. "source": { # Source to extract the backend from. # Source on which the rule is applied. - "fieldId": "A String", # Field identifier. For example config vaiable name. + "fieldId": "A String", # Field identifier. For example config variable name. "sourceType": "A String", # Type of the source. }, }, @@ -1214,7 +1214,7 @@

Method Details

}, "roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular Google Cloud resource for the selected principal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user. # Optional. Role grant configuration for the config variable. "helperTextTemplate": "A String", # Optional. Template that UI can use to provide helper text to customers. - "principal": "A String", # Optional. Prinicipal/Identity for whom the role need to assigned. + "principal": "A String", # Optional. Principal/Identity for whom the role need to assigned. "resource": { # Resource definition # Optional. Resource on which the roles needs to be granted for the principal. "pathTemplate": "A String", # Optional. Template to uniquely represent a Google Cloud resource in a format IAM expects This is a template that can have references to other values provided in the config variable template. "type": "A String", # Optional. Different types of resource supported. @@ -1288,7 +1288,7 @@

Method Details

}, "roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular Google Cloud resource for the selected principal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user. # Optional. Role grant configuration for the config variable. "helperTextTemplate": "A String", # Optional. Template that UI can use to provide helper text to customers. - "principal": "A String", # Optional. Prinicipal/Identity for whom the role need to assigned. + "principal": "A String", # Optional. Principal/Identity for whom the role need to assigned. "resource": { # Resource definition # Optional. Resource on which the roles needs to be granted for the principal. "pathTemplate": "A String", # Optional. Template to uniquely represent a Google Cloud resource in a format IAM expects This is a template that can have references to other values provided in the config variable template. "type": "A String", # Optional. Different types of resource supported. @@ -1364,7 +1364,7 @@

Method Details

}, "roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular Google Cloud resource for the selected principal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user. # Optional. Role grant configuration for the config variable. "helperTextTemplate": "A String", # Optional. Template that UI can use to provide helper text to customers. - "principal": "A String", # Optional. Prinicipal/Identity for whom the role need to assigned. + "principal": "A String", # Optional. Principal/Identity for whom the role need to assigned. "resource": { # Resource definition # Optional. Resource on which the roles needs to be granted for the principal. "pathTemplate": "A String", # Optional. Template to uniquely represent a Google Cloud resource in a format IAM expects This is a template that can have references to other values provided in the config variable template. "type": "A String", # Optional. Different types of resource supported. @@ -1440,7 +1440,7 @@

Method Details

}, "roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular Google Cloud resource for the selected principal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user. # Optional. Role grant configuration for the config variable. "helperTextTemplate": "A String", # Optional. Template that UI can use to provide helper text to customers. - "principal": "A String", # Optional. Prinicipal/Identity for whom the role need to assigned. + "principal": "A String", # Optional. Principal/Identity for whom the role need to assigned. "resource": { # Resource definition # Optional. Resource on which the roles needs to be granted for the principal. "pathTemplate": "A String", # Optional. Template to uniquely represent a Google Cloud resource in a format IAM expects This is a template that can have references to other values provided in the config variable template. "type": "A String", # Optional. Different types of resource supported. @@ -1543,7 +1543,7 @@

Method Details

}, "roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular Google Cloud resource for the selected principal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user. # Optional. Role grant configuration for the config variable. "helperTextTemplate": "A String", # Optional. Template that UI can use to provide helper text to customers. - "principal": "A String", # Optional. Prinicipal/Identity for whom the role need to assigned. + "principal": "A String", # Optional. Principal/Identity for whom the role need to assigned. "resource": { # Resource definition # Optional. Resource on which the roles needs to be granted for the principal. "pathTemplate": "A String", # Optional. Template to uniquely represent a Google Cloud resource in a format IAM expects This is a template that can have references to other values provided in the config variable template. "type": "A String", # Optional. Different types of resource supported. @@ -1569,7 +1569,7 @@

Method Details

"releaseVersion": "A String", # Output only. ReleaseVersion of the connector, for example: "1.0.1-alpha". "roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular Google Cloud resource for the selected principal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user. # Output only. Role grant configuration for this config variable. It will be DEPRECATED soon. "helperTextTemplate": "A String", # Optional. Template that UI can use to provide helper text to customers. - "principal": "A String", # Optional. Prinicipal/Identity for whom the role need to assigned. + "principal": "A String", # Optional. Principal/Identity for whom the role need to assigned. "resource": { # Resource definition # Optional. Resource on which the roles needs to be granted for the principal. "pathTemplate": "A String", # Optional. Template to uniquely represent a Google Cloud resource in a format IAM expects This is a template that can have references to other values provided in the config variable template. "type": "A String", # Optional. Different types of resource supported. @@ -1581,7 +1581,7 @@

Method Details

"roleGrants": [ # Output only. Role grant configurations for this connector version. { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular Google Cloud resource for the selected principal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user. "helperTextTemplate": "A String", # Optional. Template that UI can use to provide helper text to customers. - "principal": "A String", # Optional. Prinicipal/Identity for whom the role need to assigned. + "principal": "A String", # Optional. Principal/Identity for whom the role need to assigned. "resource": { # Resource definition # Optional. Resource on which the roles needs to be granted for the principal. "pathTemplate": "A String", # Optional. Template to uniquely represent a Google Cloud resource in a format IAM expects This is a template that can have references to other values provided in the config variable template. "type": "A String", # Optional. Different types of resource supported. @@ -1652,7 +1652,7 @@

Method Details

}, "roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular Google Cloud resource for the selected principal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user. # Optional. Role grant configuration for the config variable. "helperTextTemplate": "A String", # Optional. Template that UI can use to provide helper text to customers. - "principal": "A String", # Optional. Prinicipal/Identity for whom the role need to assigned. + "principal": "A String", # Optional. Principal/Identity for whom the role need to assigned. "resource": { # Resource definition # Optional. Resource on which the roles needs to be granted for the principal. "pathTemplate": "A String", # Optional. Template to uniquely represent a Google Cloud resource in a format IAM expects This is a template that can have references to other values provided in the config variable template. "type": "A String", # Optional. Different types of resource supported. diff --git a/googleapiclient/discovery_cache/documents/connectors.v1.json b/googleapiclient/discovery_cache/documents/connectors.v1.json index 865d35455a1..d03446952c5 100644 --- a/googleapiclient/discovery_cache/documents/connectors.v1.json +++ b/googleapiclient/discovery_cache/documents/connectors.v1.json @@ -2560,7 +2560,7 @@ } } }, -"revision": "20250205", +"revision": "20250218", "rootUrl": "https://connectors.googleapis.com/", "schemas": { "AuditConfig": { @@ -5569,6 +5569,14 @@ false "description": "JsonSchema representation of schema metadata", "id": "JsonSchema", "properties": { +"additionalDetails": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Additional details apart from standard json schema fields, this gives flexibility to store metadata about the schema", +"type": "object" +}, "default": { "description": "The default value of the field or object described by this schema.", "type": "any" @@ -7298,7 +7306,7 @@ false "type": "string" }, "principal": { -"description": "Optional. Prinicipal/Identity for whom the role need to assigned.", +"description": "Optional. Principal/Identity for whom the role need to assigned.", "enum": [ "PRINCIPAL_UNSPECIFIED", "CONNECTOR_SA" @@ -7710,7 +7718,7 @@ false "id": "Source", "properties": { "fieldId": { -"description": "Field identifier. For example config vaiable name.", +"description": "Field identifier. For example config variable name.", "type": "string" }, "sourceType": { From 21dc8b239d66f63eec9774581a7a044350a16898 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 25 Feb 2025 07:08:17 +0000 Subject: [PATCH 07/36] feat(contactcenterinsights): update the api #### contactcenterinsights:v1 The following keys were deleted: - resources.projects.resources.locations.resources.qaQuestionTags.methods.create (Total Keys: 12) - resources.projects.resources.locations.resources.qaQuestionTags.methods.list (Total Keys: 18) - schemas.GoogleCloudContactcenterinsightsV1ListQaQuestionTagsResponse (Total Keys: 5) - schemas.GoogleCloudContactcenterinsightsV1QaQuestionTag (Total Keys: 12) The following keys were added: - schemas.GoogleCloudContactcenterinsightsV1ExportInsightsDataMetadata.properties.completedExportCount (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1ExportInsightsDataMetadata.properties.failedExportCount (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataMetadata.properties.completedExportCount (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataMetadata.properties.failedExportCount (Total Keys: 2) --- ...ects.locations.conversations.analyses.html | 36 ++-- ...ocations.conversations.feedbackLabels.html | 48 ++--- ...s_v1.projects.locations.conversations.html | 112 +++++------ ...tcenterinsights_v1.projects.locations.html | 21 +- .../documents/contactcenterinsights.v1.json | 179 ++++-------------- 5 files changed, 143 insertions(+), 253 deletions(-) diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.analyses.html b/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.analyses.html index 059f5fbdd10..5c5906650c9 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.analyses.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.analyses.html @@ -124,7 +124,7 @@

Method Details

"entityMentionData": { # The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation. # Data specifying an entity mention. "entityUniqueId": "A String", # The key of this entity in conversation entities. Can be used to retrieve the exact `Entity` this mention is attached to. "sentiment": { # The data for a sentiment annotation. # Sentiment expressed for this mention of the entity. - "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. + "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score. "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, "type": "A String", # The type of the entity mention. @@ -138,7 +138,7 @@

Method Details

}, "issueMatchData": { # The data for an issue match annotation. # Data specifying an issue match. "issueAssignment": { # Information about the issue. # Information about the issue's assignment. - "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then. + "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analysis and immutable since then. "issue": "A String", # Resource name of the assigned issue. "score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1]. }, @@ -148,7 +148,7 @@

Method Details

"phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher. }, "sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment. - "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. + "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score. "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, "silenceData": { # The data for a silence annotation. # Data specifying silence. @@ -163,7 +163,7 @@

Method Details

}, "salience": 3.14, # The salience score associated with the entity in the [0, 1.0] range. The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient. "sentiment": { # The data for a sentiment annotation. # The aggregate sentiment expressed for this entity in the conversation. - "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. + "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score. "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, "type": "A String", # The entity type. @@ -179,7 +179,7 @@

Method Details

"issueModel": "A String", # Issue model that generates the result. Format: projects/{project}/locations/{location}/issueModels/{issue_model} "issues": [ # All the matched issues. { # Information about the issue. - "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then. + "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analysis and immutable since then. "issue": "A String", # Resource name of the assigned issue. "score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1]. }, @@ -266,7 +266,7 @@

Method Details

{ # One channel of conversation-level sentiment data. "channelTag": 42, # The channel of the audio that the data applies to. "sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment. - "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. + "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score. "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, }, @@ -389,7 +389,7 @@

Method Details

"entityMentionData": { # The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation. # Data specifying an entity mention. "entityUniqueId": "A String", # The key of this entity in conversation entities. Can be used to retrieve the exact `Entity` this mention is attached to. "sentiment": { # The data for a sentiment annotation. # Sentiment expressed for this mention of the entity. - "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. + "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score. "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, "type": "A String", # The type of the entity mention. @@ -403,7 +403,7 @@

Method Details

}, "issueMatchData": { # The data for an issue match annotation. # Data specifying an issue match. "issueAssignment": { # Information about the issue. # Information about the issue's assignment. - "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then. + "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analysis and immutable since then. "issue": "A String", # Resource name of the assigned issue. "score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1]. }, @@ -413,7 +413,7 @@

Method Details

"phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher. }, "sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment. - "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. + "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score. "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, "silenceData": { # The data for a silence annotation. # Data specifying silence. @@ -428,7 +428,7 @@

Method Details

}, "salience": 3.14, # The salience score associated with the entity in the [0, 1.0] range. The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient. "sentiment": { # The data for a sentiment annotation. # The aggregate sentiment expressed for this entity in the conversation. - "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. + "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score. "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, "type": "A String", # The entity type. @@ -444,7 +444,7 @@

Method Details

"issueModel": "A String", # Issue model that generates the result. Format: projects/{project}/locations/{location}/issueModels/{issue_model} "issues": [ # All the matched issues. { # Information about the issue. - "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then. + "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analysis and immutable since then. "issue": "A String", # Resource name of the assigned issue. "score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1]. }, @@ -531,7 +531,7 @@

Method Details

{ # One channel of conversation-level sentiment data. "channelTag": 42, # The channel of the audio that the data applies to. "sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment. - "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. + "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score. "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, }, @@ -613,7 +613,7 @@

Method Details

"entityMentionData": { # The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation. # Data specifying an entity mention. "entityUniqueId": "A String", # The key of this entity in conversation entities. Can be used to retrieve the exact `Entity` this mention is attached to. "sentiment": { # The data for a sentiment annotation. # Sentiment expressed for this mention of the entity. - "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. + "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score. "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, "type": "A String", # The type of the entity mention. @@ -627,7 +627,7 @@

Method Details

}, "issueMatchData": { # The data for an issue match annotation. # Data specifying an issue match. "issueAssignment": { # Information about the issue. # Information about the issue's assignment. - "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then. + "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analysis and immutable since then. "issue": "A String", # Resource name of the assigned issue. "score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1]. }, @@ -637,7 +637,7 @@

Method Details

"phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher. }, "sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment. - "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. + "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score. "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, "silenceData": { # The data for a silence annotation. # Data specifying silence. @@ -652,7 +652,7 @@

Method Details

}, "salience": 3.14, # The salience score associated with the entity in the [0, 1.0] range. The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient. "sentiment": { # The data for a sentiment annotation. # The aggregate sentiment expressed for this entity in the conversation. - "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. + "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score. "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, "type": "A String", # The entity type. @@ -668,7 +668,7 @@

Method Details

"issueModel": "A String", # Issue model that generates the result. Format: projects/{project}/locations/{location}/issueModels/{issue_model} "issues": [ # All the matched issues. { # Information about the issue. - "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then. + "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analysis and immutable since then. "issue": "A String", # Resource name of the assigned issue. "score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1]. }, @@ -755,7 +755,7 @@

Method Details

{ # One channel of conversation-level sentiment data. "channelTag": 42, # The channel of the audio that the data applies to. "sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment. - "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. + "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score. "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, }, diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.feedbackLabels.html b/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.feedbackLabels.html index 450c81e5ff3..fb61d56de37 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.feedbackLabels.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.feedbackLabels.html @@ -110,12 +110,12 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Represents a conversation, resource, and label provided by the user. +{ # Represents a conversation, resource, and label provided by the user. Can take the form of a string label or a QaAnswer label. QaAnswer labels are used for Quality AI example conversations. String labels are used for Topic Modeling. "createTime": "A String", # Output only. Create time of the label. - "label": "A String", # String label. - "labeledResource": "A String", # Resource name of the resource to be labeled. + "label": "A String", # String label used for Topic Modeling. + "labeledResource": "A String", # Resource name of the resource to be labeled. Supported resources: - qaScorecards/{scorecard}/revisions/{revision}/qaQuestions/{question} - issueModels/{issue_model} "name": "A String", # Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label} - "qaAnswerLabel": { # Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question. # QaAnswer label. + "qaAnswerLabel": { # Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question. # QaAnswer label used for Quality AI example conversations. "boolValue": True or False, # Boolean value. "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key. "naValue": True or False, # A value of "Not Applicable (N/A)". Should only ever be `true`. @@ -137,12 +137,12 @@

Method Details

Returns: An object of the form: - { # Represents a conversation, resource, and label provided by the user. + { # Represents a conversation, resource, and label provided by the user. Can take the form of a string label or a QaAnswer label. QaAnswer labels are used for Quality AI example conversations. String labels are used for Topic Modeling. "createTime": "A String", # Output only. Create time of the label. - "label": "A String", # String label. - "labeledResource": "A String", # Resource name of the resource to be labeled. + "label": "A String", # String label used for Topic Modeling. + "labeledResource": "A String", # Resource name of the resource to be labeled. Supported resources: - qaScorecards/{scorecard}/revisions/{revision}/qaQuestions/{question} - issueModels/{issue_model} "name": "A String", # Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label} - "qaAnswerLabel": { # Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question. # QaAnswer label. + "qaAnswerLabel": { # Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question. # QaAnswer label used for Quality AI example conversations. "boolValue": True or False, # Boolean value. "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key. "naValue": True or False, # A value of "Not Applicable (N/A)". Should only ever be `true`. @@ -188,12 +188,12 @@

Method Details

Returns: An object of the form: - { # Represents a conversation, resource, and label provided by the user. + { # Represents a conversation, resource, and label provided by the user. Can take the form of a string label or a QaAnswer label. QaAnswer labels are used for Quality AI example conversations. String labels are used for Topic Modeling. "createTime": "A String", # Output only. Create time of the label. - "label": "A String", # String label. - "labeledResource": "A String", # Resource name of the resource to be labeled. + "label": "A String", # String label used for Topic Modeling. + "labeledResource": "A String", # Resource name of the resource to be labeled. Supported resources: - qaScorecards/{scorecard}/revisions/{revision}/qaQuestions/{question} - issueModels/{issue_model} "name": "A String", # Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label} - "qaAnswerLabel": { # Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question. # QaAnswer label. + "qaAnswerLabel": { # Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question. # QaAnswer label used for Quality AI example conversations. "boolValue": True or False, # Boolean value. "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key. "naValue": True or False, # A value of "Not Applicable (N/A)". Should only ever be `true`. @@ -226,12 +226,12 @@

Method Details

{ # The response for listing feedback labels. "feedbackLabels": [ # The feedback labels that match the request. - { # Represents a conversation, resource, and label provided by the user. + { # Represents a conversation, resource, and label provided by the user. Can take the form of a string label or a QaAnswer label. QaAnswer labels are used for Quality AI example conversations. String labels are used for Topic Modeling. "createTime": "A String", # Output only. Create time of the label. - "label": "A String", # String label. - "labeledResource": "A String", # Resource name of the resource to be labeled. + "label": "A String", # String label used for Topic Modeling. + "labeledResource": "A String", # Resource name of the resource to be labeled. Supported resources: - qaScorecards/{scorecard}/revisions/{revision}/qaQuestions/{question} - issueModels/{issue_model} "name": "A String", # Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label} - "qaAnswerLabel": { # Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question. # QaAnswer label. + "qaAnswerLabel": { # Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question. # QaAnswer label used for Quality AI example conversations. "boolValue": True or False, # Boolean value. "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key. "naValue": True or False, # A value of "Not Applicable (N/A)". Should only ever be `true`. @@ -271,12 +271,12 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Represents a conversation, resource, and label provided by the user. +{ # Represents a conversation, resource, and label provided by the user. Can take the form of a string label or a QaAnswer label. QaAnswer labels are used for Quality AI example conversations. String labels are used for Topic Modeling. "createTime": "A String", # Output only. Create time of the label. - "label": "A String", # String label. - "labeledResource": "A String", # Resource name of the resource to be labeled. + "label": "A String", # String label used for Topic Modeling. + "labeledResource": "A String", # Resource name of the resource to be labeled. Supported resources: - qaScorecards/{scorecard}/revisions/{revision}/qaQuestions/{question} - issueModels/{issue_model} "name": "A String", # Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label} - "qaAnswerLabel": { # Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question. # QaAnswer label. + "qaAnswerLabel": { # Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question. # QaAnswer label used for Quality AI example conversations. "boolValue": True or False, # Boolean value. "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key. "naValue": True or False, # A value of "Not Applicable (N/A)". Should only ever be `true`. @@ -298,12 +298,12 @@

Method Details

Returns: An object of the form: - { # Represents a conversation, resource, and label provided by the user. + { # Represents a conversation, resource, and label provided by the user. Can take the form of a string label or a QaAnswer label. QaAnswer labels are used for Quality AI example conversations. String labels are used for Topic Modeling. "createTime": "A String", # Output only. Create time of the label. - "label": "A String", # String label. - "labeledResource": "A String", # Resource name of the resource to be labeled. + "label": "A String", # String label used for Topic Modeling. + "labeledResource": "A String", # Resource name of the resource to be labeled. Supported resources: - qaScorecards/{scorecard}/revisions/{revision}/qaQuestions/{question} - issueModels/{issue_model} "name": "A String", # Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label} - "qaAnswerLabel": { # Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question. # QaAnswer label. + "qaAnswerLabel": { # Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question. # QaAnswer label used for Quality AI example conversations. "boolValue": True or False, # Boolean value. "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key. "naValue": True or False, # A value of "Not Applicable (N/A)". Should only ever be `true`. diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.html b/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.html index a5ce553611e..2999a2aa249 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.html @@ -344,7 +344,7 @@

Method Details

"entityMentionData": { # The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation. # Data specifying an entity mention. "entityUniqueId": "A String", # The key of this entity in conversation entities. Can be used to retrieve the exact `Entity` this mention is attached to. "sentiment": { # The data for a sentiment annotation. # Sentiment expressed for this mention of the entity. - "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. + "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score. "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, "type": "A String", # The type of the entity mention. @@ -358,7 +358,7 @@

Method Details

}, "issueMatchData": { # The data for an issue match annotation. # Data specifying an issue match. "issueAssignment": { # Information about the issue. # Information about the issue's assignment. - "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then. + "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analysis and immutable since then. "issue": "A String", # Resource name of the assigned issue. "score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1]. }, @@ -368,7 +368,7 @@

Method Details

"phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher. }, "sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment. - "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. + "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score. "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, "silenceData": { # The data for a silence annotation. # Data specifying silence. @@ -383,7 +383,7 @@

Method Details

}, "salience": 3.14, # The salience score associated with the entity in the [0, 1.0] range. The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient. "sentiment": { # The data for a sentiment annotation. # The aggregate sentiment expressed for this entity in the conversation. - "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. + "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score. "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, "type": "A String", # The entity type. @@ -399,7 +399,7 @@

Method Details

"issueModel": "A String", # Issue model that generates the result. Format: projects/{project}/locations/{location}/issueModels/{issue_model} "issues": [ # All the matched issues. { # Information about the issue. - "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then. + "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analysis and immutable since then. "issue": "A String", # Resource name of the assigned issue. "score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1]. }, @@ -486,7 +486,7 @@

Method Details

{ # One channel of conversation-level sentiment data. "channelTag": 42, # The channel of the audio that the data applies to. "sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment. - "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. + "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score. "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, }, @@ -543,7 +543,7 @@

Method Details

}, }, "medium": "A String", # Immutable. The conversation medium, if unspecified will default to PHONE_CALL. - "metadataJson": "A String", # Input only. JSON metadata encoded as a string. This field is primarily used by Insights integrations with various telphony systems and must be in one of Insight's supported formats. + "metadataJson": "A String", # Input only. JSON metadata encoded as a string. This field is primarily used by Insights integrations with various telephony systems and must be in one of Insight's supported formats. "name": "A String", # Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation} "obfuscatedUserId": "A String", # Obfuscated user ID which the customer sent to us. "qualityMetadata": { # Conversation metadata related to quality management. # Conversation metadata related to quality management. @@ -659,7 +659,7 @@

Method Details

"userId": "A String", # A user-specified ID representing the participant. }, "sentiment": { # The data for a sentiment annotation. # The sentiment for this transcript segment. - "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. + "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score. "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, "text": "A String", # The text of this segment. @@ -733,7 +733,7 @@

Method Details

"entityMentionData": { # The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation. # Data specifying an entity mention. "entityUniqueId": "A String", # The key of this entity in conversation entities. Can be used to retrieve the exact `Entity` this mention is attached to. "sentiment": { # The data for a sentiment annotation. # Sentiment expressed for this mention of the entity. - "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. + "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score. "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, "type": "A String", # The type of the entity mention. @@ -747,7 +747,7 @@

Method Details

}, "issueMatchData": { # The data for an issue match annotation. # Data specifying an issue match. "issueAssignment": { # Information about the issue. # Information about the issue's assignment. - "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then. + "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analysis and immutable since then. "issue": "A String", # Resource name of the assigned issue. "score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1]. }, @@ -757,7 +757,7 @@

Method Details

"phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher. }, "sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment. - "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. + "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score. "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, "silenceData": { # The data for a silence annotation. # Data specifying silence. @@ -772,7 +772,7 @@

Method Details

}, "salience": 3.14, # The salience score associated with the entity in the [0, 1.0] range. The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient. "sentiment": { # The data for a sentiment annotation. # The aggregate sentiment expressed for this entity in the conversation. - "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. + "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score. "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, "type": "A String", # The entity type. @@ -788,7 +788,7 @@

Method Details

"issueModel": "A String", # Issue model that generates the result. Format: projects/{project}/locations/{location}/issueModels/{issue_model} "issues": [ # All the matched issues. { # Information about the issue. - "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then. + "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analysis and immutable since then. "issue": "A String", # Resource name of the assigned issue. "score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1]. }, @@ -875,7 +875,7 @@

Method Details

{ # One channel of conversation-level sentiment data. "channelTag": 42, # The channel of the audio that the data applies to. "sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment. - "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. + "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score. "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, }, @@ -932,7 +932,7 @@

Method Details

}, }, "medium": "A String", # Immutable. The conversation medium, if unspecified will default to PHONE_CALL. - "metadataJson": "A String", # Input only. JSON metadata encoded as a string. This field is primarily used by Insights integrations with various telphony systems and must be in one of Insight's supported formats. + "metadataJson": "A String", # Input only. JSON metadata encoded as a string. This field is primarily used by Insights integrations with various telephony systems and must be in one of Insight's supported formats. "name": "A String", # Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation} "obfuscatedUserId": "A String", # Obfuscated user ID which the customer sent to us. "qualityMetadata": { # Conversation metadata related to quality management. # Conversation metadata related to quality management. @@ -1048,7 +1048,7 @@

Method Details

"userId": "A String", # A user-specified ID representing the participant. }, "sentiment": { # The data for a sentiment annotation. # The sentiment for this transcript segment. - "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. + "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score. "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, "text": "A String", # The text of this segment. @@ -1152,7 +1152,7 @@

Method Details

"entityMentionData": { # The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation. # Data specifying an entity mention. "entityUniqueId": "A String", # The key of this entity in conversation entities. Can be used to retrieve the exact `Entity` this mention is attached to. "sentiment": { # The data for a sentiment annotation. # Sentiment expressed for this mention of the entity. - "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. + "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score. "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, "type": "A String", # The type of the entity mention. @@ -1166,7 +1166,7 @@

Method Details

}, "issueMatchData": { # The data for an issue match annotation. # Data specifying an issue match. "issueAssignment": { # Information about the issue. # Information about the issue's assignment. - "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then. + "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analysis and immutable since then. "issue": "A String", # Resource name of the assigned issue. "score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1]. }, @@ -1176,7 +1176,7 @@

Method Details

"phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher. }, "sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment. - "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. + "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score. "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, "silenceData": { # The data for a silence annotation. # Data specifying silence. @@ -1191,7 +1191,7 @@

Method Details

}, "salience": 3.14, # The salience score associated with the entity in the [0, 1.0] range. The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient. "sentiment": { # The data for a sentiment annotation. # The aggregate sentiment expressed for this entity in the conversation. - "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. + "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score. "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, "type": "A String", # The entity type. @@ -1207,7 +1207,7 @@

Method Details

"issueModel": "A String", # Issue model that generates the result. Format: projects/{project}/locations/{location}/issueModels/{issue_model} "issues": [ # All the matched issues. { # Information about the issue. - "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then. + "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analysis and immutable since then. "issue": "A String", # Resource name of the assigned issue. "score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1]. }, @@ -1294,7 +1294,7 @@

Method Details

{ # One channel of conversation-level sentiment data. "channelTag": 42, # The channel of the audio that the data applies to. "sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment. - "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. + "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score. "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, }, @@ -1351,7 +1351,7 @@

Method Details

}, }, "medium": "A String", # Immutable. The conversation medium, if unspecified will default to PHONE_CALL. - "metadataJson": "A String", # Input only. JSON metadata encoded as a string. This field is primarily used by Insights integrations with various telphony systems and must be in one of Insight's supported formats. + "metadataJson": "A String", # Input only. JSON metadata encoded as a string. This field is primarily used by Insights integrations with various telephony systems and must be in one of Insight's supported formats. "name": "A String", # Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation} "obfuscatedUserId": "A String", # Obfuscated user ID which the customer sent to us. "qualityMetadata": { # Conversation metadata related to quality management. # Conversation metadata related to quality management. @@ -1467,7 +1467,7 @@

Method Details

"userId": "A String", # A user-specified ID representing the participant. }, "sentiment": { # The data for a sentiment annotation. # The sentiment for this transcript segment. - "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. + "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score. "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, "text": "A String", # The text of this segment. @@ -1624,7 +1624,7 @@

Method Details

"entityMentionData": { # The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation. # Data specifying an entity mention. "entityUniqueId": "A String", # The key of this entity in conversation entities. Can be used to retrieve the exact `Entity` this mention is attached to. "sentiment": { # The data for a sentiment annotation. # Sentiment expressed for this mention of the entity. - "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. + "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score. "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, "type": "A String", # The type of the entity mention. @@ -1638,7 +1638,7 @@

Method Details

}, "issueMatchData": { # The data for an issue match annotation. # Data specifying an issue match. "issueAssignment": { # Information about the issue. # Information about the issue's assignment. - "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then. + "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analysis and immutable since then. "issue": "A String", # Resource name of the assigned issue. "score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1]. }, @@ -1648,7 +1648,7 @@

Method Details

"phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher. }, "sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment. - "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. + "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score. "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, "silenceData": { # The data for a silence annotation. # Data specifying silence. @@ -1663,7 +1663,7 @@

Method Details

}, "salience": 3.14, # The salience score associated with the entity in the [0, 1.0] range. The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient. "sentiment": { # The data for a sentiment annotation. # The aggregate sentiment expressed for this entity in the conversation. - "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. + "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score. "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, "type": "A String", # The entity type. @@ -1679,7 +1679,7 @@

Method Details

"issueModel": "A String", # Issue model that generates the result. Format: projects/{project}/locations/{location}/issueModels/{issue_model} "issues": [ # All the matched issues. { # Information about the issue. - "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then. + "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analysis and immutable since then. "issue": "A String", # Resource name of the assigned issue. "score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1]. }, @@ -1766,7 +1766,7 @@

Method Details

{ # One channel of conversation-level sentiment data. "channelTag": 42, # The channel of the audio that the data applies to. "sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment. - "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. + "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score. "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, }, @@ -1823,7 +1823,7 @@

Method Details

}, }, "medium": "A String", # Immutable. The conversation medium, if unspecified will default to PHONE_CALL. - "metadataJson": "A String", # Input only. JSON metadata encoded as a string. This field is primarily used by Insights integrations with various telphony systems and must be in one of Insight's supported formats. + "metadataJson": "A String", # Input only. JSON metadata encoded as a string. This field is primarily used by Insights integrations with various telephony systems and must be in one of Insight's supported formats. "name": "A String", # Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation} "obfuscatedUserId": "A String", # Obfuscated user ID which the customer sent to us. "qualityMetadata": { # Conversation metadata related to quality management. # Conversation metadata related to quality management. @@ -1939,7 +1939,7 @@

Method Details

"userId": "A String", # A user-specified ID representing the participant. }, "sentiment": { # The data for a sentiment annotation. # The sentiment for this transcript segment. - "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. + "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score. "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, "text": "A String", # The text of this segment. @@ -2031,7 +2031,7 @@

Method Details

"entityMentionData": { # The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation. # Data specifying an entity mention. "entityUniqueId": "A String", # The key of this entity in conversation entities. Can be used to retrieve the exact `Entity` this mention is attached to. "sentiment": { # The data for a sentiment annotation. # Sentiment expressed for this mention of the entity. - "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. + "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score. "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, "type": "A String", # The type of the entity mention. @@ -2045,7 +2045,7 @@

Method Details

}, "issueMatchData": { # The data for an issue match annotation. # Data specifying an issue match. "issueAssignment": { # Information about the issue. # Information about the issue's assignment. - "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then. + "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analysis and immutable since then. "issue": "A String", # Resource name of the assigned issue. "score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1]. }, @@ -2055,7 +2055,7 @@

Method Details

"phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher. }, "sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment. - "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. + "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score. "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, "silenceData": { # The data for a silence annotation. # Data specifying silence. @@ -2070,7 +2070,7 @@

Method Details

}, "salience": 3.14, # The salience score associated with the entity in the [0, 1.0] range. The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient. "sentiment": { # The data for a sentiment annotation. # The aggregate sentiment expressed for this entity in the conversation. - "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. + "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score. "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, "type": "A String", # The entity type. @@ -2086,7 +2086,7 @@

Method Details

"issueModel": "A String", # Issue model that generates the result. Format: projects/{project}/locations/{location}/issueModels/{issue_model} "issues": [ # All the matched issues. { # Information about the issue. - "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then. + "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analysis and immutable since then. "issue": "A String", # Resource name of the assigned issue. "score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1]. }, @@ -2173,7 +2173,7 @@

Method Details

{ # One channel of conversation-level sentiment data. "channelTag": 42, # The channel of the audio that the data applies to. "sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment. - "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. + "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score. "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, }, @@ -2230,7 +2230,7 @@

Method Details

}, }, "medium": "A String", # Immutable. The conversation medium, if unspecified will default to PHONE_CALL. - "metadataJson": "A String", # Input only. JSON metadata encoded as a string. This field is primarily used by Insights integrations with various telphony systems and must be in one of Insight's supported formats. + "metadataJson": "A String", # Input only. JSON metadata encoded as a string. This field is primarily used by Insights integrations with various telephony systems and must be in one of Insight's supported formats. "name": "A String", # Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation} "obfuscatedUserId": "A String", # Obfuscated user ID which the customer sent to us. "qualityMetadata": { # Conversation metadata related to quality management. # Conversation metadata related to quality management. @@ -2346,7 +2346,7 @@

Method Details

"userId": "A String", # A user-specified ID representing the participant. }, "sentiment": { # The data for a sentiment annotation. # The sentiment for this transcript segment. - "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. + "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score. "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, "text": "A String", # The text of this segment. @@ -2420,7 +2420,7 @@

Method Details

"entityMentionData": { # The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation. # Data specifying an entity mention. "entityUniqueId": "A String", # The key of this entity in conversation entities. Can be used to retrieve the exact `Entity` this mention is attached to. "sentiment": { # The data for a sentiment annotation. # Sentiment expressed for this mention of the entity. - "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. + "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score. "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, "type": "A String", # The type of the entity mention. @@ -2434,7 +2434,7 @@

Method Details

}, "issueMatchData": { # The data for an issue match annotation. # Data specifying an issue match. "issueAssignment": { # Information about the issue. # Information about the issue's assignment. - "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then. + "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analysis and immutable since then. "issue": "A String", # Resource name of the assigned issue. "score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1]. }, @@ -2444,7 +2444,7 @@

Method Details

"phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher. }, "sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment. - "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. + "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score. "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, "silenceData": { # The data for a silence annotation. # Data specifying silence. @@ -2459,7 +2459,7 @@

Method Details

}, "salience": 3.14, # The salience score associated with the entity in the [0, 1.0] range. The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient. "sentiment": { # The data for a sentiment annotation. # The aggregate sentiment expressed for this entity in the conversation. - "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. + "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score. "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, "type": "A String", # The entity type. @@ -2475,7 +2475,7 @@

Method Details

"issueModel": "A String", # Issue model that generates the result. Format: projects/{project}/locations/{location}/issueModels/{issue_model} "issues": [ # All the matched issues. { # Information about the issue. - "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then. + "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analysis and immutable since then. "issue": "A String", # Resource name of the assigned issue. "score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1]. }, @@ -2562,7 +2562,7 @@

Method Details

{ # One channel of conversation-level sentiment data. "channelTag": 42, # The channel of the audio that the data applies to. "sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment. - "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. + "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score. "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, }, @@ -2619,7 +2619,7 @@

Method Details

}, }, "medium": "A String", # Immutable. The conversation medium, if unspecified will default to PHONE_CALL. - "metadataJson": "A String", # Input only. JSON metadata encoded as a string. This field is primarily used by Insights integrations with various telphony systems and must be in one of Insight's supported formats. + "metadataJson": "A String", # Input only. JSON metadata encoded as a string. This field is primarily used by Insights integrations with various telephony systems and must be in one of Insight's supported formats. "name": "A String", # Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation} "obfuscatedUserId": "A String", # Obfuscated user ID which the customer sent to us. "qualityMetadata": { # Conversation metadata related to quality management. # Conversation metadata related to quality management. @@ -2735,7 +2735,7 @@

Method Details

"userId": "A String", # A user-specified ID representing the participant. }, "sentiment": { # The data for a sentiment annotation. # The sentiment for this transcript segment. - "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. + "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score. "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, "text": "A String", # The text of this segment. @@ -2811,7 +2811,7 @@

Method Details

"entityMentionData": { # The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation. # Data specifying an entity mention. "entityUniqueId": "A String", # The key of this entity in conversation entities. Can be used to retrieve the exact `Entity` this mention is attached to. "sentiment": { # The data for a sentiment annotation. # Sentiment expressed for this mention of the entity. - "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. + "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score. "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, "type": "A String", # The type of the entity mention. @@ -2825,7 +2825,7 @@

Method Details

}, "issueMatchData": { # The data for an issue match annotation. # Data specifying an issue match. "issueAssignment": { # Information about the issue. # Information about the issue's assignment. - "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then. + "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analysis and immutable since then. "issue": "A String", # Resource name of the assigned issue. "score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1]. }, @@ -2835,7 +2835,7 @@

Method Details

"phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher. }, "sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment. - "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. + "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score. "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, "silenceData": { # The data for a silence annotation. # Data specifying silence. @@ -2850,7 +2850,7 @@

Method Details

}, "salience": 3.14, # The salience score associated with the entity in the [0, 1.0] range. The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient. "sentiment": { # The data for a sentiment annotation. # The aggregate sentiment expressed for this entity in the conversation. - "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. + "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score. "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, "type": "A String", # The entity type. @@ -2866,7 +2866,7 @@

Method Details

"issueModel": "A String", # Issue model that generates the result. Format: projects/{project}/locations/{location}/issueModels/{issue_model} "issues": [ # All the matched issues. { # Information about the issue. - "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then. + "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analysis and immutable since then. "issue": "A String", # Resource name of the assigned issue. "score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1]. }, @@ -2953,7 +2953,7 @@

Method Details

{ # One channel of conversation-level sentiment data. "channelTag": 42, # The channel of the audio that the data applies to. "sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment. - "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. + "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score. "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, }, @@ -3010,7 +3010,7 @@

Method Details

}, }, "medium": "A String", # Immutable. The conversation medium, if unspecified will default to PHONE_CALL. - "metadataJson": "A String", # Input only. JSON metadata encoded as a string. This field is primarily used by Insights integrations with various telphony systems and must be in one of Insight's supported formats. + "metadataJson": "A String", # Input only. JSON metadata encoded as a string. This field is primarily used by Insights integrations with various telephony systems and must be in one of Insight's supported formats. "name": "A String", # Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation} "obfuscatedUserId": "A String", # Obfuscated user ID which the customer sent to us. "qualityMetadata": { # Conversation metadata related to quality management. # Conversation metadata related to quality management. @@ -3126,7 +3126,7 @@

Method Details

"userId": "A String", # A user-specified ID representing the participant. }, "sentiment": { # The data for a sentiment annotation. # The sentiment for this transcript segment. - "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. + "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score. "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, "text": "A String", # The text of this segment. diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.html b/docs/dyn/contactcenterinsights_v1.projects.locations.html index 753cb0c6ee3..d9d9388a999 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.html @@ -114,11 +114,6 @@

Instance Methods

Returns the phraseMatchers Resource.

-

- qaQuestionTags() -

-

Returns the qaQuestionTags Resource.

-

qaScorecards()

@@ -131,10 +126,10 @@

Instance Methods

bulkDownloadFeedbackLabels(parent, body=None, x__xgafv=None)

-

Download feedback labels in bulk.

+

Download feedback labels in bulk from an external source. Currently supports exporting Quality AI example conversations with transcripts and question bodies.

bulkUploadFeedbackLabels(parent, body=None, x__xgafv=None)

-

Upload feedback labels in bulk.

+

Upload feedback labels from an external source in bulk. Currently supports labeling Quality AI example conversations.

close()

Close httplib2 connections.

@@ -159,7 +154,7 @@

Instance Methods

Method Details

bulkDownloadFeedbackLabels(parent, body=None, x__xgafv=None) -
Download feedback labels in bulk.
+  
Download feedback labels in bulk from an external source. Currently supports exporting Quality AI example conversations with transcripts and question bodies.
 
 Args:
   parent: string, Required. The parent resource for new feedback labels. (required)
@@ -215,7 +210,7 @@ 

Method Details

bulkUploadFeedbackLabels(parent, body=None, x__xgafv=None) -
Upload feedback labels in bulk.
+  
Upload feedback labels from an external source in bulk. Currently supports labeling Quality AI example conversations.
 
 Args:
   parent: string, Required. The parent resource for new feedback labels. (required)
@@ -368,12 +363,12 @@ 

Method Details

{ # The response for listing all feedback labels. "feedbackLabels": [ # The feedback labels that match the request. - { # Represents a conversation, resource, and label provided by the user. + { # Represents a conversation, resource, and label provided by the user. Can take the form of a string label or a QaAnswer label. QaAnswer labels are used for Quality AI example conversations. String labels are used for Topic Modeling. "createTime": "A String", # Output only. Create time of the label. - "label": "A String", # String label. - "labeledResource": "A String", # Resource name of the resource to be labeled. + "label": "A String", # String label used for Topic Modeling. + "labeledResource": "A String", # Resource name of the resource to be labeled. Supported resources: - qaScorecards/{scorecard}/revisions/{revision}/qaQuestions/{question} - issueModels/{issue_model} "name": "A String", # Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label} - "qaAnswerLabel": { # Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question. # QaAnswer label. + "qaAnswerLabel": { # Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question. # QaAnswer label used for Quality AI example conversations. "boolValue": True or False, # Boolean value. "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key. "naValue": True or False, # A value of "Not Applicable (N/A)". Should only ever be `true`. diff --git a/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json b/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json index 25fa771feba..6d5ab54bde0 100644 --- a/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json +++ b/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json @@ -110,7 +110,7 @@ "locations": { "methods": { "bulkDownloadFeedbackLabels": { -"description": "Download feedback labels in bulk.", +"description": "Download feedback labels in bulk from an external source. Currently supports exporting Quality AI example conversations with transcripts and question bodies.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:bulkDownloadFeedbackLabels", "httpMethod": "POST", "id": "contactcenterinsights.projects.locations.bulkDownloadFeedbackLabels", @@ -138,7 +138,7 @@ ] }, "bulkUploadFeedbackLabels": { -"description": "Upload feedback labels in bulk.", +"description": "Upload feedback labels from an external source in bulk. Currently supports labeling Quality AI example conversations.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:bulkUploadFeedbackLabels", "httpMethod": "POST", "id": "contactcenterinsights.projects.locations.bulkUploadFeedbackLabels", @@ -1912,79 +1912,6 @@ } } }, -"qaQuestionTags": { -"methods": { -"create": { -"description": "Create a QaQuestionTag.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/qaQuestionTags", -"httpMethod": "POST", -"id": "contactcenterinsights.projects.locations.qaQuestionTags.create", -"parameterOrder": [ -"parent" -], -"parameters": { -"parent": { -"description": "Required. The parent resource of the QaQuestionTag.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+parent}/qaQuestionTags", -"request": { -"$ref": "GoogleCloudContactcenterinsightsV1QaQuestionTag" -}, -"response": { -"$ref": "GoogleCloudContactcenterinsightsV1QaQuestionTag" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"list": { -"description": "Lists the question tags.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/qaQuestionTags", -"httpMethod": "GET", -"id": "contactcenterinsights.projects.locations.qaQuestionTags.list", -"parameterOrder": [ -"parent" -], -"parameters": { -"filter": { -"description": "Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Supported fields include the following: * `project_id` - id of the project to list tags for * `qa_scorecard_revision_id` - id of the scorecard revision to list tags for * `qa_question_id - id of the question to list tags for`", -"location": "query", -"type": "string" -}, -"pageSize": { -"description": "Optional. The maximum number of questions to return in the response. If the value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "Optional. The value returned by the last `ListQaQuestionTagsResponse`. This value indicates that this is a continuation of a prior `ListQaQuestionTags` call and that the system should return the next page of data.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. The parent resource of the QaQuestionTags.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+parent}/qaQuestionTags", -"response": { -"$ref": "GoogleCloudContactcenterinsightsV1ListQaQuestionTagsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -} -} -}, "qaScorecards": { "methods": { "create": { @@ -2682,7 +2609,7 @@ } } }, -"revision": "20250210", +"revision": "20250217", "rootUrl": "https://contactcenterinsights.googleapis.com/", "schemas": { "GoogleCloudContactcenterinsightsV1Analysis": { @@ -3608,7 +3535,7 @@ "type": "string" }, "metadataJson": { -"description": "Input only. JSON metadata encoded as a string. This field is primarily used by Insights integrations with various telphony systems and must be in one of Insight's supported formats.", +"description": "Input only. JSON metadata encoded as a string. This field is primarily used by Insights integrations with various telephony systems and must be in one of Insight's supported formats.", "type": "string" }, "name": { @@ -4466,6 +4393,11 @@ "description": "Metadata for an export insights operation.", "id": "GoogleCloudContactcenterinsightsV1ExportInsightsDataMetadata", "properties": { +"completedExportCount": { +"description": "The number of conversations that were exported successfully.", +"format": "int32", +"type": "integer" +}, "createTime": { "description": "Output only. The time the operation was created.", "format": "google-datetime", @@ -4478,6 +4410,11 @@ "readOnly": true, "type": "string" }, +"failedExportCount": { +"description": "The number of conversations that failed to be exported.", +"format": "int32", +"type": "integer" +}, "partialErrors": { "description": "Partial errors during export operation that might cause the operation output to be incomplete.", "items": { @@ -4669,7 +4606,7 @@ "type": "object" }, "GoogleCloudContactcenterinsightsV1FeedbackLabel": { -"description": "Represents a conversation, resource, and label provided by the user.", +"description": "Represents a conversation, resource, and label provided by the user. Can take the form of a string label or a QaAnswer label. QaAnswer labels are used for Quality AI example conversations. String labels are used for Topic Modeling.", "id": "GoogleCloudContactcenterinsightsV1FeedbackLabel", "properties": { "createTime": { @@ -4679,11 +4616,11 @@ "type": "string" }, "label": { -"description": "String label.", +"description": "String label used for Topic Modeling.", "type": "string" }, "labeledResource": { -"description": "Resource name of the resource to be labeled.", +"description": "Resource name of the resource to be labeled. Supported resources: - qaScorecards/{scorecard}/revisions/{revision}/qaQuestions/{question} - issueModels/{issue_model}", "type": "string" }, "name": { @@ -4692,7 +4629,7 @@ }, "qaAnswerLabel": { "$ref": "GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue", -"description": "QaAnswer label." +"description": "QaAnswer label used for Quality AI example conversations." }, "updateTime": { "description": "Output only. Update time of the label.", @@ -5098,7 +5035,7 @@ "id": "GoogleCloudContactcenterinsightsV1IssueAssignment", "properties": { "displayName": { -"description": "Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then.", +"description": "Immutable. Display name of the assigned issue. This field is set at time of analysis and immutable since then.", "type": "string" }, "issue": { @@ -5435,24 +5372,6 @@ }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1ListQaQuestionTagsResponse": { -"description": "The response from a ListQaQuestionTags request.", -"id": "GoogleCloudContactcenterinsightsV1ListQaQuestionTagsResponse", -"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" -}, -"qaQuestionTags": { -"description": "The parent resource of the questions.", -"items": { -"$ref": "GoogleCloudContactcenterinsightsV1QaQuestionTag" -}, -"type": "array" -} -}, -"type": "object" -}, "GoogleCloudContactcenterinsightsV1ListQaQuestionsResponse": { "description": "The response from a ListQaQuestions request.", "id": "GoogleCloudContactcenterinsightsV1ListQaQuestionsResponse", @@ -5899,40 +5818,6 @@ }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1QaQuestionTag": { -"description": "A tag is a resource which aims to categorize a set of questions across multiple scorecards, e.g., \"Customer Satisfaction\",\"Billing\", etc.", -"id": "GoogleCloudContactcenterinsightsV1QaQuestionTag", -"properties": { -"createTime": { -"description": "Output only. The time at which the question tag was created.", -"format": "google-datetime", -"readOnly": true, -"type": "string" -}, -"displayName": { -"description": "Required. A user-specified display name for the tag.", -"type": "string" -}, -"name": { -"description": "Identifier. Resource name for the QaQuestionTag Format projects/{project}/locations/{location}/qaQuestionTags/{qa_question_tag} In the above format, the last segment, i.e., qa_question_tag, is a server-generated ID corresponding to the tag resource.", -"type": "string" -}, -"qaQuestionIds": { -"description": "Optional. The list of QA question IDs that the tag applies to. Optional, a tag may not necessarily be referenced by any questions.", -"items": { -"type": "string" -}, -"type": "array" -}, -"updateTime": { -"description": "Output only. The most recent time at which the question tag was updated.", -"format": "google-datetime", -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, "GoogleCloudContactcenterinsightsV1QaQuestionTuningMetadata": { "description": "Metadata about the tuning operation for the question. Will only be set if a scorecard containing this question has been tuned.", "id": "GoogleCloudContactcenterinsightsV1QaQuestionTuningMetadata", @@ -6501,7 +6386,7 @@ "id": "GoogleCloudContactcenterinsightsV1SentimentData", "properties": { "magnitude": { -"description": "A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.", +"description": "A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score.", "format": "float", "type": "number" }, @@ -7384,7 +7269,7 @@ "type": "string" }, "metadataJson": { -"description": "Input only. JSON metadata encoded as a string. This field is primarily used by Insights integrations with various telphony systems and must be in one of Insight's supported formats.", +"description": "Input only. JSON metadata encoded as a string. This field is primarily used by Insights integrations with various telephony systems and must be in one of Insight's supported formats.", "type": "string" }, "name": { @@ -8225,6 +8110,11 @@ "description": "Metadata for an export insights operation.", "id": "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataMetadata", "properties": { +"completedExportCount": { +"description": "The number of conversations that were exported successfully.", +"format": "int32", +"type": "integer" +}, "createTime": { "description": "Output only. The time the operation was created.", "format": "google-datetime", @@ -8237,6 +8127,11 @@ "readOnly": true, "type": "string" }, +"failedExportCount": { +"description": "The number of conversations that failed to be exported.", +"format": "int32", +"type": "integer" +}, "partialErrors": { "description": "Partial errors during export operation that might cause the operation output to be incomplete.", "items": { @@ -8428,7 +8323,7 @@ "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel": { -"description": "Represents a conversation, resource, and label provided by the user.", +"description": "Represents a conversation, resource, and label provided by the user. Can take the form of a string label or a QaAnswer label. QaAnswer labels are used for Quality AI example conversations. String labels are used for Topic Modeling.", "id": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel", "properties": { "createTime": { @@ -8438,11 +8333,11 @@ "type": "string" }, "label": { -"description": "String label.", +"description": "String label used for Topic Modeling.", "type": "string" }, "labeledResource": { -"description": "Resource name of the resource to be labeled.", +"description": "Resource name of the resource to be labeled. Supported resources: - qaScorecards/{scorecard}/revisions/{revision}/qaQuestions/{question} - issueModels/{issue_model}", "type": "string" }, "name": { @@ -8451,7 +8346,7 @@ }, "qaAnswerLabel": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValue", -"description": "QaAnswer label." +"description": "QaAnswer label used for Quality AI example conversations." }, "updateTime": { "description": "Output only. Update time of the label.", @@ -8857,7 +8752,7 @@ "id": "GoogleCloudContactcenterinsightsV1alpha1IssueAssignment", "properties": { "displayName": { -"description": "Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then.", +"description": "Immutable. Display name of the assigned issue. This field is set at time of analysis and immutable since then.", "type": "string" }, "issue": { @@ -9620,7 +9515,7 @@ "id": "GoogleCloudContactcenterinsightsV1alpha1SentimentData", "properties": { "magnitude": { -"description": "A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.", +"description": "A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score.", "format": "float", "type": "number" }, From a73e958e38d686a5d25739f4c6263e12fd5fe47f Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 25 Feb 2025 07:08:18 +0000 Subject: [PATCH 08/36] feat(container): update the api #### container:v1beta1 The following keys were added: - schemas.AutopilotConfig (Total Keys: 3) - schemas.NodePool.properties.autopilotConfig.$ref (Total Keys: 1) --- ...r_v1beta1.projects.locations.clusters.html | 9 +++++++ ...projects.locations.clusters.nodePools.html | 9 +++++++ ...ainer_v1beta1.projects.zones.clusters.html | 9 +++++++ ...ta1.projects.zones.clusters.nodePools.html | 9 +++++++ .../documents/container.v1beta1.json | 25 ++++++++++++++++--- 5 files changed, 57 insertions(+), 4 deletions(-) diff --git a/docs/dyn/container_v1beta1.projects.locations.clusters.html b/docs/dyn/container_v1beta1.projects.locations.clusters.html index dc6900922a1..37d681d64bf 100644 --- a/docs/dyn/container_v1beta1.projects.locations.clusters.html +++ b/docs/dyn/container_v1beta1.projects.locations.clusters.html @@ -944,6 +944,9 @@

Method Details

}, "nodePools": [ # The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified. { # NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload. + "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this nodepool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler to implement go/gke-managed-nodes-ccc-api + "enabled": True or False, # Denotes that nodes belonging to this node pool are Autopilot nodes. + }, "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present. "autoprovisioned": True or False, # Can this node pool be deleted automatically. "enabled": True or False, # Is autoscaling enabled for this node pool. @@ -2217,6 +2220,9 @@

Method Details

}, "nodePools": [ # The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified. { # NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload. + "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this nodepool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler to implement go/gke-managed-nodes-ccc-api + "enabled": True or False, # Denotes that nodes belonging to this node pool are Autopilot nodes. + }, "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present. "autoprovisioned": True or False, # Can this node pool be deleted automatically. "enabled": True or False, # Is autoscaling enabled for this node pool. @@ -3355,6 +3361,9 @@

Method Details

}, "nodePools": [ # The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified. { # NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload. + "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this nodepool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler to implement go/gke-managed-nodes-ccc-api + "enabled": True or False, # Denotes that nodes belonging to this node pool are Autopilot nodes. + }, "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present. "autoprovisioned": True or False, # Can this node pool be deleted automatically. "enabled": True or False, # Is autoscaling enabled for this node pool. diff --git a/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html b/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html index f26bcb51486..60292e66dd6 100644 --- a/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html +++ b/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html @@ -152,6 +152,9 @@

Method Details

{ # CreateNodePoolRequest creates a node pool for a cluster. "clusterId": "A String", # Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. "nodePool": { # NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload. # Required. The node pool to create. + "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this nodepool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler to implement go/gke-managed-nodes-ccc-api + "enabled": True or False, # Denotes that nodes belonging to this node pool are Autopilot nodes. + }, "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present. "autoprovisioned": True or False, # Can this node pool be deleted automatically. "enabled": True or False, # Is autoscaling enabled for this node pool. @@ -640,6 +643,9 @@

Method Details

An object of the form: { # NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload. + "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this nodepool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler to implement go/gke-managed-nodes-ccc-api + "enabled": True or False, # Denotes that nodes belonging to this node pool are Autopilot nodes. + }, "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present. "autoprovisioned": True or False, # Can this node pool be deleted automatically. "enabled": True or False, # Is autoscaling enabled for this node pool. @@ -956,6 +962,9 @@

Method Details

{ # ListNodePoolsResponse is the result of ListNodePoolsRequest. "nodePools": [ # A list of node pools for a cluster. { # NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload. + "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this nodepool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler to implement go/gke-managed-nodes-ccc-api + "enabled": True or False, # Denotes that nodes belonging to this node pool are Autopilot nodes. + }, "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present. "autoprovisioned": True or False, # Can this node pool be deleted automatically. "enabled": True or False, # Is autoscaling enabled for this node pool. diff --git a/docs/dyn/container_v1beta1.projects.zones.clusters.html b/docs/dyn/container_v1beta1.projects.zones.clusters.html index 90ae3077cb8..6ebb7239e8b 100644 --- a/docs/dyn/container_v1beta1.projects.zones.clusters.html +++ b/docs/dyn/container_v1beta1.projects.zones.clusters.html @@ -1042,6 +1042,9 @@

Method Details

}, "nodePools": [ # The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified. { # NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload. + "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this nodepool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler to implement go/gke-managed-nodes-ccc-api + "enabled": True or False, # Denotes that nodes belonging to this node pool are Autopilot nodes. + }, "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present. "autoprovisioned": True or False, # Can this node pool be deleted automatically. "enabled": True or False, # Is autoscaling enabled for this node pool. @@ -2315,6 +2318,9 @@

Method Details

}, "nodePools": [ # The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified. { # NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload. + "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this nodepool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler to implement go/gke-managed-nodes-ccc-api + "enabled": True or False, # Denotes that nodes belonging to this node pool are Autopilot nodes. + }, "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present. "autoprovisioned": True or False, # Can this node pool be deleted automatically. "enabled": True or False, # Is autoscaling enabled for this node pool. @@ -3497,6 +3503,9 @@

Method Details

}, "nodePools": [ # The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified. { # NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload. + "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this nodepool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler to implement go/gke-managed-nodes-ccc-api + "enabled": True or False, # Denotes that nodes belonging to this node pool are Autopilot nodes. + }, "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present. "autoprovisioned": True or False, # Can this node pool be deleted automatically. "enabled": True or False, # Is autoscaling enabled for this node pool. diff --git a/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html b/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html index 1624c46ede0..449e432a4da 100644 --- a/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html +++ b/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html @@ -217,6 +217,9 @@

Method Details

{ # CreateNodePoolRequest creates a node pool for a cluster. "clusterId": "A String", # Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. "nodePool": { # NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload. # Required. The node pool to create. + "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this nodepool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler to implement go/gke-managed-nodes-ccc-api + "enabled": True or False, # Denotes that nodes belonging to this node pool are Autopilot nodes. + }, "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present. "autoprovisioned": True or False, # Can this node pool be deleted automatically. "enabled": True or False, # Is autoscaling enabled for this node pool. @@ -705,6 +708,9 @@

Method Details

An object of the form: { # NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload. + "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this nodepool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler to implement go/gke-managed-nodes-ccc-api + "enabled": True or False, # Denotes that nodes belonging to this node pool are Autopilot nodes. + }, "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present. "autoprovisioned": True or False, # Can this node pool be deleted automatically. "enabled": True or False, # Is autoscaling enabled for this node pool. @@ -1021,6 +1027,9 @@

Method Details

{ # ListNodePoolsResponse is the result of ListNodePoolsRequest. "nodePools": [ # A list of node pools for a cluster. { # NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload. + "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this nodepool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler to implement go/gke-managed-nodes-ccc-api + "enabled": True or False, # Denotes that nodes belonging to this node pool are Autopilot nodes. + }, "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present. "autoprovisioned": True or False, # Can this node pool be deleted automatically. "enabled": True or False, # Is autoscaling enabled for this node pool. diff --git a/googleapiclient/discovery_cache/documents/container.v1beta1.json b/googleapiclient/discovery_cache/documents/container.v1beta1.json index f367cd793ce..3af3d30e19e 100644 --- a/googleapiclient/discovery_cache/documents/container.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/container.v1beta1.json @@ -2685,7 +2685,7 @@ } } }, -"revision": "20250128", +"revision": "20250204", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -3023,6 +3023,17 @@ }, "type": "object" }, +"AutopilotConfig": { +"description": "AutopilotConfig contains configuration of autopilot feature for this nodepool.", +"id": "AutopilotConfig", +"properties": { +"enabled": { +"description": "Denotes that nodes belonging to this node pool are Autopilot nodes.", +"type": "boolean" +} +}, +"type": "object" +}, "AutopilotConversionStatus": { "description": "AutopilotConversionStatus represents conversion status.", "id": "AutopilotConversionStatus", @@ -6575,6 +6586,10 @@ false "description": "NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload.", "id": "NodePool", "properties": { +"autopilotConfig": { +"$ref": "AutopilotConfig", +"description": "Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler to implement go/gke-managed-nodes-ccc-api" +}, "autoscaling": { "$ref": "NodePoolAutoscaling", "description": "Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present." @@ -8525,7 +8540,7 @@ false "Google Compute Engine quota was exceeded.", "Cluster state was manually changed by an SRE due to a system logic error.", "Unable to perform an encrypt operation against the CloudKMS key used for etcd level encryption.", -"Cluster CA is expiring soon. More codes TBA" +"Cluster CA is expiring soon." ], "type": "string" }, @@ -8945,11 +8960,13 @@ false "description": "The type of the event.", "enum": [ "EVENT_TYPE_UNSPECIFIED", -"END_OF_SUPPORT" +"END_OF_SUPPORT", +"COS_MILESTONE_VERSION_UPDATE" ], "enumDescriptions": [ "EVENT_TYPE_UNSPECIFIED indicates the event type is unspecified.", -"END_OF_SUPPORT indicates GKE version reaches end of support, check standard_support_end_time and extended_support_end_time for more details." +"END_OF_SUPPORT indicates GKE version reaches end of support, check standard_support_end_time and extended_support_end_time for more details.", +"COS_MILESTONE_VERSION_UPDATE indicates that the COS node image will update COS milestone version for new patch versions starting with the one in the description." ], "type": "string" }, From d218f6c247bedcac21d44cd6a6b94d3fd301bc32 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 25 Feb 2025 07:08:18 +0000 Subject: [PATCH 09/36] feat(datamigration): update the api #### datamigration:v1 The following keys were added: - schemas.EntityDdl.properties.ddlKind.type (Total Keys: 1) - schemas.EntityDdl.properties.editedDdlKind.type (Total Keys: 1) --- ...ojects.locations.conversionWorkspaces.html | 2 + .../documents/datamigration.v1.json | 38 ++++++++++++++++++- 2 files changed, 39 insertions(+), 1 deletion(-) diff --git a/docs/dyn/datamigration_v1.projects.locations.conversionWorkspaces.html b/docs/dyn/datamigration_v1.projects.locations.conversionWorkspaces.html index ec9d856cdfb..87a5c79d642 100644 --- a/docs/dyn/datamigration_v1.projects.locations.conversionWorkspaces.html +++ b/docs/dyn/datamigration_v1.projects.locations.conversionWorkspaces.html @@ -467,7 +467,9 @@

Method Details

"entityDdl": [ # Details about the entity DDL script. Multiple DDL scripts are provided for child entities such as a table entity will have one DDL for the table with additional DDLs for each index, constraint and such. { # A single DDL statement for a specific entity "ddl": "A String", # The actual ddl code. + "ddlKind": "A String", # The DDL Kind selected for apply, or SOURCE if getting the source tree. "ddlType": "A String", # Type of DDL (Create, Alter). + "editedDdlKind": "A String", # If ddl_kind is USER_EDIT, this holds the DDL kind of the original content - DETERMINISTIC or AI. Otherwise, this is DDL_KIND_UNSPECIFIED. "entity": "A String", # The name of the database entity the ddl refers to. "entityType": "A String", # The entity type (if the DDL is for a sub entity). "issueId": [ # EntityIssues found for this ddl. diff --git a/googleapiclient/discovery_cache/documents/datamigration.v1.json b/googleapiclient/discovery_cache/documents/datamigration.v1.json index bebf89c8c86..c32d0fea056 100644 --- a/googleapiclient/discovery_cache/documents/datamigration.v1.json +++ b/googleapiclient/discovery_cache/documents/datamigration.v1.json @@ -2332,7 +2332,7 @@ } } }, -"revision": "20250122", +"revision": "20250207", "rootUrl": "https://datamigration.googleapis.com/", "schemas": { "AlloyDbConnectionProfile": { @@ -3651,10 +3651,46 @@ "description": "The actual ddl code.", "type": "string" }, +"ddlKind": { +"description": "The DDL Kind selected for apply, or SOURCE if getting the source tree.", +"enum": [ +"DDL_KIND_UNSPECIFIED", +"SOURCE", +"DETERMINISTIC", +"AI", +"USER_EDIT" +], +"enumDescriptions": [ +"The kind of the DDL is unknown.", +"DDL of the source entity", +"Deterministic converted DDL", +"Gemini AI converted DDL", +"User edited DDL" +], +"type": "string" +}, "ddlType": { "description": "Type of DDL (Create, Alter).", "type": "string" }, +"editedDdlKind": { +"description": "If ddl_kind is USER_EDIT, this holds the DDL kind of the original content - DETERMINISTIC or AI. Otherwise, this is DDL_KIND_UNSPECIFIED.", +"enum": [ +"DDL_KIND_UNSPECIFIED", +"SOURCE", +"DETERMINISTIC", +"AI", +"USER_EDIT" +], +"enumDescriptions": [ +"The kind of the DDL is unknown.", +"DDL of the source entity", +"Deterministic converted DDL", +"Gemini AI converted DDL", +"User edited DDL" +], +"type": "string" +}, "entity": { "description": "The name of the database entity the ddl refers to.", "type": "string" From ce81144e45ca25109487e62e2e0c6f9493ac9e8b Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 25 Feb 2025 07:08:18 +0000 Subject: [PATCH 10/36] feat(datastream): update the api #### datastream:v1 The following keys were added: - schemas.BackfillAllStrategy.properties.salesforceExcludedObjects.$ref (Total Keys: 1) - schemas.BigQueryDestinationConfig.properties.blmtConfig.$ref (Total Keys: 1) - schemas.BlmtConfig (Total Keys: 7) - schemas.ConnectionProfile.properties.salesforceProfile.$ref (Total Keys: 1) - schemas.Oauth2ClientCredentials (Total Keys: 5) - schemas.SalesforceField (Total Keys: 5) - schemas.SalesforceObject (Total Keys: 8) - schemas.SalesforceOrg (Total Keys: 4) - schemas.SalesforceProfile (Total Keys: 5) - schemas.SalesforceSourceConfig (Total Keys: 6) - schemas.SourceConfig.properties.salesforceSourceConfig.$ref (Total Keys: 1) - schemas.SourceObjectIdentifier.properties.salesforceIdentifier.$ref (Total Keys: 1) - schemas.UserCredentials (Total Keys: 7) --- ...projects.locations.connectionProfiles.html | 75 +++++++ ...astream_v1.projects.locations.streams.html | 208 +++++++++++++++++ ...v1.projects.locations.streams.objects.html | 18 ++ .../documents/datastream.v1.json | 212 +++++++++++++++++- 4 files changed, 512 insertions(+), 1 deletion(-) diff --git a/docs/dyn/datastream_v1.projects.locations.connectionProfiles.html b/docs/dyn/datastream_v1.projects.locations.connectionProfiles.html index 69e4231ccc6..68ad0afd2f3 100644 --- a/docs/dyn/datastream_v1.projects.locations.connectionProfiles.html +++ b/docs/dyn/datastream_v1.projects.locations.connectionProfiles.html @@ -196,6 +196,21 @@

Method Details

"privateConnectivity": { # Private Connectivity # Private connectivity. "privateConnection": "A String", # Required. A reference to a private connection resource. Format: `projects/{project}/locations/{location}/privateConnections/{name}` }, + "salesforceProfile": { # Salesforce profile # Salesforce Connection Profile configuration. + "domain": "A String", # Required. Domain endpoint for the Salesforce connection. + "oauth2ClientCredentials": { # OAuth2 Client Credentials. # Connected app authentication. + "clientId": "A String", # Required. Client ID for Salesforce OAuth2 Client Credentials. + "clientSecret": "A String", # Optional. Client secret for Salesforce OAuth2 Client Credentials. Mutually exclusive with the `secret_manager_stored_client_secret` field. + "secretManagerStoredClientSecret": "A String", # Optional. A reference to a Secret Manager resource name storing the Salesforce OAuth2 client_secret. Mutually exclusive with the `client_secret` field. + }, + "userCredentials": { # Username-password credentials. # User-password authentication. + "password": "A String", # Optional. Password for the Salesforce connection. Mutually exclusive with the `secret_manager_stored_password` field. + "secretManagerStoredPassword": "A String", # Optional. A reference to a Secret Manager resource name storing the Salesforce connection's password. Mutually exclusive with the `password` field. + "secretManagerStoredSecurityToken": "A String", # Optional. A reference to a Secret Manager resource name storing the Salesforce connection's security token. Mutually exclusive with the `security_token` field. + "securityToken": "A String", # Optional. Security token for the Salesforce connection. Mutually exclusive with the `secret_manager_stored_security_token` field. + "username": "A String", # Required. Username for the Salesforce connection. + }, + }, "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "sqlServerProfile": { # SQLServer database profile. # SQLServer Connection Profile configuration. @@ -372,6 +387,21 @@

Method Details

"privateConnectivity": { # Private Connectivity # Private connectivity. "privateConnection": "A String", # Required. A reference to a private connection resource. Format: `projects/{project}/locations/{location}/privateConnections/{name}` }, + "salesforceProfile": { # Salesforce profile # Salesforce Connection Profile configuration. + "domain": "A String", # Required. Domain endpoint for the Salesforce connection. + "oauth2ClientCredentials": { # OAuth2 Client Credentials. # Connected app authentication. + "clientId": "A String", # Required. Client ID for Salesforce OAuth2 Client Credentials. + "clientSecret": "A String", # Optional. Client secret for Salesforce OAuth2 Client Credentials. Mutually exclusive with the `secret_manager_stored_client_secret` field. + "secretManagerStoredClientSecret": "A String", # Optional. A reference to a Secret Manager resource name storing the Salesforce OAuth2 client_secret. Mutually exclusive with the `client_secret` field. + }, + "userCredentials": { # Username-password credentials. # User-password authentication. + "password": "A String", # Optional. Password for the Salesforce connection. Mutually exclusive with the `secret_manager_stored_password` field. + "secretManagerStoredPassword": "A String", # Optional. A reference to a Secret Manager resource name storing the Salesforce connection's password. Mutually exclusive with the `password` field. + "secretManagerStoredSecurityToken": "A String", # Optional. A reference to a Secret Manager resource name storing the Salesforce connection's security token. Mutually exclusive with the `security_token` field. + "securityToken": "A String", # Optional. Security token for the Salesforce connection. Mutually exclusive with the `secret_manager_stored_security_token` field. + "username": "A String", # Required. Username for the Salesforce connection. + }, + }, "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "sqlServerProfile": { # SQLServer database profile. # SQLServer Connection Profile configuration. @@ -695,6 +725,21 @@

Method Details

"privateConnectivity": { # Private Connectivity # Private connectivity. "privateConnection": "A String", # Required. A reference to a private connection resource. Format: `projects/{project}/locations/{location}/privateConnections/{name}` }, + "salesforceProfile": { # Salesforce profile # Salesforce Connection Profile configuration. + "domain": "A String", # Required. Domain endpoint for the Salesforce connection. + "oauth2ClientCredentials": { # OAuth2 Client Credentials. # Connected app authentication. + "clientId": "A String", # Required. Client ID for Salesforce OAuth2 Client Credentials. + "clientSecret": "A String", # Optional. Client secret for Salesforce OAuth2 Client Credentials. Mutually exclusive with the `secret_manager_stored_client_secret` field. + "secretManagerStoredClientSecret": "A String", # Optional. A reference to a Secret Manager resource name storing the Salesforce OAuth2 client_secret. Mutually exclusive with the `client_secret` field. + }, + "userCredentials": { # Username-password credentials. # User-password authentication. + "password": "A String", # Optional. Password for the Salesforce connection. Mutually exclusive with the `secret_manager_stored_password` field. + "secretManagerStoredPassword": "A String", # Optional. A reference to a Secret Manager resource name storing the Salesforce connection's password. Mutually exclusive with the `password` field. + "secretManagerStoredSecurityToken": "A String", # Optional. A reference to a Secret Manager resource name storing the Salesforce connection's security token. Mutually exclusive with the `security_token` field. + "securityToken": "A String", # Optional. Security token for the Salesforce connection. Mutually exclusive with the `secret_manager_stored_security_token` field. + "username": "A String", # Required. Username for the Salesforce connection. + }, + }, "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "sqlServerProfile": { # SQLServer database profile. # SQLServer Connection Profile configuration. @@ -813,6 +858,21 @@

Method Details

"privateConnectivity": { # Private Connectivity # Private connectivity. "privateConnection": "A String", # Required. A reference to a private connection resource. Format: `projects/{project}/locations/{location}/privateConnections/{name}` }, + "salesforceProfile": { # Salesforce profile # Salesforce Connection Profile configuration. + "domain": "A String", # Required. Domain endpoint for the Salesforce connection. + "oauth2ClientCredentials": { # OAuth2 Client Credentials. # Connected app authentication. + "clientId": "A String", # Required. Client ID for Salesforce OAuth2 Client Credentials. + "clientSecret": "A String", # Optional. Client secret for Salesforce OAuth2 Client Credentials. Mutually exclusive with the `secret_manager_stored_client_secret` field. + "secretManagerStoredClientSecret": "A String", # Optional. A reference to a Secret Manager resource name storing the Salesforce OAuth2 client_secret. Mutually exclusive with the `client_secret` field. + }, + "userCredentials": { # Username-password credentials. # User-password authentication. + "password": "A String", # Optional. Password for the Salesforce connection. Mutually exclusive with the `secret_manager_stored_password` field. + "secretManagerStoredPassword": "A String", # Optional. A reference to a Secret Manager resource name storing the Salesforce connection's password. Mutually exclusive with the `password` field. + "secretManagerStoredSecurityToken": "A String", # Optional. A reference to a Secret Manager resource name storing the Salesforce connection's security token. Mutually exclusive with the `security_token` field. + "securityToken": "A String", # Optional. Security token for the Salesforce connection. Mutually exclusive with the `secret_manager_stored_security_token` field. + "username": "A String", # Required. Username for the Salesforce connection. + }, + }, "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "sqlServerProfile": { # SQLServer database profile. # SQLServer Connection Profile configuration. @@ -940,6 +1000,21 @@

Method Details

"privateConnectivity": { # Private Connectivity # Private connectivity. "privateConnection": "A String", # Required. A reference to a private connection resource. Format: `projects/{project}/locations/{location}/privateConnections/{name}` }, + "salesforceProfile": { # Salesforce profile # Salesforce Connection Profile configuration. + "domain": "A String", # Required. Domain endpoint for the Salesforce connection. + "oauth2ClientCredentials": { # OAuth2 Client Credentials. # Connected app authentication. + "clientId": "A String", # Required. Client ID for Salesforce OAuth2 Client Credentials. + "clientSecret": "A String", # Optional. Client secret for Salesforce OAuth2 Client Credentials. Mutually exclusive with the `secret_manager_stored_client_secret` field. + "secretManagerStoredClientSecret": "A String", # Optional. A reference to a Secret Manager resource name storing the Salesforce OAuth2 client_secret. Mutually exclusive with the `client_secret` field. + }, + "userCredentials": { # Username-password credentials. # User-password authentication. + "password": "A String", # Optional. Password for the Salesforce connection. Mutually exclusive with the `secret_manager_stored_password` field. + "secretManagerStoredPassword": "A String", # Optional. A reference to a Secret Manager resource name storing the Salesforce connection's password. Mutually exclusive with the `password` field. + "secretManagerStoredSecurityToken": "A String", # Optional. A reference to a Secret Manager resource name storing the Salesforce connection's security token. Mutually exclusive with the `security_token` field. + "securityToken": "A String", # Optional. Security token for the Salesforce connection. Mutually exclusive with the `secret_manager_stored_security_token` field. + "username": "A String", # Required. Username for the Salesforce connection. + }, + }, "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "sqlServerProfile": { # SQLServer database profile. # SQLServer Connection Profile configuration. diff --git a/docs/dyn/datastream_v1.projects.locations.streams.html b/docs/dyn/datastream_v1.projects.locations.streams.html index 60f922d0392..3c29fc05f2e 100644 --- a/docs/dyn/datastream_v1.projects.locations.streams.html +++ b/docs/dyn/datastream_v1.projects.locations.streams.html @@ -194,6 +194,20 @@

Method Details

}, ], }, + "salesforceExcludedObjects": { # Salesforce organization structure. # Salesforce data source objects to avoid backfilling + "objects": [ # Salesforce objects in the database server. + { # Salesforce object. + "fields": [ # Salesforce fields. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing. + { # Salesforce field. + "dataType": "A String", # The data type. + "name": "A String", # Field name. + "nillable": True or False, # Indicates whether the field can accept nil values. + }, + ], + "objectName": "A String", # Object name. + }, + ], + }, "sqlServerExcludedObjects": { # SQLServer database structure. # SQLServer data source objects to avoid backfilling "schemas": [ # SQLServer schemas in the database server. { # SQLServer schema. @@ -227,6 +241,13 @@

Method Details

"bigqueryDestinationConfig": { # BigQuery destination configuration # BigQuery destination configuration. "appendOnly": { # AppendOnly mode defines that all changes to a table will be written to the destination table. # Append only mode }, + "blmtConfig": { # The configuration for BLMT. # Optional. Big Lake Managed Tables (BLMT) configuration. + "bucket": "A String", # Required. The Cloud Storage bucket name. + "connectionName": "A String", # Required. The bigquery connection. Format: `{project}.{location}.{name}` + "fileFormat": "A String", # Required. The file format. + "rootPath": "A String", # The root path inside the Cloud Storage bucket. + "tableFormat": "A String", # Required. The table format. + }, "dataFreshness": "A String", # The guaranteed data freshness (in seconds) when querying tables created by the stream. Editing this field will only affect new tables created in the future, but existing tables will not be impacted. Lower values mean that queries will return fresher data, but may result in higher cost. "merge": { # Merge mode defines that all changes to a table will be merged at the destination table. # The standard mode }, @@ -453,6 +474,37 @@

Method Details

"publication": "A String", # Required. The name of the publication that includes the set of all tables that are defined in the stream's include_objects. "replicationSlot": "A String", # Required. Immutable. The name of the logical replication slot that's configured with the pgoutput plugin. }, + "salesforceSourceConfig": { # Salesforce source configuration # Salesforce data source configuration. + "excludeObjects": { # Salesforce organization structure. # Salesforce objects to exclude from the stream. + "objects": [ # Salesforce objects in the database server. + { # Salesforce object. + "fields": [ # Salesforce fields. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing. + { # Salesforce field. + "dataType": "A String", # The data type. + "name": "A String", # Field name. + "nillable": True or False, # Indicates whether the field can accept nil values. + }, + ], + "objectName": "A String", # Object name. + }, + ], + }, + "includeObjects": { # Salesforce organization structure. # Salesforce objects to retrieve from the source. + "objects": [ # Salesforce objects in the database server. + { # Salesforce object. + "fields": [ # Salesforce fields. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing. + { # Salesforce field. + "dataType": "A String", # The data type. + "name": "A String", # Field name. + "nillable": True or False, # Indicates whether the field can accept nil values. + }, + ], + "objectName": "A String", # Object name. + }, + ], + }, + "pollingInterval": "A String", # Required. Salesforce objects polling interval. The interval at which new changes will be polled for each object. The duration must be between 5 minutes and 24 hours. + }, "sourceConnectionProfile": "A String", # Required. Source connection profile resoource. Format: `projects/{project}/locations/{location}/connectionProfiles/{name}` "sqlServerSourceConfig": { # SQLServer data source configuration # SQLServer data source configuration. "changeTables": { # Configuration to use Change Tables CDC read method. # CDC reader reads from change tables. @@ -674,6 +726,20 @@

Method Details

}, ], }, + "salesforceExcludedObjects": { # Salesforce organization structure. # Salesforce data source objects to avoid backfilling + "objects": [ # Salesforce objects in the database server. + { # Salesforce object. + "fields": [ # Salesforce fields. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing. + { # Salesforce field. + "dataType": "A String", # The data type. + "name": "A String", # Field name. + "nillable": True or False, # Indicates whether the field can accept nil values. + }, + ], + "objectName": "A String", # Object name. + }, + ], + }, "sqlServerExcludedObjects": { # SQLServer database structure. # SQLServer data source objects to avoid backfilling "schemas": [ # SQLServer schemas in the database server. { # SQLServer schema. @@ -707,6 +773,13 @@

Method Details

"bigqueryDestinationConfig": { # BigQuery destination configuration # BigQuery destination configuration. "appendOnly": { # AppendOnly mode defines that all changes to a table will be written to the destination table. # Append only mode }, + "blmtConfig": { # The configuration for BLMT. # Optional. Big Lake Managed Tables (BLMT) configuration. + "bucket": "A String", # Required. The Cloud Storage bucket name. + "connectionName": "A String", # Required. The bigquery connection. Format: `{project}.{location}.{name}` + "fileFormat": "A String", # Required. The file format. + "rootPath": "A String", # The root path inside the Cloud Storage bucket. + "tableFormat": "A String", # Required. The table format. + }, "dataFreshness": "A String", # The guaranteed data freshness (in seconds) when querying tables created by the stream. Editing this field will only affect new tables created in the future, but existing tables will not be impacted. Lower values mean that queries will return fresher data, but may result in higher cost. "merge": { # Merge mode defines that all changes to a table will be merged at the destination table. # The standard mode }, @@ -933,6 +1006,37 @@

Method Details

"publication": "A String", # Required. The name of the publication that includes the set of all tables that are defined in the stream's include_objects. "replicationSlot": "A String", # Required. Immutable. The name of the logical replication slot that's configured with the pgoutput plugin. }, + "salesforceSourceConfig": { # Salesforce source configuration # Salesforce data source configuration. + "excludeObjects": { # Salesforce organization structure. # Salesforce objects to exclude from the stream. + "objects": [ # Salesforce objects in the database server. + { # Salesforce object. + "fields": [ # Salesforce fields. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing. + { # Salesforce field. + "dataType": "A String", # The data type. + "name": "A String", # Field name. + "nillable": True or False, # Indicates whether the field can accept nil values. + }, + ], + "objectName": "A String", # Object name. + }, + ], + }, + "includeObjects": { # Salesforce organization structure. # Salesforce objects to retrieve from the source. + "objects": [ # Salesforce objects in the database server. + { # Salesforce object. + "fields": [ # Salesforce fields. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing. + { # Salesforce field. + "dataType": "A String", # The data type. + "name": "A String", # Field name. + "nillable": True or False, # Indicates whether the field can accept nil values. + }, + ], + "objectName": "A String", # Object name. + }, + ], + }, + "pollingInterval": "A String", # Required. Salesforce objects polling interval. The interval at which new changes will be polled for each object. The duration must be between 5 minutes and 24 hours. + }, "sourceConnectionProfile": "A String", # Required. Source connection profile resoource. Format: `projects/{project}/locations/{location}/connectionProfiles/{name}` "sqlServerSourceConfig": { # SQLServer data source configuration # SQLServer data source configuration. "changeTables": { # Configuration to use Change Tables CDC read method. # CDC reader reads from change tables. @@ -1093,6 +1197,20 @@

Method Details

}, ], }, + "salesforceExcludedObjects": { # Salesforce organization structure. # Salesforce data source objects to avoid backfilling + "objects": [ # Salesforce objects in the database server. + { # Salesforce object. + "fields": [ # Salesforce fields. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing. + { # Salesforce field. + "dataType": "A String", # The data type. + "name": "A String", # Field name. + "nillable": True or False, # Indicates whether the field can accept nil values. + }, + ], + "objectName": "A String", # Object name. + }, + ], + }, "sqlServerExcludedObjects": { # SQLServer database structure. # SQLServer data source objects to avoid backfilling "schemas": [ # SQLServer schemas in the database server. { # SQLServer schema. @@ -1126,6 +1244,13 @@

Method Details

"bigqueryDestinationConfig": { # BigQuery destination configuration # BigQuery destination configuration. "appendOnly": { # AppendOnly mode defines that all changes to a table will be written to the destination table. # Append only mode }, + "blmtConfig": { # The configuration for BLMT. # Optional. Big Lake Managed Tables (BLMT) configuration. + "bucket": "A String", # Required. The Cloud Storage bucket name. + "connectionName": "A String", # Required. The bigquery connection. Format: `{project}.{location}.{name}` + "fileFormat": "A String", # Required. The file format. + "rootPath": "A String", # The root path inside the Cloud Storage bucket. + "tableFormat": "A String", # Required. The table format. + }, "dataFreshness": "A String", # The guaranteed data freshness (in seconds) when querying tables created by the stream. Editing this field will only affect new tables created in the future, but existing tables will not be impacted. Lower values mean that queries will return fresher data, but may result in higher cost. "merge": { # Merge mode defines that all changes to a table will be merged at the destination table. # The standard mode }, @@ -1352,6 +1477,37 @@

Method Details

"publication": "A String", # Required. The name of the publication that includes the set of all tables that are defined in the stream's include_objects. "replicationSlot": "A String", # Required. Immutable. The name of the logical replication slot that's configured with the pgoutput plugin. }, + "salesforceSourceConfig": { # Salesforce source configuration # Salesforce data source configuration. + "excludeObjects": { # Salesforce organization structure. # Salesforce objects to exclude from the stream. + "objects": [ # Salesforce objects in the database server. + { # Salesforce object. + "fields": [ # Salesforce fields. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing. + { # Salesforce field. + "dataType": "A String", # The data type. + "name": "A String", # Field name. + "nillable": True or False, # Indicates whether the field can accept nil values. + }, + ], + "objectName": "A String", # Object name. + }, + ], + }, + "includeObjects": { # Salesforce organization structure. # Salesforce objects to retrieve from the source. + "objects": [ # Salesforce objects in the database server. + { # Salesforce object. + "fields": [ # Salesforce fields. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing. + { # Salesforce field. + "dataType": "A String", # The data type. + "name": "A String", # Field name. + "nillable": True or False, # Indicates whether the field can accept nil values. + }, + ], + "objectName": "A String", # Object name. + }, + ], + }, + "pollingInterval": "A String", # Required. Salesforce objects polling interval. The interval at which new changes will be polled for each object. The duration must be between 5 minutes and 24 hours. + }, "sourceConnectionProfile": "A String", # Required. Source connection profile resoource. Format: `projects/{project}/locations/{location}/connectionProfiles/{name}` "sqlServerSourceConfig": { # SQLServer data source configuration # SQLServer data source configuration. "changeTables": { # Configuration to use Change Tables CDC read method. # CDC reader reads from change tables. @@ -1519,6 +1675,20 @@

Method Details

}, ], }, + "salesforceExcludedObjects": { # Salesforce organization structure. # Salesforce data source objects to avoid backfilling + "objects": [ # Salesforce objects in the database server. + { # Salesforce object. + "fields": [ # Salesforce fields. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing. + { # Salesforce field. + "dataType": "A String", # The data type. + "name": "A String", # Field name. + "nillable": True or False, # Indicates whether the field can accept nil values. + }, + ], + "objectName": "A String", # Object name. + }, + ], + }, "sqlServerExcludedObjects": { # SQLServer database structure. # SQLServer data source objects to avoid backfilling "schemas": [ # SQLServer schemas in the database server. { # SQLServer schema. @@ -1552,6 +1722,13 @@

Method Details

"bigqueryDestinationConfig": { # BigQuery destination configuration # BigQuery destination configuration. "appendOnly": { # AppendOnly mode defines that all changes to a table will be written to the destination table. # Append only mode }, + "blmtConfig": { # The configuration for BLMT. # Optional. Big Lake Managed Tables (BLMT) configuration. + "bucket": "A String", # Required. The Cloud Storage bucket name. + "connectionName": "A String", # Required. The bigquery connection. Format: `{project}.{location}.{name}` + "fileFormat": "A String", # Required. The file format. + "rootPath": "A String", # The root path inside the Cloud Storage bucket. + "tableFormat": "A String", # Required. The table format. + }, "dataFreshness": "A String", # The guaranteed data freshness (in seconds) when querying tables created by the stream. Editing this field will only affect new tables created in the future, but existing tables will not be impacted. Lower values mean that queries will return fresher data, but may result in higher cost. "merge": { # Merge mode defines that all changes to a table will be merged at the destination table. # The standard mode }, @@ -1778,6 +1955,37 @@

Method Details

"publication": "A String", # Required. The name of the publication that includes the set of all tables that are defined in the stream's include_objects. "replicationSlot": "A String", # Required. Immutable. The name of the logical replication slot that's configured with the pgoutput plugin. }, + "salesforceSourceConfig": { # Salesforce source configuration # Salesforce data source configuration. + "excludeObjects": { # Salesforce organization structure. # Salesforce objects to exclude from the stream. + "objects": [ # Salesforce objects in the database server. + { # Salesforce object. + "fields": [ # Salesforce fields. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing. + { # Salesforce field. + "dataType": "A String", # The data type. + "name": "A String", # Field name. + "nillable": True or False, # Indicates whether the field can accept nil values. + }, + ], + "objectName": "A String", # Object name. + }, + ], + }, + "includeObjects": { # Salesforce organization structure. # Salesforce objects to retrieve from the source. + "objects": [ # Salesforce objects in the database server. + { # Salesforce object. + "fields": [ # Salesforce fields. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing. + { # Salesforce field. + "dataType": "A String", # The data type. + "name": "A String", # Field name. + "nillable": True or False, # Indicates whether the field can accept nil values. + }, + ], + "objectName": "A String", # Object name. + }, + ], + }, + "pollingInterval": "A String", # Required. Salesforce objects polling interval. The interval at which new changes will be polled for each object. The duration must be between 5 minutes and 24 hours. + }, "sourceConnectionProfile": "A String", # Required. Source connection profile resoource. Format: `projects/{project}/locations/{location}/connectionProfiles/{name}` "sqlServerSourceConfig": { # SQLServer data source configuration # SQLServer data source configuration. "changeTables": { # Configuration to use Change Tables CDC read method. # CDC reader reads from change tables. diff --git a/docs/dyn/datastream_v1.projects.locations.streams.objects.html b/docs/dyn/datastream_v1.projects.locations.streams.objects.html index ba83f50e046..25b68e8a977 100644 --- a/docs/dyn/datastream_v1.projects.locations.streams.objects.html +++ b/docs/dyn/datastream_v1.projects.locations.streams.objects.html @@ -160,6 +160,9 @@

Method Details

"schema": "A String", # Required. The schema name. "table": "A String", # Required. The table name. }, + "salesforceIdentifier": { # Salesforce data source object identifier. # Salesforce data source object identifier. + "objectName": "A String", # Required. The object name. + }, "sqlServerIdentifier": { # SQLServer data source object identifier. # SQLServer data source object identifier. "schema": "A String", # Required. The schema name. "table": "A String", # Required. The table name. @@ -233,6 +236,9 @@

Method Details

"schema": "A String", # Required. The schema name. "table": "A String", # Required. The table name. }, + "salesforceIdentifier": { # Salesforce data source object identifier. # Salesforce data source object identifier. + "objectName": "A String", # Required. The object name. + }, "sqlServerIdentifier": { # SQLServer data source object identifier. # SQLServer data source object identifier. "schema": "A String", # Required. The schema name. "table": "A String", # Required. The table name. @@ -281,6 +287,9 @@

Method Details

"schema": "A String", # Required. The schema name. "table": "A String", # Required. The table name. }, + "salesforceIdentifier": { # Salesforce data source object identifier. # Salesforce data source object identifier. + "objectName": "A String", # Required. The object name. + }, "sqlServerIdentifier": { # SQLServer data source object identifier. # SQLServer data source object identifier. "schema": "A String", # Required. The schema name. "table": "A String", # Required. The table name. @@ -341,6 +350,9 @@

Method Details

"schema": "A String", # Required. The schema name. "table": "A String", # Required. The table name. }, + "salesforceIdentifier": { # Salesforce data source object identifier. # Salesforce data source object identifier. + "objectName": "A String", # Required. The object name. + }, "sqlServerIdentifier": { # SQLServer data source object identifier. # SQLServer data source object identifier. "schema": "A String", # Required. The schema name. "table": "A String", # Required. The table name. @@ -416,6 +428,9 @@

Method Details

"schema": "A String", # Required. The schema name. "table": "A String", # Required. The table name. }, + "salesforceIdentifier": { # Salesforce data source object identifier. # Salesforce data source object identifier. + "objectName": "A String", # Required. The object name. + }, "sqlServerIdentifier": { # SQLServer data source object identifier. # SQLServer data source object identifier. "schema": "A String", # Required. The schema name. "table": "A String", # Required. The table name. @@ -492,6 +507,9 @@

Method Details

"schema": "A String", # Required. The schema name. "table": "A String", # Required. The table name. }, + "salesforceIdentifier": { # Salesforce data source object identifier. # Salesforce data source object identifier. + "objectName": "A String", # Required. The object name. + }, "sqlServerIdentifier": { # SQLServer data source object identifier. # SQLServer data source object identifier. "schema": "A String", # Required. The schema name. "table": "A String", # Required. The table name. diff --git a/googleapiclient/discovery_cache/documents/datastream.v1.json b/googleapiclient/discovery_cache/documents/datastream.v1.json index 0fe37132abc..4fa25f6a1bd 100644 --- a/googleapiclient/discovery_cache/documents/datastream.v1.json +++ b/googleapiclient/discovery_cache/documents/datastream.v1.json @@ -1250,7 +1250,7 @@ } } }, -"revision": "20250202", +"revision": "20250213", "rootUrl": "https://datastream.googleapis.com/", "schemas": { "AppendOnly": { @@ -1281,6 +1281,10 @@ "$ref": "PostgresqlRdbms", "description": "PostgreSQL data source objects to avoid backfilling." }, +"salesforceExcludedObjects": { +"$ref": "SalesforceOrg", +"description": "Salesforce data source objects to avoid backfilling" +}, "sqlServerExcludedObjects": { "$ref": "SqlServerRdbms", "description": "SQLServer data source objects to avoid backfilling" @@ -1368,6 +1372,10 @@ "$ref": "AppendOnly", "description": "Append only mode" }, +"blmtConfig": { +"$ref": "BlmtConfig", +"description": "Optional. Big Lake Managed Tables (BLMT) configuration." +}, "dataFreshness": { "description": "The guaranteed data freshness (in seconds) when querying tables created by the stream. Editing this field will only affect new tables created in the future, but existing tables will not be impacted. Lower values mean that queries will return fresher data, but may result in higher cost.", "format": "google-duration", @@ -1415,6 +1423,49 @@ "properties": {}, "type": "object" }, +"BlmtConfig": { +"description": "The configuration for BLMT.", +"id": "BlmtConfig", +"properties": { +"bucket": { +"description": "Required. The Cloud Storage bucket name.", +"type": "string" +}, +"connectionName": { +"description": "Required. The bigquery connection. Format: `{project}.{location}.{name}`", +"type": "string" +}, +"fileFormat": { +"description": "Required. The file format.", +"enum": [ +"FILE_FORMAT_UNSPECIFIED", +"PARQUET" +], +"enumDescriptions": [ +"Default value.", +"Parquet file format." +], +"type": "string" +}, +"rootPath": { +"description": "The root path inside the Cloud Storage bucket.", +"type": "string" +}, +"tableFormat": { +"description": "Required. The table format.", +"enum": [ +"TABLE_FORMAT_UNSPECIFIED", +"ICEBERG" +], +"enumDescriptions": [ +"Default value.", +"Iceberg table format." +], +"type": "string" +} +}, +"type": "object" +}, "CancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "CancelOperationRequest", @@ -1494,6 +1545,10 @@ "$ref": "PrivateConnectivity", "description": "Private connectivity." }, +"salesforceProfile": { +"$ref": "SalesforceProfile", +"description": "Salesforce Connection Profile configuration." +}, "satisfiesPzi": { "description": "Output only. Reserved for future use.", "readOnly": true, @@ -2268,6 +2323,25 @@ "properties": {}, "type": "object" }, +"Oauth2ClientCredentials": { +"description": "OAuth2 Client Credentials.", +"id": "Oauth2ClientCredentials", +"properties": { +"clientId": { +"description": "Required. Client ID for Salesforce OAuth2 Client Credentials.", +"type": "string" +}, +"clientSecret": { +"description": "Optional. Client secret for Salesforce OAuth2 Client Credentials. Mutually exclusive with the `secret_manager_stored_client_secret` field.", +"type": "string" +}, +"secretManagerStoredClientSecret": { +"description": "Optional. A reference to a Secret Manager resource name storing the Salesforce OAuth2 client_secret. Mutually exclusive with the `client_secret` field.", +"type": "string" +} +}, +"type": "object" +}, "Operation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", @@ -2953,6 +3027,107 @@ }, "type": "object" }, +"SalesforceField": { +"description": "Salesforce field.", +"id": "SalesforceField", +"properties": { +"dataType": { +"description": "The data type.", +"type": "string" +}, +"name": { +"description": "Field name.", +"type": "string" +}, +"nillable": { +"description": "Indicates whether the field can accept nil values.", +"type": "boolean" +} +}, +"type": "object" +}, +"SalesforceObject": { +"description": "Salesforce object.", +"id": "SalesforceObject", +"properties": { +"fields": { +"description": "Salesforce fields. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.", +"items": { +"$ref": "SalesforceField" +}, +"type": "array" +}, +"objectName": { +"description": "Object name.", +"type": "string" +} +}, +"type": "object" +}, +"SalesforceObjectIdentifier": { +"description": "Salesforce data source object identifier.", +"id": "SalesforceObjectIdentifier", +"properties": { +"objectName": { +"description": "Required. The object name.", +"type": "string" +} +}, +"type": "object" +}, +"SalesforceOrg": { +"description": "Salesforce organization structure.", +"id": "SalesforceOrg", +"properties": { +"objects": { +"description": "Salesforce objects in the database server.", +"items": { +"$ref": "SalesforceObject" +}, +"type": "array" +} +}, +"type": "object" +}, +"SalesforceProfile": { +"description": "Salesforce profile", +"id": "SalesforceProfile", +"properties": { +"domain": { +"description": "Required. Domain endpoint for the Salesforce connection.", +"type": "string" +}, +"oauth2ClientCredentials": { +"$ref": "Oauth2ClientCredentials", +"description": "Connected app authentication." +}, +"userCredentials": { +"$ref": "UserCredentials", +"description": "User-password authentication." +} +}, +"type": "object" +}, +"SalesforceSourceConfig": { +"description": "Salesforce source configuration", +"id": "SalesforceSourceConfig", +"properties": { +"excludeObjects": { +"$ref": "SalesforceOrg", +"description": "Salesforce objects to exclude from the stream." +}, +"includeObjects": { +"$ref": "SalesforceOrg", +"description": "Salesforce objects to retrieve from the source." +}, +"pollingInterval": { +"description": "Required. Salesforce objects polling interval. The interval at which new changes will be polled for each object. The duration must be between 5 minutes and 24 hours.", +"format": "google-duration", +"type": "string" +} +}, +"type": "object" +}, "ServerAndClientVerification": { "description": "Message represents the option where Datastream will enforce the encryption and authenticate the server identity as well as the client identity. ca_certificate, client_certificate and client_key must be set if user selects this option.", "id": "ServerAndClientVerification", @@ -3010,6 +3185,10 @@ "$ref": "PostgresqlSourceConfig", "description": "PostgreSQL data source configuration." }, +"salesforceSourceConfig": { +"$ref": "SalesforceSourceConfig", +"description": "Salesforce data source configuration." +}, "sourceConnectionProfile": { "description": "Required. Source connection profile resoource. Format: `projects/{project}/locations/{location}/connectionProfiles/{name}`", "type": "string" @@ -3048,6 +3227,10 @@ "$ref": "PostgresqlObjectIdentifier", "description": "PostgreSQL data source object identifier." }, +"salesforceIdentifier": { +"$ref": "SalesforceObjectIdentifier", +"description": "Salesforce data source object identifier." +}, "sqlServerIdentifier": { "$ref": "SqlServerObjectIdentifier", "description": "SQLServer data source object identifier." @@ -3492,6 +3675,33 @@ }, "type": "object" }, +"UserCredentials": { +"description": "Username-password credentials.", +"id": "UserCredentials", +"properties": { +"password": { +"description": "Optional. Password for the Salesforce connection. Mutually exclusive with the `secret_manager_stored_password` field.", +"type": "string" +}, +"secretManagerStoredPassword": { +"description": "Optional. A reference to a Secret Manager resource name storing the Salesforce connection's password. Mutually exclusive with the `password` field.", +"type": "string" +}, +"secretManagerStoredSecurityToken": { +"description": "Optional. A reference to a Secret Manager resource name storing the Salesforce connection's security token. Mutually exclusive with the `security_token` field.", +"type": "string" +}, +"securityToken": { +"description": "Optional. Security token for the Salesforce connection. Mutually exclusive with the `secret_manager_stored_security_token` field.", +"type": "string" +}, +"username": { +"description": "Required. Username for the Salesforce connection.", +"type": "string" +} +}, +"type": "object" +}, "Validation": { "description": "A validation to perform on a stream.", "id": "Validation", From 55fe465fe65c608f368f064afc5df4f2ee21d724 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 25 Feb 2025 07:08:18 +0000 Subject: [PATCH 11/36] feat(dialogflow): update the api #### dialogflow:v2 The following keys were deleted: - resources.projects.resources.answerRecords.methods.list.parameters.filter.deprecated (Total Keys: 1) - resources.projects.resources.locations.resources.answerRecords.methods.list.parameters.filter.deprecated (Total Keys: 1) #### dialogflow:v2beta1 The following keys were deleted: - resources.projects.resources.answerRecords.methods.list.parameters.filter.deprecated (Total Keys: 1) - resources.projects.resources.locations.resources.answerRecords.methods.list.parameters.filter.deprecated (Total Keys: 1) --- .../dialogflow_v2.projects.answerRecords.html | 8 +- ...ojects.conversationModels.evaluations.html | 12 +- ...onversations.participants.suggestions.html | 2 +- ...w_v2.projects.locations.answerRecords.html | 8 +- ...ations.conversationModels.evaluations.html | 18 +- ...onversations.participants.suggestions.html | 2 +- ...ogflow_v2beta1.projects.answerRecords.html | 10 +- ...beta1.projects.conversations.messages.html | 6 +- ...1.projects.conversations.participants.html | 6 +- ...onversations.participants.suggestions.html | 2 +- docs/dyn/dialogflow_v2beta1.projects.html | 5 + ...eta1.projects.locations.answerRecords.html | 10 +- ...ects.locations.conversations.messages.html | 6 +- ....locations.conversations.participants.html | 6 +- ...onversations.participants.suggestions.html | 2 +- ...dialogflow_v2beta1.projects.locations.html | 5 + ...beta1.projects.locations.phoneNumbers.html | 228 ++++++++++++ ...2beta1.projects.locations.suggestions.html | 2 +- ...logflow_v2beta1.projects.phoneNumbers.html | 228 ++++++++++++ ...alogflow_v2beta1.projects.suggestions.html | 2 +- ...rojects.locations.agents.environments.html | 20 +- ...v3.projects.locations.agents.webhooks.html | 24 +- ...ojects.locations.agents.conversations.html | 8 +- ...rojects.locations.agents.environments.html | 20 +- ...a1.projects.locations.agents.webhooks.html | 24 +- .../documents/dialogflow.v2.json | 24 +- .../documents/dialogflow.v2beta1.json | 351 +++++++++++++++++- .../documents/dialogflow.v3.json | 8 +- .../documents/dialogflow.v3beta1.json | 8 +- 29 files changed, 924 insertions(+), 131 deletions(-) create mode 100644 docs/dyn/dialogflow_v2beta1.projects.locations.phoneNumbers.html create mode 100644 docs/dyn/dialogflow_v2beta1.projects.phoneNumbers.html diff --git a/docs/dyn/dialogflow_v2.projects.answerRecords.html b/docs/dyn/dialogflow_v2.projects.answerRecords.html index 4e9e0d6e294..1f7535726a0 100644 --- a/docs/dyn/dialogflow_v2.projects.answerRecords.html +++ b/docs/dyn/dialogflow_v2.projects.answerRecords.html @@ -98,7 +98,7 @@

Method Details

Args: parent: string, Required. The project to list all answer records for in reverse chronological order. Format: `projects//locations/`. (required) - filter: string, Optional. Filters to restrict results to specific answer records. Marked deprecated as it hasn't been, and isn't currently, supported. For more information about filtering, see [API Filtering](https://aip.dev/160). + filter: string, Optional. Filters to restrict results to specific answer records. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * conversation_id with equals(=) operator Examples: * "conversation_id=bar" matches answer records in the projects/foo/locations/global/conversations/bar conversation (assuming the parent is projects/foo/locations/global). For more information about filtering, see [API Filtering](https://aip.dev/160). pageSize: integer, Optional. The maximum number of records to return in a single page. The server may return fewer records than this. If unspecified, we use 10. The maximum is 100. pageToken: string, Optional. The ListAnswerRecordsResponse.next_page_token value returned from a previous list request used to continue listing on the next page. x__xgafv: string, V1 error format. @@ -603,7 +603,7 @@

Method Details

"answerFeedback": { # Represents feedback the customer has about the quality & correctness of a certain answer in a conversation. # Required. The AnswerFeedback for this record. You can set this with AnswerRecords.UpdateAnswerRecord in order to give us feedback about this answer. "agentAssistantDetailFeedback": { # Detail feedback of Agent Assist result. # Detail feedback of agent assist suggestions. "answerRelevance": "A String", # Optional. Whether or not the suggested answer is relevant. For example: * Query: "Can I change my mailing address?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * answer_relevance: AnswerRelevance.IRRELEVANT - "documentCorrectness": "A String", # Optional. Whether or not the information in the document is correct. For example: * Query: "Can I return the package in 2 days once received?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * Ground truth: "No return or exchange is allowed." * [document_correctness]: INCORRECT + "documentCorrectness": "A String", # Optional. Whether or not the information in the document is correct. For example: * Query: "Can I return the package in 2 days once received?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * Ground truth: "No return or exchange is allowed." * document_correctness: INCORRECT "documentEfficiency": "A String", # Optional. Whether or not the suggested document is efficient. For example, if the document is poorly written, hard to understand, hard to use or too long to find useful information, document_efficiency is DocumentEfficiency.INEFFICIENT. "knowledgeAssistFeedback": { # Feedback for knowledge assist. # Optional. Feedback for knowledge assist. "answerCopied": True or False, # Whether the suggested answer was copied by the human agent. If the value is set to be true, AnswerFeedback.clicked will be updated to be true. @@ -1154,7 +1154,7 @@

Method Details

"answerFeedback": { # Represents feedback the customer has about the quality & correctness of a certain answer in a conversation. # Required. The AnswerFeedback for this record. You can set this with AnswerRecords.UpdateAnswerRecord in order to give us feedback about this answer. "agentAssistantDetailFeedback": { # Detail feedback of Agent Assist result. # Detail feedback of agent assist suggestions. "answerRelevance": "A String", # Optional. Whether or not the suggested answer is relevant. For example: * Query: "Can I change my mailing address?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * answer_relevance: AnswerRelevance.IRRELEVANT - "documentCorrectness": "A String", # Optional. Whether or not the information in the document is correct. For example: * Query: "Can I return the package in 2 days once received?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * Ground truth: "No return or exchange is allowed." * [document_correctness]: INCORRECT + "documentCorrectness": "A String", # Optional. Whether or not the information in the document is correct. For example: * Query: "Can I return the package in 2 days once received?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * Ground truth: "No return or exchange is allowed." * document_correctness: INCORRECT "documentEfficiency": "A String", # Optional. Whether or not the suggested document is efficient. For example, if the document is poorly written, hard to understand, hard to use or too long to find useful information, document_efficiency is DocumentEfficiency.INEFFICIENT. "knowledgeAssistFeedback": { # Feedback for knowledge assist. # Optional. Feedback for knowledge assist. "answerCopied": True or False, # Whether the suggested answer was copied by the human agent. If the value is set to be true, AnswerFeedback.clicked will be updated to be true. @@ -1687,7 +1687,7 @@

Method Details

"answerFeedback": { # Represents feedback the customer has about the quality & correctness of a certain answer in a conversation. # Required. The AnswerFeedback for this record. You can set this with AnswerRecords.UpdateAnswerRecord in order to give us feedback about this answer. "agentAssistantDetailFeedback": { # Detail feedback of Agent Assist result. # Detail feedback of agent assist suggestions. "answerRelevance": "A String", # Optional. Whether or not the suggested answer is relevant. For example: * Query: "Can I change my mailing address?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * answer_relevance: AnswerRelevance.IRRELEVANT - "documentCorrectness": "A String", # Optional. Whether or not the information in the document is correct. For example: * Query: "Can I return the package in 2 days once received?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * Ground truth: "No return or exchange is allowed." * [document_correctness]: INCORRECT + "documentCorrectness": "A String", # Optional. Whether or not the information in the document is correct. For example: * Query: "Can I return the package in 2 days once received?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * Ground truth: "No return or exchange is allowed." * document_correctness: INCORRECT "documentEfficiency": "A String", # Optional. Whether or not the suggested document is efficient. For example, if the document is poorly written, hard to understand, hard to use or too long to find useful information, document_efficiency is DocumentEfficiency.INEFFICIENT. "knowledgeAssistFeedback": { # Feedback for knowledge assist. # Optional. Feedback for knowledge assist. "answerCopied": True or False, # Whether the suggested answer was copied by the human agent. If the value is set to be true, AnswerFeedback.clicked will be updated to be true. diff --git a/docs/dyn/dialogflow_v2.projects.conversationModels.evaluations.html b/docs/dyn/dialogflow_v2.projects.conversationModels.evaluations.html index 93af74e314e..a020284c71c 100644 --- a/docs/dyn/dialogflow_v2.projects.conversationModels.evaluations.html +++ b/docs/dyn/dialogflow_v2.projects.conversationModels.evaluations.html @@ -115,17 +115,17 @@

Method Details

"dataset": "A String", # Required. ConversationDataset resource name. Format: `projects//locations//conversationDatasets/` }, ], - "smartComposeConfig": { # Smart compose specific configuration for evaluation job. # Configuration for smart compose model evalution. + "smartComposeConfig": { # Smart compose specific configuration for evaluation job. # Configuration for smart compose model evaluation. "allowlistDocument": "A String", # The allowlist document resource name. Format: `projects//knowledgeBases//documents/`. Only used for smart compose model. "maxResultCount": 42, # Required. The model to be evaluated can return multiple results with confidence score on each query. These results will be sorted by the descending order of the scores and we only keep the first max_result_count results as the final results to evaluate. }, - "smartReplyConfig": { # Smart reply specific configuration for evaluation job. # Configuration for smart reply model evalution. + "smartReplyConfig": { # Smart reply specific configuration for evaluation job. # Configuration for smart reply model evaluation. "allowlistDocument": "A String", # The allowlist document resource name. Format: `projects//knowledgeBases//documents/`. Only used for smart reply model. "maxResultCount": 42, # Required. The model to be evaluated can return multiple results with confidence score on each query. These results will be sorted by the descending order of the scores and we only keep the first max_result_count results as the final results to evaluate. }, }, "name": "A String", # The resource name of the evaluation. Format: `projects//conversationModels//evaluations/` - "rawHumanEvalTemplateCsv": "A String", # Output only. Human eval template in csv format. It tooks real-world conversations provided through input dataset, generates example suggestions for customer to verify quality of the model. For Smart Reply, the generated csv file contains columns of Context, (Suggestions,Q1,Q2)*3, Actual reply. Context contains at most 10 latest messages in the conversation prior to the current suggestion. Q1: "Would you send it as the next message of agent?" Evaluated based on whether the suggest is appropriate to be sent by agent in current context. Q2: "Does the suggestion move the conversation closer to resolution?" Evaluated based on whether the suggestion provide solutions, or answers customer's question or collect information from customer to resolve the customer's issue. Actual reply column contains the actual agent reply sent in the context. + "rawHumanEvalTemplateCsv": "A String", # Output only. Human eval template in csv format. It takes real-world conversations provided through input dataset, generates example suggestions for customer to verify quality of the model. For Smart Reply, the generated csv file contains columns of Context, (Suggestions,Q1,Q2)*3, Actual reply. Context contains at most 10 latest messages in the conversation prior to the current suggestion. Q1: "Would you send it as the next message of agent?" Evaluated based on whether the suggest is appropriate to be sent by agent in current context. Q2: "Does the suggestion move the conversation closer to resolution?" Evaluated based on whether the suggestion provide solutions, or answers customer's question or collect information from customer to resolve the customer's issue. Actual reply column contains the actual agent reply sent in the context. "smartReplyMetrics": { # The evaluation metrics for smart reply model. # Output only. Only available when model is for smart reply. "allowlistCoverage": 3.14, # Percentage of target participant messages in the evaluation dataset for which similar messages have appeared at least once in the allowlist. Should be [0, 1]. "conversationCount": "A String", # Total number of conversations used to generate this metric. @@ -166,17 +166,17 @@

Method Details

"dataset": "A String", # Required. ConversationDataset resource name. Format: `projects//locations//conversationDatasets/` }, ], - "smartComposeConfig": { # Smart compose specific configuration for evaluation job. # Configuration for smart compose model evalution. + "smartComposeConfig": { # Smart compose specific configuration for evaluation job. # Configuration for smart compose model evaluation. "allowlistDocument": "A String", # The allowlist document resource name. Format: `projects//knowledgeBases//documents/`. Only used for smart compose model. "maxResultCount": 42, # Required. The model to be evaluated can return multiple results with confidence score on each query. These results will be sorted by the descending order of the scores and we only keep the first max_result_count results as the final results to evaluate. }, - "smartReplyConfig": { # Smart reply specific configuration for evaluation job. # Configuration for smart reply model evalution. + "smartReplyConfig": { # Smart reply specific configuration for evaluation job. # Configuration for smart reply model evaluation. "allowlistDocument": "A String", # The allowlist document resource name. Format: `projects//knowledgeBases//documents/`. Only used for smart reply model. "maxResultCount": 42, # Required. The model to be evaluated can return multiple results with confidence score on each query. These results will be sorted by the descending order of the scores and we only keep the first max_result_count results as the final results to evaluate. }, }, "name": "A String", # The resource name of the evaluation. Format: `projects//conversationModels//evaluations/` - "rawHumanEvalTemplateCsv": "A String", # Output only. Human eval template in csv format. It tooks real-world conversations provided through input dataset, generates example suggestions for customer to verify quality of the model. For Smart Reply, the generated csv file contains columns of Context, (Suggestions,Q1,Q2)*3, Actual reply. Context contains at most 10 latest messages in the conversation prior to the current suggestion. Q1: "Would you send it as the next message of agent?" Evaluated based on whether the suggest is appropriate to be sent by agent in current context. Q2: "Does the suggestion move the conversation closer to resolution?" Evaluated based on whether the suggestion provide solutions, or answers customer's question or collect information from customer to resolve the customer's issue. Actual reply column contains the actual agent reply sent in the context. + "rawHumanEvalTemplateCsv": "A String", # Output only. Human eval template in csv format. It takes real-world conversations provided through input dataset, generates example suggestions for customer to verify quality of the model. For Smart Reply, the generated csv file contains columns of Context, (Suggestions,Q1,Q2)*3, Actual reply. Context contains at most 10 latest messages in the conversation prior to the current suggestion. Q1: "Would you send it as the next message of agent?" Evaluated based on whether the suggest is appropriate to be sent by agent in current context. Q2: "Does the suggestion move the conversation closer to resolution?" Evaluated based on whether the suggestion provide solutions, or answers customer's question or collect information from customer to resolve the customer's issue. Actual reply column contains the actual agent reply sent in the context. "smartReplyMetrics": { # The evaluation metrics for smart reply model. # Output only. Only available when model is for smart reply. "allowlistCoverage": 3.14, # Percentage of target participant messages in the evaluation dataset for which similar messages have appeared at least once in the allowlist. Should be [0, 1]. "conversationCount": "A String", # Total number of conversations used to generate this metric. diff --git a/docs/dyn/dialogflow_v2.projects.conversations.participants.suggestions.html b/docs/dyn/dialogflow_v2.projects.conversations.participants.suggestions.html index d9cbf143b04..c22e8fab396 100644 --- a/docs/dyn/dialogflow_v2.projects.conversations.participants.suggestions.html +++ b/docs/dyn/dialogflow_v2.projects.conversations.participants.suggestions.html @@ -199,7 +199,7 @@

Method Details

{ # The request message for Participants.SuggestKnowledgeAssist. "contextSize": 42, # Optional. Max number of messages prior to and including latest_message to use as context when compiling the suggestion. The context size is by default 100 and at most 100. "latestMessage": "A String", # Optional. The name of the latest conversation message to compile suggestions for. If empty, it will be the latest message of the conversation. Format: `projects//locations//conversations//messages/`. - "previousSuggestedQuery": "A String", # Optional. The previously suggested query for the given conversation. This helps identify whether the next suggestion we generate is resonably different from the previous one. This is useful to avoid similar suggestions within the conversation. + "previousSuggestedQuery": "A String", # Optional. The previously suggested query for the given conversation. This helps identify whether the next suggestion we generate is reasonably different from the previous one. This is useful to avoid similar suggestions within the conversation. } x__xgafv: string, V1 error format. diff --git a/docs/dyn/dialogflow_v2.projects.locations.answerRecords.html b/docs/dyn/dialogflow_v2.projects.locations.answerRecords.html index 4ed8c4ed2b4..9b528e1d2ae 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.answerRecords.html +++ b/docs/dyn/dialogflow_v2.projects.locations.answerRecords.html @@ -98,7 +98,7 @@

Method Details

Args: parent: string, Required. The project to list all answer records for in reverse chronological order. Format: `projects//locations/`. (required) - filter: string, Optional. Filters to restrict results to specific answer records. Marked deprecated as it hasn't been, and isn't currently, supported. For more information about filtering, see [API Filtering](https://aip.dev/160). + filter: string, Optional. Filters to restrict results to specific answer records. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * conversation_id with equals(=) operator Examples: * "conversation_id=bar" matches answer records in the projects/foo/locations/global/conversations/bar conversation (assuming the parent is projects/foo/locations/global). For more information about filtering, see [API Filtering](https://aip.dev/160). pageSize: integer, Optional. The maximum number of records to return in a single page. The server may return fewer records than this. If unspecified, we use 10. The maximum is 100. pageToken: string, Optional. The ListAnswerRecordsResponse.next_page_token value returned from a previous list request used to continue listing on the next page. x__xgafv: string, V1 error format. @@ -603,7 +603,7 @@

Method Details

"answerFeedback": { # Represents feedback the customer has about the quality & correctness of a certain answer in a conversation. # Required. The AnswerFeedback for this record. You can set this with AnswerRecords.UpdateAnswerRecord in order to give us feedback about this answer. "agentAssistantDetailFeedback": { # Detail feedback of Agent Assist result. # Detail feedback of agent assist suggestions. "answerRelevance": "A String", # Optional. Whether or not the suggested answer is relevant. For example: * Query: "Can I change my mailing address?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * answer_relevance: AnswerRelevance.IRRELEVANT - "documentCorrectness": "A String", # Optional. Whether or not the information in the document is correct. For example: * Query: "Can I return the package in 2 days once received?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * Ground truth: "No return or exchange is allowed." * [document_correctness]: INCORRECT + "documentCorrectness": "A String", # Optional. Whether or not the information in the document is correct. For example: * Query: "Can I return the package in 2 days once received?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * Ground truth: "No return or exchange is allowed." * document_correctness: INCORRECT "documentEfficiency": "A String", # Optional. Whether or not the suggested document is efficient. For example, if the document is poorly written, hard to understand, hard to use or too long to find useful information, document_efficiency is DocumentEfficiency.INEFFICIENT. "knowledgeAssistFeedback": { # Feedback for knowledge assist. # Optional. Feedback for knowledge assist. "answerCopied": True or False, # Whether the suggested answer was copied by the human agent. If the value is set to be true, AnswerFeedback.clicked will be updated to be true. @@ -1154,7 +1154,7 @@

Method Details

"answerFeedback": { # Represents feedback the customer has about the quality & correctness of a certain answer in a conversation. # Required. The AnswerFeedback for this record. You can set this with AnswerRecords.UpdateAnswerRecord in order to give us feedback about this answer. "agentAssistantDetailFeedback": { # Detail feedback of Agent Assist result. # Detail feedback of agent assist suggestions. "answerRelevance": "A String", # Optional. Whether or not the suggested answer is relevant. For example: * Query: "Can I change my mailing address?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * answer_relevance: AnswerRelevance.IRRELEVANT - "documentCorrectness": "A String", # Optional. Whether or not the information in the document is correct. For example: * Query: "Can I return the package in 2 days once received?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * Ground truth: "No return or exchange is allowed." * [document_correctness]: INCORRECT + "documentCorrectness": "A String", # Optional. Whether or not the information in the document is correct. For example: * Query: "Can I return the package in 2 days once received?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * Ground truth: "No return or exchange is allowed." * document_correctness: INCORRECT "documentEfficiency": "A String", # Optional. Whether or not the suggested document is efficient. For example, if the document is poorly written, hard to understand, hard to use or too long to find useful information, document_efficiency is DocumentEfficiency.INEFFICIENT. "knowledgeAssistFeedback": { # Feedback for knowledge assist. # Optional. Feedback for knowledge assist. "answerCopied": True or False, # Whether the suggested answer was copied by the human agent. If the value is set to be true, AnswerFeedback.clicked will be updated to be true. @@ -1687,7 +1687,7 @@

Method Details

"answerFeedback": { # Represents feedback the customer has about the quality & correctness of a certain answer in a conversation. # Required. The AnswerFeedback for this record. You can set this with AnswerRecords.UpdateAnswerRecord in order to give us feedback about this answer. "agentAssistantDetailFeedback": { # Detail feedback of Agent Assist result. # Detail feedback of agent assist suggestions. "answerRelevance": "A String", # Optional. Whether or not the suggested answer is relevant. For example: * Query: "Can I change my mailing address?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * answer_relevance: AnswerRelevance.IRRELEVANT - "documentCorrectness": "A String", # Optional. Whether or not the information in the document is correct. For example: * Query: "Can I return the package in 2 days once received?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * Ground truth: "No return or exchange is allowed." * [document_correctness]: INCORRECT + "documentCorrectness": "A String", # Optional. Whether or not the information in the document is correct. For example: * Query: "Can I return the package in 2 days once received?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * Ground truth: "No return or exchange is allowed." * document_correctness: INCORRECT "documentEfficiency": "A String", # Optional. Whether or not the suggested document is efficient. For example, if the document is poorly written, hard to understand, hard to use or too long to find useful information, document_efficiency is DocumentEfficiency.INEFFICIENT. "knowledgeAssistFeedback": { # Feedback for knowledge assist. # Optional. Feedback for knowledge assist. "answerCopied": True or False, # Whether the suggested answer was copied by the human agent. If the value is set to be true, AnswerFeedback.clicked will be updated to be true. diff --git a/docs/dyn/dialogflow_v2.projects.locations.conversationModels.evaluations.html b/docs/dyn/dialogflow_v2.projects.locations.conversationModels.evaluations.html index dbe54140be0..2a82e97dce8 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.conversationModels.evaluations.html +++ b/docs/dyn/dialogflow_v2.projects.locations.conversationModels.evaluations.html @@ -114,17 +114,17 @@

Method Details

"dataset": "A String", # Required. ConversationDataset resource name. Format: `projects//locations//conversationDatasets/` }, ], - "smartComposeConfig": { # Smart compose specific configuration for evaluation job. # Configuration for smart compose model evalution. + "smartComposeConfig": { # Smart compose specific configuration for evaluation job. # Configuration for smart compose model evaluation. "allowlistDocument": "A String", # The allowlist document resource name. Format: `projects//knowledgeBases//documents/`. Only used for smart compose model. "maxResultCount": 42, # Required. The model to be evaluated can return multiple results with confidence score on each query. These results will be sorted by the descending order of the scores and we only keep the first max_result_count results as the final results to evaluate. }, - "smartReplyConfig": { # Smart reply specific configuration for evaluation job. # Configuration for smart reply model evalution. + "smartReplyConfig": { # Smart reply specific configuration for evaluation job. # Configuration for smart reply model evaluation. "allowlistDocument": "A String", # The allowlist document resource name. Format: `projects//knowledgeBases//documents/`. Only used for smart reply model. "maxResultCount": 42, # Required. The model to be evaluated can return multiple results with confidence score on each query. These results will be sorted by the descending order of the scores and we only keep the first max_result_count results as the final results to evaluate. }, }, "name": "A String", # The resource name of the evaluation. Format: `projects//conversationModels//evaluations/` - "rawHumanEvalTemplateCsv": "A String", # Output only. Human eval template in csv format. It tooks real-world conversations provided through input dataset, generates example suggestions for customer to verify quality of the model. For Smart Reply, the generated csv file contains columns of Context, (Suggestions,Q1,Q2)*3, Actual reply. Context contains at most 10 latest messages in the conversation prior to the current suggestion. Q1: "Would you send it as the next message of agent?" Evaluated based on whether the suggest is appropriate to be sent by agent in current context. Q2: "Does the suggestion move the conversation closer to resolution?" Evaluated based on whether the suggestion provide solutions, or answers customer's question or collect information from customer to resolve the customer's issue. Actual reply column contains the actual agent reply sent in the context. + "rawHumanEvalTemplateCsv": "A String", # Output only. Human eval template in csv format. It takes real-world conversations provided through input dataset, generates example suggestions for customer to verify quality of the model. For Smart Reply, the generated csv file contains columns of Context, (Suggestions,Q1,Q2)*3, Actual reply. Context contains at most 10 latest messages in the conversation prior to the current suggestion. Q1: "Would you send it as the next message of agent?" Evaluated based on whether the suggest is appropriate to be sent by agent in current context. Q2: "Does the suggestion move the conversation closer to resolution?" Evaluated based on whether the suggestion provide solutions, or answers customer's question or collect information from customer to resolve the customer's issue. Actual reply column contains the actual agent reply sent in the context. "smartReplyMetrics": { # The evaluation metrics for smart reply model. # Output only. Only available when model is for smart reply. "allowlistCoverage": 3.14, # Percentage of target participant messages in the evaluation dataset for which similar messages have appeared at least once in the allowlist. Should be [0, 1]. "conversationCount": "A String", # Total number of conversations used to generate this metric. @@ -190,17 +190,17 @@

Method Details

"dataset": "A String", # Required. ConversationDataset resource name. Format: `projects//locations//conversationDatasets/` }, ], - "smartComposeConfig": { # Smart compose specific configuration for evaluation job. # Configuration for smart compose model evalution. + "smartComposeConfig": { # Smart compose specific configuration for evaluation job. # Configuration for smart compose model evaluation. "allowlistDocument": "A String", # The allowlist document resource name. Format: `projects//knowledgeBases//documents/`. Only used for smart compose model. "maxResultCount": 42, # Required. The model to be evaluated can return multiple results with confidence score on each query. These results will be sorted by the descending order of the scores and we only keep the first max_result_count results as the final results to evaluate. }, - "smartReplyConfig": { # Smart reply specific configuration for evaluation job. # Configuration for smart reply model evalution. + "smartReplyConfig": { # Smart reply specific configuration for evaluation job. # Configuration for smart reply model evaluation. "allowlistDocument": "A String", # The allowlist document resource name. Format: `projects//knowledgeBases//documents/`. Only used for smart reply model. "maxResultCount": 42, # Required. The model to be evaluated can return multiple results with confidence score on each query. These results will be sorted by the descending order of the scores and we only keep the first max_result_count results as the final results to evaluate. }, }, "name": "A String", # The resource name of the evaluation. Format: `projects//conversationModels//evaluations/` - "rawHumanEvalTemplateCsv": "A String", # Output only. Human eval template in csv format. It tooks real-world conversations provided through input dataset, generates example suggestions for customer to verify quality of the model. For Smart Reply, the generated csv file contains columns of Context, (Suggestions,Q1,Q2)*3, Actual reply. Context contains at most 10 latest messages in the conversation prior to the current suggestion. Q1: "Would you send it as the next message of agent?" Evaluated based on whether the suggest is appropriate to be sent by agent in current context. Q2: "Does the suggestion move the conversation closer to resolution?" Evaluated based on whether the suggestion provide solutions, or answers customer's question or collect information from customer to resolve the customer's issue. Actual reply column contains the actual agent reply sent in the context. + "rawHumanEvalTemplateCsv": "A String", # Output only. Human eval template in csv format. It takes real-world conversations provided through input dataset, generates example suggestions for customer to verify quality of the model. For Smart Reply, the generated csv file contains columns of Context, (Suggestions,Q1,Q2)*3, Actual reply. Context contains at most 10 latest messages in the conversation prior to the current suggestion. Q1: "Would you send it as the next message of agent?" Evaluated based on whether the suggest is appropriate to be sent by agent in current context. Q2: "Does the suggestion move the conversation closer to resolution?" Evaluated based on whether the suggestion provide solutions, or answers customer's question or collect information from customer to resolve the customer's issue. Actual reply column contains the actual agent reply sent in the context. "smartReplyMetrics": { # The evaluation metrics for smart reply model. # Output only. Only available when model is for smart reply. "allowlistCoverage": 3.14, # Percentage of target participant messages in the evaluation dataset for which similar messages have appeared at least once in the allowlist. Should be [0, 1]. "conversationCount": "A String", # Total number of conversations used to generate this metric. @@ -241,17 +241,17 @@

Method Details

"dataset": "A String", # Required. ConversationDataset resource name. Format: `projects//locations//conversationDatasets/` }, ], - "smartComposeConfig": { # Smart compose specific configuration for evaluation job. # Configuration for smart compose model evalution. + "smartComposeConfig": { # Smart compose specific configuration for evaluation job. # Configuration for smart compose model evaluation. "allowlistDocument": "A String", # The allowlist document resource name. Format: `projects//knowledgeBases//documents/`. Only used for smart compose model. "maxResultCount": 42, # Required. The model to be evaluated can return multiple results with confidence score on each query. These results will be sorted by the descending order of the scores and we only keep the first max_result_count results as the final results to evaluate. }, - "smartReplyConfig": { # Smart reply specific configuration for evaluation job. # Configuration for smart reply model evalution. + "smartReplyConfig": { # Smart reply specific configuration for evaluation job. # Configuration for smart reply model evaluation. "allowlistDocument": "A String", # The allowlist document resource name. Format: `projects//knowledgeBases//documents/`. Only used for smart reply model. "maxResultCount": 42, # Required. The model to be evaluated can return multiple results with confidence score on each query. These results will be sorted by the descending order of the scores and we only keep the first max_result_count results as the final results to evaluate. }, }, "name": "A String", # The resource name of the evaluation. Format: `projects//conversationModels//evaluations/` - "rawHumanEvalTemplateCsv": "A String", # Output only. Human eval template in csv format. It tooks real-world conversations provided through input dataset, generates example suggestions for customer to verify quality of the model. For Smart Reply, the generated csv file contains columns of Context, (Suggestions,Q1,Q2)*3, Actual reply. Context contains at most 10 latest messages in the conversation prior to the current suggestion. Q1: "Would you send it as the next message of agent?" Evaluated based on whether the suggest is appropriate to be sent by agent in current context. Q2: "Does the suggestion move the conversation closer to resolution?" Evaluated based on whether the suggestion provide solutions, or answers customer's question or collect information from customer to resolve the customer's issue. Actual reply column contains the actual agent reply sent in the context. + "rawHumanEvalTemplateCsv": "A String", # Output only. Human eval template in csv format. It takes real-world conversations provided through input dataset, generates example suggestions for customer to verify quality of the model. For Smart Reply, the generated csv file contains columns of Context, (Suggestions,Q1,Q2)*3, Actual reply. Context contains at most 10 latest messages in the conversation prior to the current suggestion. Q1: "Would you send it as the next message of agent?" Evaluated based on whether the suggest is appropriate to be sent by agent in current context. Q2: "Does the suggestion move the conversation closer to resolution?" Evaluated based on whether the suggestion provide solutions, or answers customer's question or collect information from customer to resolve the customer's issue. Actual reply column contains the actual agent reply sent in the context. "smartReplyMetrics": { # The evaluation metrics for smart reply model. # Output only. Only available when model is for smart reply. "allowlistCoverage": 3.14, # Percentage of target participant messages in the evaluation dataset for which similar messages have appeared at least once in the allowlist. Should be [0, 1]. "conversationCount": "A String", # Total number of conversations used to generate this metric. diff --git a/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.suggestions.html b/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.suggestions.html index fe3058ada32..569cd9d852e 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.suggestions.html +++ b/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.suggestions.html @@ -199,7 +199,7 @@

Method Details

{ # The request message for Participants.SuggestKnowledgeAssist. "contextSize": 42, # Optional. Max number of messages prior to and including latest_message to use as context when compiling the suggestion. The context size is by default 100 and at most 100. "latestMessage": "A String", # Optional. The name of the latest conversation message to compile suggestions for. If empty, it will be the latest message of the conversation. Format: `projects//locations//conversations//messages/`. - "previousSuggestedQuery": "A String", # Optional. The previously suggested query for the given conversation. This helps identify whether the next suggestion we generate is resonably different from the previous one. This is useful to avoid similar suggestions within the conversation. + "previousSuggestedQuery": "A String", # Optional. The previously suggested query for the given conversation. This helps identify whether the next suggestion we generate is reasonably different from the previous one. This is useful to avoid similar suggestions within the conversation. } x__xgafv: string, V1 error format. diff --git a/docs/dyn/dialogflow_v2beta1.projects.answerRecords.html b/docs/dyn/dialogflow_v2beta1.projects.answerRecords.html index 8d35d633741..29c70bebfdc 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.answerRecords.html +++ b/docs/dyn/dialogflow_v2beta1.projects.answerRecords.html @@ -812,7 +812,7 @@

Method Details

"answerFeedback": { # Represents feedback the customer has about the quality & correctness of a certain answer in a conversation. # Optional. The AnswerFeedback for this record. You can set this with AnswerRecords.UpdateAnswerRecord in order to give us feedback about this answer. "agentAssistantDetailFeedback": { # Detail feedback of Agent Assistant result. # Optional. Detail feedback of agent assistant suggestions. "answerRelevance": "A String", # Optional. Whether or not the suggested answer is relevant. For example: * Query: "Can I change my mailing address?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * answer_relevance: AnswerRelevance.IRRELEVANT - "documentCorrectness": "A String", # Optional. Whether or not the information in the document is correct. For example: * Query: "Can I return the package in 2 days once received?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * Ground truth: "No return or exchange is allowed." * [document_correctness]: INCORRECT + "documentCorrectness": "A String", # Optional. Whether or not the information in the document is correct. For example: * Query: "Can I return the package in 2 days once received?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * Ground truth: "No return or exchange is allowed." * document_correctness: INCORRECT "documentEfficiency": "A String", # Optional. Whether or not the suggested document is efficient. For example, if the document is poorly written, hard to understand, hard to use or too long to find useful information, document_efficiency is DocumentEfficiency.INEFFICIENT. "knowledgeAssistFeedback": { # Feedback for knowledge assist. # Optional. Feedback for knowledge assist. "answerCopied": True or False, # Whether the suggested answer was copied by the human agent. If the value is set to be true, AnswerFeedback.clicked will be updated to be true. @@ -851,7 +851,7 @@

Method Details

Args: parent: string, Required. The project to list all answer records for in reverse chronological order. Format: `projects//locations/`. (required) - filter: string, Optional. Filters to restrict results to specific answer records. For more information about filtering, see [API Filtering](https://aip.dev/160). + filter: string, Optional. Filters to restrict results to specific answer records. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * conversation_id with equals(=) operator Examples: * "conversation_id=bar" matches answer records in the projects/foo/locations/global/conversations/bar conversation (assuming the parent is projects/foo/locations/global). For more information about filtering, see [API Filtering](https://aip.dev/160). pageSize: integer, Optional. The maximum number of records to return in a single page. The server may return fewer records than this. If unspecified, we use 10. The maximum is 100. pageToken: string, Optional. The ListAnswerRecordsResponse.next_page_token value returned from a previous list request used to continue listing on the next page. x__xgafv: string, V1 error format. @@ -1567,7 +1567,7 @@

Method Details

"answerFeedback": { # Represents feedback the customer has about the quality & correctness of a certain answer in a conversation. # Optional. The AnswerFeedback for this record. You can set this with AnswerRecords.UpdateAnswerRecord in order to give us feedback about this answer. "agentAssistantDetailFeedback": { # Detail feedback of Agent Assistant result. # Optional. Detail feedback of agent assistant suggestions. "answerRelevance": "A String", # Optional. Whether or not the suggested answer is relevant. For example: * Query: "Can I change my mailing address?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * answer_relevance: AnswerRelevance.IRRELEVANT - "documentCorrectness": "A String", # Optional. Whether or not the information in the document is correct. For example: * Query: "Can I return the package in 2 days once received?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * Ground truth: "No return or exchange is allowed." * [document_correctness]: INCORRECT + "documentCorrectness": "A String", # Optional. Whether or not the information in the document is correct. For example: * Query: "Can I return the package in 2 days once received?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * Ground truth: "No return or exchange is allowed." * document_correctness: INCORRECT "documentEfficiency": "A String", # Optional. Whether or not the suggested document is efficient. For example, if the document is poorly written, hard to understand, hard to use or too long to find useful information, document_efficiency is DocumentEfficiency.INEFFICIENT. "knowledgeAssistFeedback": { # Feedback for knowledge assist. # Optional. Feedback for knowledge assist. "answerCopied": True or False, # Whether the suggested answer was copied by the human agent. If the value is set to be true, AnswerFeedback.clicked will be updated to be true. @@ -2329,7 +2329,7 @@

Method Details

"answerFeedback": { # Represents feedback the customer has about the quality & correctness of a certain answer in a conversation. # Optional. The AnswerFeedback for this record. You can set this with AnswerRecords.UpdateAnswerRecord in order to give us feedback about this answer. "agentAssistantDetailFeedback": { # Detail feedback of Agent Assistant result. # Optional. Detail feedback of agent assistant suggestions. "answerRelevance": "A String", # Optional. Whether or not the suggested answer is relevant. For example: * Query: "Can I change my mailing address?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * answer_relevance: AnswerRelevance.IRRELEVANT - "documentCorrectness": "A String", # Optional. Whether or not the information in the document is correct. For example: * Query: "Can I return the package in 2 days once received?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * Ground truth: "No return or exchange is allowed." * [document_correctness]: INCORRECT + "documentCorrectness": "A String", # Optional. Whether or not the information in the document is correct. For example: * Query: "Can I return the package in 2 days once received?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * Ground truth: "No return or exchange is allowed." * document_correctness: INCORRECT "documentEfficiency": "A String", # Optional. Whether or not the suggested document is efficient. For example, if the document is poorly written, hard to understand, hard to use or too long to find useful information, document_efficiency is DocumentEfficiency.INEFFICIENT. "knowledgeAssistFeedback": { # Feedback for knowledge assist. # Optional. Feedback for knowledge assist. "answerCopied": True or False, # Whether the suggested answer was copied by the human agent. If the value is set to be true, AnswerFeedback.clicked will be updated to be true. @@ -3073,7 +3073,7 @@

Method Details

"answerFeedback": { # Represents feedback the customer has about the quality & correctness of a certain answer in a conversation. # Optional. The AnswerFeedback for this record. You can set this with AnswerRecords.UpdateAnswerRecord in order to give us feedback about this answer. "agentAssistantDetailFeedback": { # Detail feedback of Agent Assistant result. # Optional. Detail feedback of agent assistant suggestions. "answerRelevance": "A String", # Optional. Whether or not the suggested answer is relevant. For example: * Query: "Can I change my mailing address?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * answer_relevance: AnswerRelevance.IRRELEVANT - "documentCorrectness": "A String", # Optional. Whether or not the information in the document is correct. For example: * Query: "Can I return the package in 2 days once received?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * Ground truth: "No return or exchange is allowed." * [document_correctness]: INCORRECT + "documentCorrectness": "A String", # Optional. Whether or not the information in the document is correct. For example: * Query: "Can I return the package in 2 days once received?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * Ground truth: "No return or exchange is allowed." * document_correctness: INCORRECT "documentEfficiency": "A String", # Optional. Whether or not the suggested document is efficient. For example, if the document is poorly written, hard to understand, hard to use or too long to find useful information, document_efficiency is DocumentEfficiency.INEFFICIENT. "knowledgeAssistFeedback": { # Feedback for knowledge assist. # Optional. Feedback for knowledge assist. "answerCopied": True or False, # Whether the suggested answer was copied by the human agent. If the value is set to be true, AnswerFeedback.clicked will be updated to be true. diff --git a/docs/dyn/dialogflow_v2beta1.projects.conversations.messages.html b/docs/dyn/dialogflow_v2beta1.projects.conversations.messages.html index cf2b55f9eff..4e63e10cdf2 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.conversations.messages.html +++ b/docs/dyn/dialogflow_v2beta1.projects.conversations.messages.html @@ -120,7 +120,7 @@

Method Details

{ # Response messages from an automated agent. "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. # A signal that indicates the interaction with the Dialogflow agent has ended. }, - "liveAgentHandoff": { # Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a live agent. + "liveAgentHandoff": { # Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a Dialogflow CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a live agent. "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. "a_key": "", # Properties of the object. }, @@ -192,7 +192,7 @@

Method Details

{ # Response messages from an automated agent. "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. # A signal that indicates the interaction with the Dialogflow agent has ended. }, - "liveAgentHandoff": { # Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a live agent. + "liveAgentHandoff": { # Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a Dialogflow CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a live agent. "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. "a_key": "", # Properties of the object. }, @@ -277,7 +277,7 @@

Method Details

{ # Response messages from an automated agent. "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. # A signal that indicates the interaction with the Dialogflow agent has ended. }, - "liveAgentHandoff": { # Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a live agent. + "liveAgentHandoff": { # Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a Dialogflow CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a live agent. "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. "a_key": "", # Properties of the object. }, diff --git a/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html b/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html index 26fff8ec8fb..7fd755f1ac1 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html +++ b/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html @@ -150,7 +150,7 @@

Method Details

], }, }, - "cxCurrentPage": "A String", # The unique identifier of the CX page to override the `current_page` in the session. Format: `projects//locations//agents//flows//pages/`. If `cx_current_page` is specified, the previous state of the session will be ignored by Dialogflow CX, including the previous page and the previous session parameters. In most cases, `cx_current_page` and `cx_parameters` should be configured together to direct a session to a specific state. Note: this field should only be used if you are connecting to a Dialogflow CX agent. + "cxCurrentPage": "A String", # The unique identifier of the Dialogflow CX page to override the `current_page` in the session. Format: `projects//locations//agents//flows//pages/`. If `cx_current_page` is specified, the previous state of the session will be ignored by Dialogflow CX, including the previous page and the previous session parameters. In most cases, `cx_current_page` and `cx_parameters` should be configured together to direct a session to a specific state. Note: this field should only be used if you are connecting to a Dialogflow CX agent. "cxParameters": { # Additional parameters to be put into Dialogflow CX session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. Note: this field should only be used if you are connecting to a Dialogflow CX agent. "a_key": "", # Properties of the object. }, @@ -1647,7 +1647,7 @@

Method Details

{ # Response messages from an automated agent. "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. # A signal that indicates the interaction with the Dialogflow agent has ended. }, - "liveAgentHandoff": { # Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a live agent. + "liveAgentHandoff": { # Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a Dialogflow CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a live agent. "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. "a_key": "", # Properties of the object. }, @@ -4598,7 +4598,7 @@

Method Details

{ # Response messages from an automated agent. "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. # A signal that indicates the interaction with the Dialogflow agent has ended. }, - "liveAgentHandoff": { # Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a live agent. + "liveAgentHandoff": { # Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a Dialogflow CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a live agent. "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. "a_key": "", # Properties of the object. }, diff --git a/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.suggestions.html b/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.suggestions.html index e4c36c44133..f89c6f1fbbc 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.suggestions.html +++ b/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.suggestions.html @@ -333,7 +333,7 @@

Method Details

{ # The request message for Participants.SuggestKnowledgeAssist. "contextSize": 42, # Optional. Max number of messages prior to and including latest_message to use as context when compiling the suggestion. The context size is by default 100 and at most 100. "latestMessage": "A String", # Optional. The name of the latest conversation message to compile suggestions for. If empty, it will be the latest message of the conversation. Format: `projects//locations//conversations//messages/`. - "previousSuggestedQuery": "A String", # Optional. The previously suggested query for the given conversation. This helps identify whether the next suggestion we generate is resonably different from the previous one. This is useful to avoid similar suggestions within the conversation. + "previousSuggestedQuery": "A String", # Optional. The previously suggested query for the given conversation. This helps identify whether the next suggestion we generate is reasonably different from the previous one. This is useful to avoid similar suggestions within the conversation. } x__xgafv: string, V1 error format. diff --git a/docs/dyn/dialogflow_v2beta1.projects.html b/docs/dyn/dialogflow_v2beta1.projects.html index 5508dae56c2..250f6fcabe2 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.html +++ b/docs/dyn/dialogflow_v2beta1.projects.html @@ -114,6 +114,11 @@

Instance Methods

Returns the operations Resource.

+

+ phoneNumbers() +

+

Returns the phoneNumbers Resource.

+

suggestions()

diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.answerRecords.html b/docs/dyn/dialogflow_v2beta1.projects.locations.answerRecords.html index 8c9cd6d23c9..497c41f3b78 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.answerRecords.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.answerRecords.html @@ -812,7 +812,7 @@

Method Details

"answerFeedback": { # Represents feedback the customer has about the quality & correctness of a certain answer in a conversation. # Optional. The AnswerFeedback for this record. You can set this with AnswerRecords.UpdateAnswerRecord in order to give us feedback about this answer. "agentAssistantDetailFeedback": { # Detail feedback of Agent Assistant result. # Optional. Detail feedback of agent assistant suggestions. "answerRelevance": "A String", # Optional. Whether or not the suggested answer is relevant. For example: * Query: "Can I change my mailing address?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * answer_relevance: AnswerRelevance.IRRELEVANT - "documentCorrectness": "A String", # Optional. Whether or not the information in the document is correct. For example: * Query: "Can I return the package in 2 days once received?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * Ground truth: "No return or exchange is allowed." * [document_correctness]: INCORRECT + "documentCorrectness": "A String", # Optional. Whether or not the information in the document is correct. For example: * Query: "Can I return the package in 2 days once received?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * Ground truth: "No return or exchange is allowed." * document_correctness: INCORRECT "documentEfficiency": "A String", # Optional. Whether or not the suggested document is efficient. For example, if the document is poorly written, hard to understand, hard to use or too long to find useful information, document_efficiency is DocumentEfficiency.INEFFICIENT. "knowledgeAssistFeedback": { # Feedback for knowledge assist. # Optional. Feedback for knowledge assist. "answerCopied": True or False, # Whether the suggested answer was copied by the human agent. If the value is set to be true, AnswerFeedback.clicked will be updated to be true. @@ -851,7 +851,7 @@

Method Details

Args: parent: string, Required. The project to list all answer records for in reverse chronological order. Format: `projects//locations/`. (required) - filter: string, Optional. Filters to restrict results to specific answer records. For more information about filtering, see [API Filtering](https://aip.dev/160). + filter: string, Optional. Filters to restrict results to specific answer records. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * conversation_id with equals(=) operator Examples: * "conversation_id=bar" matches answer records in the projects/foo/locations/global/conversations/bar conversation (assuming the parent is projects/foo/locations/global). For more information about filtering, see [API Filtering](https://aip.dev/160). pageSize: integer, Optional. The maximum number of records to return in a single page. The server may return fewer records than this. If unspecified, we use 10. The maximum is 100. pageToken: string, Optional. The ListAnswerRecordsResponse.next_page_token value returned from a previous list request used to continue listing on the next page. x__xgafv: string, V1 error format. @@ -1567,7 +1567,7 @@

Method Details

"answerFeedback": { # Represents feedback the customer has about the quality & correctness of a certain answer in a conversation. # Optional. The AnswerFeedback for this record. You can set this with AnswerRecords.UpdateAnswerRecord in order to give us feedback about this answer. "agentAssistantDetailFeedback": { # Detail feedback of Agent Assistant result. # Optional. Detail feedback of agent assistant suggestions. "answerRelevance": "A String", # Optional. Whether or not the suggested answer is relevant. For example: * Query: "Can I change my mailing address?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * answer_relevance: AnswerRelevance.IRRELEVANT - "documentCorrectness": "A String", # Optional. Whether or not the information in the document is correct. For example: * Query: "Can I return the package in 2 days once received?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * Ground truth: "No return or exchange is allowed." * [document_correctness]: INCORRECT + "documentCorrectness": "A String", # Optional. Whether or not the information in the document is correct. For example: * Query: "Can I return the package in 2 days once received?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * Ground truth: "No return or exchange is allowed." * document_correctness: INCORRECT "documentEfficiency": "A String", # Optional. Whether or not the suggested document is efficient. For example, if the document is poorly written, hard to understand, hard to use or too long to find useful information, document_efficiency is DocumentEfficiency.INEFFICIENT. "knowledgeAssistFeedback": { # Feedback for knowledge assist. # Optional. Feedback for knowledge assist. "answerCopied": True or False, # Whether the suggested answer was copied by the human agent. If the value is set to be true, AnswerFeedback.clicked will be updated to be true. @@ -2329,7 +2329,7 @@

Method Details

"answerFeedback": { # Represents feedback the customer has about the quality & correctness of a certain answer in a conversation. # Optional. The AnswerFeedback for this record. You can set this with AnswerRecords.UpdateAnswerRecord in order to give us feedback about this answer. "agentAssistantDetailFeedback": { # Detail feedback of Agent Assistant result. # Optional. Detail feedback of agent assistant suggestions. "answerRelevance": "A String", # Optional. Whether or not the suggested answer is relevant. For example: * Query: "Can I change my mailing address?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * answer_relevance: AnswerRelevance.IRRELEVANT - "documentCorrectness": "A String", # Optional. Whether or not the information in the document is correct. For example: * Query: "Can I return the package in 2 days once received?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * Ground truth: "No return or exchange is allowed." * [document_correctness]: INCORRECT + "documentCorrectness": "A String", # Optional. Whether or not the information in the document is correct. For example: * Query: "Can I return the package in 2 days once received?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * Ground truth: "No return or exchange is allowed." * document_correctness: INCORRECT "documentEfficiency": "A String", # Optional. Whether or not the suggested document is efficient. For example, if the document is poorly written, hard to understand, hard to use or too long to find useful information, document_efficiency is DocumentEfficiency.INEFFICIENT. "knowledgeAssistFeedback": { # Feedback for knowledge assist. # Optional. Feedback for knowledge assist. "answerCopied": True or False, # Whether the suggested answer was copied by the human agent. If the value is set to be true, AnswerFeedback.clicked will be updated to be true. @@ -3073,7 +3073,7 @@

Method Details

"answerFeedback": { # Represents feedback the customer has about the quality & correctness of a certain answer in a conversation. # Optional. The AnswerFeedback for this record. You can set this with AnswerRecords.UpdateAnswerRecord in order to give us feedback about this answer. "agentAssistantDetailFeedback": { # Detail feedback of Agent Assistant result. # Optional. Detail feedback of agent assistant suggestions. "answerRelevance": "A String", # Optional. Whether or not the suggested answer is relevant. For example: * Query: "Can I change my mailing address?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * answer_relevance: AnswerRelevance.IRRELEVANT - "documentCorrectness": "A String", # Optional. Whether or not the information in the document is correct. For example: * Query: "Can I return the package in 2 days once received?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * Ground truth: "No return or exchange is allowed." * [document_correctness]: INCORRECT + "documentCorrectness": "A String", # Optional. Whether or not the information in the document is correct. For example: * Query: "Can I return the package in 2 days once received?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * Ground truth: "No return or exchange is allowed." * document_correctness: INCORRECT "documentEfficiency": "A String", # Optional. Whether or not the suggested document is efficient. For example, if the document is poorly written, hard to understand, hard to use or too long to find useful information, document_efficiency is DocumentEfficiency.INEFFICIENT. "knowledgeAssistFeedback": { # Feedback for knowledge assist. # Optional. Feedback for knowledge assist. "answerCopied": True or False, # Whether the suggested answer was copied by the human agent. If the value is set to be true, AnswerFeedback.clicked will be updated to be true. diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.messages.html b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.messages.html index 0c43f8d87c5..8ead285f9de 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.messages.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.messages.html @@ -120,7 +120,7 @@

Method Details

{ # Response messages from an automated agent. "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. # A signal that indicates the interaction with the Dialogflow agent has ended. }, - "liveAgentHandoff": { # Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a live agent. + "liveAgentHandoff": { # Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a Dialogflow CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a live agent. "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. "a_key": "", # Properties of the object. }, @@ -192,7 +192,7 @@

Method Details

{ # Response messages from an automated agent. "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. # A signal that indicates the interaction with the Dialogflow agent has ended. }, - "liveAgentHandoff": { # Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a live agent. + "liveAgentHandoff": { # Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a Dialogflow CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a live agent. "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. "a_key": "", # Properties of the object. }, @@ -277,7 +277,7 @@

Method Details

{ # Response messages from an automated agent. "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. # A signal that indicates the interaction with the Dialogflow agent has ended. }, - "liveAgentHandoff": { # Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a live agent. + "liveAgentHandoff": { # Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a Dialogflow CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a live agent. "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. "a_key": "", # Properties of the object. }, diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html index b2d6556dcc1..f7e1e5a017b 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html @@ -150,7 +150,7 @@

Method Details

], }, }, - "cxCurrentPage": "A String", # The unique identifier of the CX page to override the `current_page` in the session. Format: `projects//locations//agents//flows//pages/`. If `cx_current_page` is specified, the previous state of the session will be ignored by Dialogflow CX, including the previous page and the previous session parameters. In most cases, `cx_current_page` and `cx_parameters` should be configured together to direct a session to a specific state. Note: this field should only be used if you are connecting to a Dialogflow CX agent. + "cxCurrentPage": "A String", # The unique identifier of the Dialogflow CX page to override the `current_page` in the session. Format: `projects//locations//agents//flows//pages/`. If `cx_current_page` is specified, the previous state of the session will be ignored by Dialogflow CX, including the previous page and the previous session parameters. In most cases, `cx_current_page` and `cx_parameters` should be configured together to direct a session to a specific state. Note: this field should only be used if you are connecting to a Dialogflow CX agent. "cxParameters": { # Additional parameters to be put into Dialogflow CX session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. Note: this field should only be used if you are connecting to a Dialogflow CX agent. "a_key": "", # Properties of the object. }, @@ -1647,7 +1647,7 @@

Method Details

{ # Response messages from an automated agent. "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. # A signal that indicates the interaction with the Dialogflow agent has ended. }, - "liveAgentHandoff": { # Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a live agent. + "liveAgentHandoff": { # Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a Dialogflow CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a live agent. "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. "a_key": "", # Properties of the object. }, @@ -4598,7 +4598,7 @@

Method Details

{ # Response messages from an automated agent. "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. # A signal that indicates the interaction with the Dialogflow agent has ended. }, - "liveAgentHandoff": { # Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a live agent. + "liveAgentHandoff": { # Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a Dialogflow CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a live agent. "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. "a_key": "", # Properties of the object. }, diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.suggestions.html b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.suggestions.html index cfac036962a..6b62d9b1864 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.suggestions.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.suggestions.html @@ -198,7 +198,7 @@

Method Details

{ # The request message for Participants.SuggestKnowledgeAssist. "contextSize": 42, # Optional. Max number of messages prior to and including latest_message to use as context when compiling the suggestion. The context size is by default 100 and at most 100. "latestMessage": "A String", # Optional. The name of the latest conversation message to compile suggestions for. If empty, it will be the latest message of the conversation. Format: `projects//locations//conversations//messages/`. - "previousSuggestedQuery": "A String", # Optional. The previously suggested query for the given conversation. This helps identify whether the next suggestion we generate is resonably different from the previous one. This is useful to avoid similar suggestions within the conversation. + "previousSuggestedQuery": "A String", # Optional. The previously suggested query for the given conversation. This helps identify whether the next suggestion we generate is reasonably different from the previous one. This is useful to avoid similar suggestions within the conversation. } x__xgafv: string, V1 error format. diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.html b/docs/dyn/dialogflow_v2beta1.projects.locations.html index afad2beefdc..b5d2f2cdd2b 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.html @@ -114,6 +114,11 @@

Instance Methods

Returns the operations Resource.

+

+ phoneNumbers() +

+

Returns the phoneNumbers Resource.

+

sipTrunks()

diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.phoneNumbers.html b/docs/dyn/dialogflow_v2beta1.projects.locations.phoneNumbers.html new file mode 100644 index 00000000000..32e68a1d7c0 --- /dev/null +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.phoneNumbers.html @@ -0,0 +1,228 @@ + + + +

Dialogflow API . projects . locations . phoneNumbers

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

Requests deletion of a `PhoneNumber`. The `PhoneNumber` is moved into the DELETE_REQUESTED state immediately, and is deleted approximately 30 days later. This method may only be called on a `PhoneNumber` in the ACTIVE state.

+

+ list(parent, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None)

+

Returns the list of all phone numbers in the specified project.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(name, body=None, updateMask=None, x__xgafv=None)

+

Updates the specified `PhoneNumber`.

+

+ undelete(name, body=None, x__xgafv=None)

+

Cancels the deletion request for a `PhoneNumber`. This method may only be called on a `PhoneNumber` in the DELETE_REQUESTED state.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) +
Requests deletion of a `PhoneNumber`. The `PhoneNumber` is moved into the DELETE_REQUESTED state immediately, and is deleted approximately 30 days later. This method may only be called on a `PhoneNumber` in the ACTIVE state.
+
+Args:
+  name: string, Required. The unique identifier of the `PhoneNumber` to delete. Format: `projects//phoneNumbers/`. Format: `projects//locations//phoneNumbers/`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a phone number. `PhoneNumber` resources enable phone calls to be answered by Dialogflow services and are added to a project through a PhoneNumberOrder.
+  "conversationProfile": "A String", # Optional. The conversation profile calls to this `PhoneNumber` should use. The project ID here should be the same as the one in name. Format: `projects//conversationProfiles/`. Format: `projects//locations//conversationProfiles/`.
+  "lifecycleState": "A String", # Output only. The state of the `PhoneNumber`. Defaults to `ACTIVE`. `PhoneNumber` objects set to `DELETE_REQUESTED` always decline incoming calls and can be removed completely within 30 days.
+  "name": "A String", # Optional. The unique identifier of this phone number. Required for PhoneNumbers.UpdatePhoneNumber method. Format: `projects//phoneNumbers/`. Format: `projects//locations//phoneNumbers/`.
+  "phoneNumber": "A String", # Output only. Phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format. An example of a correctly formatted phone number: +15556767888.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None) +
Returns the list of all phone numbers in the specified project.
+
+Args:
+  parent: string, Required. The project to list all `PhoneNumber` resources from. Format: `projects/`. Format: `projects//locations/`. (required)
+  pageSize: integer, Optional. The maximum number of items to return in a single page. The default value is 100. The maximum value is 1000.
+  pageToken: string, Optional. The next_page_token value returned from a previous list request.
+  showDeleted: boolean, Optional. Controls whether `PhoneNumber` resources in the DELETE_REQUESTED state should be returned. Defaults to false.
+  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 PhoneNumbers.ListPhoneNumbers.
+  "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
+  "phoneNumbers": [ # The list of `PhoneNumber` resources. There is a maximum number of items returned based on the page_size field in the request.
+    { # Represents a phone number. `PhoneNumber` resources enable phone calls to be answered by Dialogflow services and are added to a project through a PhoneNumberOrder.
+      "conversationProfile": "A String", # Optional. The conversation profile calls to this `PhoneNumber` should use. The project ID here should be the same as the one in name. Format: `projects//conversationProfiles/`. Format: `projects//locations//conversationProfiles/`.
+      "lifecycleState": "A String", # Output only. The state of the `PhoneNumber`. Defaults to `ACTIVE`. `PhoneNumber` objects set to `DELETE_REQUESTED` always decline incoming calls and can be removed completely within 30 days.
+      "name": "A String", # Optional. The unique identifier of this phone number. Required for PhoneNumbers.UpdatePhoneNumber method. Format: `projects//phoneNumbers/`. Format: `projects//locations//phoneNumbers/`.
+      "phoneNumber": "A String", # Output only. Phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format. An example of a correctly formatted phone number: +15556767888.
+    },
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates the specified `PhoneNumber`.
+
+Args:
+  name: string, Optional. The unique identifier of this phone number. Required for PhoneNumbers.UpdatePhoneNumber method. Format: `projects//phoneNumbers/`. Format: `projects//locations//phoneNumbers/`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a phone number. `PhoneNumber` resources enable phone calls to be answered by Dialogflow services and are added to a project through a PhoneNumberOrder.
+  "conversationProfile": "A String", # Optional. The conversation profile calls to this `PhoneNumber` should use. The project ID here should be the same as the one in name. Format: `projects//conversationProfiles/`. Format: `projects//locations//conversationProfiles/`.
+  "lifecycleState": "A String", # Output only. The state of the `PhoneNumber`. Defaults to `ACTIVE`. `PhoneNumber` objects set to `DELETE_REQUESTED` always decline incoming calls and can be removed completely within 30 days.
+  "name": "A String", # Optional. The unique identifier of this phone number. Required for PhoneNumbers.UpdatePhoneNumber method. Format: `projects//phoneNumbers/`. Format: `projects//locations//phoneNumbers/`.
+  "phoneNumber": "A String", # Output only. Phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format. An example of a correctly formatted phone number: +15556767888.
+}
+
+  updateMask: string, Optional. The mask to control which fields get updated.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a phone number. `PhoneNumber` resources enable phone calls to be answered by Dialogflow services and are added to a project through a PhoneNumberOrder.
+  "conversationProfile": "A String", # Optional. The conversation profile calls to this `PhoneNumber` should use. The project ID here should be the same as the one in name. Format: `projects//conversationProfiles/`. Format: `projects//locations//conversationProfiles/`.
+  "lifecycleState": "A String", # Output only. The state of the `PhoneNumber`. Defaults to `ACTIVE`. `PhoneNumber` objects set to `DELETE_REQUESTED` always decline incoming calls and can be removed completely within 30 days.
+  "name": "A String", # Optional. The unique identifier of this phone number. Required for PhoneNumbers.UpdatePhoneNumber method. Format: `projects//phoneNumbers/`. Format: `projects//locations//phoneNumbers/`.
+  "phoneNumber": "A String", # Output only. Phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format. An example of a correctly formatted phone number: +15556767888.
+}
+
+ +
+ undelete(name, body=None, x__xgafv=None) +
Cancels the deletion request for a `PhoneNumber`. This method may only be called on a `PhoneNumber` in the DELETE_REQUESTED state.
+
+Args:
+  name: string, Required. The unique identifier of the `PhoneNumber` to delete. Format: `projects//phoneNumbers/`. Format: `projects//locations//phoneNumbers/`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The request message for PhoneNumbers.UndeletePhoneNumber.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a phone number. `PhoneNumber` resources enable phone calls to be answered by Dialogflow services and are added to a project through a PhoneNumberOrder.
+  "conversationProfile": "A String", # Optional. The conversation profile calls to this `PhoneNumber` should use. The project ID here should be the same as the one in name. Format: `projects//conversationProfiles/`. Format: `projects//locations//conversationProfiles/`.
+  "lifecycleState": "A String", # Output only. The state of the `PhoneNumber`. Defaults to `ACTIVE`. `PhoneNumber` objects set to `DELETE_REQUESTED` always decline incoming calls and can be removed completely within 30 days.
+  "name": "A String", # Optional. The unique identifier of this phone number. Required for PhoneNumbers.UpdatePhoneNumber method. Format: `projects//phoneNumbers/`. Format: `projects//locations//phoneNumbers/`.
+  "phoneNumber": "A String", # Output only. Phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format. An example of a correctly formatted phone number: +15556767888.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.suggestions.html b/docs/dyn/dialogflow_v2beta1.projects.locations.suggestions.html index 493ee9d6c72..2d190a62f3f 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.suggestions.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.suggestions.html @@ -319,7 +319,7 @@

Method Details

{ # Response messages from an automated agent. "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. # A signal that indicates the interaction with the Dialogflow agent has ended. }, - "liveAgentHandoff": { # Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a live agent. + "liveAgentHandoff": { # Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a Dialogflow CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a live agent. "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. "a_key": "", # Properties of the object. }, diff --git a/docs/dyn/dialogflow_v2beta1.projects.phoneNumbers.html b/docs/dyn/dialogflow_v2beta1.projects.phoneNumbers.html new file mode 100644 index 00000000000..8ec484b5df5 --- /dev/null +++ b/docs/dyn/dialogflow_v2beta1.projects.phoneNumbers.html @@ -0,0 +1,228 @@ + + + +

Dialogflow API . projects . phoneNumbers

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

Requests deletion of a `PhoneNumber`. The `PhoneNumber` is moved into the DELETE_REQUESTED state immediately, and is deleted approximately 30 days later. This method may only be called on a `PhoneNumber` in the ACTIVE state.

+

+ list(parent, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None)

+

Returns the list of all phone numbers in the specified project.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(name, body=None, updateMask=None, x__xgafv=None)

+

Updates the specified `PhoneNumber`.

+

+ undelete(name, body=None, x__xgafv=None)

+

Cancels the deletion request for a `PhoneNumber`. This method may only be called on a `PhoneNumber` in the DELETE_REQUESTED state.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) +
Requests deletion of a `PhoneNumber`. The `PhoneNumber` is moved into the DELETE_REQUESTED state immediately, and is deleted approximately 30 days later. This method may only be called on a `PhoneNumber` in the ACTIVE state.
+
+Args:
+  name: string, Required. The unique identifier of the `PhoneNumber` to delete. Format: `projects//phoneNumbers/`. Format: `projects//locations//phoneNumbers/`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a phone number. `PhoneNumber` resources enable phone calls to be answered by Dialogflow services and are added to a project through a PhoneNumberOrder.
+  "conversationProfile": "A String", # Optional. The conversation profile calls to this `PhoneNumber` should use. The project ID here should be the same as the one in name. Format: `projects//conversationProfiles/`. Format: `projects//locations//conversationProfiles/`.
+  "lifecycleState": "A String", # Output only. The state of the `PhoneNumber`. Defaults to `ACTIVE`. `PhoneNumber` objects set to `DELETE_REQUESTED` always decline incoming calls and can be removed completely within 30 days.
+  "name": "A String", # Optional. The unique identifier of this phone number. Required for PhoneNumbers.UpdatePhoneNumber method. Format: `projects//phoneNumbers/`. Format: `projects//locations//phoneNumbers/`.
+  "phoneNumber": "A String", # Output only. Phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format. An example of a correctly formatted phone number: +15556767888.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None) +
Returns the list of all phone numbers in the specified project.
+
+Args:
+  parent: string, Required. The project to list all `PhoneNumber` resources from. Format: `projects/`. Format: `projects//locations/`. (required)
+  pageSize: integer, Optional. The maximum number of items to return in a single page. The default value is 100. The maximum value is 1000.
+  pageToken: string, Optional. The next_page_token value returned from a previous list request.
+  showDeleted: boolean, Optional. Controls whether `PhoneNumber` resources in the DELETE_REQUESTED state should be returned. Defaults to false.
+  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 PhoneNumbers.ListPhoneNumbers.
+  "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
+  "phoneNumbers": [ # The list of `PhoneNumber` resources. There is a maximum number of items returned based on the page_size field in the request.
+    { # Represents a phone number. `PhoneNumber` resources enable phone calls to be answered by Dialogflow services and are added to a project through a PhoneNumberOrder.
+      "conversationProfile": "A String", # Optional. The conversation profile calls to this `PhoneNumber` should use. The project ID here should be the same as the one in name. Format: `projects//conversationProfiles/`. Format: `projects//locations//conversationProfiles/`.
+      "lifecycleState": "A String", # Output only. The state of the `PhoneNumber`. Defaults to `ACTIVE`. `PhoneNumber` objects set to `DELETE_REQUESTED` always decline incoming calls and can be removed completely within 30 days.
+      "name": "A String", # Optional. The unique identifier of this phone number. Required for PhoneNumbers.UpdatePhoneNumber method. Format: `projects//phoneNumbers/`. Format: `projects//locations//phoneNumbers/`.
+      "phoneNumber": "A String", # Output only. Phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format. An example of a correctly formatted phone number: +15556767888.
+    },
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates the specified `PhoneNumber`.
+
+Args:
+  name: string, Optional. The unique identifier of this phone number. Required for PhoneNumbers.UpdatePhoneNumber method. Format: `projects//phoneNumbers/`. Format: `projects//locations//phoneNumbers/`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a phone number. `PhoneNumber` resources enable phone calls to be answered by Dialogflow services and are added to a project through a PhoneNumberOrder.
+  "conversationProfile": "A String", # Optional. The conversation profile calls to this `PhoneNumber` should use. The project ID here should be the same as the one in name. Format: `projects//conversationProfiles/`. Format: `projects//locations//conversationProfiles/`.
+  "lifecycleState": "A String", # Output only. The state of the `PhoneNumber`. Defaults to `ACTIVE`. `PhoneNumber` objects set to `DELETE_REQUESTED` always decline incoming calls and can be removed completely within 30 days.
+  "name": "A String", # Optional. The unique identifier of this phone number. Required for PhoneNumbers.UpdatePhoneNumber method. Format: `projects//phoneNumbers/`. Format: `projects//locations//phoneNumbers/`.
+  "phoneNumber": "A String", # Output only. Phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format. An example of a correctly formatted phone number: +15556767888.
+}
+
+  updateMask: string, Optional. The mask to control which fields get updated.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a phone number. `PhoneNumber` resources enable phone calls to be answered by Dialogflow services and are added to a project through a PhoneNumberOrder.
+  "conversationProfile": "A String", # Optional. The conversation profile calls to this `PhoneNumber` should use. The project ID here should be the same as the one in name. Format: `projects//conversationProfiles/`. Format: `projects//locations//conversationProfiles/`.
+  "lifecycleState": "A String", # Output only. The state of the `PhoneNumber`. Defaults to `ACTIVE`. `PhoneNumber` objects set to `DELETE_REQUESTED` always decline incoming calls and can be removed completely within 30 days.
+  "name": "A String", # Optional. The unique identifier of this phone number. Required for PhoneNumbers.UpdatePhoneNumber method. Format: `projects//phoneNumbers/`. Format: `projects//locations//phoneNumbers/`.
+  "phoneNumber": "A String", # Output only. Phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format. An example of a correctly formatted phone number: +15556767888.
+}
+
+ +
+ undelete(name, body=None, x__xgafv=None) +
Cancels the deletion request for a `PhoneNumber`. This method may only be called on a `PhoneNumber` in the DELETE_REQUESTED state.
+
+Args:
+  name: string, Required. The unique identifier of the `PhoneNumber` to delete. Format: `projects//phoneNumbers/`. Format: `projects//locations//phoneNumbers/`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The request message for PhoneNumbers.UndeletePhoneNumber.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a phone number. `PhoneNumber` resources enable phone calls to be answered by Dialogflow services and are added to a project through a PhoneNumberOrder.
+  "conversationProfile": "A String", # Optional. The conversation profile calls to this `PhoneNumber` should use. The project ID here should be the same as the one in name. Format: `projects//conversationProfiles/`. Format: `projects//locations//conversationProfiles/`.
+  "lifecycleState": "A String", # Output only. The state of the `PhoneNumber`. Defaults to `ACTIVE`. `PhoneNumber` objects set to `DELETE_REQUESTED` always decline incoming calls and can be removed completely within 30 days.
+  "name": "A String", # Optional. The unique identifier of this phone number. Required for PhoneNumbers.UpdatePhoneNumber method. Format: `projects//phoneNumbers/`. Format: `projects//locations//phoneNumbers/`.
+  "phoneNumber": "A String", # Output only. Phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format. An example of a correctly formatted phone number: +15556767888.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/dialogflow_v2beta1.projects.suggestions.html b/docs/dyn/dialogflow_v2beta1.projects.suggestions.html index e2e7678170f..80673aea935 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.suggestions.html +++ b/docs/dyn/dialogflow_v2beta1.projects.suggestions.html @@ -319,7 +319,7 @@

Method Details

{ # Response messages from an automated agent. "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. # A signal that indicates the interaction with the Dialogflow agent has ended. }, - "liveAgentHandoff": { # Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a live agent. + "liveAgentHandoff": { # Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a Dialogflow CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a live agent. "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. "a_key": "", # Properties of the object. }, diff --git a/docs/dyn/dialogflow_v3.projects.locations.agents.environments.html b/docs/dyn/dialogflow_v3.projects.locations.agents.environments.html index a40d0a9251d..00172d161c5 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.agents.environments.html +++ b/docs/dyn/dialogflow_v3.projects.locations.agents.environments.html @@ -171,7 +171,7 @@

Method Details

"httpMethod": "A String", # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST. "oauthConfig": { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header. "clientId": "A String", # Required. The client ID provided by the 3rd party platform. - "clientSecret": "A String", # Required. The client secret provided by the 3rd party platform. + "clientSecret": "A String", # Optional. The client secret provided by the 3rd party platform. "scopes": [ # Optional. The OAuth scopes to grant. "A String", ], @@ -199,7 +199,7 @@

Method Details

"httpMethod": "A String", # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST. "oauthConfig": { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header. "clientId": "A String", # Required. The client ID provided by the 3rd party platform. - "clientSecret": "A String", # Required. The client secret provided by the 3rd party platform. + "clientSecret": "A String", # Optional. The client secret provided by the 3rd party platform. "scopes": [ # Optional. The OAuth scopes to grant. "A String", ], @@ -358,7 +358,7 @@

Method Details

"httpMethod": "A String", # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST. "oauthConfig": { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header. "clientId": "A String", # Required. The client ID provided by the 3rd party platform. - "clientSecret": "A String", # Required. The client secret provided by the 3rd party platform. + "clientSecret": "A String", # Optional. The client secret provided by the 3rd party platform. "scopes": [ # Optional. The OAuth scopes to grant. "A String", ], @@ -386,7 +386,7 @@

Method Details

"httpMethod": "A String", # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST. "oauthConfig": { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header. "clientId": "A String", # Required. The client ID provided by the 3rd party platform. - "clientSecret": "A String", # Required. The client secret provided by the 3rd party platform. + "clientSecret": "A String", # Optional. The client secret provided by the 3rd party platform. "scopes": [ # Optional. The OAuth scopes to grant. "A String", ], @@ -461,7 +461,7 @@

Method Details

"httpMethod": "A String", # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST. "oauthConfig": { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header. "clientId": "A String", # Required. The client ID provided by the 3rd party platform. - "clientSecret": "A String", # Required. The client secret provided by the 3rd party platform. + "clientSecret": "A String", # Optional. The client secret provided by the 3rd party platform. "scopes": [ # Optional. The OAuth scopes to grant. "A String", ], @@ -489,7 +489,7 @@

Method Details

"httpMethod": "A String", # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST. "oauthConfig": { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header. "clientId": "A String", # Required. The client ID provided by the 3rd party platform. - "clientSecret": "A String", # Required. The client secret provided by the 3rd party platform. + "clientSecret": "A String", # Optional. The client secret provided by the 3rd party platform. "scopes": [ # Optional. The OAuth scopes to grant. "A String", ], @@ -581,7 +581,7 @@

Method Details

"httpMethod": "A String", # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST. "oauthConfig": { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header. "clientId": "A String", # Required. The client ID provided by the 3rd party platform. - "clientSecret": "A String", # Required. The client secret provided by the 3rd party platform. + "clientSecret": "A String", # Optional. The client secret provided by the 3rd party platform. "scopes": [ # Optional. The OAuth scopes to grant. "A String", ], @@ -609,7 +609,7 @@

Method Details

"httpMethod": "A String", # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST. "oauthConfig": { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header. "clientId": "A String", # Required. The client ID provided by the 3rd party platform. - "clientSecret": "A String", # Required. The client secret provided by the 3rd party platform. + "clientSecret": "A String", # Optional. The client secret provided by the 3rd party platform. "scopes": [ # Optional. The OAuth scopes to grant. "A String", ], @@ -692,7 +692,7 @@

Method Details

"httpMethod": "A String", # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST. "oauthConfig": { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header. "clientId": "A String", # Required. The client ID provided by the 3rd party platform. - "clientSecret": "A String", # Required. The client secret provided by the 3rd party platform. + "clientSecret": "A String", # Optional. The client secret provided by the 3rd party platform. "scopes": [ # Optional. The OAuth scopes to grant. "A String", ], @@ -720,7 +720,7 @@

Method Details

"httpMethod": "A String", # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST. "oauthConfig": { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header. "clientId": "A String", # Required. The client ID provided by the 3rd party platform. - "clientSecret": "A String", # Required. The client secret provided by the 3rd party platform. + "clientSecret": "A String", # Optional. The client secret provided by the 3rd party platform. "scopes": [ # Optional. The OAuth scopes to grant. "A String", ], diff --git a/docs/dyn/dialogflow_v3.projects.locations.agents.webhooks.html b/docs/dyn/dialogflow_v3.projects.locations.agents.webhooks.html index f8bf537d043..c67a1fd3c5f 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.agents.webhooks.html +++ b/docs/dyn/dialogflow_v3.projects.locations.agents.webhooks.html @@ -120,7 +120,7 @@

Method Details

"httpMethod": "A String", # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST. "oauthConfig": { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header. "clientId": "A String", # Required. The client ID provided by the 3rd party platform. - "clientSecret": "A String", # Required. The client secret provided by the 3rd party platform. + "clientSecret": "A String", # Optional. The client secret provided by the 3rd party platform. "scopes": [ # Optional. The OAuth scopes to grant. "A String", ], @@ -148,7 +148,7 @@

Method Details

"httpMethod": "A String", # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST. "oauthConfig": { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header. "clientId": "A String", # Required. The client ID provided by the 3rd party platform. - "clientSecret": "A String", # Required. The client secret provided by the 3rd party platform. + "clientSecret": "A String", # Optional. The client secret provided by the 3rd party platform. "scopes": [ # Optional. The OAuth scopes to grant. "A String", ], @@ -190,7 +190,7 @@

Method Details

"httpMethod": "A String", # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST. "oauthConfig": { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header. "clientId": "A String", # Required. The client ID provided by the 3rd party platform. - "clientSecret": "A String", # Required. The client secret provided by the 3rd party platform. + "clientSecret": "A String", # Optional. The client secret provided by the 3rd party platform. "scopes": [ # Optional. The OAuth scopes to grant. "A String", ], @@ -218,7 +218,7 @@

Method Details

"httpMethod": "A String", # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST. "oauthConfig": { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header. "clientId": "A String", # Required. The client ID provided by the 3rd party platform. - "clientSecret": "A String", # Required. The client secret provided by the 3rd party platform. + "clientSecret": "A String", # Optional. The client secret provided by the 3rd party platform. "scopes": [ # Optional. The OAuth scopes to grant. "A String", ], @@ -286,7 +286,7 @@

Method Details

"httpMethod": "A String", # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST. "oauthConfig": { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header. "clientId": "A String", # Required. The client ID provided by the 3rd party platform. - "clientSecret": "A String", # Required. The client secret provided by the 3rd party platform. + "clientSecret": "A String", # Optional. The client secret provided by the 3rd party platform. "scopes": [ # Optional. The OAuth scopes to grant. "A String", ], @@ -314,7 +314,7 @@

Method Details

"httpMethod": "A String", # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST. "oauthConfig": { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header. "clientId": "A String", # Required. The client ID provided by the 3rd party platform. - "clientSecret": "A String", # Required. The client secret provided by the 3rd party platform. + "clientSecret": "A String", # Optional. The client secret provided by the 3rd party platform. "scopes": [ # Optional. The OAuth scopes to grant. "A String", ], @@ -368,7 +368,7 @@

Method Details

"httpMethod": "A String", # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST. "oauthConfig": { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header. "clientId": "A String", # Required. The client ID provided by the 3rd party platform. - "clientSecret": "A String", # Required. The client secret provided by the 3rd party platform. + "clientSecret": "A String", # Optional. The client secret provided by the 3rd party platform. "scopes": [ # Optional. The OAuth scopes to grant. "A String", ], @@ -396,7 +396,7 @@

Method Details

"httpMethod": "A String", # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST. "oauthConfig": { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header. "clientId": "A String", # Required. The client ID provided by the 3rd party platform. - "clientSecret": "A String", # Required. The client secret provided by the 3rd party platform. + "clientSecret": "A String", # Optional. The client secret provided by the 3rd party platform. "scopes": [ # Optional. The OAuth scopes to grant. "A String", ], @@ -456,7 +456,7 @@

Method Details

"httpMethod": "A String", # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST. "oauthConfig": { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header. "clientId": "A String", # Required. The client ID provided by the 3rd party platform. - "clientSecret": "A String", # Required. The client secret provided by the 3rd party platform. + "clientSecret": "A String", # Optional. The client secret provided by the 3rd party platform. "scopes": [ # Optional. The OAuth scopes to grant. "A String", ], @@ -484,7 +484,7 @@

Method Details

"httpMethod": "A String", # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST. "oauthConfig": { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header. "clientId": "A String", # Required. The client ID provided by the 3rd party platform. - "clientSecret": "A String", # Required. The client secret provided by the 3rd party platform. + "clientSecret": "A String", # Optional. The client secret provided by the 3rd party platform. "scopes": [ # Optional. The OAuth scopes to grant. "A String", ], @@ -527,7 +527,7 @@

Method Details

"httpMethod": "A String", # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST. "oauthConfig": { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header. "clientId": "A String", # Required. The client ID provided by the 3rd party platform. - "clientSecret": "A String", # Required. The client secret provided by the 3rd party platform. + "clientSecret": "A String", # Optional. The client secret provided by the 3rd party platform. "scopes": [ # Optional. The OAuth scopes to grant. "A String", ], @@ -555,7 +555,7 @@

Method Details

"httpMethod": "A String", # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST. "oauthConfig": { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header. "clientId": "A String", # Required. The client ID provided by the 3rd party platform. - "clientSecret": "A String", # Required. The client secret provided by the 3rd party platform. + "clientSecret": "A String", # Optional. The client secret provided by the 3rd party platform. "scopes": [ # Optional. The OAuth scopes to grant. "A String", ], diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.conversations.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.conversations.html index eef5822162d..2e087ee3fa3 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.conversations.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.conversations.html @@ -158,7 +158,7 @@

Method Details

"httpMethod": "A String", # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST. "oauthConfig": { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header. "clientId": "A String", # Required. The client ID provided by the 3rd party platform. - "clientSecret": "A String", # Required. The client secret provided by the 3rd party platform. + "clientSecret": "A String", # Optional. The client secret provided by the 3rd party platform. "scopes": [ # Optional. The OAuth scopes to grant. "A String", ], @@ -186,7 +186,7 @@

Method Details

"httpMethod": "A String", # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST. "oauthConfig": { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header. "clientId": "A String", # Required. The client ID provided by the 3rd party platform. - "clientSecret": "A String", # Required. The client secret provided by the 3rd party platform. + "clientSecret": "A String", # Optional. The client secret provided by the 3rd party platform. "scopes": [ # Optional. The OAuth scopes to grant. "A String", ], @@ -6116,7 +6116,7 @@

Method Details

"httpMethod": "A String", # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST. "oauthConfig": { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header. "clientId": "A String", # Required. The client ID provided by the 3rd party platform. - "clientSecret": "A String", # Required. The client secret provided by the 3rd party platform. + "clientSecret": "A String", # Optional. The client secret provided by the 3rd party platform. "scopes": [ # Optional. The OAuth scopes to grant. "A String", ], @@ -6144,7 +6144,7 @@

Method Details

"httpMethod": "A String", # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST. "oauthConfig": { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header. "clientId": "A String", # Required. The client ID provided by the 3rd party platform. - "clientSecret": "A String", # Required. The client secret provided by the 3rd party platform. + "clientSecret": "A String", # Optional. The client secret provided by the 3rd party platform. "scopes": [ # Optional. The OAuth scopes to grant. "A String", ], diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.environments.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.environments.html index 66bfe8fc011..b0328743c40 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.environments.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.environments.html @@ -171,7 +171,7 @@

Method Details

"httpMethod": "A String", # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST. "oauthConfig": { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header. "clientId": "A String", # Required. The client ID provided by the 3rd party platform. - "clientSecret": "A String", # Required. The client secret provided by the 3rd party platform. + "clientSecret": "A String", # Optional. The client secret provided by the 3rd party platform. "scopes": [ # Optional. The OAuth scopes to grant. "A String", ], @@ -199,7 +199,7 @@

Method Details

"httpMethod": "A String", # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST. "oauthConfig": { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header. "clientId": "A String", # Required. The client ID provided by the 3rd party platform. - "clientSecret": "A String", # Required. The client secret provided by the 3rd party platform. + "clientSecret": "A String", # Optional. The client secret provided by the 3rd party platform. "scopes": [ # Optional. The OAuth scopes to grant. "A String", ], @@ -358,7 +358,7 @@

Method Details

"httpMethod": "A String", # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST. "oauthConfig": { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header. "clientId": "A String", # Required. The client ID provided by the 3rd party platform. - "clientSecret": "A String", # Required. The client secret provided by the 3rd party platform. + "clientSecret": "A String", # Optional. The client secret provided by the 3rd party platform. "scopes": [ # Optional. The OAuth scopes to grant. "A String", ], @@ -386,7 +386,7 @@

Method Details

"httpMethod": "A String", # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST. "oauthConfig": { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header. "clientId": "A String", # Required. The client ID provided by the 3rd party platform. - "clientSecret": "A String", # Required. The client secret provided by the 3rd party platform. + "clientSecret": "A String", # Optional. The client secret provided by the 3rd party platform. "scopes": [ # Optional. The OAuth scopes to grant. "A String", ], @@ -461,7 +461,7 @@

Method Details

"httpMethod": "A String", # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST. "oauthConfig": { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header. "clientId": "A String", # Required. The client ID provided by the 3rd party platform. - "clientSecret": "A String", # Required. The client secret provided by the 3rd party platform. + "clientSecret": "A String", # Optional. The client secret provided by the 3rd party platform. "scopes": [ # Optional. The OAuth scopes to grant. "A String", ], @@ -489,7 +489,7 @@

Method Details

"httpMethod": "A String", # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST. "oauthConfig": { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header. "clientId": "A String", # Required. The client ID provided by the 3rd party platform. - "clientSecret": "A String", # Required. The client secret provided by the 3rd party platform. + "clientSecret": "A String", # Optional. The client secret provided by the 3rd party platform. "scopes": [ # Optional. The OAuth scopes to grant. "A String", ], @@ -581,7 +581,7 @@

Method Details

"httpMethod": "A String", # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST. "oauthConfig": { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header. "clientId": "A String", # Required. The client ID provided by the 3rd party platform. - "clientSecret": "A String", # Required. The client secret provided by the 3rd party platform. + "clientSecret": "A String", # Optional. The client secret provided by the 3rd party platform. "scopes": [ # Optional. The OAuth scopes to grant. "A String", ], @@ -609,7 +609,7 @@

Method Details

"httpMethod": "A String", # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST. "oauthConfig": { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header. "clientId": "A String", # Required. The client ID provided by the 3rd party platform. - "clientSecret": "A String", # Required. The client secret provided by the 3rd party platform. + "clientSecret": "A String", # Optional. The client secret provided by the 3rd party platform. "scopes": [ # Optional. The OAuth scopes to grant. "A String", ], @@ -692,7 +692,7 @@

Method Details

"httpMethod": "A String", # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST. "oauthConfig": { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header. "clientId": "A String", # Required. The client ID provided by the 3rd party platform. - "clientSecret": "A String", # Required. The client secret provided by the 3rd party platform. + "clientSecret": "A String", # Optional. The client secret provided by the 3rd party platform. "scopes": [ # Optional. The OAuth scopes to grant. "A String", ], @@ -720,7 +720,7 @@

Method Details

"httpMethod": "A String", # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST. "oauthConfig": { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header. "clientId": "A String", # Required. The client ID provided by the 3rd party platform. - "clientSecret": "A String", # Required. The client secret provided by the 3rd party platform. + "clientSecret": "A String", # Optional. The client secret provided by the 3rd party platform. "scopes": [ # Optional. The OAuth scopes to grant. "A String", ], diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.webhooks.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.webhooks.html index 72b90d1f18f..2fa046a038a 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.webhooks.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.webhooks.html @@ -120,7 +120,7 @@

Method Details

"httpMethod": "A String", # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST. "oauthConfig": { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header. "clientId": "A String", # Required. The client ID provided by the 3rd party platform. - "clientSecret": "A String", # Required. The client secret provided by the 3rd party platform. + "clientSecret": "A String", # Optional. The client secret provided by the 3rd party platform. "scopes": [ # Optional. The OAuth scopes to grant. "A String", ], @@ -148,7 +148,7 @@

Method Details

"httpMethod": "A String", # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST. "oauthConfig": { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header. "clientId": "A String", # Required. The client ID provided by the 3rd party platform. - "clientSecret": "A String", # Required. The client secret provided by the 3rd party platform. + "clientSecret": "A String", # Optional. The client secret provided by the 3rd party platform. "scopes": [ # Optional. The OAuth scopes to grant. "A String", ], @@ -190,7 +190,7 @@

Method Details

"httpMethod": "A String", # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST. "oauthConfig": { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header. "clientId": "A String", # Required. The client ID provided by the 3rd party platform. - "clientSecret": "A String", # Required. The client secret provided by the 3rd party platform. + "clientSecret": "A String", # Optional. The client secret provided by the 3rd party platform. "scopes": [ # Optional. The OAuth scopes to grant. "A String", ], @@ -218,7 +218,7 @@

Method Details

"httpMethod": "A String", # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST. "oauthConfig": { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header. "clientId": "A String", # Required. The client ID provided by the 3rd party platform. - "clientSecret": "A String", # Required. The client secret provided by the 3rd party platform. + "clientSecret": "A String", # Optional. The client secret provided by the 3rd party platform. "scopes": [ # Optional. The OAuth scopes to grant. "A String", ], @@ -286,7 +286,7 @@

Method Details

"httpMethod": "A String", # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST. "oauthConfig": { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header. "clientId": "A String", # Required. The client ID provided by the 3rd party platform. - "clientSecret": "A String", # Required. The client secret provided by the 3rd party platform. + "clientSecret": "A String", # Optional. The client secret provided by the 3rd party platform. "scopes": [ # Optional. The OAuth scopes to grant. "A String", ], @@ -314,7 +314,7 @@

Method Details

"httpMethod": "A String", # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST. "oauthConfig": { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header. "clientId": "A String", # Required. The client ID provided by the 3rd party platform. - "clientSecret": "A String", # Required. The client secret provided by the 3rd party platform. + "clientSecret": "A String", # Optional. The client secret provided by the 3rd party platform. "scopes": [ # Optional. The OAuth scopes to grant. "A String", ], @@ -368,7 +368,7 @@

Method Details

"httpMethod": "A String", # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST. "oauthConfig": { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header. "clientId": "A String", # Required. The client ID provided by the 3rd party platform. - "clientSecret": "A String", # Required. The client secret provided by the 3rd party platform. + "clientSecret": "A String", # Optional. The client secret provided by the 3rd party platform. "scopes": [ # Optional. The OAuth scopes to grant. "A String", ], @@ -396,7 +396,7 @@

Method Details

"httpMethod": "A String", # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST. "oauthConfig": { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header. "clientId": "A String", # Required. The client ID provided by the 3rd party platform. - "clientSecret": "A String", # Required. The client secret provided by the 3rd party platform. + "clientSecret": "A String", # Optional. The client secret provided by the 3rd party platform. "scopes": [ # Optional. The OAuth scopes to grant. "A String", ], @@ -456,7 +456,7 @@

Method Details

"httpMethod": "A String", # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST. "oauthConfig": { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header. "clientId": "A String", # Required. The client ID provided by the 3rd party platform. - "clientSecret": "A String", # Required. The client secret provided by the 3rd party platform. + "clientSecret": "A String", # Optional. The client secret provided by the 3rd party platform. "scopes": [ # Optional. The OAuth scopes to grant. "A String", ], @@ -484,7 +484,7 @@

Method Details

"httpMethod": "A String", # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST. "oauthConfig": { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header. "clientId": "A String", # Required. The client ID provided by the 3rd party platform. - "clientSecret": "A String", # Required. The client secret provided by the 3rd party platform. + "clientSecret": "A String", # Optional. The client secret provided by the 3rd party platform. "scopes": [ # Optional. The OAuth scopes to grant. "A String", ], @@ -527,7 +527,7 @@

Method Details

"httpMethod": "A String", # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST. "oauthConfig": { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header. "clientId": "A String", # Required. The client ID provided by the 3rd party platform. - "clientSecret": "A String", # Required. The client secret provided by the 3rd party platform. + "clientSecret": "A String", # Optional. The client secret provided by the 3rd party platform. "scopes": [ # Optional. The OAuth scopes to grant. "A String", ], @@ -555,7 +555,7 @@

Method Details

"httpMethod": "A String", # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST. "oauthConfig": { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header. "clientId": "A String", # Required. The client ID provided by the 3rd party platform. - "clientSecret": "A String", # Required. The client secret provided by the 3rd party platform. + "clientSecret": "A String", # Optional. The client secret provided by the 3rd party platform. "scopes": [ # Optional. The OAuth scopes to grant. "A String", ], diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v2.json b/googleapiclient/discovery_cache/documents/dialogflow.v2.json index c2303aeacc3..fd92fbfc845 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v2.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v2.json @@ -2613,8 +2613,7 @@ ], "parameters": { "filter": { -"deprecated": true, -"description": "Optional. Filters to restrict results to specific answer records. Marked deprecated as it hasn't been, and isn't currently, supported. For more information about filtering, see [API Filtering](https://aip.dev/160).", +"description": "Optional. Filters to restrict results to specific answer records. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * conversation_id with equals(=) operator Examples: * \"conversation_id=bar\" matches answer records in the projects/foo/locations/global/conversations/bar conversation (assuming the parent is projects/foo/locations/global). For more information about filtering, see [API Filtering](https://aip.dev/160).", "location": "query", "type": "string" }, @@ -6502,8 +6501,7 @@ ], "parameters": { "filter": { -"deprecated": true, -"description": "Optional. Filters to restrict results to specific answer records. Marked deprecated as it hasn't been, and isn't currently, supported. For more information about filtering, see [API Filtering](https://aip.dev/160).", +"description": "Optional. Filters to restrict results to specific answer records. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * conversation_id with equals(=) operator Examples: * \"conversation_id=bar\" matches answer records in the projects/foo/locations/global/conversations/bar conversation (assuming the parent is projects/foo/locations/global). For more information about filtering, see [API Filtering](https://aip.dev/160).", "location": "query", "type": "string" }, @@ -8714,7 +8712,7 @@ } } }, -"revision": "20250207", +"revision": "20250213", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -10800,7 +10798,7 @@ "type": "string" }, "clientSecret": { -"description": "Required. The client secret provided by the 3rd party platform.", +"description": "Optional. The client secret provided by the 3rd party platform.", "type": "string" }, "scopes": { @@ -13175,7 +13173,7 @@ "type": "string" }, "clientSecret": { -"description": "Required. The client secret provided by the 3rd party platform.", +"description": "Optional. The client secret provided by the 3rd party platform.", "type": "string" }, "scopes": { @@ -13533,7 +13531,7 @@ true "type": "string" }, "documentCorrectness": { -"description": "Optional. Whether or not the information in the document is correct. For example: * Query: \"Can I return the package in 2 days once received?\" * Suggested document says: \"Items must be returned/exchanged within 60 days of the purchase date.\" * Ground truth: \"No return or exchange is allowed.\" * [document_correctness]: INCORRECT", +"description": "Optional. Whether or not the information in the document is correct. For example: * Query: \"Can I return the package in 2 days once received?\" * Suggested document says: \"Items must be returned/exchanged within 60 days of the purchase date.\" * Ground truth: \"No return or exchange is allowed.\" * document_correctness: INCORRECT", "enum": [ "DOCUMENT_CORRECTNESS_UNSPECIFIED", "INCORRECT", @@ -14563,7 +14561,7 @@ true "type": "string" }, "rawHumanEvalTemplateCsv": { -"description": "Output only. Human eval template in csv format. It tooks real-world conversations provided through input dataset, generates example suggestions for customer to verify quality of the model. For Smart Reply, the generated csv file contains columns of Context, (Suggestions,Q1,Q2)*3, Actual reply. Context contains at most 10 latest messages in the conversation prior to the current suggestion. Q1: \"Would you send it as the next message of agent?\" Evaluated based on whether the suggest is appropriate to be sent by agent in current context. Q2: \"Does the suggestion move the conversation closer to resolution?\" Evaluated based on whether the suggestion provide solutions, or answers customer's question or collect information from customer to resolve the customer's issue. Actual reply column contains the actual agent reply sent in the context.", +"description": "Output only. Human eval template in csv format. It takes real-world conversations provided through input dataset, generates example suggestions for customer to verify quality of the model. For Smart Reply, the generated csv file contains columns of Context, (Suggestions,Q1,Q2)*3, Actual reply. Context contains at most 10 latest messages in the conversation prior to the current suggestion. Q1: \"Would you send it as the next message of agent?\" Evaluated based on whether the suggest is appropriate to be sent by agent in current context. Q2: \"Does the suggestion move the conversation closer to resolution?\" Evaluated based on whether the suggestion provide solutions, or answers customer's question or collect information from customer to resolve the customer's issue. Actual reply column contains the actual agent reply sent in the context.", "readOnly": true, "type": "string" }, @@ -15274,11 +15272,11 @@ true }, "smartComposeConfig": { "$ref": "GoogleCloudDialogflowV2EvaluationConfigSmartComposeConfig", -"description": "Configuration for smart compose model evalution." +"description": "Configuration for smart compose model evaluation." }, "smartReplyConfig": { "$ref": "GoogleCloudDialogflowV2EvaluationConfigSmartReplyConfig", -"description": "Configuration for smart reply model evalution." +"description": "Configuration for smart reply model evaluation." } }, "type": "object" @@ -19204,7 +19202,7 @@ true "type": "string" }, "previousSuggestedQuery": { -"description": "Optional. The previously suggested query for the given conversation. This helps identify whether the next suggestion we generate is resonably different from the previous one. This is useful to avoid similar suggestions within the conversation.", +"description": "Optional. The previously suggested query for the given conversation. This helps identify whether the next suggestion we generate is reasonably different from the previous one. This is useful to avoid similar suggestions within the conversation.", "type": "string" } }, @@ -21899,7 +21897,7 @@ true "type": "object" }, "GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff": { -"description": "Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human.", +"description": "Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a Dialogflow CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human.", "id": "GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff", "properties": { "metadata": { diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json b/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json index c9d23e1346b..beb926e9d56 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json @@ -2645,8 +2645,7 @@ ], "parameters": { "filter": { -"deprecated": true, -"description": "Optional. Filters to restrict results to specific answer records. For more information about filtering, see [API Filtering](https://aip.dev/160).", +"description": "Optional. Filters to restrict results to specific answer records. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * conversation_id with equals(=) operator Examples: * \"conversation_id=bar\" matches answer records in the projects/foo/locations/global/conversations/bar conversation (assuming the parent is projects/foo/locations/global). For more information about filtering, see [API Filtering](https://aip.dev/160).", "location": "query", "type": "string" }, @@ -6294,8 +6293,7 @@ ], "parameters": { "filter": { -"deprecated": true, -"description": "Optional. Filters to restrict results to specific answer records. For more information about filtering, see [API Filtering](https://aip.dev/160).", +"description": "Optional. Filters to restrict results to specific answer records. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * conversation_id with equals(=) operator Examples: * \"conversation_id=bar\" matches answer records in the projects/foo/locations/global/conversations/bar conversation (assuming the parent is projects/foo/locations/global). For more information about filtering, see [API Filtering](https://aip.dev/160).", "location": "query", "type": "string" }, @@ -7822,6 +7820,142 @@ } } }, +"phoneNumbers": { +"methods": { +"delete": { +"description": "Requests deletion of a `PhoneNumber`. The `PhoneNumber` is moved into the DELETE_REQUESTED state immediately, and is deleted approximately 30 days later. This method may only be called on a `PhoneNumber` in the ACTIVE state.", +"flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/phoneNumbers/{phoneNumbersId}", +"httpMethod": "DELETE", +"id": "dialogflow.projects.locations.phoneNumbers.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The unique identifier of the `PhoneNumber` to delete. Format: `projects//phoneNumbers/`. Format: `projects//locations//phoneNumbers/`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/phoneNumbers/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2beta1/{+name}", +"response": { +"$ref": "GoogleCloudDialogflowV2beta1PhoneNumber" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dialogflow" +] +}, +"list": { +"description": "Returns the list of all phone numbers in the specified project.", +"flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/phoneNumbers", +"httpMethod": "GET", +"id": "dialogflow.projects.locations.phoneNumbers.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. The maximum number of items to return in a single page. The default value is 100. The maximum value is 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The next_page_token value returned from a previous list request.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The project to list all `PhoneNumber` resources from. Format: `projects/`. Format: `projects//locations/`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"showDeleted": { +"description": "Optional. Controls whether `PhoneNumber` resources in the DELETE_REQUESTED state should be returned. Defaults to false.", +"location": "query", +"type": "boolean" +} +}, +"path": "v2beta1/{+parent}/phoneNumbers", +"response": { +"$ref": "GoogleCloudDialogflowV2beta1ListPhoneNumbersResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dialogflow" +] +}, +"patch": { +"description": "Updates the specified `PhoneNumber`.", +"flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/phoneNumbers/{phoneNumbersId}", +"httpMethod": "PATCH", +"id": "dialogflow.projects.locations.phoneNumbers.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Optional. The unique identifier of this phone number. Required for PhoneNumbers.UpdatePhoneNumber method. Format: `projects//phoneNumbers/`. Format: `projects//locations//phoneNumbers/`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/phoneNumbers/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. The mask to control which fields get updated.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v2beta1/{+name}", +"request": { +"$ref": "GoogleCloudDialogflowV2beta1PhoneNumber" +}, +"response": { +"$ref": "GoogleCloudDialogflowV2beta1PhoneNumber" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dialogflow" +] +}, +"undelete": { +"description": "Cancels the deletion request for a `PhoneNumber`. This method may only be called on a `PhoneNumber` in the DELETE_REQUESTED state.", +"flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/phoneNumbers/{phoneNumbersId}:undelete", +"httpMethod": "POST", +"id": "dialogflow.projects.locations.phoneNumbers.undelete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The unique identifier of the `PhoneNumber` to delete. Format: `projects//phoneNumbers/`. Format: `projects//locations//phoneNumbers/`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/phoneNumbers/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2beta1/{+name}:undelete", +"request": { +"$ref": "GoogleCloudDialogflowV2beta1UndeletePhoneNumberRequest" +}, +"response": { +"$ref": "GoogleCloudDialogflowV2beta1PhoneNumber" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dialogflow" +] +} +} +}, "sipTrunks": { "methods": { "create": { @@ -8174,6 +8308,142 @@ } } }, +"phoneNumbers": { +"methods": { +"delete": { +"description": "Requests deletion of a `PhoneNumber`. The `PhoneNumber` is moved into the DELETE_REQUESTED state immediately, and is deleted approximately 30 days later. This method may only be called on a `PhoneNumber` in the ACTIVE state.", +"flatPath": "v2beta1/projects/{projectsId}/phoneNumbers/{phoneNumbersId}", +"httpMethod": "DELETE", +"id": "dialogflow.projects.phoneNumbers.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The unique identifier of the `PhoneNumber` to delete. Format: `projects//phoneNumbers/`. Format: `projects//locations//phoneNumbers/`.", +"location": "path", +"pattern": "^projects/[^/]+/phoneNumbers/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2beta1/{+name}", +"response": { +"$ref": "GoogleCloudDialogflowV2beta1PhoneNumber" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dialogflow" +] +}, +"list": { +"description": "Returns the list of all phone numbers in the specified project.", +"flatPath": "v2beta1/projects/{projectsId}/phoneNumbers", +"httpMethod": "GET", +"id": "dialogflow.projects.phoneNumbers.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. The maximum number of items to return in a single page. The default value is 100. The maximum value is 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The next_page_token value returned from a previous list request.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The project to list all `PhoneNumber` resources from. Format: `projects/`. Format: `projects//locations/`.", +"location": "path", +"pattern": "^projects/[^/]+$", +"required": true, +"type": "string" +}, +"showDeleted": { +"description": "Optional. Controls whether `PhoneNumber` resources in the DELETE_REQUESTED state should be returned. Defaults to false.", +"location": "query", +"type": "boolean" +} +}, +"path": "v2beta1/{+parent}/phoneNumbers", +"response": { +"$ref": "GoogleCloudDialogflowV2beta1ListPhoneNumbersResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dialogflow" +] +}, +"patch": { +"description": "Updates the specified `PhoneNumber`.", +"flatPath": "v2beta1/projects/{projectsId}/phoneNumbers/{phoneNumbersId}", +"httpMethod": "PATCH", +"id": "dialogflow.projects.phoneNumbers.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Optional. The unique identifier of this phone number. Required for PhoneNumbers.UpdatePhoneNumber method. Format: `projects//phoneNumbers/`. Format: `projects//locations//phoneNumbers/`.", +"location": "path", +"pattern": "^projects/[^/]+/phoneNumbers/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. The mask to control which fields get updated.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v2beta1/{+name}", +"request": { +"$ref": "GoogleCloudDialogflowV2beta1PhoneNumber" +}, +"response": { +"$ref": "GoogleCloudDialogflowV2beta1PhoneNumber" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dialogflow" +] +}, +"undelete": { +"description": "Cancels the deletion request for a `PhoneNumber`. This method may only be called on a `PhoneNumber` in the DELETE_REQUESTED state.", +"flatPath": "v2beta1/projects/{projectsId}/phoneNumbers/{phoneNumbersId}:undelete", +"httpMethod": "POST", +"id": "dialogflow.projects.phoneNumbers.undelete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The unique identifier of the `PhoneNumber` to delete. Format: `projects//phoneNumbers/`. Format: `projects//locations//phoneNumbers/`.", +"location": "path", +"pattern": "^projects/[^/]+/phoneNumbers/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2beta1/{+name}:undelete", +"request": { +"$ref": "GoogleCloudDialogflowV2beta1UndeletePhoneNumberRequest" +}, +"response": { +"$ref": "GoogleCloudDialogflowV2beta1PhoneNumber" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dialogflow" +] +} +} +}, "suggestions": { "methods": { "generateStatelessSummary": { @@ -8239,7 +8509,7 @@ } } }, -"revision": "20250207", +"revision": "20250213", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -10325,7 +10595,7 @@ "type": "string" }, "clientSecret": { -"description": "Required. The client secret provided by the 3rd party platform.", +"description": "Optional. The client secret provided by the 3rd party platform.", "type": "string" }, "scopes": { @@ -12700,7 +12970,7 @@ "type": "string" }, "clientSecret": { -"description": "Required. The client secret provided by the 3rd party platform.", +"description": "Optional. The client secret provided by the 3rd party platform.", "type": "string" }, "scopes": { @@ -15462,7 +15732,7 @@ true "type": "string" }, "documentCorrectness": { -"description": "Optional. Whether or not the information in the document is correct. For example: * Query: \"Can I return the package in 2 days once received?\" * Suggested document says: \"Items must be returned/exchanged within 60 days of the purchase date.\" * Ground truth: \"No return or exchange is allowed.\" * [document_correctness]: INCORRECT", +"description": "Optional. Whether or not the information in the document is correct. For example: * Query: \"Can I return the package in 2 days once received?\" * Suggested document says: \"Items must be returned/exchanged within 60 days of the purchase date.\" * Ground truth: \"No return or exchange is allowed.\" * document_correctness: INCORRECT", "enum": [ "DOCUMENT_CORRECTNESS_UNSPECIFIED", "INCORRECT", @@ -15603,7 +15873,7 @@ true "description": "The natural language speech audio to be processed." }, "cxCurrentPage": { -"description": "The unique identifier of the CX page to override the `current_page` in the session. Format: `projects//locations//agents//flows//pages/`. If `cx_current_page` is specified, the previous state of the session will be ignored by Dialogflow CX, including the previous page and the previous session parameters. In most cases, `cx_current_page` and `cx_parameters` should be configured together to direct a session to a specific state. Note: this field should only be used if you are connecting to a Dialogflow CX agent.", +"description": "The unique identifier of the Dialogflow CX page to override the `current_page` in the session. Format: `projects//locations//agents//flows//pages/`. If `cx_current_page` is specified, the previous state of the session will be ignored by Dialogflow CX, including the previous page and the previous session parameters. In most cases, `cx_current_page` and `cx_parameters` should be configured together to direct a session to a specific state. Note: this field should only be used if you are connecting to a Dialogflow CX agent.", "type": "string" }, "cxParameters": { @@ -19832,6 +20102,24 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2beta1ListPhoneNumbersResponse": { +"description": "The response message for PhoneNumbers.ListPhoneNumbers.", +"id": "GoogleCloudDialogflowV2beta1ListPhoneNumbersResponse", +"properties": { +"nextPageToken": { +"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", +"type": "string" +}, +"phoneNumbers": { +"description": "The list of `PhoneNumber` resources. There is a maximum number of items returned based on the page_size field in the request.", +"items": { +"$ref": "GoogleCloudDialogflowV2beta1PhoneNumber" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1ListSessionEntityTypesResponse": { "description": "The response message for SessionEntityTypes.ListSessionEntityTypes.", "id": "GoogleCloudDialogflowV2beta1ListSessionEntityTypesResponse", @@ -20179,6 +20467,41 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2beta1PhoneNumber": { +"description": "Represents a phone number. `PhoneNumber` resources enable phone calls to be answered by Dialogflow services and are added to a project through a PhoneNumberOrder.", +"id": "GoogleCloudDialogflowV2beta1PhoneNumber", +"properties": { +"conversationProfile": { +"description": "Optional. The conversation profile calls to this `PhoneNumber` should use. The project ID here should be the same as the one in name. Format: `projects//conversationProfiles/`. Format: `projects//locations//conversationProfiles/`.", +"type": "string" +}, +"lifecycleState": { +"description": "Output only. The state of the `PhoneNumber`. Defaults to `ACTIVE`. `PhoneNumber` objects set to `DELETE_REQUESTED` always decline incoming calls and can be removed completely within 30 days.", +"enum": [ +"LIFECYCLE_STATE_UNSPECIFIED", +"ACTIVE", +"DELETE_REQUESTED" +], +"enumDescriptions": [ +"This value is never used.", +"Number is active and can receive phone calls.", +"Number is pending deletion, and cannot receive calls." +], +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Optional. The unique identifier of this phone number. Required for PhoneNumbers.UpdatePhoneNumber method. Format: `projects//phoneNumbers/`. Format: `projects//locations//phoneNumbers/`.", +"type": "string" +}, +"phoneNumber": { +"description": "Output only. Phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format. An example of a correctly formatted phone number: +15556767888.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1QueryInput": { "description": "Represents the query input. It can contain either: 1. An audio config which instructs the speech recognizer how to process the speech audio. 2. A conversational query in the form of text. 3. An event that specifies which intent to trigger.", "id": "GoogleCloudDialogflowV2beta1QueryInput", @@ -20424,7 +20747,7 @@ true "type": "object" }, "GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff": { -"description": "Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human.", +"description": "Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a Dialogflow CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human.", "id": "GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff", "properties": { "metadata": { @@ -21426,7 +21749,7 @@ true "type": "string" }, "previousSuggestedQuery": { -"description": "Optional. The previously suggested query for the given conversation. This helps identify whether the next suggestion we generate is resonably different from the previous one. This is useful to avoid similar suggestions within the conversation.", +"description": "Optional. The previously suggested query for the given conversation. This helps identify whether the next suggestion we generate is reasonably different from the previous one. This is useful to avoid similar suggestions within the conversation.", "type": "string" } }, @@ -21954,6 +22277,12 @@ true "properties": {}, "type": "object" }, +"GoogleCloudDialogflowV2beta1UndeletePhoneNumberRequest": { +"description": "The request message for PhoneNumbers.UndeletePhoneNumber.", +"id": "GoogleCloudDialogflowV2beta1UndeletePhoneNumberRequest", +"properties": {}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1ValidationError": { "description": "Represents a single validation error.", "id": "GoogleCloudDialogflowV2beta1ValidationError", diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v3.json b/googleapiclient/discovery_cache/documents/dialogflow.v3.json index 37b8c3e48c4..128fd81fb96 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v3.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v3.json @@ -4453,7 +4453,7 @@ } } }, -"revision": "20250207", +"revision": "20250213", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -10041,7 +10041,7 @@ false "type": "string" }, "clientSecret": { -"description": "Required. The client secret provided by the 3rd party platform.", +"description": "Optional. The client secret provided by the 3rd party platform.", "type": "string" }, "scopes": { @@ -12416,7 +12416,7 @@ false "type": "string" }, "clientSecret": { -"description": "Required. The client secret provided by the 3rd party platform.", +"description": "Optional. The client secret provided by the 3rd party platform.", "type": "string" }, "scopes": { @@ -17191,7 +17191,7 @@ true "type": "object" }, "GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff": { -"description": "Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human.", +"description": "Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a Dialogflow CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human.", "id": "GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff", "properties": { "metadata": { diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json b/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json index e3ed79fc0ac..7e35e3818c7 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json @@ -5185,7 +5185,7 @@ } } }, -"revision": "20250207", +"revision": "20250213", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -7271,7 +7271,7 @@ "type": "string" }, "clientSecret": { -"description": "Required. The client secret provided by the 3rd party platform.", +"description": "Optional. The client secret provided by the 3rd party platform.", "type": "string" }, "scopes": { @@ -14536,7 +14536,7 @@ false "type": "string" }, "clientSecret": { -"description": "Required. The client secret provided by the 3rd party platform.", +"description": "Optional. The client secret provided by the 3rd party platform.", "type": "string" }, "scopes": { @@ -19311,7 +19311,7 @@ true "type": "object" }, "GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff": { -"description": "Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human.", +"description": "Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a Dialogflow CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human.", "id": "GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff", "properties": { "metadata": { From e46681ccd541803e046fb522b8981799afbc6f83 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 25 Feb 2025 07:08:18 +0000 Subject: [PATCH 12/36] feat(discoveryengine): update the api #### discoveryengine:v1 The following keys were deleted: - schemas.GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse (Total Keys: 7) - schemas.GoogleCloudDiscoveryengineV1betaFetchSitemapsResponse (Total Keys: 7) The following keys were added: - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.create (Total Keys: 12) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch (Total Keys: 14) - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.create (Total Keys: 12) - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch (Total Keys: 14) - schemas.GoogleCloudDiscoveryengineV1AnswerReferenceStructuredDocumentInfo.properties.uri (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1CreateSitemapMetadata (Total Keys: 6) - schemas.GoogleCloudDiscoveryengineV1DataStore.properties.identityMappingStore.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1DeleteSitemapMetadata (Total Keys: 6) - schemas.GoogleCloudDiscoveryengineV1FetchSitemapsResponse (Total Keys: 7) - schemas.GoogleCloudDiscoveryengineV1Sitemap (Total Keys: 8) - schemas.GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo.properties.uri (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaDataStore.properties.identityMappingStore.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries (Total Keys: 3) - schemas.GoogleCloudDiscoveryengineV1betaDataStore.properties.identityMappingStore.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries (Total Keys: 4) - schemas.GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse (Total Keys: 7) - schemas.GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries (Total Keys: 4) - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata (Total Keys: 6) - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse (Total Keys: 5) - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata (Total Keys: 6) - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse (Total Keys: 5) #### discoveryengine:v1alpha The following keys were deleted: - schemas.GoogleCloudDiscoveryengineV1betaFetchSitemapsResponse (Total Keys: 7) The following keys were added: - resources.projects.resources.locations.resources.collections.resources.engines.resources.completionConfig.methods.removeSuggestion (Total Keys: 12) - schemas.GoogleCloudDiscoveryengineV1CreateSitemapMetadata (Total Keys: 6) - schemas.GoogleCloudDiscoveryengineV1DataStore.properties.identityMappingStore.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1DeleteSitemapMetadata (Total Keys: 6) - schemas.GoogleCloudDiscoveryengineV1Sitemap (Total Keys: 8) - schemas.GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo.properties.uri (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaDataStore.properties.identityMappingStore.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaRemoveSuggestionRequest (Total Keys: 8) - schemas.GoogleCloudDiscoveryengineV1alphaRemoveSuggestionResponse (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent.properties.contentConfig.readOnly (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent.properties.workspaceType (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries (Total Keys: 3) - schemas.GoogleCloudDiscoveryengineV1betaDataStore.properties.identityMappingStore.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries (Total Keys: 4) - schemas.GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse (Total Keys: 7) - schemas.GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries (Total Keys: 4) - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata (Total Keys: 6) - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse (Total Keys: 5) - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata (Total Keys: 6) - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse (Total Keys: 5) The following keys were changed: - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.completionConfig.methods.completeQuery.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.completionConfig.methods.completeQuery.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.completionConfig.methods.completeQuery.scopes (Total Keys: 1) #### discoveryengine:v1beta The following keys were deleted: - schemas.GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse (Total Keys: 7) The following keys were added: - resources.projects.resources.locations.methods.obtainCrawlRate (Total Keys: 12) - resources.projects.resources.locations.methods.removeDedicatedCrawlRate (Total Keys: 12) - resources.projects.resources.locations.methods.setDedicatedCrawlRate (Total Keys: 12) - resources.projects.resources.locations.resources.collections.resources.engines.resources.completionConfig.methods.removeSuggestion (Total Keys: 12) - schemas.GoogleCloudDiscoveryengineV1CreateSitemapMetadata (Total Keys: 6) - schemas.GoogleCloudDiscoveryengineV1DataStore.properties.identityMappingStore.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1DeleteSitemapMetadata (Total Keys: 6) - schemas.GoogleCloudDiscoveryengineV1Sitemap (Total Keys: 8) - schemas.GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo.properties.uri (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaDataStore.properties.identityMappingStore.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaAnswerReferenceStructuredDocumentInfo.properties.uri (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries (Total Keys: 3) - schemas.GoogleCloudDiscoveryengineV1betaDataStore.properties.identityMappingStore.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries (Total Keys: 4) - schemas.GoogleCloudDiscoveryengineV1betaObtainCrawlRateRequest (Total Keys: 3) - schemas.GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse (Total Keys: 7) - schemas.GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries (Total Keys: 4) - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata (Total Keys: 6) - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateRequest (Total Keys: 3) - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse (Total Keys: 5) - schemas.GoogleCloudDiscoveryengineV1betaRemoveSuggestionRequest (Total Keys: 8) - schemas.GoogleCloudDiscoveryengineV1betaRemoveSuggestionResponse (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata (Total Keys: 6) - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateRequest (Total Keys: 7) - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse (Total Keys: 5) --- ...ects.locations.collections.dataStores.html | 15 +- ...collections.dataStores.servingConfigs.html | 28 +- ...llections.dataStores.sessions.answers.html | 6 +- ...tions.collections.dataStores.sessions.html | 36 +- ...llections.dataStores.siteSearchEngine.html | 5 + ....dataStores.siteSearchEngine.sitemaps.html | 202 +++++++ ...ns.collections.engines.servingConfigs.html | 28 +- ....collections.engines.sessions.answers.html | 6 +- ...ocations.collections.engines.sessions.html | 36 +- ...gine_v1.projects.locations.dataStores.html | 15 +- ...s.locations.dataStores.servingConfigs.html | 28 +- ...locations.dataStores.sessions.answers.html | 6 +- ...rojects.locations.dataStores.sessions.html | 36 +- ...locations.dataStores.siteSearchEngine.html | 5 + ....dataStores.siteSearchEngine.sitemaps.html | 202 +++++++ ...llections.dataStores.completionConfig.html | 2 +- ...ects.locations.collections.dataStores.html | 15 +- ...collections.dataStores.servingConfigs.html | 28 +- ...llections.dataStores.sessions.answers.html | 6 +- ...tions.collections.dataStores.sessions.html | 36 +- ....collections.dataStores.widgetConfigs.html | 3 +- ....collections.engines.completionConfig.html | 37 +- ...ns.collections.engines.servingConfigs.html | 28 +- ....collections.engines.sessions.answers.html | 6 +- ...ocations.collections.engines.sessions.html | 36 +- ...ons.collections.engines.widgetConfigs.html | 3 +- ...locations.dataStores.completionConfig.html | 2 +- ...v1alpha.projects.locations.dataStores.html | 15 +- ...s.locations.dataStores.servingConfigs.html | 28 +- ...locations.dataStores.sessions.answers.html | 6 +- ...rojects.locations.dataStores.sessions.html | 36 +- ...ts.locations.dataStores.widgetConfigs.html | 3 +- ...1alpha.projects.locations.evaluations.html | 6 +- ...llections.dataStores.completionConfig.html | 2 +- ...ects.locations.collections.dataStores.html | 15 +- ...collections.dataStores.servingConfigs.html | 28 +- ...llections.dataStores.sessions.answers.html | 6 +- ...tions.collections.dataStores.sessions.html | 36 +- ....collections.engines.completionConfig.html | 37 +- ...ns.collections.engines.servingConfigs.html | 28 +- ....collections.engines.sessions.answers.html | 6 +- ...ocations.collections.engines.sessions.html | 36 +- ...locations.dataStores.completionConfig.html | 2 +- ..._v1beta.projects.locations.dataStores.html | 15 +- ...s.locations.dataStores.servingConfigs.html | 28 +- ...locations.dataStores.sessions.answers.html | 6 +- ...rojects.locations.dataStores.sessions.html | 36 +- ...v1beta.projects.locations.evaluations.html | 6 +- ...overyengine_v1beta.projects.locations.html | 463 ++++++++++++++++ .../documents/discoveryengine.v1.json | 522 ++++++++++++++++-- .../documents/discoveryengine.v1alpha.json | 384 +++++++++++-- .../documents/discoveryengine.v1beta.json | 508 +++++++++++++++-- 52 files changed, 2719 insertions(+), 395 deletions(-) create mode 100644 docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.siteSearchEngine.sitemaps.html create mode 100644 docs/dyn/discoveryengine_v1.projects.locations.dataStores.siteSearchEngine.sitemaps.html diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html index 270b1a5042f..73f8e47f358 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html @@ -243,7 +243,7 @@

Method Details

}, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. - "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. + "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. "chunkingConfig": { # Configuration for chunking config. # Whether chunking mode is enabled. @@ -284,6 +284,7 @@

Method Details

"enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. }, + "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. "isInfobotFaqDataStore": True or False, # Optional. If set, this DataStore is an Infobot FAQ DataStore. "kmsKeyName": "A String", # Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. @@ -420,7 +421,7 @@

Method Details

}, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. - "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. + "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. "chunkingConfig": { # Configuration for chunking config. # Whether chunking mode is enabled. @@ -461,6 +462,7 @@

Method Details

"enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. }, + "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. "isInfobotFaqDataStore": True or False, # Optional. If set, this DataStore is an Infobot FAQ DataStore. "kmsKeyName": "A String", # Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. @@ -553,7 +555,7 @@

Method Details

}, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. - "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. + "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. "chunkingConfig": { # Configuration for chunking config. # Whether chunking mode is enabled. @@ -594,6 +596,7 @@

Method Details

"enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. }, + "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. "isInfobotFaqDataStore": True or False, # Optional. If set, this DataStore is an Infobot FAQ DataStore. "kmsKeyName": "A String", # Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. @@ -674,7 +677,7 @@

Method Details

}, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. - "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. + "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. "chunkingConfig": { # Configuration for chunking config. # Whether chunking mode is enabled. @@ -715,6 +718,7 @@

Method Details

"enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. }, + "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. "isInfobotFaqDataStore": True or False, # Optional. If set, this DataStore is an Infobot FAQ DataStore. "kmsKeyName": "A String", # Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. @@ -777,7 +781,7 @@

Method Details

}, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. - "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. + "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. "chunkingConfig": { # Configuration for chunking config. # Whether chunking mode is enabled. @@ -818,6 +822,7 @@

Method Details

"enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. }, + "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. "isInfobotFaqDataStore": True or False, # Optional. If set, this DataStore is an Infobot FAQ DataStore. "kmsKeyName": "A String", # Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html index cf100669496..187e42fa874 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html @@ -285,13 +285,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -340,6 +340,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -430,13 +432,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -485,6 +487,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -1095,7 +1099,7 @@

Method Details

"session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. - "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. + "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. }, "spellCorrectionSpec": { # The specification for query spell correction. # The spell correction specification that specifies the mode under which spell correction takes effect. "mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. @@ -1419,7 +1423,7 @@

Method Details

"session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. - "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. + "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. }, "spellCorrectionSpec": { # The specification for query spell correction. # The spell correction specification that specifies the mode under which spell correction takes effect. "mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. @@ -1807,13 +1811,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -1862,6 +1866,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -1952,13 +1958,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -2007,6 +2013,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.answers.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.answers.html index 8ea5d30510f..1314f939cc0 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.answers.html @@ -107,13 +107,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -162,6 +162,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.html index cf2ec9c468c..a5896a7d77b 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.html @@ -132,13 +132,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -187,6 +187,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -293,13 +295,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -348,6 +350,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -480,13 +484,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -535,6 +539,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -655,13 +661,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -710,6 +716,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -834,13 +842,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -889,6 +897,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -996,13 +1006,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -1051,6 +1061,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.siteSearchEngine.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.siteSearchEngine.html index e49dd7e288c..fecf5024608 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.siteSearchEngine.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.siteSearchEngine.html @@ -79,6 +79,11 @@

Instance Methods

Returns the operations Resource.

+

+ sitemaps() +

+

Returns the sitemaps Resource.

+

targetSites()

diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.siteSearchEngine.sitemaps.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.siteSearchEngine.sitemaps.html new file mode 100644 index 00000000000..4834239e485 --- /dev/null +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.siteSearchEngine.sitemaps.html @@ -0,0 +1,202 @@ + + + +

Discovery Engine API . projects . locations . collections . dataStores . siteSearchEngine . sitemaps

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, x__xgafv=None)

+

Creates a Sitemap.

+

+ delete(name, x__xgafv=None)

+

Deletes a Sitemap.

+

+ fetch(parent, matcher_urisMatcher_uris=None, x__xgafv=None)

+

Fetch Sitemaps in a DataStore.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates a Sitemap.
+
+Args:
+  parent: string, Required. Parent resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A sitemap for the SiteSearchEngine.
+  "createTime": "A String", # Output only. The sitemap's creation time.
+  "name": "A String", # Output only. The fully qualified resource name of the sitemap. `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/sitemaps/*` The `sitemap_id` suffix is system-generated.
+  "uri": "A String", # Public URI for the sitemap, e.g. `www.example.com/sitemap.xml`.
+}
+
+  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, x__xgafv=None) +
Deletes a Sitemap.
+
+Args:
+  name: string, Required. Full resource name of Sitemap, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}`. If the caller does not have permission to access the Sitemap, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Sitemap does not exist, a NOT_FOUND error is returned. (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.
+  },
+}
+
+ +
+ fetch(parent, matcher_urisMatcher_uris=None, x__xgafv=None) +
Fetch Sitemaps in a DataStore.
+
+Args:
+  parent: string, Required. Parent resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`. (required)
+  matcher_urisMatcher_uris: string, The Sitemap uris. (repeated)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for SiteSearchEngineService.FetchSitemaps method.
+  "sitemapsMetadata": [ # List of Sitemaps fetched.
+    { # Contains a Sitemap and its metadata.
+      "sitemap": { # A sitemap for the SiteSearchEngine. # The Sitemap.
+        "createTime": "A String", # Output only. The sitemap's creation time.
+        "name": "A String", # Output only. The fully qualified resource name of the sitemap. `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/sitemaps/*` The `sitemap_id` suffix is system-generated.
+        "uri": "A String", # Public URI for the sitemap, e.g. `www.example.com/sitemap.xml`.
+      },
+    },
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html index 16c7bd3d3c4..9cce37a0589 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html @@ -285,13 +285,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -340,6 +340,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -430,13 +432,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -485,6 +487,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -1095,7 +1099,7 @@

Method Details

"session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. - "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. + "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. }, "spellCorrectionSpec": { # The specification for query spell correction. # The spell correction specification that specifies the mode under which spell correction takes effect. "mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. @@ -1419,7 +1423,7 @@

Method Details

"session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. - "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. + "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. }, "spellCorrectionSpec": { # The specification for query spell correction. # The spell correction specification that specifies the mode under which spell correction takes effect. "mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. @@ -1807,13 +1811,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -1862,6 +1866,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -1952,13 +1958,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -2007,6 +2013,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.answers.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.answers.html index bcbcefb767b..040675c0a13 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.answers.html @@ -107,13 +107,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -162,6 +162,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.html index 696c5aa2356..faa8958036f 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.html @@ -132,13 +132,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -187,6 +187,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -293,13 +295,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -348,6 +350,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -480,13 +484,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -535,6 +539,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -655,13 +661,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -710,6 +716,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -834,13 +842,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -889,6 +897,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -996,13 +1006,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -1051,6 +1061,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html index 3090db83904..6d5525402b4 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html @@ -235,7 +235,7 @@

Method Details

}, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. - "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. + "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. "chunkingConfig": { # Configuration for chunking config. # Whether chunking mode is enabled. @@ -276,6 +276,7 @@

Method Details

"enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. }, + "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. "isInfobotFaqDataStore": True or False, # Optional. If set, this DataStore is an Infobot FAQ DataStore. "kmsKeyName": "A String", # Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. @@ -412,7 +413,7 @@

Method Details

}, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. - "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. + "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. "chunkingConfig": { # Configuration for chunking config. # Whether chunking mode is enabled. @@ -453,6 +454,7 @@

Method Details

"enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. }, + "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. "isInfobotFaqDataStore": True or False, # Optional. If set, this DataStore is an Infobot FAQ DataStore. "kmsKeyName": "A String", # Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. @@ -545,7 +547,7 @@

Method Details

}, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. - "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. + "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. "chunkingConfig": { # Configuration for chunking config. # Whether chunking mode is enabled. @@ -586,6 +588,7 @@

Method Details

"enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. }, + "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. "isInfobotFaqDataStore": True or False, # Optional. If set, this DataStore is an Infobot FAQ DataStore. "kmsKeyName": "A String", # Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. @@ -666,7 +669,7 @@

Method Details

}, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. - "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. + "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. "chunkingConfig": { # Configuration for chunking config. # Whether chunking mode is enabled. @@ -707,6 +710,7 @@

Method Details

"enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. }, + "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. "isInfobotFaqDataStore": True or False, # Optional. If set, this DataStore is an Infobot FAQ DataStore. "kmsKeyName": "A String", # Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. @@ -769,7 +773,7 @@

Method Details

}, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. - "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. + "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. "chunkingConfig": { # Configuration for chunking config. # Whether chunking mode is enabled. @@ -810,6 +814,7 @@

Method Details

"enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. }, + "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. "isInfobotFaqDataStore": True or False, # Optional. If set, this DataStore is an Infobot FAQ DataStore. "kmsKeyName": "A String", # Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html index d7b7121469d..7243bae5d12 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html @@ -285,13 +285,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -340,6 +340,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -430,13 +432,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -485,6 +487,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -1095,7 +1099,7 @@

Method Details

"session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. - "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. + "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. }, "spellCorrectionSpec": { # The specification for query spell correction. # The spell correction specification that specifies the mode under which spell correction takes effect. "mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. @@ -1419,7 +1423,7 @@

Method Details

"session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. - "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. + "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. }, "spellCorrectionSpec": { # The specification for query spell correction. # The spell correction specification that specifies the mode under which spell correction takes effect. "mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. @@ -1807,13 +1811,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -1862,6 +1866,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -1952,13 +1958,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -2007,6 +2013,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.answers.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.answers.html index b7ac60d6ce8..8b9e07fb92a 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.answers.html @@ -107,13 +107,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -162,6 +162,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.html index 85e2aebeb6e..4c3b8d7b688 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.html @@ -132,13 +132,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -187,6 +187,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -293,13 +295,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -348,6 +350,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -480,13 +484,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -535,6 +539,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -655,13 +661,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -710,6 +716,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -834,13 +842,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -889,6 +897,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -996,13 +1006,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -1051,6 +1061,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.siteSearchEngine.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.siteSearchEngine.html index 6a9236bc451..bd8e2d811f7 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.siteSearchEngine.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.siteSearchEngine.html @@ -74,6 +74,11 @@

Discovery Engine API . projects . locations . dataStores . siteSearchEngine

Instance Methods

+

+ sitemaps() +

+

Returns the sitemaps Resource.

+

targetSites()

diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.siteSearchEngine.sitemaps.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.siteSearchEngine.sitemaps.html new file mode 100644 index 00000000000..e893ad5b4ba --- /dev/null +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.siteSearchEngine.sitemaps.html @@ -0,0 +1,202 @@ + + + +

Discovery Engine API . projects . locations . dataStores . siteSearchEngine . sitemaps

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, x__xgafv=None)

+

Creates a Sitemap.

+

+ delete(name, x__xgafv=None)

+

Deletes a Sitemap.

+

+ fetch(parent, matcher_urisMatcher_uris=None, x__xgafv=None)

+

Fetch Sitemaps in a DataStore.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates a Sitemap.
+
+Args:
+  parent: string, Required. Parent resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A sitemap for the SiteSearchEngine.
+  "createTime": "A String", # Output only. The sitemap's creation time.
+  "name": "A String", # Output only. The fully qualified resource name of the sitemap. `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/sitemaps/*` The `sitemap_id` suffix is system-generated.
+  "uri": "A String", # Public URI for the sitemap, e.g. `www.example.com/sitemap.xml`.
+}
+
+  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, x__xgafv=None) +
Deletes a Sitemap.
+
+Args:
+  name: string, Required. Full resource name of Sitemap, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}`. If the caller does not have permission to access the Sitemap, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Sitemap does not exist, a NOT_FOUND error is returned. (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.
+  },
+}
+
+ +
+ fetch(parent, matcher_urisMatcher_uris=None, x__xgafv=None) +
Fetch Sitemaps in a DataStore.
+
+Args:
+  parent: string, Required. Parent resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`. (required)
+  matcher_urisMatcher_uris: string, The Sitemap uris. (repeated)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for SiteSearchEngineService.FetchSitemaps method.
+  "sitemapsMetadata": [ # List of Sitemaps fetched.
+    { # Contains a Sitemap and its metadata.
+      "sitemap": { # A sitemap for the SiteSearchEngine. # The Sitemap.
+        "createTime": "A String", # Output only. The sitemap's creation time.
+        "name": "A String", # Output only. The fully qualified resource name of the sitemap. `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/sitemaps/*` The `sitemap_id` suffix is system-generated.
+        "uri": "A String", # Public URI for the sitemap, e.g. `www.example.com/sitemap.xml`.
+      },
+    },
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.completionConfig.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.completionConfig.html index 27fa5758061..2b6f9b9e094 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.completionConfig.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.completionConfig.html @@ -106,7 +106,7 @@

Method Details

}, "includeTailSuggestions": True or False, # Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned. "query": "A String", # Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. The query can not be empty for most of the suggestion types. If it is empty, an `INVALID_ARGUMENT` error is returned. The exception is when the suggestion_types contains only the type `RECENT_SEARCH`, the query can be an empty string. The is called "zero prefix" feature, which returns user's recently searched queries given the empty query. - "queryModel": "A String", # Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. + "queryModel": "A String", # Specifies the autocomplete query model, which only applies to the QUERY SuggestionType. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. "suggestionTypeSpecs": [ # Optional. Specification of each suggestion type. { # Specification of each suggestion type. "maxSuggestions": 42, # Optional. Maximum number of suggestions to return for each suggestion type. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html index 37baaadaff6..d9ac1424359 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html @@ -260,7 +260,7 @@

Method Details

}, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. - "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. + "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. "chunkingConfig": { # Configuration for chunking config. # Whether chunking mode is enabled. @@ -301,6 +301,7 @@

Method Details

"enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. }, + "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "idpConfig": { # Identity Provider Config. # Output only. Data store level identity provider config. "externalIdpConfig": { # Third party IDP Config. # External Identity provider config. "workforcePoolName": "A String", # Workforce pool name. Example: "locations/global/workforcePools/pool_id" @@ -473,7 +474,7 @@

Method Details

}, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. - "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. + "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. "chunkingConfig": { # Configuration for chunking config. # Whether chunking mode is enabled. @@ -514,6 +515,7 @@

Method Details

"enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. }, + "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "idpConfig": { # Identity Provider Config. # Output only. Data store level identity provider config. "externalIdpConfig": { # Third party IDP Config. # External Identity provider config. "workforcePoolName": "A String", # Workforce pool name. Example: "locations/global/workforcePools/pool_id" @@ -693,7 +695,7 @@

Method Details

}, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. - "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. + "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. "chunkingConfig": { # Configuration for chunking config. # Whether chunking mode is enabled. @@ -734,6 +736,7 @@

Method Details

"enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. }, + "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "idpConfig": { # Identity Provider Config. # Output only. Data store level identity provider config. "externalIdpConfig": { # Third party IDP Config. # External Identity provider config. "workforcePoolName": "A String", # Workforce pool name. Example: "locations/global/workforcePools/pool_id" @@ -850,7 +853,7 @@

Method Details

}, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. - "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. + "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. "chunkingConfig": { # Configuration for chunking config. # Whether chunking mode is enabled. @@ -891,6 +894,7 @@

Method Details

"enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. }, + "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "idpConfig": { # Identity Provider Config. # Output only. Data store level identity provider config. "externalIdpConfig": { # Third party IDP Config. # External Identity provider config. "workforcePoolName": "A String", # Workforce pool name. Example: "locations/global/workforcePools/pool_id" @@ -989,7 +993,7 @@

Method Details

}, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. - "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. + "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. "chunkingConfig": { # Configuration for chunking config. # Whether chunking mode is enabled. @@ -1030,6 +1034,7 @@

Method Details

"enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. }, + "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "idpConfig": { # Identity Provider Config. # Output only. Data store level identity provider config. "externalIdpConfig": { # Third party IDP Config. # External Identity provider config. "workforcePoolName": "A String", # Workforce pool name. Example: "locations/global/workforcePools/pool_id" diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html index 41742744688..084be2f8958 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html @@ -303,13 +303,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -358,6 +358,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -448,13 +450,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -503,6 +505,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -1427,7 +1431,7 @@

Method Details

"session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. - "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. + "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. }, "spellCorrectionSpec": { # The specification for query spell correction. # The spell correction specification that specifies the mode under which spell correction takes effect. "mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. @@ -1955,7 +1959,7 @@

Method Details

"session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. - "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. + "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. }, "spellCorrectionSpec": { # The specification for query spell correction. # The spell correction specification that specifies the mode under which spell correction takes effect. "mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. @@ -2526,13 +2530,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -2581,6 +2585,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -2671,13 +2677,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -2726,6 +2732,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.answers.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.answers.html index 60498ed278e..0f1572ec96e 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.answers.html @@ -107,13 +107,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -162,6 +162,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.html index c6f944030eb..24c178d5b3c 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.html @@ -132,13 +132,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -187,6 +187,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -293,13 +295,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -348,6 +350,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -480,13 +484,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -535,6 +539,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -655,13 +661,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -710,6 +716,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -834,13 +842,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -889,6 +897,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -996,13 +1006,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -1051,6 +1061,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.widgetConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.widgetConfigs.html index 2267e287965..7cc01750998 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.widgetConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.widgetConfigs.html @@ -122,11 +122,12 @@

Method Details

"dataSource": "A String", # The name of the data source, retrieved from `Collection.data_connector.data_source`. "dataStoreComponents": [ # For the data store collection, list of the children data stores. { # Read-only data store component that contains data stores fields that may be used for filtering, it's the child of `CollectionComponent`. - "contentConfig": "A String", # The content config of the data store. + "contentConfig": "A String", # Output only. The content config of the data store. "displayName": "A String", # The display name of the data store. "entityName": "A String", # The name of the entity, retrieved from `Collection.data_connector.entities.entityName`. "id": "A String", # Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID. "name": "A String", # The name of the data store. It should be data store resource name Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. For APIs under WidgetService, such as WidgetService.LookUpWidgetConfig, the project number and location part is erased in this field. + "workspaceType": "A String", # Output only. Workspace Source Types for workspace data, retrieved from `DataStore.workspace_config.type`. }, ], "displayName": "A String", # The display name of the collection. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.completionConfig.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.completionConfig.html index 6dfd7fcbc35..6d06755566e 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.completionConfig.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.completionConfig.html @@ -80,6 +80,9 @@

Instance Methods

completeQuery(completionConfig, body=None, x__xgafv=None)

Completes the user input with advanced keyword suggestions.

+

+ removeSuggestion(completionConfig, body=None, x__xgafv=None)

+

Removes the search history suggestion in an engine for a user. This will remove the suggestion from being returned in the AdvancedCompleteQueryResponse.recent_search_suggestions for this user. If the user searches the same suggestion again, the new history will override and suggest this suggestion again.

Method Details

close() @@ -106,7 +109,7 @@

Method Details

}, "includeTailSuggestions": True or False, # Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned. "query": "A String", # Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. The query can not be empty for most of the suggestion types. If it is empty, an `INVALID_ARGUMENT` error is returned. The exception is when the suggestion_types contains only the type `RECENT_SEARCH`, the query can be an empty string. The is called "zero prefix" feature, which returns user's recently searched queries given the empty query. - "queryModel": "A String", # Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. + "queryModel": "A String", # Specifies the autocomplete query model, which only applies to the QUERY SuggestionType. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. "suggestionTypeSpecs": [ # Optional. Specification of each suggestion type. { # Specification of each suggestion type. "maxSuggestions": 42, # Optional. Maximum number of suggestions to return for each suggestion type. @@ -261,4 +264,36 @@

Method Details

}
+
+ removeSuggestion(completionConfig, body=None, x__xgafv=None) +
Removes the search history suggestion in an engine for a user. This will remove the suggestion from being returned in the AdvancedCompleteQueryResponse.recent_search_suggestions for this user. If the user searches the same suggestion again, the new history will override and suggest this suggestion again.
+
+Args:
+  completionConfig: string, Required. The completion_config of the parent engine resource name for which the search history suggestion is to be removed, such as `projects/*/locations/global/collections/default_collection/engines/*/completionConfig`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for CompletionService.RemoveSuggestion method.
+  "removeAllSearchHistorySuggestions": True or False, # Remove all search history suggestions for the user.
+  "removeTime": "A String", # Optional. Time at which the suggestion was removed. If not set, the current time will be used.
+  "searchHistorySuggestion": "A String", # The search history suggestion to be removed.
+  "userInfo": { # Information of an end user. # Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info.
+    "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set.
+    "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+  },
+  "userPseudoId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128.
+}
+
+  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 CompletionService.RemoveSuggestion method.
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html index e1215fda0f7..b6cd37195d5 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html @@ -303,13 +303,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -358,6 +358,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -448,13 +450,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -503,6 +505,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -1427,7 +1431,7 @@

Method Details

"session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. - "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. + "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. }, "spellCorrectionSpec": { # The specification for query spell correction. # The spell correction specification that specifies the mode under which spell correction takes effect. "mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. @@ -1955,7 +1959,7 @@

Method Details

"session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. - "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. + "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. }, "spellCorrectionSpec": { # The specification for query spell correction. # The spell correction specification that specifies the mode under which spell correction takes effect. "mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. @@ -2526,13 +2530,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -2581,6 +2585,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -2671,13 +2677,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -2726,6 +2732,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.answers.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.answers.html index 86ad3f9baec..bd911a481ad 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.answers.html @@ -107,13 +107,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -162,6 +162,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.html index 06e2e72e54b..fa0e5a827a9 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.html @@ -132,13 +132,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -187,6 +187,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -293,13 +295,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -348,6 +350,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -480,13 +484,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -535,6 +539,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -655,13 +661,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -710,6 +716,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -834,13 +842,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -889,6 +897,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -996,13 +1006,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -1051,6 +1061,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.widgetConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.widgetConfigs.html index ba617d1c0f6..ab5e6d536eb 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.widgetConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.widgetConfigs.html @@ -122,11 +122,12 @@

Method Details

"dataSource": "A String", # The name of the data source, retrieved from `Collection.data_connector.data_source`. "dataStoreComponents": [ # For the data store collection, list of the children data stores. { # Read-only data store component that contains data stores fields that may be used for filtering, it's the child of `CollectionComponent`. - "contentConfig": "A String", # The content config of the data store. + "contentConfig": "A String", # Output only. The content config of the data store. "displayName": "A String", # The display name of the data store. "entityName": "A String", # The name of the entity, retrieved from `Collection.data_connector.entities.entityName`. "id": "A String", # Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID. "name": "A String", # The name of the data store. It should be data store resource name Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. For APIs under WidgetService, such as WidgetService.LookUpWidgetConfig, the project number and location part is erased in this field. + "workspaceType": "A String", # Output only. Workspace Source Types for workspace data, retrieved from `DataStore.workspace_config.type`. }, ], "displayName": "A String", # The display name of the collection. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.completionConfig.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.completionConfig.html index ea796750d52..63e427c5fc9 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.completionConfig.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.completionConfig.html @@ -106,7 +106,7 @@

Method Details

}, "includeTailSuggestions": True or False, # Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned. "query": "A String", # Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. The query can not be empty for most of the suggestion types. If it is empty, an `INVALID_ARGUMENT` error is returned. The exception is when the suggestion_types contains only the type `RECENT_SEARCH`, the query can be an empty string. The is called "zero prefix" feature, which returns user's recently searched queries given the empty query. - "queryModel": "A String", # Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. + "queryModel": "A String", # Specifies the autocomplete query model, which only applies to the QUERY SuggestionType. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. "suggestionTypeSpecs": [ # Optional. Specification of each suggestion type. { # Specification of each suggestion type. "maxSuggestions": 42, # Optional. Maximum number of suggestions to return for each suggestion type. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html index b1375308d53..2060f60608b 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html @@ -252,7 +252,7 @@

Method Details

}, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. - "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. + "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. "chunkingConfig": { # Configuration for chunking config. # Whether chunking mode is enabled. @@ -293,6 +293,7 @@

Method Details

"enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. }, + "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "idpConfig": { # Identity Provider Config. # Output only. Data store level identity provider config. "externalIdpConfig": { # Third party IDP Config. # External Identity provider config. "workforcePoolName": "A String", # Workforce pool name. Example: "locations/global/workforcePools/pool_id" @@ -465,7 +466,7 @@

Method Details

}, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. - "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. + "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. "chunkingConfig": { # Configuration for chunking config. # Whether chunking mode is enabled. @@ -506,6 +507,7 @@

Method Details

"enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. }, + "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "idpConfig": { # Identity Provider Config. # Output only. Data store level identity provider config. "externalIdpConfig": { # Third party IDP Config. # External Identity provider config. "workforcePoolName": "A String", # Workforce pool name. Example: "locations/global/workforcePools/pool_id" @@ -685,7 +687,7 @@

Method Details

}, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. - "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. + "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. "chunkingConfig": { # Configuration for chunking config. # Whether chunking mode is enabled. @@ -726,6 +728,7 @@

Method Details

"enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. }, + "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "idpConfig": { # Identity Provider Config. # Output only. Data store level identity provider config. "externalIdpConfig": { # Third party IDP Config. # External Identity provider config. "workforcePoolName": "A String", # Workforce pool name. Example: "locations/global/workforcePools/pool_id" @@ -842,7 +845,7 @@

Method Details

}, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. - "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. + "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. "chunkingConfig": { # Configuration for chunking config. # Whether chunking mode is enabled. @@ -883,6 +886,7 @@

Method Details

"enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. }, + "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "idpConfig": { # Identity Provider Config. # Output only. Data store level identity provider config. "externalIdpConfig": { # Third party IDP Config. # External Identity provider config. "workforcePoolName": "A String", # Workforce pool name. Example: "locations/global/workforcePools/pool_id" @@ -981,7 +985,7 @@

Method Details

}, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. - "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. + "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. "chunkingConfig": { # Configuration for chunking config. # Whether chunking mode is enabled. @@ -1022,6 +1026,7 @@

Method Details

"enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. }, + "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "idpConfig": { # Identity Provider Config. # Output only. Data store level identity provider config. "externalIdpConfig": { # Third party IDP Config. # External Identity provider config. "workforcePoolName": "A String", # Workforce pool name. Example: "locations/global/workforcePools/pool_id" diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html index b79e13a9cb7..b428173897b 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html @@ -303,13 +303,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -358,6 +358,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -448,13 +450,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -503,6 +505,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -1427,7 +1431,7 @@

Method Details

"session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. - "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. + "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. }, "spellCorrectionSpec": { # The specification for query spell correction. # The spell correction specification that specifies the mode under which spell correction takes effect. "mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. @@ -1955,7 +1959,7 @@

Method Details

"session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. - "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. + "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. }, "spellCorrectionSpec": { # The specification for query spell correction. # The spell correction specification that specifies the mode under which spell correction takes effect. "mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. @@ -2526,13 +2530,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -2581,6 +2585,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -2671,13 +2677,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -2726,6 +2732,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.answers.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.answers.html index 482dd15acb2..c5650a464c6 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.answers.html @@ -107,13 +107,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -162,6 +162,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.html index 0c1d014c708..7c01079c4b1 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.html @@ -132,13 +132,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -187,6 +187,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -293,13 +295,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -348,6 +350,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -480,13 +484,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -535,6 +539,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -655,13 +661,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -710,6 +716,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -834,13 +842,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -889,6 +897,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -996,13 +1006,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -1051,6 +1061,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.widgetConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.widgetConfigs.html index 1ef1065b17c..7eb646521e5 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.widgetConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.widgetConfigs.html @@ -122,11 +122,12 @@

Method Details

"dataSource": "A String", # The name of the data source, retrieved from `Collection.data_connector.data_source`. "dataStoreComponents": [ # For the data store collection, list of the children data stores. { # Read-only data store component that contains data stores fields that may be used for filtering, it's the child of `CollectionComponent`. - "contentConfig": "A String", # The content config of the data store. + "contentConfig": "A String", # Output only. The content config of the data store. "displayName": "A String", # The display name of the data store. "entityName": "A String", # The name of the entity, retrieved from `Collection.data_connector.entities.entityName`. "id": "A String", # Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID. "name": "A String", # The name of the data store. It should be data store resource name Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. For APIs under WidgetService, such as WidgetService.LookUpWidgetConfig, the project number and location part is erased in this field. + "workspaceType": "A String", # Output only. Workspace Source Types for workspace data, retrieved from `DataStore.workspace_config.type`. }, ], "displayName": "A String", # The display name of the collection. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html index b37f8d97abe..89dafc1ec1d 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html @@ -310,7 +310,7 @@

Method Details

"session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. - "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. + "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. }, "spellCorrectionSpec": { # The specification for query spell correction. # The spell correction specification that specifies the mode under which spell correction takes effect. "mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. @@ -599,7 +599,7 @@

Method Details

"session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. - "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. + "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. }, "spellCorrectionSpec": { # The specification for query spell correction. # The spell correction specification that specifies the mode under which spell correction takes effect. "mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. @@ -864,7 +864,7 @@

Method Details

"session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. - "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. + "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. }, "spellCorrectionSpec": { # The specification for query spell correction. # The spell correction specification that specifies the mode under which spell correction takes effect. "mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.completionConfig.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.completionConfig.html index 924545b8722..352dcfa7c74 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.completionConfig.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.completionConfig.html @@ -106,7 +106,7 @@

Method Details

}, "includeTailSuggestions": True or False, # Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned. "query": "A String", # Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. The query can not be empty for most of the suggestion types. If it is empty, an `INVALID_ARGUMENT` error is returned. The exception is when the suggestion_types contains only the type `RECENT_SEARCH`, the query can be an empty string. The is called "zero prefix" feature, which returns user's recently searched queries given the empty query. - "queryModel": "A String", # Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. + "queryModel": "A String", # Specifies the autocomplete query model, which only applies to the QUERY SuggestionType. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. "suggestionTypeSpecs": [ # Optional. Specification of each suggestion type. { # Specification of each suggestion type. "maxSuggestions": 42, # Optional. Maximum number of suggestions to return for each suggestion type. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html index e962020f5f7..0d740349395 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html @@ -248,7 +248,7 @@

Method Details

}, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. - "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. + "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. "chunkingConfig": { # Configuration for chunking config. # Whether chunking mode is enabled. @@ -289,6 +289,7 @@

Method Details

"enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. }, + "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. "isInfobotFaqDataStore": True or False, # Optional. If set, this DataStore is an Infobot FAQ DataStore. "kmsKeyName": "A String", # Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. @@ -434,7 +435,7 @@

Method Details

}, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. - "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. + "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. "chunkingConfig": { # Configuration for chunking config. # Whether chunking mode is enabled. @@ -475,6 +476,7 @@

Method Details

"enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. }, + "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. "isInfobotFaqDataStore": True or False, # Optional. If set, this DataStore is an Infobot FAQ DataStore. "kmsKeyName": "A String", # Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. @@ -576,7 +578,7 @@

Method Details

}, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. - "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. + "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. "chunkingConfig": { # Configuration for chunking config. # Whether chunking mode is enabled. @@ -617,6 +619,7 @@

Method Details

"enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. }, + "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. "isInfobotFaqDataStore": True or False, # Optional. If set, this DataStore is an Infobot FAQ DataStore. "kmsKeyName": "A String", # Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. @@ -706,7 +709,7 @@

Method Details

}, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. - "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. + "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. "chunkingConfig": { # Configuration for chunking config. # Whether chunking mode is enabled. @@ -747,6 +750,7 @@

Method Details

"enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. }, + "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. "isInfobotFaqDataStore": True or False, # Optional. If set, this DataStore is an Infobot FAQ DataStore. "kmsKeyName": "A String", # Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. @@ -818,7 +822,7 @@

Method Details

}, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. - "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. + "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. "chunkingConfig": { # Configuration for chunking config. # Whether chunking mode is enabled. @@ -859,6 +863,7 @@

Method Details

"enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. }, + "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. "isInfobotFaqDataStore": True or False, # Optional. If set, this DataStore is an Infobot FAQ DataStore. "kmsKeyName": "A String", # Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html index c980295751c..a53ced0b380 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html @@ -300,13 +300,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -355,6 +355,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -445,13 +447,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -500,6 +502,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -1373,7 +1377,7 @@

Method Details

"session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. - "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. + "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. }, "spellCorrectionSpec": { # The specification for query spell correction. # The spell correction specification that specifies the mode under which spell correction takes effect. "mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. @@ -1869,7 +1873,7 @@

Method Details

"session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. - "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. + "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. }, "spellCorrectionSpec": { # The specification for query spell correction. # The spell correction specification that specifies the mode under which spell correction takes effect. "mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. @@ -2411,13 +2415,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -2466,6 +2470,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -2556,13 +2562,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -2611,6 +2617,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.answers.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.answers.html index 7c0f6aabea1..fe277a9ef18 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.answers.html @@ -107,13 +107,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -162,6 +162,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.html index 9187de11cb1..500f9f61da4 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.html @@ -132,13 +132,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -187,6 +187,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -293,13 +295,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -348,6 +350,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -480,13 +484,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -535,6 +539,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -655,13 +661,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -710,6 +716,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -834,13 +842,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -889,6 +897,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -996,13 +1006,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -1051,6 +1061,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.completionConfig.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.completionConfig.html index 495b976c81e..32f9c7aa9ca 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.completionConfig.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.completionConfig.html @@ -80,6 +80,9 @@

Instance Methods

completeQuery(completionConfig, body=None, x__xgafv=None)

Completes the user input with advanced keyword suggestions.

+

+ removeSuggestion(completionConfig, body=None, x__xgafv=None)

+

Removes the search history suggestion in an engine for a user. This will remove the suggestion from being returned in the AdvancedCompleteQueryResponse.recent_search_suggestions for this user. If the user searches the same suggestion again, the new history will override and suggest this suggestion again.

Method Details

close() @@ -106,7 +109,7 @@

Method Details

}, "includeTailSuggestions": True or False, # Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned. "query": "A String", # Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. The query can not be empty for most of the suggestion types. If it is empty, an `INVALID_ARGUMENT` error is returned. The exception is when the suggestion_types contains only the type `RECENT_SEARCH`, the query can be an empty string. The is called "zero prefix" feature, which returns user's recently searched queries given the empty query. - "queryModel": "A String", # Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. + "queryModel": "A String", # Specifies the autocomplete query model, which only applies to the QUERY SuggestionType. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. "suggestionTypeSpecs": [ # Optional. Specification of each suggestion type. { # Specification of each suggestion type. "maxSuggestions": 42, # Optional. Maximum number of suggestions to return for each suggestion type. @@ -235,4 +238,36 @@

Method Details

}
+
+ removeSuggestion(completionConfig, body=None, x__xgafv=None) +
Removes the search history suggestion in an engine for a user. This will remove the suggestion from being returned in the AdvancedCompleteQueryResponse.recent_search_suggestions for this user. If the user searches the same suggestion again, the new history will override and suggest this suggestion again.
+
+Args:
+  completionConfig: string, Required. The completion_config of the parent engine resource name for which the search history suggestion is to be removed, such as `projects/*/locations/global/collections/default_collection/engines/*/completionConfig`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for CompletionService.RemoveSuggestion method.
+  "removeAllSearchHistorySuggestions": True or False, # Remove all search history suggestions for the user.
+  "removeTime": "A String", # Optional. Time at which the suggestion was removed. If not set, the current time will be used.
+  "searchHistorySuggestion": "A String", # The search history suggestion to be removed.
+  "userInfo": { # Information of an end user. # Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info.
+    "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set.
+    "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+  },
+  "userPseudoId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128.
+}
+
+  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 CompletionService.RemoveSuggestion method.
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html index c14d2b94d53..effaa124bcc 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html @@ -300,13 +300,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -355,6 +355,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -445,13 +447,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -500,6 +502,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -1373,7 +1377,7 @@

Method Details

"session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. - "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. + "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. }, "spellCorrectionSpec": { # The specification for query spell correction. # The spell correction specification that specifies the mode under which spell correction takes effect. "mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. @@ -1869,7 +1873,7 @@

Method Details

"session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. - "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. + "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. }, "spellCorrectionSpec": { # The specification for query spell correction. # The spell correction specification that specifies the mode under which spell correction takes effect. "mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. @@ -2411,13 +2415,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -2466,6 +2470,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -2556,13 +2562,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -2611,6 +2617,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.answers.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.answers.html index a7df87c425a..074f7d1de82 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.answers.html @@ -107,13 +107,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -162,6 +162,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.html index 682b2b33a8a..669a6d05b8d 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.html @@ -132,13 +132,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -187,6 +187,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -293,13 +295,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -348,6 +350,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -480,13 +484,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -535,6 +539,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -655,13 +661,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -710,6 +716,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -834,13 +842,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -889,6 +897,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -996,13 +1006,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -1051,6 +1061,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.completionConfig.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.completionConfig.html index e3a2924a604..a9e0e20e598 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.completionConfig.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.completionConfig.html @@ -106,7 +106,7 @@

Method Details

}, "includeTailSuggestions": True or False, # Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned. "query": "A String", # Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. The query can not be empty for most of the suggestion types. If it is empty, an `INVALID_ARGUMENT` error is returned. The exception is when the suggestion_types contains only the type `RECENT_SEARCH`, the query can be an empty string. The is called "zero prefix" feature, which returns user's recently searched queries given the empty query. - "queryModel": "A String", # Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. + "queryModel": "A String", # Specifies the autocomplete query model, which only applies to the QUERY SuggestionType. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. "suggestionTypeSpecs": [ # Optional. Specification of each suggestion type. { # Specification of each suggestion type. "maxSuggestions": 42, # Optional. Maximum number of suggestions to return for each suggestion type. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html index 7c21e7c4549..e46b0612d18 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html @@ -240,7 +240,7 @@

Method Details

}, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. - "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. + "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. "chunkingConfig": { # Configuration for chunking config. # Whether chunking mode is enabled. @@ -281,6 +281,7 @@

Method Details

"enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. }, + "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. "isInfobotFaqDataStore": True or False, # Optional. If set, this DataStore is an Infobot FAQ DataStore. "kmsKeyName": "A String", # Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. @@ -426,7 +427,7 @@

Method Details

}, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. - "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. + "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. "chunkingConfig": { # Configuration for chunking config. # Whether chunking mode is enabled. @@ -467,6 +468,7 @@

Method Details

"enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. }, + "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. "isInfobotFaqDataStore": True or False, # Optional. If set, this DataStore is an Infobot FAQ DataStore. "kmsKeyName": "A String", # Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. @@ -568,7 +570,7 @@

Method Details

}, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. - "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. + "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. "chunkingConfig": { # Configuration for chunking config. # Whether chunking mode is enabled. @@ -609,6 +611,7 @@

Method Details

"enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. }, + "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. "isInfobotFaqDataStore": True or False, # Optional. If set, this DataStore is an Infobot FAQ DataStore. "kmsKeyName": "A String", # Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. @@ -698,7 +701,7 @@

Method Details

}, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. - "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. + "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. "chunkingConfig": { # Configuration for chunking config. # Whether chunking mode is enabled. @@ -739,6 +742,7 @@

Method Details

"enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. }, + "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. "isInfobotFaqDataStore": True or False, # Optional. If set, this DataStore is an Infobot FAQ DataStore. "kmsKeyName": "A String", # Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. @@ -810,7 +814,7 @@

Method Details

}, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. - "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. + "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. "chunkingConfig": { # Configuration for chunking config. # Whether chunking mode is enabled. @@ -851,6 +855,7 @@

Method Details

"enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. }, + "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. "isInfobotFaqDataStore": True or False, # Optional. If set, this DataStore is an Infobot FAQ DataStore. "kmsKeyName": "A String", # Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html index fad49d18a6a..d8b12b1d7ba 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html @@ -300,13 +300,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -355,6 +355,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -445,13 +447,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -500,6 +502,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -1373,7 +1377,7 @@

Method Details

"session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. - "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. + "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. }, "spellCorrectionSpec": { # The specification for query spell correction. # The spell correction specification that specifies the mode under which spell correction takes effect. "mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. @@ -1869,7 +1873,7 @@

Method Details

"session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. - "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. + "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. }, "spellCorrectionSpec": { # The specification for query spell correction. # The spell correction specification that specifies the mode under which spell correction takes effect. "mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. @@ -2411,13 +2415,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -2466,6 +2470,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -2556,13 +2562,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -2611,6 +2617,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.answers.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.answers.html index 2d1f988130b..f634ec42953 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.answers.html @@ -107,13 +107,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -162,6 +162,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.html index 280327efa90..ea18f1bc40c 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.html @@ -132,13 +132,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -187,6 +187,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -293,13 +295,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -348,6 +350,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -480,13 +484,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -535,6 +539,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -655,13 +661,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -710,6 +716,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -834,13 +842,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -889,6 +897,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. @@ -996,13 +1006,13 @@

Method Details

"answerText": "A String", # The textual answer. "citations": [ # Citations. { # Citation info for a segment. - "endIndex": "A String", # End of the attributed segment, exclusive. + "endIndex": "A String", # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. "sources": [ # Citation sources for the attributed segment. { # Citation source. "referenceId": "A String", # ID of the citation source. }, ], - "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. }, ], "completeTime": "A String", # Output only. Answer completed timestamp. @@ -1051,6 +1061,8 @@

Method Details

"structData": { # Structured search data. "a_key": "", # Properties of the object. }, + "title": "A String", # Output only. The title of the document. + "uri": "A String", # Output only. The URI of the document. }, "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information. "chunkContents": [ # List of cited chunk contents derived from document content. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html b/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html index 902bd21ed48..2e31b6e7550 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html @@ -304,7 +304,7 @@

Method Details

"session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. - "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. + "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. }, "spellCorrectionSpec": { # The specification for query spell correction. # The spell correction specification that specifies the mode under which spell correction takes effect. "mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. @@ -587,7 +587,7 @@

Method Details

"session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. - "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. + "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. }, "spellCorrectionSpec": { # The specification for query spell correction. # The spell correction specification that specifies the mode under which spell correction takes effect. "mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. @@ -846,7 +846,7 @@

Method Details

"session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. - "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. + "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. }, "spellCorrectionSpec": { # The specification for query spell correction. # The spell correction specification that specifies the mode under which spell correction takes effect. "mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.html b/docs/dyn/discoveryengine_v1beta.projects.locations.html index e92ab47b0fa..172b739ce48 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.html @@ -125,6 +125,15 @@

Instance Methods

generateGroundedContent(location, body=None, x__xgafv=None)

Generates grounded content.

+

+ obtainCrawlRate(location, body=None, x__xgafv=None)

+

Obtains the time series data of organic or dedicated crawl rate for monitoring. When dedicated crawl rate is not set, it will return vertex AI's organic crawl rate time series. Organic crawl means Google automatically crawl the internet at its own convenience. When dedicated crawl rate is set, it will return vertex AI's dedicated crawl rate time series.

+

+ removeDedicatedCrawlRate(location, body=None, x__xgafv=None)

+

Removes the dedicated crawl rate for a craw_rate_scope. If the dedicated crawl rate was set, this will disable vertex AI's crawl bot from using the dedicated crawl rate for crawling. If the dedicated crawl rate was not set, this is a no-op.

+

+ setDedicatedCrawlRate(location, body=None, x__xgafv=None)

+

Sets the dedicated crawl rate for a crawl_rate_scope. If the dedicated crawl rate was not set, this will enable vertex AI's crawl bot to use the new dedicated crawl rate for crawling. If the dedicated crawl rate was set, vertex AI's crawl bot will try to update the rate to the new value. If the new value is too high, the crawl bot may crawl at a lower rate to avoid overloading the user's website.

Method Details

close() @@ -273,4 +282,458 @@

Method Details

}
+
+ obtainCrawlRate(location, body=None, x__xgafv=None) +
Obtains the time series data of organic or dedicated crawl rate for monitoring. When dedicated crawl rate is not set, it will return vertex AI's organic crawl rate time series. Organic crawl means Google automatically crawl the internet at its own convenience. When dedicated crawl rate is set, it will return vertex AI's dedicated crawl rate time series.
+
+Args:
+  location: string, Required. The location resource where crawl rate management will be performed. Format: `projects/{project}/locations/{location}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for CrawlRateManagementService.ObtainCrawlRate method.
+  "crawlRateScope": "A String", # Required. The scope of the crawl rate that the user wants to monitor. Currently, only domain and host name are supported. A domain name example: `example.com`. A host name example: `www.example.com`. Please do not include `/` in the domain or host name.
+}
+
+  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 CrawlRateManagementService.ObtainCrawlRate method. The response contains organcic or dedicated crawl rate time series data for monitoring, depending on whether dedicated crawl rate is set.
+  "dedicatedCrawlRateTimeSeries": { # The historical dedicated crawl rate timeseries data, used for monitoring. Dedicated crawl is used by Vertex AI to crawl the user's website when dedicate crawl is set. # The historical dedicated crawl rate timeseries data, used for monitoring.
+    "autoRefreshCrawlRate": { # The historical crawl rate timeseries data, used for monitoring. # Vertex AI's dedicated crawl rate time series of auto-refresh, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and the crawl rate is for best effort use cases like refreshing urls periodically.
+      "qpsTimeSeries": { # A collection of data points that describes the time-varying values of a metric. A time series is identified by a combination of a fully-specified monitored resource and a fully-specified metric. This type is used for both listing and creating time series. # The QPS of the crawl rate.
+        "description": "A String", # Input only. A detailed description of the time series that will be associated with the google.api.MetricDescriptor for the metric. Once set, this field cannot be changed through CreateTimeSeries.
+        "metadata": { # Auxiliary metadata for a MonitoredResource object. MonitoredResource objects contain the minimum set of information to uniquely identify a monitored resource instance. There is some other useful auxiliary metadata. Monitoring and Logging use an ingestion pipeline to extract metadata for cloud resources of all types, and store the metadata in this message. # Output only. The associated monitored resource metadata. When reading a time series, this field will include metadata labels that are explicitly named in the reduction. When creating a time series, this field is ignored.
+          "systemLabels": { # Output only. Values for predefined system metadata labels. System labels are a kind of metadata extracted by Google, including "machine_image", "vpc", "subnet_id", "security_group", "name", etc. System label values can be only strings, Boolean values, or a list of strings. For example: { "name": "my-test-instance", "security_group": ["a", "b", "c"], "spot_instance": false }
+            "a_key": "", # Properties of the object.
+          },
+          "userLabels": { # Output only. A map of user-defined metadata labels.
+            "a_key": "A String",
+          },
+        },
+        "metric": { # A specific metric, identified by specifying values for all of the labels of a `MetricDescriptor`. # The associated metric. A fully-specified metric used to identify the time series.
+          "labels": { # The set of label values that uniquely identify this metric. All labels listed in the `MetricDescriptor` must be assigned values.
+            "a_key": "A String",
+          },
+          "type": "A String", # An existing metric type, see google.api.MetricDescriptor. For example, `custom.googleapis.com/invoice/paid/amount`.
+        },
+        "metricKind": "A String", # The metric kind of the time series. When listing time series, this metric kind might be different from the metric kind of the associated metric if this time series is an alignment or reduction of other time series. When creating a time series, this field is optional. If present, it must be the same as the metric kind of the associated metric. If the associated metric's descriptor must be auto-created, then this field specifies the metric kind of the new descriptor and must be either `GAUGE` (the default) or `CUMULATIVE`.
+        "points": [ # The data points of this time series. When listing time series, points are returned in reverse time order. When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must be `BOOL`, `INT64`, `DOUBLE`, or `DISTRIBUTION`.
+          { # A single data point in a time series.
+            "interval": { # A time interval extending just after a start time through an end time. If the start time is the same as the end time, then the interval represents a single point in time. # The time interval to which the data point applies. For `GAUGE` metrics, the start time is optional, but if it is supplied, it must equal the end time. For `DELTA` metrics, the start and end time should specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For `CUMULATIVE` metrics, the start and end time should specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points.
+              "endTime": "A String", # Required. The end of the time interval.
+              "startTime": "A String", # Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.
+            },
+            "value": { # A single strongly-typed value. # The value of the data point.
+              "boolValue": True or False, # A Boolean value: `true` or `false`.
+              "distributionValue": { # `Distribution` contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of buckets. The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values. The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by formulas for buckets of fixed or exponentially increasing widths. Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the `mean` and `sum_of_squared_deviation` fields meaningless. # A distribution value.
+                "bucketCounts": [ # The number of values in each bucket of the histogram, as described in `bucket_options`. If the distribution does not have a histogram, then omit this field. If there is a histogram, then the sum of the values in `bucket_counts` must equal the value in the `count` field of the distribution. If present, `bucket_counts` should contain N values, where N is the number of buckets specified in `bucket_options`. If you supply fewer than N values, the remaining values are assumed to be 0. The order of the values in `bucket_counts` follows the bucket numbering schemes described for the three bucket types. The first value must be the count for the underflow bucket (number 0). The next N-2 values are the counts for the finite buckets (number 1 through N-2). The N'th value in `bucket_counts` is the count for the overflow bucket (number N-1).
+                  "A String",
+                ],
+                "bucketOptions": { # `BucketOptions` describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. `BucketOptions` does not include the number of values in each bucket. A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i > 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite. # Defines the histogram bucket boundaries. If the distribution does not contain a histogram, then omit this field.
+                  "explicitBuckets": { # Specifies a set of buckets with arbitrary widths. There are `size(bounds) + 1` (= N) buckets. Bucket `i` has the following boundaries: Upper bound (0 <= i < N-1): bounds[i] Lower bound (1 <= i < N); bounds[i - 1] The `bounds` field must contain at least one element. If `bounds` has only one element, then there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets. # The explicit buckets.
+                    "bounds": [ # The values must be monotonically increasing.
+                      3.14,
+                    ],
+                  },
+                  "exponentialBuckets": { # Specifies an exponential sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket. There are `num_finite_buckets + 2` (= N) buckets. Bucket `i` has the following boundaries: Upper bound (0 <= i < N-1): scale * (growth_factor ^ i). Lower bound (1 <= i < N): scale * (growth_factor ^ (i - 1)). # The exponential buckets.
+                    "growthFactor": 3.14, # Must be greater than 1.
+                    "numFiniteBuckets": 42, # Must be greater than 0.
+                    "scale": 3.14, # Must be greater than 0.
+                  },
+                  "linearBuckets": { # Specifies a linear sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket. There are `num_finite_buckets + 2` (= N) buckets. Bucket `i` has the following boundaries: Upper bound (0 <= i < N-1): offset + (width * i). Lower bound (1 <= i < N): offset + (width * (i - 1)). # The linear bucket.
+                    "numFiniteBuckets": 42, # Must be greater than 0.
+                    "offset": 3.14, # Lower bound of the first bucket.
+                    "width": 3.14, # Must be greater than 0.
+                  },
+                },
+                "count": "A String", # The number of values in the population. Must be non-negative. This value must equal the sum of the values in `bucket_counts` if a histogram is provided.
+                "exemplars": [ # Must be in increasing order of `value` field.
+                  { # Exemplars are example points that may be used to annotate aggregated distribution values. They are metadata that gives information about a particular value added to a Distribution bucket, such as a trace ID that was active when a value was added. They may contain further information, such as a example values and timestamps, origin, etc.
+                    "attachments": [ # Contextual information about the example value. Examples are: Trace: type.googleapis.com/google.monitoring.v3.SpanContext Literal string: type.googleapis.com/google.protobuf.StringValue Labels dropped during aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabels There may be only a single attachment of any given message type in a single exemplar, and this is enforced by the system.
+                      {
+                        "a_key": "", # Properties of the object. Contains field @type with type URL.
+                      },
+                    ],
+                    "timestamp": "A String", # The observation (sampling) time of the above value.
+                    "value": 3.14, # Value of the exemplar point. This value determines to which bucket the exemplar belongs.
+                  },
+                ],
+                "mean": 3.14, # The arithmetic mean of the values in the population. If `count` is zero then this field must be zero.
+                "range": { # The range of the population values. # If specified, contains the range of the population values. The field must not be present if the `count` is zero.
+                  "max": 3.14, # The maximum of the population values.
+                  "min": 3.14, # The minimum of the population values.
+                },
+                "sumOfSquaredDeviation": 3.14, # The sum of squared deviations from the mean of the values in the population. For values x_i this is: Sum[i=1..n]((x_i - mean)^2) Knuth, "The Art of Computer Programming", Vol. 2, page 232, 3rd edition describes Welford's method for accumulating this sum in one pass. If `count` is zero then this field must be zero.
+              },
+              "doubleValue": 3.14, # A 64-bit double-precision floating-point number. Its magnitude is approximately ±10±300 and it has 16 significant digits of precision.
+              "int64Value": "A String", # A 64-bit integer. Its range is approximately ±9.2x1018.
+              "stringValue": "A String", # A variable-length string value.
+            },
+          },
+        ],
+        "resource": { # An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The `type` field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the `labels` field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for `"gce_instance"` has labels `"project_id"`, `"instance_id"` and `"zone"`: { "type": "gce_instance", "labels": { "project_id": "my-project", "instance_id": "12345678901234", "zone": "us-central1-a" }} # The associated monitored resource. Custom metrics can use only certain monitored resource types in their time series data. For more information, see [Monitored resources for custom metrics](https://cloud.google.com/monitoring/custom-metrics/creating-metrics#custom-metric-resources).
+          "labels": { # Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels `"project_id"`, `"instance_id"`, and `"zone"`.
+            "a_key": "A String",
+          },
+          "type": "A String", # Required. The monitored resource type. This field must match the `type` field of a MonitoredResourceDescriptor object. For example, the type of a Compute Engine VM instance is `gce_instance`. Some descriptors include the service name in the type; for example, the type of a Datastream stream is `datastream.googleapis.com/Stream`.
+        },
+        "unit": "A String", # The units in which the metric value is reported. It is only applicable if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit` defines the representation of the stored metric values. This field can only be changed through CreateTimeSeries when it is empty.
+        "valueType": "A String", # The value type of the time series. When listing time series, this value type might be different from the value type of the associated metric if this time series is an alignment or reduction of other time series. When creating a time series, this field is optional. If present, it must be the same as the type of the data in the `points` field.
+      },
+    },
+    "userTriggeredCrawlRate": { # The historical crawl rate timeseries data, used for monitoring. # Vertex AI's dedicated crawl rate time series of user triggered crawl, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and user triggered crawl rate is for deterministic use cases like crawling urls or sitemaps specified by users.
+      "qpsTimeSeries": { # A collection of data points that describes the time-varying values of a metric. A time series is identified by a combination of a fully-specified monitored resource and a fully-specified metric. This type is used for both listing and creating time series. # The QPS of the crawl rate.
+        "description": "A String", # Input only. A detailed description of the time series that will be associated with the google.api.MetricDescriptor for the metric. Once set, this field cannot be changed through CreateTimeSeries.
+        "metadata": { # Auxiliary metadata for a MonitoredResource object. MonitoredResource objects contain the minimum set of information to uniquely identify a monitored resource instance. There is some other useful auxiliary metadata. Monitoring and Logging use an ingestion pipeline to extract metadata for cloud resources of all types, and store the metadata in this message. # Output only. The associated monitored resource metadata. When reading a time series, this field will include metadata labels that are explicitly named in the reduction. When creating a time series, this field is ignored.
+          "systemLabels": { # Output only. Values for predefined system metadata labels. System labels are a kind of metadata extracted by Google, including "machine_image", "vpc", "subnet_id", "security_group", "name", etc. System label values can be only strings, Boolean values, or a list of strings. For example: { "name": "my-test-instance", "security_group": ["a", "b", "c"], "spot_instance": false }
+            "a_key": "", # Properties of the object.
+          },
+          "userLabels": { # Output only. A map of user-defined metadata labels.
+            "a_key": "A String",
+          },
+        },
+        "metric": { # A specific metric, identified by specifying values for all of the labels of a `MetricDescriptor`. # The associated metric. A fully-specified metric used to identify the time series.
+          "labels": { # The set of label values that uniquely identify this metric. All labels listed in the `MetricDescriptor` must be assigned values.
+            "a_key": "A String",
+          },
+          "type": "A String", # An existing metric type, see google.api.MetricDescriptor. For example, `custom.googleapis.com/invoice/paid/amount`.
+        },
+        "metricKind": "A String", # The metric kind of the time series. When listing time series, this metric kind might be different from the metric kind of the associated metric if this time series is an alignment or reduction of other time series. When creating a time series, this field is optional. If present, it must be the same as the metric kind of the associated metric. If the associated metric's descriptor must be auto-created, then this field specifies the metric kind of the new descriptor and must be either `GAUGE` (the default) or `CUMULATIVE`.
+        "points": [ # The data points of this time series. When listing time series, points are returned in reverse time order. When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must be `BOOL`, `INT64`, `DOUBLE`, or `DISTRIBUTION`.
+          { # A single data point in a time series.
+            "interval": { # A time interval extending just after a start time through an end time. If the start time is the same as the end time, then the interval represents a single point in time. # The time interval to which the data point applies. For `GAUGE` metrics, the start time is optional, but if it is supplied, it must equal the end time. For `DELTA` metrics, the start and end time should specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For `CUMULATIVE` metrics, the start and end time should specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points.
+              "endTime": "A String", # Required. The end of the time interval.
+              "startTime": "A String", # Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.
+            },
+            "value": { # A single strongly-typed value. # The value of the data point.
+              "boolValue": True or False, # A Boolean value: `true` or `false`.
+              "distributionValue": { # `Distribution` contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of buckets. The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values. The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by formulas for buckets of fixed or exponentially increasing widths. Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the `mean` and `sum_of_squared_deviation` fields meaningless. # A distribution value.
+                "bucketCounts": [ # The number of values in each bucket of the histogram, as described in `bucket_options`. If the distribution does not have a histogram, then omit this field. If there is a histogram, then the sum of the values in `bucket_counts` must equal the value in the `count` field of the distribution. If present, `bucket_counts` should contain N values, where N is the number of buckets specified in `bucket_options`. If you supply fewer than N values, the remaining values are assumed to be 0. The order of the values in `bucket_counts` follows the bucket numbering schemes described for the three bucket types. The first value must be the count for the underflow bucket (number 0). The next N-2 values are the counts for the finite buckets (number 1 through N-2). The N'th value in `bucket_counts` is the count for the overflow bucket (number N-1).
+                  "A String",
+                ],
+                "bucketOptions": { # `BucketOptions` describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. `BucketOptions` does not include the number of values in each bucket. A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i > 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite. # Defines the histogram bucket boundaries. If the distribution does not contain a histogram, then omit this field.
+                  "explicitBuckets": { # Specifies a set of buckets with arbitrary widths. There are `size(bounds) + 1` (= N) buckets. Bucket `i` has the following boundaries: Upper bound (0 <= i < N-1): bounds[i] Lower bound (1 <= i < N); bounds[i - 1] The `bounds` field must contain at least one element. If `bounds` has only one element, then there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets. # The explicit buckets.
+                    "bounds": [ # The values must be monotonically increasing.
+                      3.14,
+                    ],
+                  },
+                  "exponentialBuckets": { # Specifies an exponential sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket. There are `num_finite_buckets + 2` (= N) buckets. Bucket `i` has the following boundaries: Upper bound (0 <= i < N-1): scale * (growth_factor ^ i). Lower bound (1 <= i < N): scale * (growth_factor ^ (i - 1)). # The exponential buckets.
+                    "growthFactor": 3.14, # Must be greater than 1.
+                    "numFiniteBuckets": 42, # Must be greater than 0.
+                    "scale": 3.14, # Must be greater than 0.
+                  },
+                  "linearBuckets": { # Specifies a linear sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket. There are `num_finite_buckets + 2` (= N) buckets. Bucket `i` has the following boundaries: Upper bound (0 <= i < N-1): offset + (width * i). Lower bound (1 <= i < N): offset + (width * (i - 1)). # The linear bucket.
+                    "numFiniteBuckets": 42, # Must be greater than 0.
+                    "offset": 3.14, # Lower bound of the first bucket.
+                    "width": 3.14, # Must be greater than 0.
+                  },
+                },
+                "count": "A String", # The number of values in the population. Must be non-negative. This value must equal the sum of the values in `bucket_counts` if a histogram is provided.
+                "exemplars": [ # Must be in increasing order of `value` field.
+                  { # Exemplars are example points that may be used to annotate aggregated distribution values. They are metadata that gives information about a particular value added to a Distribution bucket, such as a trace ID that was active when a value was added. They may contain further information, such as a example values and timestamps, origin, etc.
+                    "attachments": [ # Contextual information about the example value. Examples are: Trace: type.googleapis.com/google.monitoring.v3.SpanContext Literal string: type.googleapis.com/google.protobuf.StringValue Labels dropped during aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabels There may be only a single attachment of any given message type in a single exemplar, and this is enforced by the system.
+                      {
+                        "a_key": "", # Properties of the object. Contains field @type with type URL.
+                      },
+                    ],
+                    "timestamp": "A String", # The observation (sampling) time of the above value.
+                    "value": 3.14, # Value of the exemplar point. This value determines to which bucket the exemplar belongs.
+                  },
+                ],
+                "mean": 3.14, # The arithmetic mean of the values in the population. If `count` is zero then this field must be zero.
+                "range": { # The range of the population values. # If specified, contains the range of the population values. The field must not be present if the `count` is zero.
+                  "max": 3.14, # The maximum of the population values.
+                  "min": 3.14, # The minimum of the population values.
+                },
+                "sumOfSquaredDeviation": 3.14, # The sum of squared deviations from the mean of the values in the population. For values x_i this is: Sum[i=1..n]((x_i - mean)^2) Knuth, "The Art of Computer Programming", Vol. 2, page 232, 3rd edition describes Welford's method for accumulating this sum in one pass. If `count` is zero then this field must be zero.
+              },
+              "doubleValue": 3.14, # A 64-bit double-precision floating-point number. Its magnitude is approximately ±10±300 and it has 16 significant digits of precision.
+              "int64Value": "A String", # A 64-bit integer. Its range is approximately ±9.2x1018.
+              "stringValue": "A String", # A variable-length string value.
+            },
+          },
+        ],
+        "resource": { # An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The `type` field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the `labels` field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for `"gce_instance"` has labels `"project_id"`, `"instance_id"` and `"zone"`: { "type": "gce_instance", "labels": { "project_id": "my-project", "instance_id": "12345678901234", "zone": "us-central1-a" }} # The associated monitored resource. Custom metrics can use only certain monitored resource types in their time series data. For more information, see [Monitored resources for custom metrics](https://cloud.google.com/monitoring/custom-metrics/creating-metrics#custom-metric-resources).
+          "labels": { # Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels `"project_id"`, `"instance_id"`, and `"zone"`.
+            "a_key": "A String",
+          },
+          "type": "A String", # Required. The monitored resource type. This field must match the `type` field of a MonitoredResourceDescriptor object. For example, the type of a Compute Engine VM instance is `gce_instance`. Some descriptors include the service name in the type; for example, the type of a Datastream stream is `datastream.googleapis.com/Stream`.
+        },
+        "unit": "A String", # The units in which the metric value is reported. It is only applicable if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit` defines the representation of the stored metric values. This field can only be changed through CreateTimeSeries when it is empty.
+        "valueType": "A String", # The value type of the time series. When listing time series, this value type might be different from the value type of the associated metric if this time series is an alignment or reduction of other time series. When creating a time series, this field is optional. If present, it must be the same as the type of the data in the `points` field.
+      },
+    },
+  },
+  "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). # Errors from service when handling the request.
+    "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.
+  },
+  "organicCrawlRateTimeSeries": { # The historical organic crawl rate timeseries data, used for monitoring. Organic crawl is auto-determined by Google to crawl the user's website when dedicate crawl is not set. Crawl rate is the QPS of crawl request Google sends to the user's website. # The historical organic crawl rate timeseries data, used for monitoring.
+    "googleOrganicCrawlRate": { # The historical crawl rate timeseries data, used for monitoring. # Google's organic crawl rate time series, which is the sum of all googlebots' crawl rate. Please refer to https://developers.google.com/search/docs/crawling-indexing/overview-google-crawlers for more details about googlebots.
+      "qpsTimeSeries": { # A collection of data points that describes the time-varying values of a metric. A time series is identified by a combination of a fully-specified monitored resource and a fully-specified metric. This type is used for both listing and creating time series. # The QPS of the crawl rate.
+        "description": "A String", # Input only. A detailed description of the time series that will be associated with the google.api.MetricDescriptor for the metric. Once set, this field cannot be changed through CreateTimeSeries.
+        "metadata": { # Auxiliary metadata for a MonitoredResource object. MonitoredResource objects contain the minimum set of information to uniquely identify a monitored resource instance. There is some other useful auxiliary metadata. Monitoring and Logging use an ingestion pipeline to extract metadata for cloud resources of all types, and store the metadata in this message. # Output only. The associated monitored resource metadata. When reading a time series, this field will include metadata labels that are explicitly named in the reduction. When creating a time series, this field is ignored.
+          "systemLabels": { # Output only. Values for predefined system metadata labels. System labels are a kind of metadata extracted by Google, including "machine_image", "vpc", "subnet_id", "security_group", "name", etc. System label values can be only strings, Boolean values, or a list of strings. For example: { "name": "my-test-instance", "security_group": ["a", "b", "c"], "spot_instance": false }
+            "a_key": "", # Properties of the object.
+          },
+          "userLabels": { # Output only. A map of user-defined metadata labels.
+            "a_key": "A String",
+          },
+        },
+        "metric": { # A specific metric, identified by specifying values for all of the labels of a `MetricDescriptor`. # The associated metric. A fully-specified metric used to identify the time series.
+          "labels": { # The set of label values that uniquely identify this metric. All labels listed in the `MetricDescriptor` must be assigned values.
+            "a_key": "A String",
+          },
+          "type": "A String", # An existing metric type, see google.api.MetricDescriptor. For example, `custom.googleapis.com/invoice/paid/amount`.
+        },
+        "metricKind": "A String", # The metric kind of the time series. When listing time series, this metric kind might be different from the metric kind of the associated metric if this time series is an alignment or reduction of other time series. When creating a time series, this field is optional. If present, it must be the same as the metric kind of the associated metric. If the associated metric's descriptor must be auto-created, then this field specifies the metric kind of the new descriptor and must be either `GAUGE` (the default) or `CUMULATIVE`.
+        "points": [ # The data points of this time series. When listing time series, points are returned in reverse time order. When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must be `BOOL`, `INT64`, `DOUBLE`, or `DISTRIBUTION`.
+          { # A single data point in a time series.
+            "interval": { # A time interval extending just after a start time through an end time. If the start time is the same as the end time, then the interval represents a single point in time. # The time interval to which the data point applies. For `GAUGE` metrics, the start time is optional, but if it is supplied, it must equal the end time. For `DELTA` metrics, the start and end time should specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For `CUMULATIVE` metrics, the start and end time should specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points.
+              "endTime": "A String", # Required. The end of the time interval.
+              "startTime": "A String", # Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.
+            },
+            "value": { # A single strongly-typed value. # The value of the data point.
+              "boolValue": True or False, # A Boolean value: `true` or `false`.
+              "distributionValue": { # `Distribution` contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of buckets. The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values. The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by formulas for buckets of fixed or exponentially increasing widths. Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the `mean` and `sum_of_squared_deviation` fields meaningless. # A distribution value.
+                "bucketCounts": [ # The number of values in each bucket of the histogram, as described in `bucket_options`. If the distribution does not have a histogram, then omit this field. If there is a histogram, then the sum of the values in `bucket_counts` must equal the value in the `count` field of the distribution. If present, `bucket_counts` should contain N values, where N is the number of buckets specified in `bucket_options`. If you supply fewer than N values, the remaining values are assumed to be 0. The order of the values in `bucket_counts` follows the bucket numbering schemes described for the three bucket types. The first value must be the count for the underflow bucket (number 0). The next N-2 values are the counts for the finite buckets (number 1 through N-2). The N'th value in `bucket_counts` is the count for the overflow bucket (number N-1).
+                  "A String",
+                ],
+                "bucketOptions": { # `BucketOptions` describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. `BucketOptions` does not include the number of values in each bucket. A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i > 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite. # Defines the histogram bucket boundaries. If the distribution does not contain a histogram, then omit this field.
+                  "explicitBuckets": { # Specifies a set of buckets with arbitrary widths. There are `size(bounds) + 1` (= N) buckets. Bucket `i` has the following boundaries: Upper bound (0 <= i < N-1): bounds[i] Lower bound (1 <= i < N); bounds[i - 1] The `bounds` field must contain at least one element. If `bounds` has only one element, then there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets. # The explicit buckets.
+                    "bounds": [ # The values must be monotonically increasing.
+                      3.14,
+                    ],
+                  },
+                  "exponentialBuckets": { # Specifies an exponential sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket. There are `num_finite_buckets + 2` (= N) buckets. Bucket `i` has the following boundaries: Upper bound (0 <= i < N-1): scale * (growth_factor ^ i). Lower bound (1 <= i < N): scale * (growth_factor ^ (i - 1)). # The exponential buckets.
+                    "growthFactor": 3.14, # Must be greater than 1.
+                    "numFiniteBuckets": 42, # Must be greater than 0.
+                    "scale": 3.14, # Must be greater than 0.
+                  },
+                  "linearBuckets": { # Specifies a linear sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket. There are `num_finite_buckets + 2` (= N) buckets. Bucket `i` has the following boundaries: Upper bound (0 <= i < N-1): offset + (width * i). Lower bound (1 <= i < N): offset + (width * (i - 1)). # The linear bucket.
+                    "numFiniteBuckets": 42, # Must be greater than 0.
+                    "offset": 3.14, # Lower bound of the first bucket.
+                    "width": 3.14, # Must be greater than 0.
+                  },
+                },
+                "count": "A String", # The number of values in the population. Must be non-negative. This value must equal the sum of the values in `bucket_counts` if a histogram is provided.
+                "exemplars": [ # Must be in increasing order of `value` field.
+                  { # Exemplars are example points that may be used to annotate aggregated distribution values. They are metadata that gives information about a particular value added to a Distribution bucket, such as a trace ID that was active when a value was added. They may contain further information, such as a example values and timestamps, origin, etc.
+                    "attachments": [ # Contextual information about the example value. Examples are: Trace: type.googleapis.com/google.monitoring.v3.SpanContext Literal string: type.googleapis.com/google.protobuf.StringValue Labels dropped during aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabels There may be only a single attachment of any given message type in a single exemplar, and this is enforced by the system.
+                      {
+                        "a_key": "", # Properties of the object. Contains field @type with type URL.
+                      },
+                    ],
+                    "timestamp": "A String", # The observation (sampling) time of the above value.
+                    "value": 3.14, # Value of the exemplar point. This value determines to which bucket the exemplar belongs.
+                  },
+                ],
+                "mean": 3.14, # The arithmetic mean of the values in the population. If `count` is zero then this field must be zero.
+                "range": { # The range of the population values. # If specified, contains the range of the population values. The field must not be present if the `count` is zero.
+                  "max": 3.14, # The maximum of the population values.
+                  "min": 3.14, # The minimum of the population values.
+                },
+                "sumOfSquaredDeviation": 3.14, # The sum of squared deviations from the mean of the values in the population. For values x_i this is: Sum[i=1..n]((x_i - mean)^2) Knuth, "The Art of Computer Programming", Vol. 2, page 232, 3rd edition describes Welford's method for accumulating this sum in one pass. If `count` is zero then this field must be zero.
+              },
+              "doubleValue": 3.14, # A 64-bit double-precision floating-point number. Its magnitude is approximately ±10±300 and it has 16 significant digits of precision.
+              "int64Value": "A String", # A 64-bit integer. Its range is approximately ±9.2x1018.
+              "stringValue": "A String", # A variable-length string value.
+            },
+          },
+        ],
+        "resource": { # An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The `type` field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the `labels` field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for `"gce_instance"` has labels `"project_id"`, `"instance_id"` and `"zone"`: { "type": "gce_instance", "labels": { "project_id": "my-project", "instance_id": "12345678901234", "zone": "us-central1-a" }} # The associated monitored resource. Custom metrics can use only certain monitored resource types in their time series data. For more information, see [Monitored resources for custom metrics](https://cloud.google.com/monitoring/custom-metrics/creating-metrics#custom-metric-resources).
+          "labels": { # Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels `"project_id"`, `"instance_id"`, and `"zone"`.
+            "a_key": "A String",
+          },
+          "type": "A String", # Required. The monitored resource type. This field must match the `type` field of a MonitoredResourceDescriptor object. For example, the type of a Compute Engine VM instance is `gce_instance`. Some descriptors include the service name in the type; for example, the type of a Datastream stream is `datastream.googleapis.com/Stream`.
+        },
+        "unit": "A String", # The units in which the metric value is reported. It is only applicable if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit` defines the representation of the stored metric values. This field can only be changed through CreateTimeSeries when it is empty.
+        "valueType": "A String", # The value type of the time series. When listing time series, this value type might be different from the value type of the associated metric if this time series is an alignment or reduction of other time series. When creating a time series, this field is optional. If present, it must be the same as the type of the data in the `points` field.
+      },
+    },
+    "vertexAiOrganicCrawlRate": { # The historical crawl rate timeseries data, used for monitoring. # Vertex AI's organic crawl rate time series, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is not set. Please refer to https://developers.google.com/search/docs/crawling-indexing/google-common-crawlers#google-cloudvertexbot for more details about Google-CloudVertexBot.
+      "qpsTimeSeries": { # A collection of data points that describes the time-varying values of a metric. A time series is identified by a combination of a fully-specified monitored resource and a fully-specified metric. This type is used for both listing and creating time series. # The QPS of the crawl rate.
+        "description": "A String", # Input only. A detailed description of the time series that will be associated with the google.api.MetricDescriptor for the metric. Once set, this field cannot be changed through CreateTimeSeries.
+        "metadata": { # Auxiliary metadata for a MonitoredResource object. MonitoredResource objects contain the minimum set of information to uniquely identify a monitored resource instance. There is some other useful auxiliary metadata. Monitoring and Logging use an ingestion pipeline to extract metadata for cloud resources of all types, and store the metadata in this message. # Output only. The associated monitored resource metadata. When reading a time series, this field will include metadata labels that are explicitly named in the reduction. When creating a time series, this field is ignored.
+          "systemLabels": { # Output only. Values for predefined system metadata labels. System labels are a kind of metadata extracted by Google, including "machine_image", "vpc", "subnet_id", "security_group", "name", etc. System label values can be only strings, Boolean values, or a list of strings. For example: { "name": "my-test-instance", "security_group": ["a", "b", "c"], "spot_instance": false }
+            "a_key": "", # Properties of the object.
+          },
+          "userLabels": { # Output only. A map of user-defined metadata labels.
+            "a_key": "A String",
+          },
+        },
+        "metric": { # A specific metric, identified by specifying values for all of the labels of a `MetricDescriptor`. # The associated metric. A fully-specified metric used to identify the time series.
+          "labels": { # The set of label values that uniquely identify this metric. All labels listed in the `MetricDescriptor` must be assigned values.
+            "a_key": "A String",
+          },
+          "type": "A String", # An existing metric type, see google.api.MetricDescriptor. For example, `custom.googleapis.com/invoice/paid/amount`.
+        },
+        "metricKind": "A String", # The metric kind of the time series. When listing time series, this metric kind might be different from the metric kind of the associated metric if this time series is an alignment or reduction of other time series. When creating a time series, this field is optional. If present, it must be the same as the metric kind of the associated metric. If the associated metric's descriptor must be auto-created, then this field specifies the metric kind of the new descriptor and must be either `GAUGE` (the default) or `CUMULATIVE`.
+        "points": [ # The data points of this time series. When listing time series, points are returned in reverse time order. When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must be `BOOL`, `INT64`, `DOUBLE`, or `DISTRIBUTION`.
+          { # A single data point in a time series.
+            "interval": { # A time interval extending just after a start time through an end time. If the start time is the same as the end time, then the interval represents a single point in time. # The time interval to which the data point applies. For `GAUGE` metrics, the start time is optional, but if it is supplied, it must equal the end time. For `DELTA` metrics, the start and end time should specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For `CUMULATIVE` metrics, the start and end time should specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points.
+              "endTime": "A String", # Required. The end of the time interval.
+              "startTime": "A String", # Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.
+            },
+            "value": { # A single strongly-typed value. # The value of the data point.
+              "boolValue": True or False, # A Boolean value: `true` or `false`.
+              "distributionValue": { # `Distribution` contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of buckets. The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values. The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by formulas for buckets of fixed or exponentially increasing widths. Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the `mean` and `sum_of_squared_deviation` fields meaningless. # A distribution value.
+                "bucketCounts": [ # The number of values in each bucket of the histogram, as described in `bucket_options`. If the distribution does not have a histogram, then omit this field. If there is a histogram, then the sum of the values in `bucket_counts` must equal the value in the `count` field of the distribution. If present, `bucket_counts` should contain N values, where N is the number of buckets specified in `bucket_options`. If you supply fewer than N values, the remaining values are assumed to be 0. The order of the values in `bucket_counts` follows the bucket numbering schemes described for the three bucket types. The first value must be the count for the underflow bucket (number 0). The next N-2 values are the counts for the finite buckets (number 1 through N-2). The N'th value in `bucket_counts` is the count for the overflow bucket (number N-1).
+                  "A String",
+                ],
+                "bucketOptions": { # `BucketOptions` describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. `BucketOptions` does not include the number of values in each bucket. A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i > 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite. # Defines the histogram bucket boundaries. If the distribution does not contain a histogram, then omit this field.
+                  "explicitBuckets": { # Specifies a set of buckets with arbitrary widths. There are `size(bounds) + 1` (= N) buckets. Bucket `i` has the following boundaries: Upper bound (0 <= i < N-1): bounds[i] Lower bound (1 <= i < N); bounds[i - 1] The `bounds` field must contain at least one element. If `bounds` has only one element, then there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets. # The explicit buckets.
+                    "bounds": [ # The values must be monotonically increasing.
+                      3.14,
+                    ],
+                  },
+                  "exponentialBuckets": { # Specifies an exponential sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket. There are `num_finite_buckets + 2` (= N) buckets. Bucket `i` has the following boundaries: Upper bound (0 <= i < N-1): scale * (growth_factor ^ i). Lower bound (1 <= i < N): scale * (growth_factor ^ (i - 1)). # The exponential buckets.
+                    "growthFactor": 3.14, # Must be greater than 1.
+                    "numFiniteBuckets": 42, # Must be greater than 0.
+                    "scale": 3.14, # Must be greater than 0.
+                  },
+                  "linearBuckets": { # Specifies a linear sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket. There are `num_finite_buckets + 2` (= N) buckets. Bucket `i` has the following boundaries: Upper bound (0 <= i < N-1): offset + (width * i). Lower bound (1 <= i < N): offset + (width * (i - 1)). # The linear bucket.
+                    "numFiniteBuckets": 42, # Must be greater than 0.
+                    "offset": 3.14, # Lower bound of the first bucket.
+                    "width": 3.14, # Must be greater than 0.
+                  },
+                },
+                "count": "A String", # The number of values in the population. Must be non-negative. This value must equal the sum of the values in `bucket_counts` if a histogram is provided.
+                "exemplars": [ # Must be in increasing order of `value` field.
+                  { # Exemplars are example points that may be used to annotate aggregated distribution values. They are metadata that gives information about a particular value added to a Distribution bucket, such as a trace ID that was active when a value was added. They may contain further information, such as a example values and timestamps, origin, etc.
+                    "attachments": [ # Contextual information about the example value. Examples are: Trace: type.googleapis.com/google.monitoring.v3.SpanContext Literal string: type.googleapis.com/google.protobuf.StringValue Labels dropped during aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabels There may be only a single attachment of any given message type in a single exemplar, and this is enforced by the system.
+                      {
+                        "a_key": "", # Properties of the object. Contains field @type with type URL.
+                      },
+                    ],
+                    "timestamp": "A String", # The observation (sampling) time of the above value.
+                    "value": 3.14, # Value of the exemplar point. This value determines to which bucket the exemplar belongs.
+                  },
+                ],
+                "mean": 3.14, # The arithmetic mean of the values in the population. If `count` is zero then this field must be zero.
+                "range": { # The range of the population values. # If specified, contains the range of the population values. The field must not be present if the `count` is zero.
+                  "max": 3.14, # The maximum of the population values.
+                  "min": 3.14, # The minimum of the population values.
+                },
+                "sumOfSquaredDeviation": 3.14, # The sum of squared deviations from the mean of the values in the population. For values x_i this is: Sum[i=1..n]((x_i - mean)^2) Knuth, "The Art of Computer Programming", Vol. 2, page 232, 3rd edition describes Welford's method for accumulating this sum in one pass. If `count` is zero then this field must be zero.
+              },
+              "doubleValue": 3.14, # A 64-bit double-precision floating-point number. Its magnitude is approximately ±10±300 and it has 16 significant digits of precision.
+              "int64Value": "A String", # A 64-bit integer. Its range is approximately ±9.2x1018.
+              "stringValue": "A String", # A variable-length string value.
+            },
+          },
+        ],
+        "resource": { # An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The `type` field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the `labels` field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for `"gce_instance"` has labels `"project_id"`, `"instance_id"` and `"zone"`: { "type": "gce_instance", "labels": { "project_id": "my-project", "instance_id": "12345678901234", "zone": "us-central1-a" }} # The associated monitored resource. Custom metrics can use only certain monitored resource types in their time series data. For more information, see [Monitored resources for custom metrics](https://cloud.google.com/monitoring/custom-metrics/creating-metrics#custom-metric-resources).
+          "labels": { # Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels `"project_id"`, `"instance_id"`, and `"zone"`.
+            "a_key": "A String",
+          },
+          "type": "A String", # Required. The monitored resource type. This field must match the `type` field of a MonitoredResourceDescriptor object. For example, the type of a Compute Engine VM instance is `gce_instance`. Some descriptors include the service name in the type; for example, the type of a Datastream stream is `datastream.googleapis.com/Stream`.
+        },
+        "unit": "A String", # The units in which the metric value is reported. It is only applicable if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit` defines the representation of the stored metric values. This field can only be changed through CreateTimeSeries when it is empty.
+        "valueType": "A String", # The value type of the time series. When listing time series, this value type might be different from the value type of the associated metric if this time series is an alignment or reduction of other time series. When creating a time series, this field is optional. If present, it must be the same as the type of the data in the `points` field.
+      },
+    },
+  },
+  "state": "A String", # Output only. The state of the response.
+}
+
+ +
+ removeDedicatedCrawlRate(location, body=None, x__xgafv=None) +
Removes the dedicated crawl rate for a craw_rate_scope. If the dedicated crawl rate was set, this will disable vertex AI's crawl bot from using the dedicated crawl rate for crawling. If the dedicated crawl rate was not set, this is a no-op.
+
+Args:
+  location: string, Required. The location resource where crawl rate management will be performed. Format: `projects/{project}/locations/{location}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for CrawlRateManagementService.RemoveDedicatedCrawlRate method. The user can remove the dedicated crawl rate for a crawl_rate_scope they own, and Google will fall back to organic crawl, and the crawl rate will be determined by Google.
+  "crawlRateScope": "A String", # Required. The scope of the crawl rate change. Currently, only domain and host name are supported. A domain name example: `example.com`. A host name example: `www.example.com`. Please do not include `/` in the domain or host name.
+}
+
+  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.
+  },
+}
+
+ +
+ setDedicatedCrawlRate(location, body=None, x__xgafv=None) +
Sets the dedicated crawl rate for a crawl_rate_scope. If the dedicated crawl rate was not set, this will enable vertex AI's crawl bot to use the new dedicated crawl rate for crawling. If the dedicated crawl rate was set, vertex AI's crawl bot will try to update the rate to the new value. If the new value is too high, the crawl bot may crawl at a lower rate to avoid overloading the user's website.
+
+Args:
+  location: string, Required. The location resource where crawl rate management will be performed. Format: `projects/{project}/locations/{location}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for CrawlRateManagementService.SetDedicatedCrawlRate method. The user can set the crawl rate for a crawl_rate_scope they own. They can set up an overall crawl rate, or set up a user-triggered crawl rate and a auto-refresh crawl rate separately. If an overall crawl rate is set, Vertex AI will automatically splits crawl_rate into user-triggered and auto-refresh.
+  "crawlRate": 42, # Optional. The crawl QPS set by the user. It is not guaranteed that Vertex crawl bot will crawl at this QPS. If the crawl rate is too high, the real QPS may be lower than the value set by the user to avoid overloading the user's website.
+  "crawlRateScope": "A String", # Required. The scope of the crawl rate that the user wants to config. Currently, only domain and host name are supported. A domain name example: `example.com`. A host name example: `www.example.com`. Please do not include `/` in the domain or host name.
+  "crawlType": "A String", # Optional. Whether it's the crawl rate of user-triggered or auto-refresh.
+  "mode": "A String", # Optional. Whether the rate is explicitly set by users, or set by vertex AI.
+}
+
+  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.
+  },
+}
+
+ \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json index 14c8c41c007..bfc85cd97ae 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json @@ -2317,6 +2317,94 @@ } } }, +"sitemaps": { +"methods": { +"create": { +"description": "Creates a Sitemap.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.sitemaps.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. Parent resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/sitemaps", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1Sitemap" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a Sitemap.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps/{sitemapsId}", +"httpMethod": "DELETE", +"id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.sitemaps.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Full resource name of Sitemap, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}`. If the caller does not have permission to access the Sitemap, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Sitemap does not exist, a NOT_FOUND error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine/sitemaps/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"fetch": { +"description": "Fetch Sitemaps in a DataStore.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps:fetch", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.sitemaps.fetch", +"parameterOrder": [ +"parent" +], +"parameters": { +"matcher.urisMatcher.uris": { +"description": "The Sitemap uris.", +"location": "query", +"repeated": true, +"type": "string" +}, +"parent": { +"description": "Required. Parent resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/sitemaps:fetch", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1FetchSitemapsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "targetSites": { "methods": { "batchCreate": { @@ -5582,6 +5670,94 @@ } }, "resources": { +"sitemaps": { +"methods": { +"create": { +"description": "Creates a Sitemap.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.sitemaps.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. Parent resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/sitemaps", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1Sitemap" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a Sitemap.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps/{sitemapsId}", +"httpMethod": "DELETE", +"id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.sitemaps.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Full resource name of Sitemap, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}`. If the caller does not have permission to access the Sitemap, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Sitemap does not exist, a NOT_FOUND error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine/sitemaps/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"fetch": { +"description": "Fetch Sitemaps in a DataStore.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps:fetch", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.sitemaps.fetch", +"parameterOrder": [ +"parent" +], +"parameters": { +"matcher.urisMatcher.uris": { +"description": "The Sitemap uris.", +"location": "query", +"repeated": true, +"type": "string" +}, +"parent": { +"description": "Required. Parent resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/sitemaps:fetch", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1FetchSitemapsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "targetSites": { "methods": { "batchCreate": { @@ -6594,7 +6770,7 @@ } } }, -"revision": "20250211", +"revision": "20250214", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiDistribution": { @@ -7147,7 +7323,7 @@ "id": "GoogleCloudDiscoveryengineV1AnswerCitation", "properties": { "endIndex": { -"description": "End of the attributed segment, exclusive.", +"description": "End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length.", "format": "int64", "type": "string" }, @@ -7159,7 +7335,7 @@ "type": "array" }, "startIndex": { -"description": "Index indicates the start of the segment, measured in bytes (UTF-8 unicode).", +"description": "Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length.", "format": "int64", "type": "string" } @@ -7926,6 +8102,16 @@ }, "description": "Structured search data.", "type": "object" +}, +"title": { +"description": "Output only. The title of the document.", +"readOnly": true, +"type": "string" +}, +"uri": { +"description": "Output only. The URI of the document.", +"readOnly": true, +"type": "string" } }, "type": "object" @@ -9336,6 +9522,23 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1CreateSitemapMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.CreateSitemap operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1CreateSitemapMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata": { "description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata", @@ -9500,7 +9703,7 @@ "type": "string" }, "defaultSchemaId": { -"description": "Output only. The id of the default Schema asscociated to this data store.", +"description": "Output only. The id of the default Schema associated to this data store.", "readOnly": true, "type": "string" }, @@ -9516,6 +9719,10 @@ "$ref": "GoogleCloudDiscoveryengineV1HealthcareFhirConfig", "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical." }, +"identityMappingStore": { +"description": "Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`.", +"type": "string" +}, "industryVertical": { "description": "Immutable. The industry vertical that the data store registers.", "enum": [ @@ -9713,6 +9920,23 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1DeleteSitemapMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.DeleteSitemap operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1DeleteSitemapMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata": { "description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata", @@ -10269,6 +10493,31 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1FetchSitemapsResponse": { +"description": "Response message for SiteSearchEngineService.FetchSitemaps method.", +"id": "GoogleCloudDiscoveryengineV1FetchSitemapsResponse", +"properties": { +"sitemapsMetadata": { +"description": "List of Sitemaps fetched.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1FetchSitemapsResponseSitemapMetadata" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1FetchSitemapsResponseSitemapMetadata": { +"description": "Contains a Sitemap and its metadata.", +"id": "GoogleCloudDiscoveryengineV1FetchSitemapsResponseSitemapMetadata", +"properties": { +"sitemap": { +"$ref": "GoogleCloudDiscoveryengineV1Sitemap", +"description": "The Sitemap." +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1FhirStoreSource": { "description": "Cloud FhirStore source import data from.", "id": "GoogleCloudDiscoveryengineV1FhirStoreSource", @@ -12826,7 +13075,7 @@ "type": "string" }, "searchResultPersistenceCount": { -"description": "The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode.", +"description": "The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode.", "format": "int32", "type": "integer" } @@ -13486,6 +13735,28 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1Sitemap": { +"description": "A sitemap for the SiteSearchEngine.", +"id": "GoogleCloudDiscoveryengineV1Sitemap", +"properties": { +"createTime": { +"description": "Output only. The sitemap's creation time.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Output only. The fully qualified resource name of the sitemap. `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/sitemaps/*` The `sitemap_id` suffix is system-generated.", +"readOnly": true, +"type": "string" +}, +"uri": { +"description": "Public URI for the sitemap, e.g. `www.example.com/sitemap.xml`.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1SpannerSource": { "description": "The Spanner source for importing data", "id": "GoogleCloudDiscoveryengineV1SpannerSource", @@ -14191,7 +14462,7 @@ "id": "GoogleCloudDiscoveryengineV1alphaAnswerCitation", "properties": { "endIndex": { -"description": "End of the attributed segment, exclusive.", +"description": "End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length.", "format": "int64", "type": "string" }, @@ -14203,7 +14474,7 @@ "type": "array" }, "startIndex": { -"description": "Index indicates the start of the segment, measured in bytes (UTF-8 unicode).", +"description": "Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length.", "format": "int64", "type": "string" } @@ -14386,6 +14657,16 @@ }, "description": "Structured search data.", "type": "object" +}, +"title": { +"description": "Output only. The title of the document.", +"readOnly": true, +"type": "string" +}, +"uri": { +"description": "Output only. The URI of the document.", +"readOnly": true, +"type": "string" } }, "type": "object" @@ -15558,7 +15839,7 @@ "type": "string" }, "defaultSchemaId": { -"description": "Output only. The id of the default Schema asscociated to this data store.", +"description": "Output only. The id of the default Schema associated to this data store.", "readOnly": true, "type": "string" }, @@ -15574,6 +15855,10 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig", "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical." }, +"identityMappingStore": { +"description": "Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`.", +"type": "string" +}, "idpConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfig", "description": "Output only. Data store level identity provider config.", @@ -16474,31 +16759,6 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse": { -"description": "Response message for SiteSearchEngineService.FetchSitemaps method.", -"id": "GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse", -"properties": { -"sitemapsMetadata": { -"description": "List of Sitemaps fetched.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata" -}, -"type": "array" -} -}, -"type": "object" -}, -"GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata": { -"description": "Contains a Sitemap and its metadata.", -"id": "GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata", -"properties": { -"sitemap": { -"$ref": "GoogleCloudDiscoveryengineV1alphaSitemap", -"description": "The Sitemap." -} -}, -"type": "object" -}, "GoogleCloudDiscoveryengineV1alphaFieldConfig": { "description": "Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.", "id": "GoogleCloudDiscoveryengineV1alphaFieldConfig", @@ -18564,7 +18824,7 @@ "type": "string" }, "searchResultPersistenceCount": { -"description": "The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode.", +"description": "The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode.", "format": "int32", "type": "integer" } @@ -19508,6 +19768,17 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries": { +"description": "The historical crawl rate timeseries data, used for monitoring.", +"id": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries", +"properties": { +"qpsTimeSeries": { +"$ref": "GoogleMonitoringV3TimeSeries", +"description": "The QPS of the crawl rate." +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata": { "description": "Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata", @@ -19642,7 +19913,7 @@ "type": "string" }, "defaultSchemaId": { -"description": "Output only. The id of the default Schema asscociated to this data store.", +"description": "Output only. The id of the default Schema associated to this data store.", "readOnly": true, "type": "string" }, @@ -19658,6 +19929,10 @@ "$ref": "GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig", "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical." }, +"identityMappingStore": { +"description": "Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`.", +"type": "string" +}, "industryVertical": { "description": "Immutable. The industry vertical that the data store registers.", "enum": [ @@ -19778,6 +20053,21 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries": { +"description": "The historical dedicated crawl rate timeseries data, used for monitoring. Dedicated crawl is used by Vertex AI to crawl the user's website when dedicate crawl is set.", +"id": "GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries", +"properties": { +"autoRefreshCrawlRate": { +"$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries", +"description": "Vertex AI's dedicated crawl rate time series of auto-refresh, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and the crawl rate is for best effort use cases like refreshing urls periodically." +}, +"userTriggeredCrawlRate": { +"$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries", +"description": "Vertex AI's dedicated crawl rate time series of user triggered crawl, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and user triggered crawl rate is for deterministic use cases like crawling urls or sitemaps specified by users." +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata": { "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata", @@ -20304,31 +20594,6 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaFetchSitemapsResponse": { -"description": "Response message for SiteSearchEngineService.FetchSitemaps method.", -"id": "GoogleCloudDiscoveryengineV1betaFetchSitemapsResponse", -"properties": { -"sitemapsMetadata": { -"description": "List of Sitemaps fetched.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1betaFetchSitemapsResponseSitemapMetadata" -}, -"type": "array" -} -}, -"type": "object" -}, -"GoogleCloudDiscoveryengineV1betaFetchSitemapsResponseSitemapMetadata": { -"description": "Contains a Sitemap and its metadata.", -"id": "GoogleCloudDiscoveryengineV1betaFetchSitemapsResponseSitemapMetadata", -"properties": { -"sitemap": { -"$ref": "GoogleCloudDiscoveryengineV1betaSitemap", -"description": "The Sitemap." -} -}, -"type": "object" -}, "GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig": { "description": "Config to data store for `HEALTHCARE_FHIR` vertical.", "id": "GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig", @@ -20706,6 +20971,55 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse": { +"description": "Response message for CrawlRateManagementService.ObtainCrawlRate method. The response contains organcic or dedicated crawl rate time series data for monitoring, depending on whether dedicated crawl rate is set.", +"id": "GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse", +"properties": { +"dedicatedCrawlRateTimeSeries": { +"$ref": "GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries", +"description": "The historical dedicated crawl rate timeseries data, used for monitoring." +}, +"error": { +"$ref": "GoogleRpcStatus", +"description": "Errors from service when handling the request." +}, +"organicCrawlRateTimeSeries": { +"$ref": "GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries", +"description": "The historical organic crawl rate timeseries data, used for monitoring." +}, +"state": { +"description": "Output only. The state of the response.", +"enum": [ +"STATE_UNSPECIFIED", +"SUCCEEDED", +"FAILED" +], +"enumDescriptions": [ +"The state is unspecified.", +"The state is successful.", +"The state is failed." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries": { +"description": "The historical organic crawl rate timeseries data, used for monitoring. Organic crawl is auto-determined by Google to crawl the user's website when dedicate crawl is not set. Crawl rate is the QPS of crawl request Google sends to the user's website.", +"id": "GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries", +"properties": { +"googleOrganicCrawlRate": { +"$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries", +"description": "Google's organic crawl rate time series, which is the sum of all googlebots' crawl rate. Please refer to https://developers.google.com/search/docs/crawling-indexing/overview-google-crawlers for more details about googlebots." +}, +"vertexAiOrganicCrawlRate": { +"$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries", +"description": "Vertex AI's organic crawl rate time series, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is not set. Please refer to https://developers.google.com/search/docs/crawling-indexing/google-common-crawlers#google-cloudvertexbot for more details about Google-CloudVertexBot." +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaProject": { "description": "Metadata and configurations for a Google Cloud project in the service.", "id": "GoogleCloudDiscoveryengineV1betaProject", @@ -20926,6 +21240,49 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata": { +"description": "Metadata related to the progress of the CrawlRateManagementService.RemoveDedicatedCrawlRate operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse": { +"description": "Response message for CrawlRateManagementService.RemoveDedicatedCrawlRate method. It simply returns the state of the response, and an error message if the state is FAILED.", +"id": "GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse", +"properties": { +"error": { +"$ref": "GoogleRpcStatus", +"description": "Errors from service when handling the request." +}, +"state": { +"description": "Output only. The state of the response.", +"enum": [ +"STATE_UNSPECIFIED", +"SUCCEEDED", +"FAILED" +], +"enumDescriptions": [ +"The state is unspecified.", +"The state is successful.", +"The state is failed." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaSchema": { "description": "Defines the structure and layout of a type of document data.", "id": "GoogleCloudDiscoveryengineV1betaSchema", @@ -21668,7 +22025,7 @@ "type": "string" }, "searchResultPersistenceCount": { -"description": "The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode.", +"description": "The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode.", "format": "int32", "type": "integer" } @@ -21696,6 +22053,49 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata": { +"description": "Metadata related to the progress of the CrawlRateManagementService.SetDedicatedCrawlRate operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse": { +"description": "Response message for CrawlRateManagementService.SetDedicatedCrawlRate method. It simply returns the state of the response, and an error message if the state is FAILED.", +"id": "GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse", +"properties": { +"error": { +"$ref": "GoogleRpcStatus", +"description": "Errors from service when handling the request." +}, +"state": { +"description": "Output only. The state of the response.", +"enum": [ +"STATE_UNSPECIFIED", +"SUCCEEDED", +"FAILED" +], +"enumDescriptions": [ +"The state is unspecified.", +"The state is successful.", +"The state is failed." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaSingleRegionKey": { "description": "Metadata for single-regional CMEKs.", "id": "GoogleCloudDiscoveryengineV1betaSingleRegionKey", diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json index 79c59d405df..27581cfa9aa 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json @@ -4,6 +4,9 @@ "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." +}, +"https://www.googleapis.com/auth/cloud_search.query": { +"description": "Search your organization's data in the Cloud Search index" } } } @@ -1830,7 +1833,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud_search.query" ] } } @@ -4199,6 +4203,35 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponse" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud_search.query" +] +}, +"removeSuggestion": { +"description": "Removes the search history suggestion in an engine for a user. This will remove the suggestion from being returned in the AdvancedCompleteQueryResponse.recent_search_suggestions for this user. If the user searches the same suggestion again, the new history will override and suggest this suggestion again.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/completionConfig:removeSuggestion", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.collections.engines.completionConfig.removeSuggestion", +"parameterOrder": [ +"completionConfig" +], +"parameters": { +"completionConfig": { +"description": "Required. The completion_config of the parent engine resource name for which the search history suggestion is to be removed, such as `projects/*/locations/global/collections/default_collection/engines/*/completionConfig`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/completionConfig$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+completionConfig}:removeSuggestion", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaRemoveSuggestionRequest" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaRemoveSuggestionResponse" +}, +"scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } @@ -5990,7 +6023,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud_search.query" ] } } @@ -8977,7 +9011,7 @@ } } }, -"revision": "20250211", +"revision": "20250214", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "ApiservingMediaRequestInfo": { @@ -10380,6 +10414,23 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1CreateSitemapMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.CreateSitemap operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1CreateSitemapMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata": { "description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata", @@ -10440,7 +10491,7 @@ "type": "string" }, "defaultSchemaId": { -"description": "Output only. The id of the default Schema asscociated to this data store.", +"description": "Output only. The id of the default Schema associated to this data store.", "readOnly": true, "type": "string" }, @@ -10456,6 +10507,10 @@ "$ref": "GoogleCloudDiscoveryengineV1HealthcareFhirConfig", "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical." }, +"identityMappingStore": { +"description": "Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`.", +"type": "string" +}, "industryVertical": { "description": "Immutable. The industry vertical that the data store registers.", "enum": [ @@ -10653,6 +10708,23 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1DeleteSitemapMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.DeleteSitemap operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1DeleteSitemapMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata": { "description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata", @@ -11894,6 +11966,28 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1Sitemap": { +"description": "A sitemap for the SiteSearchEngine.", +"id": "GoogleCloudDiscoveryengineV1Sitemap", +"properties": { +"createTime": { +"description": "Output only. The sitemap's creation time.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Output only. The fully qualified resource name of the sitemap. `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/sitemaps/*` The `sitemap_id` suffix is system-generated.", +"readOnly": true, +"type": "string" +}, +"uri": { +"description": "Public URI for the sitemap, e.g. `www.example.com/sitemap.xml`.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1TargetSite": { "description": "A target site for the SiteSearchEngine.", "id": "GoogleCloudDiscoveryengineV1TargetSite", @@ -12195,7 +12289,7 @@ "type": "string" }, "queryModel": { -"description": "Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.", +"description": "Specifies the autocomplete query model, which only applies to the QUERY SuggestionType. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.", "type": "string" }, "suggestionTypeSpecs": { @@ -12625,7 +12719,7 @@ "id": "GoogleCloudDiscoveryengineV1alphaAnswerCitation", "properties": { "endIndex": { -"description": "End of the attributed segment, exclusive.", +"description": "End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length.", "format": "int64", "type": "string" }, @@ -12637,7 +12731,7 @@ "type": "array" }, "startIndex": { -"description": "Index indicates the start of the segment, measured in bytes (UTF-8 unicode).", +"description": "Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length.", "format": "int64", "type": "string" } @@ -13412,6 +13506,16 @@ }, "description": "Structured search data.", "type": "object" +}, +"title": { +"description": "Output only. The title of the document.", +"readOnly": true, +"type": "string" +}, +"uri": { +"description": "Output only. The URI of the document.", +"readOnly": true, +"type": "string" } }, "type": "object" @@ -15540,7 +15644,7 @@ "type": "string" }, "defaultSchemaId": { -"description": "Output only. The id of the default Schema asscociated to this data store.", +"description": "Output only. The id of the default Schema associated to this data store.", "readOnly": true, "type": "string" }, @@ -15556,6 +15660,10 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig", "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical." }, +"identityMappingStore": { +"description": "Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`.", +"type": "string" +}, "idpConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfig", "description": "Output only. Data store level identity provider config.", @@ -19634,6 +19742,40 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaRemoveSuggestionRequest": { +"description": "Request message for CompletionService.RemoveSuggestion method.", +"id": "GoogleCloudDiscoveryengineV1alphaRemoveSuggestionRequest", +"properties": { +"removeAllSearchHistorySuggestions": { +"description": "Remove all search history suggestions for the user.", +"type": "boolean" +}, +"removeTime": { +"description": "Optional. Time at which the suggestion was removed. If not set, the current time will be used.", +"format": "google-datetime", +"type": "string" +}, +"searchHistorySuggestion": { +"description": "The search history suggestion to be removed.", +"type": "string" +}, +"userInfo": { +"$ref": "GoogleCloudDiscoveryengineV1alphaUserInfo", +"description": "Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info." +}, +"userPseudoId": { +"description": "Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaRemoveSuggestionResponse": { +"description": "Response message for CompletionService.RemoveSuggestion method.", +"id": "GoogleCloudDiscoveryengineV1alphaRemoveSuggestionResponse", +"properties": {}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaReply": { "description": "Defines a reply message to user.", "id": "GoogleCloudDiscoveryengineV1alphaReply", @@ -20822,7 +20964,7 @@ "type": "string" }, "searchResultPersistenceCount": { -"description": "The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode.", +"description": "The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode.", "format": "int32", "type": "integer" } @@ -22879,7 +23021,7 @@ "id": "GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent", "properties": { "contentConfig": { -"description": "The content config of the data store.", +"description": "Output only. The content config of the data store.", "enum": [ "CONTENT_CONFIG_UNSPECIFIED", "NO_CONTENT", @@ -22894,6 +23036,7 @@ "The data store is used for public website search.", "The data store is used for workspace search. Details of workspace data store are specified in the WorkspaceConfig." ], +"readOnly": true, "type": "string" }, "displayName": { @@ -22912,6 +23055,33 @@ "name": { "description": "The name of the data store. It should be data store resource name Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. For APIs under WidgetService, such as WidgetService.LookUpWidgetConfig, the project number and location part is erased in this field.", "type": "string" +}, +"workspaceType": { +"description": "Output only. Workspace Source Types for workspace data, retrieved from `DataStore.workspace_config.type`.", +"enum": [ +"TYPE_UNSPECIFIED", +"GOOGLE_DRIVE", +"GOOGLE_MAIL", +"GOOGLE_SITES", +"GOOGLE_CALENDAR", +"GOOGLE_CHAT", +"GOOGLE_GROUPS", +"GOOGLE_KEEP", +"GOOGLE_PEOPLE" +], +"enumDescriptions": [ +"Defaults to an unspecified Workspace type.", +"Workspace Data Store contains Drive data", +"Workspace Data Store contains Mail data", +"Workspace Data Store contains Sites data", +"Workspace Data Store contains Calendar data", +"Workspace Data Store contains Chat data", +"Workspace Data Store contains Groups data", +"Workspace Data Store contains Keep data", +"Workspace Data Store contains People data" +], +"readOnly": true, +"type": "string" } }, "type": "object" @@ -23609,6 +23779,17 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries": { +"description": "The historical crawl rate timeseries data, used for monitoring.", +"id": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries", +"properties": { +"qpsTimeSeries": { +"$ref": "GoogleMonitoringV3TimeSeries", +"description": "The QPS of the crawl rate." +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata": { "description": "Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata", @@ -23743,7 +23924,7 @@ "type": "string" }, "defaultSchemaId": { -"description": "Output only. The id of the default Schema asscociated to this data store.", +"description": "Output only. The id of the default Schema associated to this data store.", "readOnly": true, "type": "string" }, @@ -23759,6 +23940,10 @@ "$ref": "GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig", "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical." }, +"identityMappingStore": { +"description": "Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`.", +"type": "string" +}, "industryVertical": { "description": "Immutable. The industry vertical that the data store registers.", "enum": [ @@ -23879,6 +24064,21 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries": { +"description": "The historical dedicated crawl rate timeseries data, used for monitoring. Dedicated crawl is used by Vertex AI to crawl the user's website when dedicate crawl is set.", +"id": "GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries", +"properties": { +"autoRefreshCrawlRate": { +"$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries", +"description": "Vertex AI's dedicated crawl rate time series of auto-refresh, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and the crawl rate is for best effort use cases like refreshing urls periodically." +}, +"userTriggeredCrawlRate": { +"$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries", +"description": "Vertex AI's dedicated crawl rate time series of user triggered crawl, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and user triggered crawl rate is for deterministic use cases like crawling urls or sitemaps specified by users." +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata": { "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata", @@ -24405,31 +24605,6 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaFetchSitemapsResponse": { -"description": "Response message for SiteSearchEngineService.FetchSitemaps method.", -"id": "GoogleCloudDiscoveryengineV1betaFetchSitemapsResponse", -"properties": { -"sitemapsMetadata": { -"description": "List of Sitemaps fetched.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1betaFetchSitemapsResponseSitemapMetadata" -}, -"type": "array" -} -}, -"type": "object" -}, -"GoogleCloudDiscoveryengineV1betaFetchSitemapsResponseSitemapMetadata": { -"description": "Contains a Sitemap and its metadata.", -"id": "GoogleCloudDiscoveryengineV1betaFetchSitemapsResponseSitemapMetadata", -"properties": { -"sitemap": { -"$ref": "GoogleCloudDiscoveryengineV1betaSitemap", -"description": "The Sitemap." -} -}, -"type": "object" -}, "GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig": { "description": "Config to data store for `HEALTHCARE_FHIR` vertical.", "id": "GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig", @@ -24807,6 +24982,55 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse": { +"description": "Response message for CrawlRateManagementService.ObtainCrawlRate method. The response contains organcic or dedicated crawl rate time series data for monitoring, depending on whether dedicated crawl rate is set.", +"id": "GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse", +"properties": { +"dedicatedCrawlRateTimeSeries": { +"$ref": "GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries", +"description": "The historical dedicated crawl rate timeseries data, used for monitoring." +}, +"error": { +"$ref": "GoogleRpcStatus", +"description": "Errors from service when handling the request." +}, +"organicCrawlRateTimeSeries": { +"$ref": "GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries", +"description": "The historical organic crawl rate timeseries data, used for monitoring." +}, +"state": { +"description": "Output only. The state of the response.", +"enum": [ +"STATE_UNSPECIFIED", +"SUCCEEDED", +"FAILED" +], +"enumDescriptions": [ +"The state is unspecified.", +"The state is successful.", +"The state is failed." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries": { +"description": "The historical organic crawl rate timeseries data, used for monitoring. Organic crawl is auto-determined by Google to crawl the user's website when dedicate crawl is not set. Crawl rate is the QPS of crawl request Google sends to the user's website.", +"id": "GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries", +"properties": { +"googleOrganicCrawlRate": { +"$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries", +"description": "Google's organic crawl rate time series, which is the sum of all googlebots' crawl rate. Please refer to https://developers.google.com/search/docs/crawling-indexing/overview-google-crawlers for more details about googlebots." +}, +"vertexAiOrganicCrawlRate": { +"$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries", +"description": "Vertex AI's organic crawl rate time series, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is not set. Please refer to https://developers.google.com/search/docs/crawling-indexing/google-common-crawlers#google-cloudvertexbot for more details about Google-CloudVertexBot." +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaProject": { "description": "Metadata and configurations for a Google Cloud project in the service.", "id": "GoogleCloudDiscoveryengineV1betaProject", @@ -25027,6 +25251,49 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata": { +"description": "Metadata related to the progress of the CrawlRateManagementService.RemoveDedicatedCrawlRate operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse": { +"description": "Response message for CrawlRateManagementService.RemoveDedicatedCrawlRate method. It simply returns the state of the response, and an error message if the state is FAILED.", +"id": "GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse", +"properties": { +"error": { +"$ref": "GoogleRpcStatus", +"description": "Errors from service when handling the request." +}, +"state": { +"description": "Output only. The state of the response.", +"enum": [ +"STATE_UNSPECIFIED", +"SUCCEEDED", +"FAILED" +], +"enumDescriptions": [ +"The state is unspecified.", +"The state is successful.", +"The state is failed." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaSchema": { "description": "Defines the structure and layout of a type of document data.", "id": "GoogleCloudDiscoveryengineV1betaSchema", @@ -25769,7 +26036,7 @@ "type": "string" }, "searchResultPersistenceCount": { -"description": "The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode.", +"description": "The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode.", "format": "int32", "type": "integer" } @@ -25797,6 +26064,49 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata": { +"description": "Metadata related to the progress of the CrawlRateManagementService.SetDedicatedCrawlRate operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse": { +"description": "Response message for CrawlRateManagementService.SetDedicatedCrawlRate method. It simply returns the state of the response, and an error message if the state is FAILED.", +"id": "GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse", +"properties": { +"error": { +"$ref": "GoogleRpcStatus", +"description": "Errors from service when handling the request." +}, +"state": { +"description": "Output only. The state of the response.", +"enum": [ +"STATE_UNSPECIFIED", +"SUCCEEDED", +"FAILED" +], +"enumDescriptions": [ +"The state is unspecified.", +"The state is successful.", +"The state is failed." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaSingleRegionKey": { "description": "Metadata for single-regional CMEKs.", "id": "GoogleCloudDiscoveryengineV1betaSingleRegionKey", diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json index 6b0338ca3f1..c8718c7048e 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json @@ -188,6 +188,90 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"obtainCrawlRate": { +"description": "Obtains the time series data of organic or dedicated crawl rate for monitoring. When dedicated crawl rate is not set, it will return vertex AI's organic crawl rate time series. Organic crawl means Google automatically crawl the internet at its own convenience. When dedicated crawl rate is set, it will return vertex AI's dedicated crawl rate time series.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}:obtainCrawlRate", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.obtainCrawlRate", +"parameterOrder": [ +"location" +], +"parameters": { +"location": { +"description": "Required. The location resource where crawl rate management will be performed. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+location}:obtainCrawlRate", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1betaObtainCrawlRateRequest" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"removeDedicatedCrawlRate": { +"description": "Removes the dedicated crawl rate for a craw_rate_scope. If the dedicated crawl rate was set, this will disable vertex AI's crawl bot from using the dedicated crawl rate for crawling. If the dedicated crawl rate was not set, this is a no-op.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}:removeDedicatedCrawlRate", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.removeDedicatedCrawlRate", +"parameterOrder": [ +"location" +], +"parameters": { +"location": { +"description": "Required. The location resource where crawl rate management will be performed. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+location}:removeDedicatedCrawlRate", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"setDedicatedCrawlRate": { +"description": "Sets the dedicated crawl rate for a crawl_rate_scope. If the dedicated crawl rate was not set, this will enable vertex AI's crawl bot to use the new dedicated crawl rate for crawling. If the dedicated crawl rate was set, vertex AI's crawl bot will try to update the rate to the new value. If the new value is too high, the crawl bot may crawl at a lower rate to avoid overloading the user's website.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}:setDedicatedCrawlRate", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.setDedicatedCrawlRate", +"parameterOrder": [ +"location" +], +"parameters": { +"location": { +"description": "Required. The location resource where crawl rate management will be performed. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+location}:setDedicatedCrawlRate", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } }, "resources": { @@ -3217,6 +3301,34 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"removeSuggestion": { +"description": "Removes the search history suggestion in an engine for a user. This will remove the suggestion from being returned in the AdvancedCompleteQueryResponse.recent_search_suggestions for this user. If the user searches the same suggestion again, the new history will override and suggest this suggestion again.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/completionConfig:removeSuggestion", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.collections.engines.completionConfig.removeSuggestion", +"parameterOrder": [ +"completionConfig" +], +"parameters": { +"completionConfig": { +"description": "Required. The completion_config of the parent engine resource name for which the search history suggestion is to be removed, such as `projects/*/locations/global/collections/default_collection/engines/*/completionConfig`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/completionConfig$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+completionConfig}:removeSuggestion", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1betaRemoveSuggestionRequest" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1betaRemoveSuggestionResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } } }, @@ -7638,7 +7750,7 @@ } } }, -"revision": "20250211", +"revision": "20250214", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiDistribution": { @@ -8459,6 +8571,23 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1CreateSitemapMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.CreateSitemap operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1CreateSitemapMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata": { "description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata", @@ -8519,7 +8648,7 @@ "type": "string" }, "defaultSchemaId": { -"description": "Output only. The id of the default Schema asscociated to this data store.", +"description": "Output only. The id of the default Schema associated to this data store.", "readOnly": true, "type": "string" }, @@ -8535,6 +8664,10 @@ "$ref": "GoogleCloudDiscoveryengineV1HealthcareFhirConfig", "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical." }, +"identityMappingStore": { +"description": "Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`.", +"type": "string" +}, "industryVertical": { "description": "Immutable. The industry vertical that the data store registers.", "enum": [ @@ -8732,6 +8865,23 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1DeleteSitemapMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.DeleteSitemap operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1DeleteSitemapMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata": { "description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata", @@ -9973,6 +10123,28 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1Sitemap": { +"description": "A sitemap for the SiteSearchEngine.", +"id": "GoogleCloudDiscoveryengineV1Sitemap", +"properties": { +"createTime": { +"description": "Output only. The sitemap's creation time.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Output only. The fully qualified resource name of the sitemap. `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/sitemaps/*` The `sitemap_id` suffix is system-generated.", +"readOnly": true, +"type": "string" +}, +"uri": { +"description": "Public URI for the sitemap, e.g. `www.example.com/sitemap.xml`.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1TargetSite": { "description": "A target site for the SiteSearchEngine.", "id": "GoogleCloudDiscoveryengineV1TargetSite", @@ -10404,7 +10576,7 @@ "id": "GoogleCloudDiscoveryengineV1alphaAnswerCitation", "properties": { "endIndex": { -"description": "End of the attributed segment, exclusive.", +"description": "End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length.", "format": "int64", "type": "string" }, @@ -10416,7 +10588,7 @@ "type": "array" }, "startIndex": { -"description": "Index indicates the start of the segment, measured in bytes (UTF-8 unicode).", +"description": "Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length.", "format": "int64", "type": "string" } @@ -10599,6 +10771,16 @@ }, "description": "Structured search data.", "type": "object" +}, +"title": { +"description": "Output only. The title of the document.", +"readOnly": true, +"type": "string" +}, +"uri": { +"description": "Output only. The URI of the document.", +"readOnly": true, +"type": "string" } }, "type": "object" @@ -11771,7 +11953,7 @@ "type": "string" }, "defaultSchemaId": { -"description": "Output only. The id of the default Schema asscociated to this data store.", +"description": "Output only. The id of the default Schema associated to this data store.", "readOnly": true, "type": "string" }, @@ -11787,6 +11969,10 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig", "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical." }, +"identityMappingStore": { +"description": "Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`.", +"type": "string" +}, "idpConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfig", "description": "Output only. Data store level identity provider config.", @@ -12687,31 +12873,6 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse": { -"description": "Response message for SiteSearchEngineService.FetchSitemaps method.", -"id": "GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse", -"properties": { -"sitemapsMetadata": { -"description": "List of Sitemaps fetched.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata" -}, -"type": "array" -} -}, -"type": "object" -}, -"GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata": { -"description": "Contains a Sitemap and its metadata.", -"id": "GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata", -"properties": { -"sitemap": { -"$ref": "GoogleCloudDiscoveryengineV1alphaSitemap", -"description": "The Sitemap." -} -}, -"type": "object" -}, "GoogleCloudDiscoveryengineV1alphaFieldConfig": { "description": "Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.", "id": "GoogleCloudDiscoveryengineV1alphaFieldConfig", @@ -14777,7 +14938,7 @@ "type": "string" }, "searchResultPersistenceCount": { -"description": "The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode.", +"description": "The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode.", "format": "int32", "type": "integer" } @@ -15343,7 +15504,7 @@ "type": "string" }, "queryModel": { -"description": "Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.", +"description": "Specifies the autocomplete query model, which only applies to the QUERY SuggestionType. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.", "type": "string" }, "suggestionTypeSpecs": { @@ -15773,7 +15934,7 @@ "id": "GoogleCloudDiscoveryengineV1betaAnswerCitation", "properties": { "endIndex": { -"description": "End of the attributed segment, exclusive.", +"description": "End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length.", "format": "int64", "type": "string" }, @@ -15785,7 +15946,7 @@ "type": "array" }, "startIndex": { -"description": "Index indicates the start of the segment, measured in bytes (UTF-8 unicode).", +"description": "Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length.", "format": "int64", "type": "string" } @@ -16556,6 +16717,16 @@ }, "description": "Structured search data.", "type": "object" +}, +"title": { +"description": "Output only. The title of the document.", +"readOnly": true, +"type": "string" +}, +"uri": { +"description": "Output only. The URI of the document.", +"readOnly": true, +"type": "string" } }, "type": "object" @@ -17922,6 +18093,17 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries": { +"description": "The historical crawl rate timeseries data, used for monitoring.", +"id": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries", +"properties": { +"qpsTimeSeries": { +"$ref": "GoogleMonitoringV3TimeSeries", +"description": "The QPS of the crawl rate." +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata": { "description": "Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata", @@ -18160,7 +18342,7 @@ "type": "string" }, "defaultSchemaId": { -"description": "Output only. The id of the default Schema asscociated to this data store.", +"description": "Output only. The id of the default Schema associated to this data store.", "readOnly": true, "type": "string" }, @@ -18176,6 +18358,10 @@ "$ref": "GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig", "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical." }, +"identityMappingStore": { +"description": "Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`.", +"type": "string" +}, "industryVertical": { "description": "Immutable. The industry vertical that the data store registers.", "enum": [ @@ -18296,6 +18482,21 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries": { +"description": "The historical dedicated crawl rate timeseries data, used for monitoring. Dedicated crawl is used by Vertex AI to crawl the user's website when dedicate crawl is set.", +"id": "GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries", +"properties": { +"autoRefreshCrawlRate": { +"$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries", +"description": "Vertex AI's dedicated crawl rate time series of auto-refresh, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and the crawl rate is for best effort use cases like refreshing urls periodically." +}, +"userTriggeredCrawlRate": { +"$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries", +"description": "Vertex AI's dedicated crawl rate time series of user triggered crawl, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and user triggered crawl rate is for deterministic use cases like crawling urls or sitemaps specified by users." +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata": { "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata", @@ -20577,6 +20778,66 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaObtainCrawlRateRequest": { +"description": "Request message for CrawlRateManagementService.ObtainCrawlRate method.", +"id": "GoogleCloudDiscoveryengineV1betaObtainCrawlRateRequest", +"properties": { +"crawlRateScope": { +"description": "Required. The scope of the crawl rate that the user wants to monitor. Currently, only domain and host name are supported. A domain name example: `example.com`. A host name example: `www.example.com`. Please do not include `/` in the domain or host name.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse": { +"description": "Response message for CrawlRateManagementService.ObtainCrawlRate method. The response contains organcic or dedicated crawl rate time series data for monitoring, depending on whether dedicated crawl rate is set.", +"id": "GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse", +"properties": { +"dedicatedCrawlRateTimeSeries": { +"$ref": "GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries", +"description": "The historical dedicated crawl rate timeseries data, used for monitoring." +}, +"error": { +"$ref": "GoogleRpcStatus", +"description": "Errors from service when handling the request." +}, +"organicCrawlRateTimeSeries": { +"$ref": "GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries", +"description": "The historical organic crawl rate timeseries data, used for monitoring." +}, +"state": { +"description": "Output only. The state of the response.", +"enum": [ +"STATE_UNSPECIFIED", +"SUCCEEDED", +"FAILED" +], +"enumDescriptions": [ +"The state is unspecified.", +"The state is successful.", +"The state is failed." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries": { +"description": "The historical organic crawl rate timeseries data, used for monitoring. Organic crawl is auto-determined by Google to crawl the user's website when dedicate crawl is not set. Crawl rate is the QPS of crawl request Google sends to the user's website.", +"id": "GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries", +"properties": { +"googleOrganicCrawlRate": { +"$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries", +"description": "Google's organic crawl rate time series, which is the sum of all googlebots' crawl rate. Please refer to https://developers.google.com/search/docs/crawling-indexing/overview-google-crawlers for more details about googlebots." +}, +"vertexAiOrganicCrawlRate": { +"$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries", +"description": "Vertex AI's organic crawl rate time series, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is not set. Please refer to https://developers.google.com/search/docs/crawling-indexing/google-common-crawlers#google-cloudvertexbot for more details about Google-CloudVertexBot." +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaPageInfo": { "description": "Detailed page information.", "id": "GoogleCloudDiscoveryengineV1betaPageInfo", @@ -21183,6 +21444,94 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata": { +"description": "Metadata related to the progress of the CrawlRateManagementService.RemoveDedicatedCrawlRate operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateRequest": { +"description": "Request message for CrawlRateManagementService.RemoveDedicatedCrawlRate method. The user can remove the dedicated crawl rate for a crawl_rate_scope they own, and Google will fall back to organic crawl, and the crawl rate will be determined by Google.", +"id": "GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateRequest", +"properties": { +"crawlRateScope": { +"description": "Required. The scope of the crawl rate change. Currently, only domain and host name are supported. A domain name example: `example.com`. A host name example: `www.example.com`. Please do not include `/` in the domain or host name.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse": { +"description": "Response message for CrawlRateManagementService.RemoveDedicatedCrawlRate method. It simply returns the state of the response, and an error message if the state is FAILED.", +"id": "GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse", +"properties": { +"error": { +"$ref": "GoogleRpcStatus", +"description": "Errors from service when handling the request." +}, +"state": { +"description": "Output only. The state of the response.", +"enum": [ +"STATE_UNSPECIFIED", +"SUCCEEDED", +"FAILED" +], +"enumDescriptions": [ +"The state is unspecified.", +"The state is successful.", +"The state is failed." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaRemoveSuggestionRequest": { +"description": "Request message for CompletionService.RemoveSuggestion method.", +"id": "GoogleCloudDiscoveryengineV1betaRemoveSuggestionRequest", +"properties": { +"removeAllSearchHistorySuggestions": { +"description": "Remove all search history suggestions for the user.", +"type": "boolean" +}, +"removeTime": { +"description": "Optional. Time at which the suggestion was removed. If not set, the current time will be used.", +"format": "google-datetime", +"type": "string" +}, +"searchHistorySuggestion": { +"description": "The search history suggestion to be removed.", +"type": "string" +}, +"userInfo": { +"$ref": "GoogleCloudDiscoveryengineV1betaUserInfo", +"description": "Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info." +}, +"userPseudoId": { +"description": "Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaRemoveSuggestionResponse": { +"description": "Response message for CompletionService.RemoveSuggestion method.", +"id": "GoogleCloudDiscoveryengineV1betaRemoveSuggestionResponse", +"properties": {}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaReply": { "description": "Defines a reply message to user.", "id": "GoogleCloudDiscoveryengineV1betaReply", @@ -22172,7 +22521,7 @@ "type": "string" }, "searchResultPersistenceCount": { -"description": "The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode.", +"description": "The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode.", "format": "int32", "type": "integer" } @@ -23104,6 +23453,93 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata": { +"description": "Metadata related to the progress of the CrawlRateManagementService.SetDedicatedCrawlRate operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateRequest": { +"description": "Request message for CrawlRateManagementService.SetDedicatedCrawlRate method. The user can set the crawl rate for a crawl_rate_scope they own. They can set up an overall crawl rate, or set up a user-triggered crawl rate and a auto-refresh crawl rate separately. If an overall crawl rate is set, Vertex AI will automatically splits crawl_rate into user-triggered and auto-refresh.", +"id": "GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateRequest", +"properties": { +"crawlRate": { +"description": "Optional. The crawl QPS set by the user. It is not guaranteed that Vertex crawl bot will crawl at this QPS. If the crawl rate is too high, the real QPS may be lower than the value set by the user to avoid overloading the user's website.", +"format": "int32", +"type": "integer" +}, +"crawlRateScope": { +"description": "Required. The scope of the crawl rate that the user wants to config. Currently, only domain and host name are supported. A domain name example: `example.com`. A host name example: `www.example.com`. Please do not include `/` in the domain or host name.", +"type": "string" +}, +"crawlType": { +"description": "Optional. Whether it's the crawl rate of user-triggered or auto-refresh.", +"enum": [ +"CRAWL_TYPE_UNSPECIFIED", +"USER_TRIGGERED", +"AUTO_REFRESH" +], +"enumDescriptions": [ +"The crawl type is unspecified.", +"The crawl type is user-triggered.", +"The crawl type is auto-refresh." +], +"type": "string" +}, +"mode": { +"description": "Optional. Whether the rate is explicitly set by users, or set by vertex AI.", +"enum": [ +"MODE_UNSPECIFIED", +"AUTOMATIC", +"EXPLICIT" +], +"enumDescriptions": [ +"The mode is unspecified. If the user does not specify the mode, default to AUTOMATIC.", +"Vertex AI automatically splits crawl_rate into user-triggered and auto-refresh. Users don't need to specify SetDedicatedCrawlRateRequest.CrawlType if the mode is AUTOMATIC.", +"Users explicitly set user-triggered or auto-refresh crawl rate." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse": { +"description": "Response message for CrawlRateManagementService.SetDedicatedCrawlRate method. It simply returns the state of the response, and an error message if the state is FAILED.", +"id": "GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse", +"properties": { +"error": { +"$ref": "GoogleRpcStatus", +"description": "Errors from service when handling the request." +}, +"state": { +"description": "Output only. The state of the response.", +"enum": [ +"STATE_UNSPECIFIED", +"SUCCEEDED", +"FAILED" +], +"enumDescriptions": [ +"The state is unspecified.", +"The state is successful.", +"The state is failed." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaSingleRegionKey": { "description": "Metadata for single-regional CMEKs.", "id": "GoogleCloudDiscoveryengineV1betaSingleRegionKey", From f6ebb71762b96bddf2db17cc02a32289aa8a8972 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 25 Feb 2025 07:08:18 +0000 Subject: [PATCH 13/36] feat(displayvideo): update the api #### displayvideo:v3 The following keys were deleted: - schemas.SdfUploadTask (Total Keys: 10) #### displayvideo:v4 The following keys were added: - resources.advertisers.methods.audit (Total Keys: 15) - resources.advertisers.methods.create (Total Keys: 8) - resources.advertisers.methods.delete (Total Keys: 12) - resources.advertisers.methods.editAssignedTargetingOptions (Total Keys: 13) - resources.advertisers.methods.get (Total Keys: 12) - resources.advertisers.methods.list (Total Keys: 40) - resources.advertisers.methods.patch (Total Keys: 16) - resources.advertisers.resources.adGroupAds.methods.get (Total Keys: 17) - resources.advertisers.resources.adGroupAds.methods.list (Total Keys: 21) - resources.advertisers.resources.adGroups.methods.bulkListAssignedTargetingOptions (Total Keys: 25) - resources.advertisers.resources.adGroups.methods.get (Total Keys: 17) - resources.advertisers.resources.adGroups.methods.list (Total Keys: 21) - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.get (Total Keys: 25) - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.list (Total Keys: 30) - resources.advertisers.resources.assets.methods.upload (Total Keys: 17) - resources.advertisers.resources.campaigns.methods.create (Total Keys: 13) - resources.advertisers.resources.campaigns.methods.delete (Total Keys: 17) - resources.advertisers.resources.campaigns.methods.get (Total Keys: 17) - resources.advertisers.resources.campaigns.methods.list (Total Keys: 21) - resources.advertisers.resources.campaigns.methods.patch (Total Keys: 21) - resources.advertisers.resources.channels.methods.create (Total Keys: 16) - resources.advertisers.resources.channels.methods.get (Total Keys: 20) - resources.advertisers.resources.channels.methods.list (Total Keys: 24) - resources.advertisers.resources.channels.methods.patch (Total Keys: 23) - resources.advertisers.resources.channels.resources.sites.methods.bulkEdit (Total Keys: 17) - resources.advertisers.resources.channels.resources.sites.methods.create (Total Keys: 20) - resources.advertisers.resources.channels.resources.sites.methods.delete (Total Keys: 19) - resources.advertisers.resources.channels.resources.sites.methods.list (Total Keys: 29) - resources.advertisers.resources.channels.resources.sites.methods.replace (Total Keys: 17) - resources.advertisers.resources.creatives.methods.create (Total Keys: 13) - resources.advertisers.resources.creatives.methods.delete (Total Keys: 17) - resources.advertisers.resources.creatives.methods.get (Total Keys: 17) - resources.advertisers.resources.creatives.methods.list (Total Keys: 21) - resources.advertisers.resources.creatives.methods.patch (Total Keys: 21) - resources.advertisers.resources.insertionOrders.methods.create (Total Keys: 13) - resources.advertisers.resources.insertionOrders.methods.delete (Total Keys: 17) - resources.advertisers.resources.insertionOrders.methods.get (Total Keys: 17) - resources.advertisers.resources.insertionOrders.methods.list (Total Keys: 21) - resources.advertisers.resources.insertionOrders.methods.patch (Total Keys: 21) - resources.advertisers.resources.invoices.methods.list (Total Keys: 21) - resources.advertisers.resources.invoices.methods.lookupInvoiceCurrency (Total Keys: 14) - resources.advertisers.resources.lineItems.methods.bulkEditAssignedTargetingOptions (Total Keys: 13) - resources.advertisers.resources.lineItems.methods.bulkListAssignedTargetingOptions (Total Keys: 25) - resources.advertisers.resources.lineItems.methods.bulkUpdate (Total Keys: 13) - resources.advertisers.resources.lineItems.methods.create (Total Keys: 13) - resources.advertisers.resources.lineItems.methods.delete (Total Keys: 17) - resources.advertisers.resources.lineItems.methods.duplicate (Total Keys: 18) - resources.advertisers.resources.lineItems.methods.generateDefault (Total Keys: 13) - resources.advertisers.resources.lineItems.methods.get (Total Keys: 17) - resources.advertisers.resources.lineItems.methods.list (Total Keys: 21) - resources.advertisers.resources.lineItems.methods.patch (Total Keys: 21) - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.create (Total Keys: 22) - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete (Total Keys: 25) - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.get (Total Keys: 25) - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.list (Total Keys: 30) - resources.advertisers.resources.locationLists.methods.create (Total Keys: 13) - resources.advertisers.resources.locationLists.methods.get (Total Keys: 17) - resources.advertisers.resources.locationLists.methods.list (Total Keys: 21) - resources.advertisers.resources.locationLists.methods.patch (Total Keys: 20) - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.bulkEdit (Total Keys: 17) - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.create (Total Keys: 16) - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.delete (Total Keys: 20) - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list (Total Keys: 24) - resources.advertisers.resources.negativeKeywordLists.methods.create (Total Keys: 13) - resources.advertisers.resources.negativeKeywordLists.methods.delete (Total Keys: 17) - resources.advertisers.resources.negativeKeywordLists.methods.get (Total Keys: 17) - resources.advertisers.resources.negativeKeywordLists.methods.list (Total Keys: 17) - resources.advertisers.resources.negativeKeywordLists.methods.patch (Total Keys: 20) - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.bulkEdit (Total Keys: 17) - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.create (Total Keys: 17) - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.delete (Total Keys: 20) - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list (Total Keys: 26) - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.replace (Total Keys: 17) - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.create (Total Keys: 17) - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete (Total Keys: 20) - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.get (Total Keys: 20) - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.list (Total Keys: 25) - resources.combinedAudiences.methods.get (Total Keys: 18) - resources.combinedAudiences.methods.list (Total Keys: 22) - resources.customBiddingAlgorithms.methods.create (Total Keys: 8) - resources.customBiddingAlgorithms.methods.get (Total Keys: 18) - resources.customBiddingAlgorithms.methods.list (Total Keys: 22) - resources.customBiddingAlgorithms.methods.patch (Total Keys: 16) - resources.customBiddingAlgorithms.methods.uploadRules (Total Keys: 18) - resources.customBiddingAlgorithms.methods.uploadScript (Total Keys: 18) - resources.customBiddingAlgorithms.resources.rules.methods.create (Total Keys: 19) - resources.customBiddingAlgorithms.resources.rules.methods.get (Total Keys: 23) - resources.customBiddingAlgorithms.resources.rules.methods.list (Total Keys: 25) - resources.customBiddingAlgorithms.resources.scripts.methods.create (Total Keys: 19) - resources.customBiddingAlgorithms.resources.scripts.methods.get (Total Keys: 23) - resources.customBiddingAlgorithms.resources.scripts.methods.list (Total Keys: 25) - resources.customLists.methods.get (Total Keys: 15) - resources.customLists.methods.list (Total Keys: 19) - resources.firstPartyAndPartnerAudiences.methods.create (Total Keys: 11) - resources.firstPartyAndPartnerAudiences.methods.editCustomerMatchMembers (Total Keys: 13) - resources.firstPartyAndPartnerAudiences.methods.get (Total Keys: 18) - resources.firstPartyAndPartnerAudiences.methods.list (Total Keys: 22) - resources.firstPartyAndPartnerAudiences.methods.patch (Total Keys: 19) - resources.floodlightGroups.methods.get (Total Keys: 15) - resources.floodlightGroups.methods.patch (Total Keys: 18) - resources.floodlightGroups.resources.floodlightActivities.methods.get (Total Keys: 20) - resources.floodlightGroups.resources.floodlightActivities.methods.list (Total Keys: 22) - resources.googleAudiences.methods.get (Total Keys: 18) - resources.googleAudiences.methods.list (Total Keys: 22) - resources.guaranteedOrders.methods.create (Total Keys: 14) - resources.guaranteedOrders.methods.editGuaranteedOrderReadAccessors (Total Keys: 12) - resources.guaranteedOrders.methods.get (Total Keys: 17) - resources.guaranteedOrders.methods.list (Total Keys: 22) - resources.guaranteedOrders.methods.patch (Total Keys: 21) - resources.inventorySourceGroups.methods.create (Total Keys: 14) - resources.inventorySourceGroups.methods.delete (Total Keys: 18) - resources.inventorySourceGroups.methods.get (Total Keys: 18) - resources.inventorySourceGroups.methods.list (Total Keys: 22) - resources.inventorySourceGroups.methods.patch (Total Keys: 21) - resources.inventorySourceGroups.resources.assignedInventorySources.methods.bulkEdit (Total Keys: 13) - resources.inventorySourceGroups.resources.assignedInventorySources.methods.create (Total Keys: 19) - resources.inventorySourceGroups.resources.assignedInventorySources.methods.delete (Total Keys: 23) - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list (Total Keys: 27) - resources.inventorySources.methods.create (Total Keys: 14) - resources.inventorySources.methods.editInventorySourceReadWriteAccessors (Total Keys: 13) - resources.inventorySources.methods.get (Total Keys: 18) - resources.inventorySources.methods.list (Total Keys: 22) - resources.inventorySources.methods.patch (Total Keys: 22) - resources.partners.methods.editAssignedTargetingOptions (Total Keys: 13) - resources.partners.methods.get (Total Keys: 12) - resources.partners.methods.list (Total Keys: 16) - resources.partners.resources.channels.methods.create (Total Keys: 16) - resources.partners.resources.channels.methods.get (Total Keys: 20) - resources.partners.resources.channels.methods.list (Total Keys: 24) - resources.partners.resources.channels.methods.patch (Total Keys: 23) - resources.partners.resources.channels.resources.sites.methods.bulkEdit (Total Keys: 17) - resources.partners.resources.channels.resources.sites.methods.create (Total Keys: 20) - resources.partners.resources.channels.resources.sites.methods.delete (Total Keys: 19) - resources.partners.resources.channels.resources.sites.methods.list (Total Keys: 29) - resources.partners.resources.channels.resources.sites.methods.replace (Total Keys: 17) - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.create (Total Keys: 17) - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete (Total Keys: 20) - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.get (Total Keys: 20) - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.list (Total Keys: 25) - resources.sdfdownloadtasks.methods.create (Total Keys: 8) - resources.targetingTypes.resources.targetingOptions.methods.get (Total Keys: 18) - resources.targetingTypes.resources.targetingOptions.methods.list (Total Keys: 23) - resources.targetingTypes.resources.targetingOptions.methods.search (Total Keys: 12) - resources.users.methods.bulkEditAssignedUserRoles (Total Keys: 13) - resources.users.methods.create (Total Keys: 8) - resources.users.methods.delete (Total Keys: 12) - resources.users.methods.get (Total Keys: 12) - resources.users.methods.list (Total Keys: 16) - resources.users.methods.patch (Total Keys: 16) - schemas.ActiveViewVideoViewabilityMetricConfig (Total Keys: 7) - schemas.AdGroup (Total Keys: 39) - schemas.Adloox (Total Keys: 20) - schemas.Advertiser (Total Keys: 52) - schemas.AgeRangeAssignedTargetingOptionDetails (Total Keys: 3) - schemas.AgeRangeTargetingOptionDetails (Total Keys: 4) - schemas.AlgorithmRules (Total Keys: 46) - schemas.AppAssignedTargetingOptionDetails (Total Keys: 7) - schemas.AppCategoryAssignedTargetingOptionDetails (Total Keys: 6) - schemas.AppCategoryTargetingOptionDetails (Total Keys: 4) - schemas.Asset (Total Keys: 9) - schemas.AssignedInventorySource (Total Keys: 8) - schemas.AssignedLocation (Total Keys: 8) - schemas.AssignedTargetingOption (Total Keys: 59) - schemas.AssignedUserRole (Total Keys: 9) - schemas.AudienceGroupAssignedTargetingOptionDetails (Total Keys: 9) - schemas.AudioAd (Total Keys: 3) - schemas.AudioContentTypeAssignedTargetingOptionDetails (Total Keys: 3) - schemas.AudioContentTypeTargetingOptionDetails (Total Keys: 4) - schemas.AudioVideoOffset (Total Keys: 6) - schemas.AuditAdvertiserResponse (Total Keys: 18) - schemas.AuthorizedSellerStatusAssignedTargetingOptionDetails (Total Keys: 5) - schemas.AuthorizedSellerStatusTargetingOptionDetails (Total Keys: 4) - schemas.BiddingStrategy (Total Keys: 6) - schemas.BrowserAssignedTargetingOptionDetails (Total Keys: 6) - schemas.BrowserTargetingOptionDetails (Total Keys: 4) - schemas.BudgetSummary (Total Keys: 10) - schemas.BulkEditAdvertiserAssignedTargetingOptionsRequest (Total Keys: 6) - schemas.BulkEditAdvertiserAssignedTargetingOptionsResponse (Total Keys: 4) - schemas.BulkEditAssignedInventorySourcesRequest (Total Keys: 11) - schemas.BulkEditAssignedInventorySourcesResponse (Total Keys: 4) - schemas.BulkEditAssignedLocationsRequest (Total Keys: 7) - schemas.BulkEditAssignedLocationsResponse (Total Keys: 4) - schemas.BulkEditAssignedTargetingOptionsRequest (Total Keys: 9) - schemas.BulkEditAssignedTargetingOptionsResponse (Total Keys: 12) - schemas.BulkEditAssignedUserRolesRequest (Total Keys: 6) - schemas.BulkEditAssignedUserRolesResponse (Total Keys: 4) - schemas.BulkEditNegativeKeywordsRequest (Total Keys: 6) - schemas.BulkEditNegativeKeywordsResponse (Total Keys: 4) - schemas.BulkEditPartnerAssignedTargetingOptionsRequest (Total Keys: 6) - schemas.BulkEditPartnerAssignedTargetingOptionsResponse (Total Keys: 4) - schemas.BulkEditSitesRequest (Total Keys: 10) - schemas.BulkEditSitesResponse (Total Keys: 4) - schemas.BulkListAdGroupAssignedTargetingOptionsResponse (Total Keys: 5) - schemas.BulkListAdvertiserAssignedTargetingOptionsResponse (Total Keys: 5) - schemas.BulkListAssignedTargetingOptionsResponse (Total Keys: 5) - schemas.BulkUpdateLineItemsRequest (Total Keys: 8) - schemas.BulkUpdateLineItemsResponse (Total Keys: 13) - schemas.BumperAd (Total Keys: 3) - schemas.BusinessChainAssignedTargetingOptionDetails (Total Keys: 8) - schemas.BusinessChainSearchTerms (Total Keys: 4) - schemas.BusinessChainTargetingOptionDetails (Total Keys: 8) - schemas.Campaign (Total Keys: 42) - schemas.CarrierAndIspAssignedTargetingOptionDetails (Total Keys: 6) - schemas.CarrierAndIspTargetingOptionDetails (Total Keys: 6) - schemas.CategoryAssignedTargetingOptionDetails (Total Keys: 6) - schemas.CategoryTargetingOptionDetails (Total Keys: 4) - schemas.Channel (Total Keys: 23) - schemas.CmHybridConfig (Total Keys: 16) - schemas.CmTrackingAd (Total Keys: 8) - schemas.CombinedAudience (Total Keys: 17) - schemas.CommonInStreamAttribute (Total Keys: 6) - schemas.Consent (Total Keys: 4) - schemas.ContactInfo (Total Keys: 14) - schemas.ContentDurationAssignedTargetingOptionDetails (Total Keys: 5) - schemas.ContentDurationTargetingOptionDetails (Total Keys: 4) - schemas.ContentGenreAssignedTargetingOptionDetails (Total Keys: 6) - schemas.ContentGenreTargetingOptionDetails (Total Keys: 4) - schemas.ContentInstreamPositionAssignedTargetingOptionDetails (Total Keys: 5) - schemas.ContentInstreamPositionTargetingOptionDetails (Total Keys: 4) - schemas.ContentOutstreamPositionAssignedTargetingOptionDetails (Total Keys: 5) - schemas.ContentOutstreamPositionTargetingOptionDetails (Total Keys: 4) - schemas.ContentStreamTypeAssignedTargetingOptionDetails (Total Keys: 5) - schemas.ContentStreamTypeTargetingOptionDetails (Total Keys: 4) - schemas.ConversionCountingConfig (Total Keys: 6) - schemas.CounterEvent (Total Keys: 4) - schemas.CreateAssetRequest (Total Keys: 3) - schemas.CreateAssetResponse (Total Keys: 3) - schemas.CreateAssignedTargetingOptionsRequest (Total Keys: 5) - schemas.CreateSdfDownloadTaskRequest (Total Keys: 10) - schemas.Creative (Total Keys: 83) - schemas.CustomBiddingAlgorithm (Total Keys: 46) - schemas.CustomBiddingModelDetails (Total Keys: 7) - schemas.CustomBiddingScript (Total Keys: 24) - schemas.CustomLabel (Total Keys: 4) - schemas.CustomList (Total Keys: 17) - schemas.Date (Total Keys: 12) - schemas.DayAndTime (Total Keys: 14) - schemas.DeleteAssignedTargetingOptionsRequest (Total Keys: 5) - schemas.DeviceMakeModelAssignedTargetingOptionDetails (Total Keys: 6) - schemas.DeviceMakeModelTargetingOptionDetails (Total Keys: 4) - schemas.DeviceTypeAssignedTargetingOptionDetails (Total Keys: 6) - schemas.DeviceTypeTargetingOptionDetails (Total Keys: 4) - schemas.DigitalContentLabelAssignedTargetingOptionDetails (Total Keys: 3) - schemas.DigitalContentLabelTargetingOptionDetails (Total Keys: 4) - schemas.Dimensions (Total Keys: 6) - schemas.DisplayVideoSourceAd (Total Keys: 4) - schemas.DoubleVerify (Total Keys: 35) - schemas.DuplicateLineItemRequest (Total Keys: 3) - schemas.DuplicateLineItemResponse (Total Keys: 4) - schemas.EditCustomerMatchMembersRequest (Total Keys: 8) - schemas.EditCustomerMatchMembersResponse (Total Keys: 4) - schemas.EditGuaranteedOrderReadAccessorsRequest (Total Keys: 11) - schemas.EditGuaranteedOrderReadAccessorsResponse (Total Keys: 6) - schemas.EditInventorySourceReadWriteAccessorsRequest (Total Keys: 14) - schemas.Empty (Total Keys: 2) - schemas.EnvironmentAssignedTargetingOptionDetails (Total Keys: 3) - schemas.EnvironmentTargetingOptionDetails (Total Keys: 4) - schemas.ExchangeAssignedTargetingOptionDetails (Total Keys: 3) - schemas.ExchangeConfig (Total Keys: 13) - schemas.ExchangeReviewStatus (Total Keys: 4) - schemas.ExchangeTargetingOptionDetails (Total Keys: 4) - schemas.ExitEvent (Total Keys: 5) - schemas.FirstPartyAndPartnerAudience (Total Keys: 50) - schemas.FixedBidStrategy (Total Keys: 4) - schemas.FloodlightActivity (Total Keys: 20) - schemas.FloodlightGroup (Total Keys: 13) - schemas.FrequencyCap (Total Keys: 10) - schemas.GenderAssignedTargetingOptionDetails (Total Keys: 3) - schemas.GenderTargetingOptionDetails (Total Keys: 4) - schemas.GenerateDefaultLineItemRequest (Total Keys: 7) - schemas.GeoRegionAssignedTargetingOptionDetails (Total Keys: 8) - schemas.GeoRegionSearchTerms (Total Keys: 3) - schemas.GeoRegionTargetingOptionDetails (Total Keys: 6) - schemas.GoogleAudience (Total Keys: 19) - schemas.GuaranteedOrder (Total Keys: 34) - schemas.HouseholdIncomeAssignedTargetingOptionDetails (Total Keys: 3) - schemas.HouseholdIncomeTargetingOptionDetails (Total Keys: 4) - schemas.IdFilter (Total Keys: 26) - schemas.ImageAsset (Total Keys: 6) - schemas.InStreamAd (Total Keys: 5) - schemas.InsertionOrder (Total Keys: 42) - schemas.IntegralAdScience (Total Keys: 21) - schemas.IntegrationDetails (Total Keys: 4) - schemas.InventorySource (Total Keys: 85) - schemas.Invoice (Total Keys: 27) - schemas.KeywordAssignedTargetingOptionDetails (Total Keys: 4) - schemas.Kpi (Total Keys: 10) - schemas.LanguageAssignedTargetingOptionDetails (Total Keys: 6) - schemas.LanguageTargetingOptionDetails (Total Keys: 4) - schemas.LineItem (Total Keys: 60) - schemas.ListAdGroupAdsResponse (Total Keys: 5) - schemas.ListAdGroupAssignedTargetingOptionsResponse (Total Keys: 5) - schemas.ListAdGroupsResponse (Total Keys: 5) - schemas.ListAdvertiserAssignedTargetingOptionsResponse (Total Keys: 5) - schemas.ListAdvertisersResponse (Total Keys: 5) - schemas.ListAssignedInventorySourcesResponse (Total Keys: 5) - schemas.ListAssignedLocationsResponse (Total Keys: 5) - schemas.ListCampaignsResponse (Total Keys: 5) - schemas.ListChannelsResponse (Total Keys: 5) - schemas.ListCombinedAudiencesResponse (Total Keys: 5) - schemas.ListCreativesResponse (Total Keys: 5) - schemas.ListCustomBiddingAlgorithmRulesResponse (Total Keys: 5) - schemas.ListCustomBiddingAlgorithmsResponse (Total Keys: 5) - schemas.ListCustomBiddingScriptsResponse (Total Keys: 5) - schemas.ListCustomListsResponse (Total Keys: 5) - schemas.ListFirstPartyAndPartnerAudiencesResponse (Total Keys: 5) - schemas.ListFloodlightActivitiesResponse (Total Keys: 5) - schemas.ListGoogleAudiencesResponse (Total Keys: 5) - schemas.ListGuaranteedOrdersResponse (Total Keys: 5) - schemas.ListInsertionOrdersResponse (Total Keys: 5) - schemas.ListInventorySourceGroupsResponse (Total Keys: 5) - schemas.ListInventorySourcesResponse (Total Keys: 5) - schemas.ListInvoicesResponse (Total Keys: 5) - schemas.ListLineItemAssignedTargetingOptionsResponse (Total Keys: 5) - schemas.ListLineItemsResponse (Total Keys: 5) - schemas.ListLocationListsResponse (Total Keys: 5) - schemas.ListNegativeKeywordListsResponse (Total Keys: 5) - schemas.ListNegativeKeywordsResponse (Total Keys: 5) - schemas.ListPartnerAssignedTargetingOptionsResponse (Total Keys: 5) - schemas.ListPartnersResponse (Total Keys: 5) - schemas.ListSitesResponse (Total Keys: 5) - schemas.ListTargetingOptionsResponse (Total Keys: 5) - schemas.ListUsersResponse (Total Keys: 5) - schemas.LocationList (Total Keys: 11) - schemas.LookbackWindow (Total Keys: 6) - schemas.LookupInvoiceCurrencyResponse (Total Keys: 3) - schemas.MastheadAd (Total Keys: 13) - schemas.MaximizeSpendBidStrategy (Total Keys: 8) - schemas.MeasurementConfig (Total Keys: 4) - schemas.MobileApp (Total Keys: 9) - schemas.MobileDeviceIdList (Total Keys: 5) - schemas.Money (Total Keys: 7) - schemas.NativeContentPositionAssignedTargetingOptionDetails (Total Keys: 3) - schemas.NativeContentPositionTargetingOptionDetails (Total Keys: 4) - schemas.NegativeKeyword (Total Keys: 23) - schemas.NonSkippableAd (Total Keys: 5) - schemas.ObaIcon (Total Keys: 6) - schemas.OmidAssignedTargetingOptionDetails (Total Keys: 3) - schemas.OmidTargetingOptionDetails (Total Keys: 4) - schemas.OnScreenPositionAssignedTargetingOptionDetails (Total Keys: 7) - schemas.OnScreenPositionTargetingOptionDetails (Total Keys: 4) - schemas.OperatingSystemAssignedTargetingOptionDetails (Total Keys: 6) - schemas.OperatingSystemTargetingOptionDetails (Total Keys: 4) - schemas.Pacing (Total Keys: 8) - schemas.ParentEntityFilter (Total Keys: 8) - schemas.ParentalStatusAssignedTargetingOptionDetails (Total Keys: 3) - schemas.ParentalStatusTargetingOptionDetails (Total Keys: 4) - schemas.Partner (Total Keys: 46) - schemas.PerformanceGoal (Total Keys: 17) - schemas.PoiAssignedTargetingOptionDetails (Total Keys: 14) - schemas.PoiSearchTerms (Total Keys: 3) - schemas.PoiTargetingOptionDetails (Total Keys: 10) - schemas.PrismaConfig (Total Keys: 5) - schemas.PrismaCpeCode (Total Keys: 5) - schemas.ProductFeedData (Total Keys: 6) - schemas.ProductMatchDimension (Total Keys: 4) - schemas.ProximityLocationListAssignedTargetingOptionDetails (Total Keys: 7) - schemas.RateDetails (Total Keys: 8) - schemas.RegionalLocationListAssignedTargetingOptionDetails (Total Keys: 5) - schemas.RemarketingConfig (Total Keys: 7) - schemas.ReplaceNegativeKeywordsRequest (Total Keys: 4) - schemas.ReplaceNegativeKeywordsResponse (Total Keys: 4) - schemas.ReplaceSitesRequest (Total Keys: 8) - schemas.ReplaceSitesResponse (Total Keys: 4) - schemas.ReviewStatusInfo (Total Keys: 7) - schemas.ScriptError (Total Keys: 8) - schemas.SdfConfig (Total Keys: 4) - schemas.SdfDownloadTask (Total Keys: 10) - schemas.SearchTargetingOptionsRequest (Total Keys: 10) - schemas.SearchTargetingOptionsResponse (Total Keys: 5) - schemas.SensitiveCategoryAssignedTargetingOptionDetails (Total Keys: 3) - schemas.SensitiveCategoryTargetingOptionDetails (Total Keys: 4) - schemas.SessionPositionAssignedTargetingOptionDetails (Total Keys: 3) - schemas.Site (Total Keys: 4) - schemas.SubExchangeAssignedTargetingOptionDetails (Total Keys: 3) - schemas.SubExchangeTargetingOptionDetails (Total Keys: 4) - schemas.TargetFrequency (Total Keys: 7) - schemas.TargetingExpansionConfig (Total Keys: 7) - schemas.TargetingOption (Total Keys: 41) - schemas.ThirdPartyMeasurementConfigs (Total Keys: 10) - schemas.ThirdPartyOnlyConfig (Total Keys: 3) - schemas.ThirdPartyVendorConfig (Total Keys: 4) - schemas.ThirdPartyVerifierAssignedTargetingOptionDetails (Total Keys: 5) - schemas.TimeRange (Total Keys: 6) - schemas.TimerEvent (Total Keys: 4) - schemas.TrackingFloodlightActivityConfig (Total Keys: 8) - schemas.Transcode (Total Keys: 16) - schemas.UniversalAdId (Total Keys: 4) - schemas.User (Total Keys: 23) - schemas.VideoAdSequenceSettings (Total Keys: 5) - schemas.VideoAdSequenceStep (Total Keys: 9) - schemas.VideoDiscoveryAd (Total Keys: 5) - schemas.VideoPerformanceAd (Total Keys: 15) - schemas.VideoPlayerSizeAssignedTargetingOptionDetails (Total Keys: 3) - schemas.VideoPlayerSizeTargetingOptionDetails (Total Keys: 4) - schemas.ViewabilityAssignedTargetingOptionDetails (Total Keys: 3) - schemas.ViewabilityTargetingOptionDetails (Total Keys: 4) - schemas.YoutubeAndPartnersBiddingStrategy (Total Keys: 10) - schemas.YoutubeAndPartnersInventorySourceConfig (Total Keys: 5) - schemas.YoutubeAndPartnersSettings (Total Keys: 16) - schemas.YoutubeChannelAssignedTargetingOptionDetails (Total Keys: 4) - schemas.YoutubeVideoAssignedTargetingOptionDetails (Total Keys: 4) - schemas.YoutubeVideoDetails (Total Keys: 4) --- ...displayvideo_v2.advertisers.campaigns.html | 36 +- ...displayvideo_v2.advertisers.creatives.html | 588 +- docs/dyn/displayvideo_v2.advertisers.html | 54 +- ...yvideo_v2.advertisers.insertionOrders.html | 144 +- ...displayvideo_v2.advertisers.lineItems.html | 196 +- ...rgetingTypes.assignedTargetingOptions.html | 72 +- ...rgetingTypes.assignedTargetingOptions.html | 72 +- ...yvideo_v2.advertisers.youtubeAdGroups.html | 18 +- ...rgetingTypes.assignedTargetingOptions.html | 36 +- ...splayvideo_v2.customBiddingAlgorithms.html | 4 +- ...eo_v2.customBiddingAlgorithms.scripts.html | 4 +- docs/dyn/displayvideo_v2.partners.html | 36 +- ...rgetingTypes.assignedTargetingOptions.html | 72 +- .../displayvideo_v3.advertisers.adGroups.html | 42 +- ...rgetingTypes.assignedTargetingOptions.html | 60 +- ...displayvideo_v3.advertisers.campaigns.html | 66 +- ...rgetingTypes.assignedTargetingOptions.html | 60 +- ...displayvideo_v3.advertisers.creatives.html | 588 +- docs/dyn/displayvideo_v3.advertisers.html | 90 +- ...yvideo_v3.advertisers.insertionOrders.html | 186 +- ...rgetingTypes.assignedTargetingOptions.html | 120 +- ...displayvideo_v3.advertisers.lineItems.html | 236 +- ...rgetingTypes.assignedTargetingOptions.html | 120 +- ...rgetingTypes.assignedTargetingOptions.html | 120 +- ...splayvideo_v3.customBiddingAlgorithms.html | 4 +- ...ideo_v3.customBiddingAlgorithms.rules.html | 4 +- ...eo_v3.customBiddingAlgorithms.scripts.html | 4 +- ...yvideo_v3.firstAndThirdPartyAudiences.html | 14 +- docs/dyn/displayvideo_v3.partners.html | 60 +- ...rgetingTypes.assignedTargetingOptions.html | 120 +- ...isplayvideo_v4.advertisers.adGroupAds.html | 479 + .../displayvideo_v4.advertisers.adGroups.html | 625 + ...rgetingTypes.assignedTargetingOptions.html | 895 + ...4.advertisers.adGroups.targetingTypes.html | 91 + .../displayvideo_v4.advertisers.assets.html | 120 + ...displayvideo_v4.advertisers.campaigns.html | 647 + .../displayvideo_v4.advertisers.channels.html | 262 + ...ayvideo_v4.advertisers.channels.sites.html | 281 + ...displayvideo_v4.advertisers.creatives.html | 1091 + docs/dyn/displayvideo_v4.advertisers.html | 1698 ++ ...yvideo_v4.advertisers.insertionOrders.html | 767 + .../displayvideo_v4.advertisers.invoices.html | 213 + ...displayvideo_v4.advertisers.lineItems.html | 2500 ++ ...rgetingTypes.assignedTargetingOptions.html | 1684 ++ ....advertisers.lineItems.targetingTypes.html | 91 + ...isers.locationLists.assignedLocations.html | 239 + ...layvideo_v4.advertisers.locationLists.html | 246 + ...o_v4.advertisers.negativeKeywordLists.html | 266 + ...negativeKeywordLists.negativeKeywords.html | 274 + ...rgetingTypes.assignedTargetingOptions.html | 1680 ++ ...ayvideo_v4.advertisers.targetingTypes.html | 91 + .../displayvideo_v4.combinedAudiences.html | 163 + ...splayvideo_v4.customBiddingAlgorithms.html | 371 + ...ideo_v4.customBiddingAlgorithms.rules.html | 235 + ...eo_v4.customBiddingAlgorithms.scripts.html | 255 + docs/dyn/displayvideo_v4.customLists.html | 161 + ...ideo_v4.firstPartyAndPartnerAudiences.html | 586 + ...floodlightGroups.floodlightActivities.html | 186 + .../dyn/displayvideo_v4.floodlightGroups.html | 196 + docs/dyn/displayvideo_v4.googleAudiences.html | 165 + .../dyn/displayvideo_v4.guaranteedOrders.html | 374 + docs/dyn/displayvideo_v4.html | 65 + ...SourceGroups.assignedInventorySources.html | 243 + ...displayvideo_v4.inventorySourceGroups.html | 261 + .../dyn/displayvideo_v4.inventorySources.html | 662 + .../displayvideo_v4.partners.channels.html | 262 + ...splayvideo_v4.partners.channels.sites.html | 281 + docs/dyn/displayvideo_v4.partners.html | 915 + ...rgetingTypes.assignedTargetingOptions.html | 1680 ++ ...splayvideo_v4.partners.targetingTypes.html | 91 + .../dyn/displayvideo_v4.sdfdownloadtasks.html | 86 + docs/dyn/displayvideo_v4.targetingTypes.html | 91 + ...eo_v4.targetingTypes.targetingOptions.html | 693 + docs/dyn/displayvideo_v4.users.html | 352 + .../documents/displayvideo.v2.json | 186 +- .../documents/displayvideo.v3.json | 289 +- .../documents/displayvideo.v4.json | 21407 +++++++++++++++- 77 files changed, 45703 insertions(+), 2019 deletions(-) create mode 100644 docs/dyn/displayvideo_v4.advertisers.adGroupAds.html create mode 100644 docs/dyn/displayvideo_v4.advertisers.adGroups.html create mode 100644 docs/dyn/displayvideo_v4.advertisers.adGroups.targetingTypes.assignedTargetingOptions.html create mode 100644 docs/dyn/displayvideo_v4.advertisers.adGroups.targetingTypes.html create mode 100644 docs/dyn/displayvideo_v4.advertisers.assets.html create mode 100644 docs/dyn/displayvideo_v4.advertisers.campaigns.html create mode 100644 docs/dyn/displayvideo_v4.advertisers.channels.html create mode 100644 docs/dyn/displayvideo_v4.advertisers.channels.sites.html create mode 100644 docs/dyn/displayvideo_v4.advertisers.creatives.html create mode 100644 docs/dyn/displayvideo_v4.advertisers.html create mode 100644 docs/dyn/displayvideo_v4.advertisers.insertionOrders.html create mode 100644 docs/dyn/displayvideo_v4.advertisers.invoices.html create mode 100644 docs/dyn/displayvideo_v4.advertisers.lineItems.html create mode 100644 docs/dyn/displayvideo_v4.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html create mode 100644 docs/dyn/displayvideo_v4.advertisers.lineItems.targetingTypes.html create mode 100644 docs/dyn/displayvideo_v4.advertisers.locationLists.assignedLocations.html create mode 100644 docs/dyn/displayvideo_v4.advertisers.locationLists.html create mode 100644 docs/dyn/displayvideo_v4.advertisers.negativeKeywordLists.html create mode 100644 docs/dyn/displayvideo_v4.advertisers.negativeKeywordLists.negativeKeywords.html create mode 100644 docs/dyn/displayvideo_v4.advertisers.targetingTypes.assignedTargetingOptions.html create mode 100644 docs/dyn/displayvideo_v4.advertisers.targetingTypes.html create mode 100644 docs/dyn/displayvideo_v4.combinedAudiences.html create mode 100644 docs/dyn/displayvideo_v4.customBiddingAlgorithms.html create mode 100644 docs/dyn/displayvideo_v4.customBiddingAlgorithms.rules.html create mode 100644 docs/dyn/displayvideo_v4.customBiddingAlgorithms.scripts.html create mode 100644 docs/dyn/displayvideo_v4.customLists.html create mode 100644 docs/dyn/displayvideo_v4.firstPartyAndPartnerAudiences.html create mode 100644 docs/dyn/displayvideo_v4.floodlightGroups.floodlightActivities.html create mode 100644 docs/dyn/displayvideo_v4.floodlightGroups.html create mode 100644 docs/dyn/displayvideo_v4.googleAudiences.html create mode 100644 docs/dyn/displayvideo_v4.guaranteedOrders.html create mode 100644 docs/dyn/displayvideo_v4.inventorySourceGroups.assignedInventorySources.html create mode 100644 docs/dyn/displayvideo_v4.inventorySourceGroups.html create mode 100644 docs/dyn/displayvideo_v4.inventorySources.html create mode 100644 docs/dyn/displayvideo_v4.partners.channels.html create mode 100644 docs/dyn/displayvideo_v4.partners.channels.sites.html create mode 100644 docs/dyn/displayvideo_v4.partners.html create mode 100644 docs/dyn/displayvideo_v4.partners.targetingTypes.assignedTargetingOptions.html create mode 100644 docs/dyn/displayvideo_v4.partners.targetingTypes.html create mode 100644 docs/dyn/displayvideo_v4.targetingTypes.html create mode 100644 docs/dyn/displayvideo_v4.targetingTypes.targetingOptions.html create mode 100644 docs/dyn/displayvideo_v4.users.html diff --git a/docs/dyn/displayvideo_v2.advertisers.campaigns.html b/docs/dyn/displayvideo_v2.advertisers.campaigns.html index 0302e741c8e..8c8c14a177e 100644 --- a/docs/dyn/displayvideo_v2.advertisers.campaigns.html +++ b/docs/dyn/displayvideo_v2.advertisers.campaigns.html @@ -171,11 +171,11 @@

Method Details

"campaignId": "A String", # Output only. The unique ID of the campaign. Assigned by the system. "displayName": "A String", # Required. The display name of the campaign. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not the insertion orders under this campaign can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. * For CreateCampaign method, `ENTITY_STATUS_ARCHIVED` is not allowed. - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency cap setting of the campaign. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency cap setting of the campaign. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap) "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. - "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. - "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). + "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. }, "name": "A String", # Output only. The resource name of the campaign. @@ -251,11 +251,11 @@

Method Details

"campaignId": "A String", # Output only. The unique ID of the campaign. Assigned by the system. "displayName": "A String", # Required. The display name of the campaign. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not the insertion orders under this campaign can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. * For CreateCampaign method, `ENTITY_STATUS_ARCHIVED` is not allowed. - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency cap setting of the campaign. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency cap setting of the campaign. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap) "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. - "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. - "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). + "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. }, "name": "A String", # Output only. The resource name of the campaign. @@ -358,11 +358,11 @@

Method Details

"campaignId": "A String", # Output only. The unique ID of the campaign. Assigned by the system. "displayName": "A String", # Required. The display name of the campaign. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not the insertion orders under this campaign can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. * For CreateCampaign method, `ENTITY_STATUS_ARCHIVED` is not allowed. - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency cap setting of the campaign. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency cap setting of the campaign. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap) "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. - "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. - "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). + "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. }, "name": "A String", # Output only. The resource name of the campaign. @@ -451,11 +451,11 @@

Method Details

"campaignId": "A String", # Output only. The unique ID of the campaign. Assigned by the system. "displayName": "A String", # Required. The display name of the campaign. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not the insertion orders under this campaign can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. * For CreateCampaign method, `ENTITY_STATUS_ARCHIVED` is not allowed. - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency cap setting of the campaign. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency cap setting of the campaign. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap) "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. - "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. - "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). + "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. }, "name": "A String", # Output only. The resource name of the campaign. @@ -551,11 +551,11 @@

Method Details

"campaignId": "A String", # Output only. The unique ID of the campaign. Assigned by the system. "displayName": "A String", # Required. The display name of the campaign. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not the insertion orders under this campaign can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. * For CreateCampaign method, `ENTITY_STATUS_ARCHIVED` is not allowed. - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency cap setting of the campaign. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency cap setting of the campaign. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap) "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. - "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. - "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). + "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. }, "name": "A String", # Output only. The resource name of the campaign. @@ -632,11 +632,11 @@

Method Details

"campaignId": "A String", # Output only. The unique ID of the campaign. Assigned by the system. "displayName": "A String", # Required. The display name of the campaign. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not the insertion orders under this campaign can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. * For CreateCampaign method, `ENTITY_STATUS_ARCHIVED` is not allowed. - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency cap setting of the campaign. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency cap setting of the campaign. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap) "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. - "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. - "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). + "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. }, "name": "A String", # Output only. The resource name of the campaign. diff --git a/docs/dyn/displayvideo_v2.advertisers.creatives.html b/docs/dyn/displayvideo_v2.advertisers.creatives.html index df79ae18ffb..c670b6196fc 100644 --- a/docs/dyn/displayvideo_v2.advertisers.creatives.html +++ b/docs/dyn/displayvideo_v2.advertisers.creatives.html @@ -111,33 +111,33 @@

Method Details

The object takes the form of: { # A single Creative. - "additionalDimensions": [ # Additional dimensions. Applicable when creative_type is one of: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_LIGHTBOX` * `CREATIVE_TYPE_PUBLISHER_HOSTED` If this field is specified, width_pixels and height_pixels are both required and must be greater than or equal to 0. + "additionalDimensions": [ # Optional. Additional dimensions. Applicable when creative_type is one of: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_LIGHTBOX` * `CREATIVE_TYPE_PUBLISHER_HOSTED` If this field is specified, width_pixels and height_pixels are both required and must be greater than or equal to 0. { # Dimensions. "heightPixels": 42, # The height in pixels. "widthPixels": 42, # The width in pixels. }, ], "advertiserId": "A String", # Output only. The unique ID of the advertiser the creative belongs to. - "appendedTag": "A String", # Third-party HTML tracking tag to be appended to the creative tag. + "appendedTag": "A String", # Optional. Third-party HTML tracking tag to be appended to the creative tag. "assets": [ # Required. Assets associated to this creative. { # Asset association for the creative. - "asset": { # A single asset. # The associated asset. + "asset": { # A single asset. # Optional. The associated asset. "content": "A String", # The asset content. For uploaded assets, the content is the serving path. "mediaId": "A String", # Media ID of the uploaded asset. This is a unique identifier for the asset. This ID can be passed to other API calls, e.g. CreateCreative to associate the asset with a creative. The Media ID space updated on **April 5, 2023**. Update media IDs cached before **April 5, 2023** by retrieving the new media ID from associated creative resources or re-uploading the asset. }, - "role": "A String", # The role of this asset for the creative. + "role": "A String", # Optional. The role of this asset for the creative. }, ], "cmPlacementId": "A String", # Output only. The unique ID of the Campaign Manager 360 placement associated with the creative. This field is only applicable for creatives that are synced from Campaign Manager. - "cmTrackingAd": { # A Campaign Manager 360 tracking ad. # The Campaign Manager 360 tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager 360 and third-party ad serving: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` Output only for other cases. - "cmAdId": "A String", # The ad ID of the campaign manager 360 tracking Ad. - "cmCreativeId": "A String", # The creative ID of the campaign manager 360 tracking Ad. - "cmPlacementId": "A String", # The placement ID of the campaign manager 360 tracking Ad. + "cmTrackingAd": { # A Campaign Manager 360 tracking ad. # Optional. The Campaign Manager 360 tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager 360 and third-party ad serving: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` Output only for other cases. + "cmAdId": "A String", # Optional. The ad ID of the campaign manager 360 tracking Ad. + "cmCreativeId": "A String", # Optional. The creative ID of the campaign manager 360 tracking Ad. + "cmPlacementId": "A String", # Optional. The placement ID of the campaign manager 360 tracking Ad. }, - "companionCreativeIds": [ # The IDs of companion creatives for a video creative. You can assign existing display creatives (with image or HTML5 assets) to serve surrounding the publisher's video player. Companions display around the video player while the video is playing and remain after the video has completed. Creatives contain additional dimensions can not be companion creatives. This field is only supported for following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` + "companionCreativeIds": [ # Optional. The IDs of companion creatives for a video creative. You can assign existing display creatives (with image or HTML5 assets) to serve surrounding the publisher's video player. Companions display around the video player while the video is playing and remain after the video has completed. Creatives contain additional dimensions can not be companion creatives. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` "A String", ], - "counterEvents": [ # Counter events for a rich media creative. Counters track the number of times that a user interacts with any part of a rich media creative in a specified way (mouse-overs, mouse-outs, clicks, taps, data loading, keyboard entries, etc.). Any event that can be captured in the creative can be recorded as a counter. Leave it empty or unset for creatives containing image assets only. + "counterEvents": [ # Optional. Counter events for a rich media creative. Counters track the number of times that a user interacts with any part of a rich media creative in a specified way (mouse-overs, mouse-outs, clicks, taps, data loading, keyboard entries, etc.). Any event that can be captured in the creative can be recorded as a counter. Leave it empty or unset for creatives containing image assets only. { # Counter event of the creative. "name": "A String", # Required. The name of the counter event. "reportingName": "A String", # Required. The name used to identify this counter event in reports. @@ -158,8 +158,8 @@

Method Details

"entityStatus": "A String", # Required. Controls whether or not the creative can serve. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED` * `ENTITY_STATUS_PAUSED` "exitEvents": [ # Required. Exit events for this creative. An exit (also known as a click tag) is any area in your creative that someone can click or tap to open an advertiser's landing page. Every creative must include at least one exit. You can add an exit to your creative in any of the following ways: * Use Google Web Designer's tap area. * Define a JavaScript variable called "clickTag". * Use the Enabler (Enabler.exit()) to track exits in rich media formats. { # Exit event of the creative. - "name": "A String", # The name of the click tag of the exit event. The name must be unique within one creative. Leave it empty or unset for creatives containing image assets only. - "reportingName": "A String", # The name used to identify this event in reports. Leave it empty or unset for creatives containing image assets only. + "name": "A String", # Optional. The name of the click tag of the exit event. The name must be unique within one creative. Leave it empty or unset for creatives containing image assets only. + "reportingName": "A String", # Optional. The name used to identify this event in reports. Leave it empty or unset for creatives containing image assets only. "type": "A String", # Required. The type of the exit event. "url": "A String", # Required. The click through URL of the exit event. This is required when type is: * `EXIT_EVENT_TYPE_DEFAULT` * `EXIT_EVENT_TYPE_BACKUP` }, @@ -168,33 +168,33 @@

Method Details

"expandingDirection": "A String", # Optional. Specifies the expanding direction of the creative. Required and only valid for third-party expandable creatives. Third-party expandable creatives are creatives with following hosting source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_EXPANDABLE` "hostingSource": "A String", # Required. Indicates where the creative is hosted. "html5Video": True or False, # Output only. Indicates the third-party VAST tag creative requires HTML5 Video support. Output only and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_VIDEO` - "iasCampaignMonitoring": True or False, # Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. To enable this for the creative, make sure the Advertiser.creative_config.ias_client_id has been set to your IAS client ID. - "integrationCode": "A String", # ID information used to link this creative to an external system. Must be UTF-8 encoded with a length of no more than 10,000 characters. - "jsTrackerUrl": "A String", # JavaScript measurement URL from supported third-party verification providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not supported. This field is only writeable in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` + "iasCampaignMonitoring": True or False, # Optional. Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. To enable this for the creative, make sure the Advertiser.creative_config.ias_client_id has been set to your IAS client ID. + "integrationCode": "A String", # Optional. ID information used to link this creative to an external system. Must be UTF-8 encoded with a length of no more than 10,000 characters. + "jsTrackerUrl": "A String", # Optional. JavaScript measurement URL from supported third-party verification providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not supported. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` "lineItemIds": [ # Output only. The IDs of the line items this creative is associated with. To associate a creative to a line item, use LineItem.creative_ids instead. "A String", ], "mediaDuration": "A String", # Output only. Media duration of the creative. Applicable when creative_type is one of: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_PUBLISHER_HOSTED` "mp3Audio": True or False, # Output only. Indicates the third-party audio creative supports MP3. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` "name": "A String", # Output only. The resource name of the creative. - "notes": "A String", # User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters. - "obaIcon": { # OBA Icon for a Creative # Specifies the OBA icon for a video creative. This field is only supported in following creative_type: * `CREATIVE_TYPE_VIDEO` - "clickTrackingUrl": "A String", # Required. The click tracking URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com - "dimensions": { # Dimensions. # The dimensions of the OBA icon. + "notes": "A String", # Optional. User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters. + "obaIcon": { # OBA Icon for a Creative # Optional. Specifies the OBA icon for a video creative. This field is only supported in the following creative_type: * `CREATIVE_TYPE_VIDEO` + "clickTrackingUrl": "A String", # Required. The click tracking URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com` + "dimensions": { # Dimensions. # Optional. The dimensions of the OBA icon. "heightPixels": 42, # The height in pixels. "widthPixels": 42, # The width in pixels. }, - "landingPageUrl": "A String", # Required. The landing page URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com - "position": "A String", # The position of the OBA icon on the creative. - "program": "A String", # The program of the OBA icon. For example: “AdChoices”. - "resourceMimeType": "A String", # The MIME type of the OBA icon resource. - "resourceUrl": "A String", # The URL of the OBA icon resource. - "viewTrackingUrl": "A String", # Required. The view tracking URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com + "landingPageUrl": "A String", # Required. The landing page URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com` + "position": "A String", # Optional. The position of the OBA icon on the creative. + "program": "A String", # Optional. The program of the OBA icon. For example: “AdChoices”. + "resourceMimeType": "A String", # Optional. The MIME type of the OBA icon resource. + "resourceUrl": "A String", # Optional. The URL of the OBA icon resource. + "viewTrackingUrl": "A String", # Required. The view tracking URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com` }, "oggAudio": True or False, # Output only. Indicates the third-party audio creative supports OGG. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` - "progressOffset": { # The length an audio or a video has been played. # Amount of time to play the video before counting a view. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` - "percentage": "A String", # The offset in percentage of the audio or video duration. - "seconds": "A String", # The offset in seconds from the start of the audio or video. + "progressOffset": { # The length an audio or a video has been played. # Optional. Amount of time to play the video before counting a view. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + "percentage": "A String", # Optional. The offset in percentage of the audio or video duration. + "seconds": "A String", # Optional. The offset in seconds from the start of the audio or video. }, "requireHtml5": True or False, # Optional. Indicates that the creative relies on HTML5 to render properly. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` "requireMraid": True or False, # Optional. Indicates that the creative requires MRAID (Mobile Rich Media Ad Interface Definitions system). Set this if the creative relies on mobile gestures for interactivity, such as swiping or tapping. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` @@ -216,46 +216,46 @@

Method Details

}, ], }, - "skipOffset": { # The length an audio or a video has been played. # Amount of time to play the video before the skip button appears. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` - "percentage": "A String", # The offset in percentage of the audio or video duration. - "seconds": "A String", # The offset in seconds from the start of the audio or video. + "skipOffset": { # The length an audio or a video has been played. # Optional. Amount of time to play the video before the skip button appears. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + "percentage": "A String", # Optional. The offset in percentage of the audio or video duration. + "seconds": "A String", # Optional. The offset in seconds from the start of the audio or video. }, - "skippable": True or False, # Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + "skippable": True or False, # Optional. Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` "thirdPartyTag": "A String", # Optional. The original third-party tag used for the creative. Required and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` - "thirdPartyUrls": [ # Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` + "thirdPartyUrls": [ # Optional. Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` { # Tracking URLs from third parties to track interactions with an audio or a video creative. - "type": "A String", # The type of interaction needs to be tracked by the tracking URL - "url": "A String", # Tracking URL used to track the interaction. Provide a URL with optional path or query string, beginning with `https:`. For example, https://www.example.com/path + "type": "A String", # Optional. The type of interaction needs to be tracked by the tracking URL + "url": "A String", # Optional. Tracking URL used to track the interaction. Provide a URL with optional path or query string, beginning with `https:`. For example, `https://www.example.com/path` }, ], - "timerEvents": [ # Timer custom events for a rich media creative. Timers track the time during which a user views and interacts with a specified part of a rich media creative. A creative can have multiple timer events, each timed independently. Leave it empty or unset for creatives containing image assets only. + "timerEvents": [ # Optional. Timer custom events for a rich media creative. Timers track the time during which a user views and interacts with a specified part of a rich media creative. A creative can have multiple timer events, each timed independently. Leave it empty or unset for creatives containing image assets only. { # Timer event of the creative. "name": "A String", # Required. The name of the timer event. "reportingName": "A String", # Required. The name used to identify this timer event in reports. }, ], - "trackerUrls": [ # Tracking URLs for analytics providers or third-party ad technology vendors. The URLs must start with https (except on inventory that doesn't require SSL compliance). If using macros in your URL, use only macros supported by Display & Video 360. Standard URLs only, no IMG or SCRIPT tags. This field is only writeable in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` + "trackerUrls": [ # Optional. Tracking URLs for analytics providers or third-party ad technology vendors. The URLs must start with `https:` (except on inventory that doesn't require SSL compliance). If using macros in your URL, use only macros supported by Display & Video 360. Standard URLs only, no IMG or SCRIPT tags. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` "A String", ], - "transcodes": [ # Output only. Audio/Video transcodes. Display & Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher's system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer’s connection and screen size. This field is only supported in following creative_type: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_AUDIO` + "transcodes": [ # Output only. Audio/Video transcodes. Display & Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher's system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer’s connection and screen size. This field is only supported in the following creative_type: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_AUDIO` { # Represents information about the transcoded audio or video file. - "audioBitRateKbps": "A String", # The bit rate for the audio stream of the transcoded video, or the bit rate for the transcoded audio, in kilobits per second. - "audioSampleRateHz": "A String", # The sample rate for the audio stream of the transcoded video, or the sample rate for the transcoded audio, in hertz. - "bitRateKbps": "A String", # The transcoding bit rate of the transcoded video, in kilobits per second. - "dimensions": { # Dimensions. # The dimensions of the transcoded video. + "audioBitRateKbps": "A String", # Optional. The bit rate for the audio stream of the transcoded video, or the bit rate for the transcoded audio, in kilobits per second. + "audioSampleRateHz": "A String", # Optional. The sample rate for the audio stream of the transcoded video, or the sample rate for the transcoded audio, in hertz. + "bitRateKbps": "A String", # Optional. The transcoding bit rate of the transcoded video, in kilobits per second. + "dimensions": { # Dimensions. # Optional. The dimensions of the transcoded video. "heightPixels": 42, # The height in pixels. "widthPixels": 42, # The width in pixels. }, - "fileSizeBytes": "A String", # The size of the transcoded file, in bytes. - "frameRate": 3.14, # The frame rate of the transcoded video, in frames per second. - "mimeType": "A String", # The MIME type of the transcoded file. - "name": "A String", # The name of the transcoded file. - "transcoded": True or False, # Indicates if the transcoding was successful. + "fileSizeBytes": "A String", # Optional. The size of the transcoded file, in bytes. + "frameRate": 3.14, # Optional. The frame rate of the transcoded video, in frames per second. + "mimeType": "A String", # Optional. The MIME type of the transcoded file. + "name": "A String", # Optional. The name of the transcoded file. + "transcoded": True or False, # Optional. Indicates if the transcoding was successful. }, ], "universalAdId": { # A creative identifier provided by a registry that is unique across all platforms. This is part of the VAST 4.0 standard. # Optional. An optional creative identifier provided by a registry that is unique across all platforms. Universal Ad ID is part of the VAST 4.0 standard. It can be modified after the creative is created. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` - "id": "A String", # The unique creative identifier. - "registry": "A String", # The registry provides unique creative identifiers. + "id": "A String", # Optional. The unique creative identifier. + "registry": "A String", # Optional. The registry provides unique creative identifiers. }, "updateTime": "A String", # Output only. The timestamp when the creative was last updated, either by the user or system (e.g. creative review). Assigned by the system. "vastTagUrl": "A String", # Optional. The URL of the VAST tag for a third-party VAST tag creative. Required and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` @@ -271,33 +271,33 @@

Method Details

An object of the form: { # A single Creative. - "additionalDimensions": [ # Additional dimensions. Applicable when creative_type is one of: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_LIGHTBOX` * `CREATIVE_TYPE_PUBLISHER_HOSTED` If this field is specified, width_pixels and height_pixels are both required and must be greater than or equal to 0. + "additionalDimensions": [ # Optional. Additional dimensions. Applicable when creative_type is one of: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_LIGHTBOX` * `CREATIVE_TYPE_PUBLISHER_HOSTED` If this field is specified, width_pixels and height_pixels are both required and must be greater than or equal to 0. { # Dimensions. "heightPixels": 42, # The height in pixels. "widthPixels": 42, # The width in pixels. }, ], "advertiserId": "A String", # Output only. The unique ID of the advertiser the creative belongs to. - "appendedTag": "A String", # Third-party HTML tracking tag to be appended to the creative tag. + "appendedTag": "A String", # Optional. Third-party HTML tracking tag to be appended to the creative tag. "assets": [ # Required. Assets associated to this creative. { # Asset association for the creative. - "asset": { # A single asset. # The associated asset. + "asset": { # A single asset. # Optional. The associated asset. "content": "A String", # The asset content. For uploaded assets, the content is the serving path. "mediaId": "A String", # Media ID of the uploaded asset. This is a unique identifier for the asset. This ID can be passed to other API calls, e.g. CreateCreative to associate the asset with a creative. The Media ID space updated on **April 5, 2023**. Update media IDs cached before **April 5, 2023** by retrieving the new media ID from associated creative resources or re-uploading the asset. }, - "role": "A String", # The role of this asset for the creative. + "role": "A String", # Optional. The role of this asset for the creative. }, ], "cmPlacementId": "A String", # Output only. The unique ID of the Campaign Manager 360 placement associated with the creative. This field is only applicable for creatives that are synced from Campaign Manager. - "cmTrackingAd": { # A Campaign Manager 360 tracking ad. # The Campaign Manager 360 tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager 360 and third-party ad serving: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` Output only for other cases. - "cmAdId": "A String", # The ad ID of the campaign manager 360 tracking Ad. - "cmCreativeId": "A String", # The creative ID of the campaign manager 360 tracking Ad. - "cmPlacementId": "A String", # The placement ID of the campaign manager 360 tracking Ad. + "cmTrackingAd": { # A Campaign Manager 360 tracking ad. # Optional. The Campaign Manager 360 tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager 360 and third-party ad serving: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` Output only for other cases. + "cmAdId": "A String", # Optional. The ad ID of the campaign manager 360 tracking Ad. + "cmCreativeId": "A String", # Optional. The creative ID of the campaign manager 360 tracking Ad. + "cmPlacementId": "A String", # Optional. The placement ID of the campaign manager 360 tracking Ad. }, - "companionCreativeIds": [ # The IDs of companion creatives for a video creative. You can assign existing display creatives (with image or HTML5 assets) to serve surrounding the publisher's video player. Companions display around the video player while the video is playing and remain after the video has completed. Creatives contain additional dimensions can not be companion creatives. This field is only supported for following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` + "companionCreativeIds": [ # Optional. The IDs of companion creatives for a video creative. You can assign existing display creatives (with image or HTML5 assets) to serve surrounding the publisher's video player. Companions display around the video player while the video is playing and remain after the video has completed. Creatives contain additional dimensions can not be companion creatives. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` "A String", ], - "counterEvents": [ # Counter events for a rich media creative. Counters track the number of times that a user interacts with any part of a rich media creative in a specified way (mouse-overs, mouse-outs, clicks, taps, data loading, keyboard entries, etc.). Any event that can be captured in the creative can be recorded as a counter. Leave it empty or unset for creatives containing image assets only. + "counterEvents": [ # Optional. Counter events for a rich media creative. Counters track the number of times that a user interacts with any part of a rich media creative in a specified way (mouse-overs, mouse-outs, clicks, taps, data loading, keyboard entries, etc.). Any event that can be captured in the creative can be recorded as a counter. Leave it empty or unset for creatives containing image assets only. { # Counter event of the creative. "name": "A String", # Required. The name of the counter event. "reportingName": "A String", # Required. The name used to identify this counter event in reports. @@ -318,8 +318,8 @@

Method Details

"entityStatus": "A String", # Required. Controls whether or not the creative can serve. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED` * `ENTITY_STATUS_PAUSED` "exitEvents": [ # Required. Exit events for this creative. An exit (also known as a click tag) is any area in your creative that someone can click or tap to open an advertiser's landing page. Every creative must include at least one exit. You can add an exit to your creative in any of the following ways: * Use Google Web Designer's tap area. * Define a JavaScript variable called "clickTag". * Use the Enabler (Enabler.exit()) to track exits in rich media formats. { # Exit event of the creative. - "name": "A String", # The name of the click tag of the exit event. The name must be unique within one creative. Leave it empty or unset for creatives containing image assets only. - "reportingName": "A String", # The name used to identify this event in reports. Leave it empty or unset for creatives containing image assets only. + "name": "A String", # Optional. The name of the click tag of the exit event. The name must be unique within one creative. Leave it empty or unset for creatives containing image assets only. + "reportingName": "A String", # Optional. The name used to identify this event in reports. Leave it empty or unset for creatives containing image assets only. "type": "A String", # Required. The type of the exit event. "url": "A String", # Required. The click through URL of the exit event. This is required when type is: * `EXIT_EVENT_TYPE_DEFAULT` * `EXIT_EVENT_TYPE_BACKUP` }, @@ -328,33 +328,33 @@

Method Details

"expandingDirection": "A String", # Optional. Specifies the expanding direction of the creative. Required and only valid for third-party expandable creatives. Third-party expandable creatives are creatives with following hosting source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_EXPANDABLE` "hostingSource": "A String", # Required. Indicates where the creative is hosted. "html5Video": True or False, # Output only. Indicates the third-party VAST tag creative requires HTML5 Video support. Output only and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_VIDEO` - "iasCampaignMonitoring": True or False, # Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. To enable this for the creative, make sure the Advertiser.creative_config.ias_client_id has been set to your IAS client ID. - "integrationCode": "A String", # ID information used to link this creative to an external system. Must be UTF-8 encoded with a length of no more than 10,000 characters. - "jsTrackerUrl": "A String", # JavaScript measurement URL from supported third-party verification providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not supported. This field is only writeable in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` + "iasCampaignMonitoring": True or False, # Optional. Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. To enable this for the creative, make sure the Advertiser.creative_config.ias_client_id has been set to your IAS client ID. + "integrationCode": "A String", # Optional. ID information used to link this creative to an external system. Must be UTF-8 encoded with a length of no more than 10,000 characters. + "jsTrackerUrl": "A String", # Optional. JavaScript measurement URL from supported third-party verification providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not supported. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` "lineItemIds": [ # Output only. The IDs of the line items this creative is associated with. To associate a creative to a line item, use LineItem.creative_ids instead. "A String", ], "mediaDuration": "A String", # Output only. Media duration of the creative. Applicable when creative_type is one of: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_PUBLISHER_HOSTED` "mp3Audio": True or False, # Output only. Indicates the third-party audio creative supports MP3. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` "name": "A String", # Output only. The resource name of the creative. - "notes": "A String", # User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters. - "obaIcon": { # OBA Icon for a Creative # Specifies the OBA icon for a video creative. This field is only supported in following creative_type: * `CREATIVE_TYPE_VIDEO` - "clickTrackingUrl": "A String", # Required. The click tracking URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com - "dimensions": { # Dimensions. # The dimensions of the OBA icon. + "notes": "A String", # Optional. User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters. + "obaIcon": { # OBA Icon for a Creative # Optional. Specifies the OBA icon for a video creative. This field is only supported in the following creative_type: * `CREATIVE_TYPE_VIDEO` + "clickTrackingUrl": "A String", # Required. The click tracking URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com` + "dimensions": { # Dimensions. # Optional. The dimensions of the OBA icon. "heightPixels": 42, # The height in pixels. "widthPixels": 42, # The width in pixels. }, - "landingPageUrl": "A String", # Required. The landing page URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com - "position": "A String", # The position of the OBA icon on the creative. - "program": "A String", # The program of the OBA icon. For example: “AdChoices”. - "resourceMimeType": "A String", # The MIME type of the OBA icon resource. - "resourceUrl": "A String", # The URL of the OBA icon resource. - "viewTrackingUrl": "A String", # Required. The view tracking URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com + "landingPageUrl": "A String", # Required. The landing page URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com` + "position": "A String", # Optional. The position of the OBA icon on the creative. + "program": "A String", # Optional. The program of the OBA icon. For example: “AdChoices”. + "resourceMimeType": "A String", # Optional. The MIME type of the OBA icon resource. + "resourceUrl": "A String", # Optional. The URL of the OBA icon resource. + "viewTrackingUrl": "A String", # Required. The view tracking URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com` }, "oggAudio": True or False, # Output only. Indicates the third-party audio creative supports OGG. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` - "progressOffset": { # The length an audio or a video has been played. # Amount of time to play the video before counting a view. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` - "percentage": "A String", # The offset in percentage of the audio or video duration. - "seconds": "A String", # The offset in seconds from the start of the audio or video. + "progressOffset": { # The length an audio or a video has been played. # Optional. Amount of time to play the video before counting a view. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + "percentage": "A String", # Optional. The offset in percentage of the audio or video duration. + "seconds": "A String", # Optional. The offset in seconds from the start of the audio or video. }, "requireHtml5": True or False, # Optional. Indicates that the creative relies on HTML5 to render properly. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` "requireMraid": True or False, # Optional. Indicates that the creative requires MRAID (Mobile Rich Media Ad Interface Definitions system). Set this if the creative relies on mobile gestures for interactivity, such as swiping or tapping. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` @@ -376,46 +376,46 @@

Method Details

}, ], }, - "skipOffset": { # The length an audio or a video has been played. # Amount of time to play the video before the skip button appears. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` - "percentage": "A String", # The offset in percentage of the audio or video duration. - "seconds": "A String", # The offset in seconds from the start of the audio or video. + "skipOffset": { # The length an audio or a video has been played. # Optional. Amount of time to play the video before the skip button appears. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + "percentage": "A String", # Optional. The offset in percentage of the audio or video duration. + "seconds": "A String", # Optional. The offset in seconds from the start of the audio or video. }, - "skippable": True or False, # Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + "skippable": True or False, # Optional. Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` "thirdPartyTag": "A String", # Optional. The original third-party tag used for the creative. Required and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` - "thirdPartyUrls": [ # Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` + "thirdPartyUrls": [ # Optional. Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` { # Tracking URLs from third parties to track interactions with an audio or a video creative. - "type": "A String", # The type of interaction needs to be tracked by the tracking URL - "url": "A String", # Tracking URL used to track the interaction. Provide a URL with optional path or query string, beginning with `https:`. For example, https://www.example.com/path + "type": "A String", # Optional. The type of interaction needs to be tracked by the tracking URL + "url": "A String", # Optional. Tracking URL used to track the interaction. Provide a URL with optional path or query string, beginning with `https:`. For example, `https://www.example.com/path` }, ], - "timerEvents": [ # Timer custom events for a rich media creative. Timers track the time during which a user views and interacts with a specified part of a rich media creative. A creative can have multiple timer events, each timed independently. Leave it empty or unset for creatives containing image assets only. + "timerEvents": [ # Optional. Timer custom events for a rich media creative. Timers track the time during which a user views and interacts with a specified part of a rich media creative. A creative can have multiple timer events, each timed independently. Leave it empty or unset for creatives containing image assets only. { # Timer event of the creative. "name": "A String", # Required. The name of the timer event. "reportingName": "A String", # Required. The name used to identify this timer event in reports. }, ], - "trackerUrls": [ # Tracking URLs for analytics providers or third-party ad technology vendors. The URLs must start with https (except on inventory that doesn't require SSL compliance). If using macros in your URL, use only macros supported by Display & Video 360. Standard URLs only, no IMG or SCRIPT tags. This field is only writeable in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` + "trackerUrls": [ # Optional. Tracking URLs for analytics providers or third-party ad technology vendors. The URLs must start with `https:` (except on inventory that doesn't require SSL compliance). If using macros in your URL, use only macros supported by Display & Video 360. Standard URLs only, no IMG or SCRIPT tags. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` "A String", ], - "transcodes": [ # Output only. Audio/Video transcodes. Display & Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher's system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer’s connection and screen size. This field is only supported in following creative_type: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_AUDIO` + "transcodes": [ # Output only. Audio/Video transcodes. Display & Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher's system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer’s connection and screen size. This field is only supported in the following creative_type: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_AUDIO` { # Represents information about the transcoded audio or video file. - "audioBitRateKbps": "A String", # The bit rate for the audio stream of the transcoded video, or the bit rate for the transcoded audio, in kilobits per second. - "audioSampleRateHz": "A String", # The sample rate for the audio stream of the transcoded video, or the sample rate for the transcoded audio, in hertz. - "bitRateKbps": "A String", # The transcoding bit rate of the transcoded video, in kilobits per second. - "dimensions": { # Dimensions. # The dimensions of the transcoded video. + "audioBitRateKbps": "A String", # Optional. The bit rate for the audio stream of the transcoded video, or the bit rate for the transcoded audio, in kilobits per second. + "audioSampleRateHz": "A String", # Optional. The sample rate for the audio stream of the transcoded video, or the sample rate for the transcoded audio, in hertz. + "bitRateKbps": "A String", # Optional. The transcoding bit rate of the transcoded video, in kilobits per second. + "dimensions": { # Dimensions. # Optional. The dimensions of the transcoded video. "heightPixels": 42, # The height in pixels. "widthPixels": 42, # The width in pixels. }, - "fileSizeBytes": "A String", # The size of the transcoded file, in bytes. - "frameRate": 3.14, # The frame rate of the transcoded video, in frames per second. - "mimeType": "A String", # The MIME type of the transcoded file. - "name": "A String", # The name of the transcoded file. - "transcoded": True or False, # Indicates if the transcoding was successful. + "fileSizeBytes": "A String", # Optional. The size of the transcoded file, in bytes. + "frameRate": 3.14, # Optional. The frame rate of the transcoded video, in frames per second. + "mimeType": "A String", # Optional. The MIME type of the transcoded file. + "name": "A String", # Optional. The name of the transcoded file. + "transcoded": True or False, # Optional. Indicates if the transcoding was successful. }, ], "universalAdId": { # A creative identifier provided by a registry that is unique across all platforms. This is part of the VAST 4.0 standard. # Optional. An optional creative identifier provided by a registry that is unique across all platforms. Universal Ad ID is part of the VAST 4.0 standard. It can be modified after the creative is created. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` - "id": "A String", # The unique creative identifier. - "registry": "A String", # The registry provides unique creative identifiers. + "id": "A String", # Optional. The unique creative identifier. + "registry": "A String", # Optional. The registry provides unique creative identifiers. }, "updateTime": "A String", # Output only. The timestamp when the creative was last updated, either by the user or system (e.g. creative review). Assigned by the system. "vastTagUrl": "A String", # Optional. The URL of the VAST tag for a third-party VAST tag creative. Required and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` @@ -458,33 +458,33 @@

Method Details

An object of the form: { # A single Creative. - "additionalDimensions": [ # Additional dimensions. Applicable when creative_type is one of: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_LIGHTBOX` * `CREATIVE_TYPE_PUBLISHER_HOSTED` If this field is specified, width_pixels and height_pixels are both required and must be greater than or equal to 0. + "additionalDimensions": [ # Optional. Additional dimensions. Applicable when creative_type is one of: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_LIGHTBOX` * `CREATIVE_TYPE_PUBLISHER_HOSTED` If this field is specified, width_pixels and height_pixels are both required and must be greater than or equal to 0. { # Dimensions. "heightPixels": 42, # The height in pixels. "widthPixels": 42, # The width in pixels. }, ], "advertiserId": "A String", # Output only. The unique ID of the advertiser the creative belongs to. - "appendedTag": "A String", # Third-party HTML tracking tag to be appended to the creative tag. + "appendedTag": "A String", # Optional. Third-party HTML tracking tag to be appended to the creative tag. "assets": [ # Required. Assets associated to this creative. { # Asset association for the creative. - "asset": { # A single asset. # The associated asset. + "asset": { # A single asset. # Optional. The associated asset. "content": "A String", # The asset content. For uploaded assets, the content is the serving path. "mediaId": "A String", # Media ID of the uploaded asset. This is a unique identifier for the asset. This ID can be passed to other API calls, e.g. CreateCreative to associate the asset with a creative. The Media ID space updated on **April 5, 2023**. Update media IDs cached before **April 5, 2023** by retrieving the new media ID from associated creative resources or re-uploading the asset. }, - "role": "A String", # The role of this asset for the creative. + "role": "A String", # Optional. The role of this asset for the creative. }, ], "cmPlacementId": "A String", # Output only. The unique ID of the Campaign Manager 360 placement associated with the creative. This field is only applicable for creatives that are synced from Campaign Manager. - "cmTrackingAd": { # A Campaign Manager 360 tracking ad. # The Campaign Manager 360 tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager 360 and third-party ad serving: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` Output only for other cases. - "cmAdId": "A String", # The ad ID of the campaign manager 360 tracking Ad. - "cmCreativeId": "A String", # The creative ID of the campaign manager 360 tracking Ad. - "cmPlacementId": "A String", # The placement ID of the campaign manager 360 tracking Ad. + "cmTrackingAd": { # A Campaign Manager 360 tracking ad. # Optional. The Campaign Manager 360 tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager 360 and third-party ad serving: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` Output only for other cases. + "cmAdId": "A String", # Optional. The ad ID of the campaign manager 360 tracking Ad. + "cmCreativeId": "A String", # Optional. The creative ID of the campaign manager 360 tracking Ad. + "cmPlacementId": "A String", # Optional. The placement ID of the campaign manager 360 tracking Ad. }, - "companionCreativeIds": [ # The IDs of companion creatives for a video creative. You can assign existing display creatives (with image or HTML5 assets) to serve surrounding the publisher's video player. Companions display around the video player while the video is playing and remain after the video has completed. Creatives contain additional dimensions can not be companion creatives. This field is only supported for following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` + "companionCreativeIds": [ # Optional. The IDs of companion creatives for a video creative. You can assign existing display creatives (with image or HTML5 assets) to serve surrounding the publisher's video player. Companions display around the video player while the video is playing and remain after the video has completed. Creatives contain additional dimensions can not be companion creatives. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` "A String", ], - "counterEvents": [ # Counter events for a rich media creative. Counters track the number of times that a user interacts with any part of a rich media creative in a specified way (mouse-overs, mouse-outs, clicks, taps, data loading, keyboard entries, etc.). Any event that can be captured in the creative can be recorded as a counter. Leave it empty or unset for creatives containing image assets only. + "counterEvents": [ # Optional. Counter events for a rich media creative. Counters track the number of times that a user interacts with any part of a rich media creative in a specified way (mouse-overs, mouse-outs, clicks, taps, data loading, keyboard entries, etc.). Any event that can be captured in the creative can be recorded as a counter. Leave it empty or unset for creatives containing image assets only. { # Counter event of the creative. "name": "A String", # Required. The name of the counter event. "reportingName": "A String", # Required. The name used to identify this counter event in reports. @@ -505,8 +505,8 @@

Method Details

"entityStatus": "A String", # Required. Controls whether or not the creative can serve. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED` * `ENTITY_STATUS_PAUSED` "exitEvents": [ # Required. Exit events for this creative. An exit (also known as a click tag) is any area in your creative that someone can click or tap to open an advertiser's landing page. Every creative must include at least one exit. You can add an exit to your creative in any of the following ways: * Use Google Web Designer's tap area. * Define a JavaScript variable called "clickTag". * Use the Enabler (Enabler.exit()) to track exits in rich media formats. { # Exit event of the creative. - "name": "A String", # The name of the click tag of the exit event. The name must be unique within one creative. Leave it empty or unset for creatives containing image assets only. - "reportingName": "A String", # The name used to identify this event in reports. Leave it empty or unset for creatives containing image assets only. + "name": "A String", # Optional. The name of the click tag of the exit event. The name must be unique within one creative. Leave it empty or unset for creatives containing image assets only. + "reportingName": "A String", # Optional. The name used to identify this event in reports. Leave it empty or unset for creatives containing image assets only. "type": "A String", # Required. The type of the exit event. "url": "A String", # Required. The click through URL of the exit event. This is required when type is: * `EXIT_EVENT_TYPE_DEFAULT` * `EXIT_EVENT_TYPE_BACKUP` }, @@ -515,33 +515,33 @@

Method Details

"expandingDirection": "A String", # Optional. Specifies the expanding direction of the creative. Required and only valid for third-party expandable creatives. Third-party expandable creatives are creatives with following hosting source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_EXPANDABLE` "hostingSource": "A String", # Required. Indicates where the creative is hosted. "html5Video": True or False, # Output only. Indicates the third-party VAST tag creative requires HTML5 Video support. Output only and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_VIDEO` - "iasCampaignMonitoring": True or False, # Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. To enable this for the creative, make sure the Advertiser.creative_config.ias_client_id has been set to your IAS client ID. - "integrationCode": "A String", # ID information used to link this creative to an external system. Must be UTF-8 encoded with a length of no more than 10,000 characters. - "jsTrackerUrl": "A String", # JavaScript measurement URL from supported third-party verification providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not supported. This field is only writeable in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` + "iasCampaignMonitoring": True or False, # Optional. Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. To enable this for the creative, make sure the Advertiser.creative_config.ias_client_id has been set to your IAS client ID. + "integrationCode": "A String", # Optional. ID information used to link this creative to an external system. Must be UTF-8 encoded with a length of no more than 10,000 characters. + "jsTrackerUrl": "A String", # Optional. JavaScript measurement URL from supported third-party verification providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not supported. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` "lineItemIds": [ # Output only. The IDs of the line items this creative is associated with. To associate a creative to a line item, use LineItem.creative_ids instead. "A String", ], "mediaDuration": "A String", # Output only. Media duration of the creative. Applicable when creative_type is one of: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_PUBLISHER_HOSTED` "mp3Audio": True or False, # Output only. Indicates the third-party audio creative supports MP3. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` "name": "A String", # Output only. The resource name of the creative. - "notes": "A String", # User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters. - "obaIcon": { # OBA Icon for a Creative # Specifies the OBA icon for a video creative. This field is only supported in following creative_type: * `CREATIVE_TYPE_VIDEO` - "clickTrackingUrl": "A String", # Required. The click tracking URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com - "dimensions": { # Dimensions. # The dimensions of the OBA icon. + "notes": "A String", # Optional. User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters. + "obaIcon": { # OBA Icon for a Creative # Optional. Specifies the OBA icon for a video creative. This field is only supported in the following creative_type: * `CREATIVE_TYPE_VIDEO` + "clickTrackingUrl": "A String", # Required. The click tracking URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com` + "dimensions": { # Dimensions. # Optional. The dimensions of the OBA icon. "heightPixels": 42, # The height in pixels. "widthPixels": 42, # The width in pixels. }, - "landingPageUrl": "A String", # Required. The landing page URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com - "position": "A String", # The position of the OBA icon on the creative. - "program": "A String", # The program of the OBA icon. For example: “AdChoices”. - "resourceMimeType": "A String", # The MIME type of the OBA icon resource. - "resourceUrl": "A String", # The URL of the OBA icon resource. - "viewTrackingUrl": "A String", # Required. The view tracking URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com + "landingPageUrl": "A String", # Required. The landing page URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com` + "position": "A String", # Optional. The position of the OBA icon on the creative. + "program": "A String", # Optional. The program of the OBA icon. For example: “AdChoices”. + "resourceMimeType": "A String", # Optional. The MIME type of the OBA icon resource. + "resourceUrl": "A String", # Optional. The URL of the OBA icon resource. + "viewTrackingUrl": "A String", # Required. The view tracking URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com` }, "oggAudio": True or False, # Output only. Indicates the third-party audio creative supports OGG. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` - "progressOffset": { # The length an audio or a video has been played. # Amount of time to play the video before counting a view. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` - "percentage": "A String", # The offset in percentage of the audio or video duration. - "seconds": "A String", # The offset in seconds from the start of the audio or video. + "progressOffset": { # The length an audio or a video has been played. # Optional. Amount of time to play the video before counting a view. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + "percentage": "A String", # Optional. The offset in percentage of the audio or video duration. + "seconds": "A String", # Optional. The offset in seconds from the start of the audio or video. }, "requireHtml5": True or False, # Optional. Indicates that the creative relies on HTML5 to render properly. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` "requireMraid": True or False, # Optional. Indicates that the creative requires MRAID (Mobile Rich Media Ad Interface Definitions system). Set this if the creative relies on mobile gestures for interactivity, such as swiping or tapping. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` @@ -563,46 +563,46 @@

Method Details

}, ], }, - "skipOffset": { # The length an audio or a video has been played. # Amount of time to play the video before the skip button appears. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` - "percentage": "A String", # The offset in percentage of the audio or video duration. - "seconds": "A String", # The offset in seconds from the start of the audio or video. + "skipOffset": { # The length an audio or a video has been played. # Optional. Amount of time to play the video before the skip button appears. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + "percentage": "A String", # Optional. The offset in percentage of the audio or video duration. + "seconds": "A String", # Optional. The offset in seconds from the start of the audio or video. }, - "skippable": True or False, # Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + "skippable": True or False, # Optional. Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` "thirdPartyTag": "A String", # Optional. The original third-party tag used for the creative. Required and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` - "thirdPartyUrls": [ # Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` + "thirdPartyUrls": [ # Optional. Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` { # Tracking URLs from third parties to track interactions with an audio or a video creative. - "type": "A String", # The type of interaction needs to be tracked by the tracking URL - "url": "A String", # Tracking URL used to track the interaction. Provide a URL with optional path or query string, beginning with `https:`. For example, https://www.example.com/path + "type": "A String", # Optional. The type of interaction needs to be tracked by the tracking URL + "url": "A String", # Optional. Tracking URL used to track the interaction. Provide a URL with optional path or query string, beginning with `https:`. For example, `https://www.example.com/path` }, ], - "timerEvents": [ # Timer custom events for a rich media creative. Timers track the time during which a user views and interacts with a specified part of a rich media creative. A creative can have multiple timer events, each timed independently. Leave it empty or unset for creatives containing image assets only. + "timerEvents": [ # Optional. Timer custom events for a rich media creative. Timers track the time during which a user views and interacts with a specified part of a rich media creative. A creative can have multiple timer events, each timed independently. Leave it empty or unset for creatives containing image assets only. { # Timer event of the creative. "name": "A String", # Required. The name of the timer event. "reportingName": "A String", # Required. The name used to identify this timer event in reports. }, ], - "trackerUrls": [ # Tracking URLs for analytics providers or third-party ad technology vendors. The URLs must start with https (except on inventory that doesn't require SSL compliance). If using macros in your URL, use only macros supported by Display & Video 360. Standard URLs only, no IMG or SCRIPT tags. This field is only writeable in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` + "trackerUrls": [ # Optional. Tracking URLs for analytics providers or third-party ad technology vendors. The URLs must start with `https:` (except on inventory that doesn't require SSL compliance). If using macros in your URL, use only macros supported by Display & Video 360. Standard URLs only, no IMG or SCRIPT tags. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` "A String", ], - "transcodes": [ # Output only. Audio/Video transcodes. Display & Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher's system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer’s connection and screen size. This field is only supported in following creative_type: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_AUDIO` + "transcodes": [ # Output only. Audio/Video transcodes. Display & Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher's system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer’s connection and screen size. This field is only supported in the following creative_type: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_AUDIO` { # Represents information about the transcoded audio or video file. - "audioBitRateKbps": "A String", # The bit rate for the audio stream of the transcoded video, or the bit rate for the transcoded audio, in kilobits per second. - "audioSampleRateHz": "A String", # The sample rate for the audio stream of the transcoded video, or the sample rate for the transcoded audio, in hertz. - "bitRateKbps": "A String", # The transcoding bit rate of the transcoded video, in kilobits per second. - "dimensions": { # Dimensions. # The dimensions of the transcoded video. + "audioBitRateKbps": "A String", # Optional. The bit rate for the audio stream of the transcoded video, or the bit rate for the transcoded audio, in kilobits per second. + "audioSampleRateHz": "A String", # Optional. The sample rate for the audio stream of the transcoded video, or the sample rate for the transcoded audio, in hertz. + "bitRateKbps": "A String", # Optional. The transcoding bit rate of the transcoded video, in kilobits per second. + "dimensions": { # Dimensions. # Optional. The dimensions of the transcoded video. "heightPixels": 42, # The height in pixels. "widthPixels": 42, # The width in pixels. }, - "fileSizeBytes": "A String", # The size of the transcoded file, in bytes. - "frameRate": 3.14, # The frame rate of the transcoded video, in frames per second. - "mimeType": "A String", # The MIME type of the transcoded file. - "name": "A String", # The name of the transcoded file. - "transcoded": True or False, # Indicates if the transcoding was successful. + "fileSizeBytes": "A String", # Optional. The size of the transcoded file, in bytes. + "frameRate": 3.14, # Optional. The frame rate of the transcoded video, in frames per second. + "mimeType": "A String", # Optional. The MIME type of the transcoded file. + "name": "A String", # Optional. The name of the transcoded file. + "transcoded": True or False, # Optional. Indicates if the transcoding was successful. }, ], "universalAdId": { # A creative identifier provided by a registry that is unique across all platforms. This is part of the VAST 4.0 standard. # Optional. An optional creative identifier provided by a registry that is unique across all platforms. Universal Ad ID is part of the VAST 4.0 standard. It can be modified after the creative is created. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` - "id": "A String", # The unique creative identifier. - "registry": "A String", # The registry provides unique creative identifiers. + "id": "A String", # Optional. The unique creative identifier. + "registry": "A String", # Optional. The registry provides unique creative identifiers. }, "updateTime": "A String", # Output only. The timestamp when the creative was last updated, either by the user or system (e.g. creative review). Assigned by the system. "vastTagUrl": "A String", # Optional. The URL of the VAST tag for a third-party VAST tag creative. Required and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` @@ -631,33 +631,33 @@

Method Details

{ "creatives": [ # The list of creatives. This list will be absent if empty. { # A single Creative. - "additionalDimensions": [ # Additional dimensions. Applicable when creative_type is one of: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_LIGHTBOX` * `CREATIVE_TYPE_PUBLISHER_HOSTED` If this field is specified, width_pixels and height_pixels are both required and must be greater than or equal to 0. + "additionalDimensions": [ # Optional. Additional dimensions. Applicable when creative_type is one of: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_LIGHTBOX` * `CREATIVE_TYPE_PUBLISHER_HOSTED` If this field is specified, width_pixels and height_pixels are both required and must be greater than or equal to 0. { # Dimensions. "heightPixels": 42, # The height in pixels. "widthPixels": 42, # The width in pixels. }, ], "advertiserId": "A String", # Output only. The unique ID of the advertiser the creative belongs to. - "appendedTag": "A String", # Third-party HTML tracking tag to be appended to the creative tag. + "appendedTag": "A String", # Optional. Third-party HTML tracking tag to be appended to the creative tag. "assets": [ # Required. Assets associated to this creative. { # Asset association for the creative. - "asset": { # A single asset. # The associated asset. + "asset": { # A single asset. # Optional. The associated asset. "content": "A String", # The asset content. For uploaded assets, the content is the serving path. "mediaId": "A String", # Media ID of the uploaded asset. This is a unique identifier for the asset. This ID can be passed to other API calls, e.g. CreateCreative to associate the asset with a creative. The Media ID space updated on **April 5, 2023**. Update media IDs cached before **April 5, 2023** by retrieving the new media ID from associated creative resources or re-uploading the asset. }, - "role": "A String", # The role of this asset for the creative. + "role": "A String", # Optional. The role of this asset for the creative. }, ], "cmPlacementId": "A String", # Output only. The unique ID of the Campaign Manager 360 placement associated with the creative. This field is only applicable for creatives that are synced from Campaign Manager. - "cmTrackingAd": { # A Campaign Manager 360 tracking ad. # The Campaign Manager 360 tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager 360 and third-party ad serving: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` Output only for other cases. - "cmAdId": "A String", # The ad ID of the campaign manager 360 tracking Ad. - "cmCreativeId": "A String", # The creative ID of the campaign manager 360 tracking Ad. - "cmPlacementId": "A String", # The placement ID of the campaign manager 360 tracking Ad. + "cmTrackingAd": { # A Campaign Manager 360 tracking ad. # Optional. The Campaign Manager 360 tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager 360 and third-party ad serving: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` Output only for other cases. + "cmAdId": "A String", # Optional. The ad ID of the campaign manager 360 tracking Ad. + "cmCreativeId": "A String", # Optional. The creative ID of the campaign manager 360 tracking Ad. + "cmPlacementId": "A String", # Optional. The placement ID of the campaign manager 360 tracking Ad. }, - "companionCreativeIds": [ # The IDs of companion creatives for a video creative. You can assign existing display creatives (with image or HTML5 assets) to serve surrounding the publisher's video player. Companions display around the video player while the video is playing and remain after the video has completed. Creatives contain additional dimensions can not be companion creatives. This field is only supported for following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` + "companionCreativeIds": [ # Optional. The IDs of companion creatives for a video creative. You can assign existing display creatives (with image or HTML5 assets) to serve surrounding the publisher's video player. Companions display around the video player while the video is playing and remain after the video has completed. Creatives contain additional dimensions can not be companion creatives. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` "A String", ], - "counterEvents": [ # Counter events for a rich media creative. Counters track the number of times that a user interacts with any part of a rich media creative in a specified way (mouse-overs, mouse-outs, clicks, taps, data loading, keyboard entries, etc.). Any event that can be captured in the creative can be recorded as a counter. Leave it empty or unset for creatives containing image assets only. + "counterEvents": [ # Optional. Counter events for a rich media creative. Counters track the number of times that a user interacts with any part of a rich media creative in a specified way (mouse-overs, mouse-outs, clicks, taps, data loading, keyboard entries, etc.). Any event that can be captured in the creative can be recorded as a counter. Leave it empty or unset for creatives containing image assets only. { # Counter event of the creative. "name": "A String", # Required. The name of the counter event. "reportingName": "A String", # Required. The name used to identify this counter event in reports. @@ -678,8 +678,8 @@

Method Details

"entityStatus": "A String", # Required. Controls whether or not the creative can serve. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED` * `ENTITY_STATUS_PAUSED` "exitEvents": [ # Required. Exit events for this creative. An exit (also known as a click tag) is any area in your creative that someone can click or tap to open an advertiser's landing page. Every creative must include at least one exit. You can add an exit to your creative in any of the following ways: * Use Google Web Designer's tap area. * Define a JavaScript variable called "clickTag". * Use the Enabler (Enabler.exit()) to track exits in rich media formats. { # Exit event of the creative. - "name": "A String", # The name of the click tag of the exit event. The name must be unique within one creative. Leave it empty or unset for creatives containing image assets only. - "reportingName": "A String", # The name used to identify this event in reports. Leave it empty or unset for creatives containing image assets only. + "name": "A String", # Optional. The name of the click tag of the exit event. The name must be unique within one creative. Leave it empty or unset for creatives containing image assets only. + "reportingName": "A String", # Optional. The name used to identify this event in reports. Leave it empty or unset for creatives containing image assets only. "type": "A String", # Required. The type of the exit event. "url": "A String", # Required. The click through URL of the exit event. This is required when type is: * `EXIT_EVENT_TYPE_DEFAULT` * `EXIT_EVENT_TYPE_BACKUP` }, @@ -688,33 +688,33 @@

Method Details

"expandingDirection": "A String", # Optional. Specifies the expanding direction of the creative. Required and only valid for third-party expandable creatives. Third-party expandable creatives are creatives with following hosting source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_EXPANDABLE` "hostingSource": "A String", # Required. Indicates where the creative is hosted. "html5Video": True or False, # Output only. Indicates the third-party VAST tag creative requires HTML5 Video support. Output only and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_VIDEO` - "iasCampaignMonitoring": True or False, # Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. To enable this for the creative, make sure the Advertiser.creative_config.ias_client_id has been set to your IAS client ID. - "integrationCode": "A String", # ID information used to link this creative to an external system. Must be UTF-8 encoded with a length of no more than 10,000 characters. - "jsTrackerUrl": "A String", # JavaScript measurement URL from supported third-party verification providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not supported. This field is only writeable in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` + "iasCampaignMonitoring": True or False, # Optional. Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. To enable this for the creative, make sure the Advertiser.creative_config.ias_client_id has been set to your IAS client ID. + "integrationCode": "A String", # Optional. ID information used to link this creative to an external system. Must be UTF-8 encoded with a length of no more than 10,000 characters. + "jsTrackerUrl": "A String", # Optional. JavaScript measurement URL from supported third-party verification providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not supported. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` "lineItemIds": [ # Output only. The IDs of the line items this creative is associated with. To associate a creative to a line item, use LineItem.creative_ids instead. "A String", ], "mediaDuration": "A String", # Output only. Media duration of the creative. Applicable when creative_type is one of: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_PUBLISHER_HOSTED` "mp3Audio": True or False, # Output only. Indicates the third-party audio creative supports MP3. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` "name": "A String", # Output only. The resource name of the creative. - "notes": "A String", # User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters. - "obaIcon": { # OBA Icon for a Creative # Specifies the OBA icon for a video creative. This field is only supported in following creative_type: * `CREATIVE_TYPE_VIDEO` - "clickTrackingUrl": "A String", # Required. The click tracking URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com - "dimensions": { # Dimensions. # The dimensions of the OBA icon. + "notes": "A String", # Optional. User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters. + "obaIcon": { # OBA Icon for a Creative # Optional. Specifies the OBA icon for a video creative. This field is only supported in the following creative_type: * `CREATIVE_TYPE_VIDEO` + "clickTrackingUrl": "A String", # Required. The click tracking URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com` + "dimensions": { # Dimensions. # Optional. The dimensions of the OBA icon. "heightPixels": 42, # The height in pixels. "widthPixels": 42, # The width in pixels. }, - "landingPageUrl": "A String", # Required. The landing page URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com - "position": "A String", # The position of the OBA icon on the creative. - "program": "A String", # The program of the OBA icon. For example: “AdChoices”. - "resourceMimeType": "A String", # The MIME type of the OBA icon resource. - "resourceUrl": "A String", # The URL of the OBA icon resource. - "viewTrackingUrl": "A String", # Required. The view tracking URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com + "landingPageUrl": "A String", # Required. The landing page URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com` + "position": "A String", # Optional. The position of the OBA icon on the creative. + "program": "A String", # Optional. The program of the OBA icon. For example: “AdChoices”. + "resourceMimeType": "A String", # Optional. The MIME type of the OBA icon resource. + "resourceUrl": "A String", # Optional. The URL of the OBA icon resource. + "viewTrackingUrl": "A String", # Required. The view tracking URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com` }, "oggAudio": True or False, # Output only. Indicates the third-party audio creative supports OGG. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` - "progressOffset": { # The length an audio or a video has been played. # Amount of time to play the video before counting a view. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` - "percentage": "A String", # The offset in percentage of the audio or video duration. - "seconds": "A String", # The offset in seconds from the start of the audio or video. + "progressOffset": { # The length an audio or a video has been played. # Optional. Amount of time to play the video before counting a view. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + "percentage": "A String", # Optional. The offset in percentage of the audio or video duration. + "seconds": "A String", # Optional. The offset in seconds from the start of the audio or video. }, "requireHtml5": True or False, # Optional. Indicates that the creative relies on HTML5 to render properly. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` "requireMraid": True or False, # Optional. Indicates that the creative requires MRAID (Mobile Rich Media Ad Interface Definitions system). Set this if the creative relies on mobile gestures for interactivity, such as swiping or tapping. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` @@ -736,46 +736,46 @@

Method Details

}, ], }, - "skipOffset": { # The length an audio or a video has been played. # Amount of time to play the video before the skip button appears. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` - "percentage": "A String", # The offset in percentage of the audio or video duration. - "seconds": "A String", # The offset in seconds from the start of the audio or video. + "skipOffset": { # The length an audio or a video has been played. # Optional. Amount of time to play the video before the skip button appears. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + "percentage": "A String", # Optional. The offset in percentage of the audio or video duration. + "seconds": "A String", # Optional. The offset in seconds from the start of the audio or video. }, - "skippable": True or False, # Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + "skippable": True or False, # Optional. Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` "thirdPartyTag": "A String", # Optional. The original third-party tag used for the creative. Required and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` - "thirdPartyUrls": [ # Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` + "thirdPartyUrls": [ # Optional. Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` { # Tracking URLs from third parties to track interactions with an audio or a video creative. - "type": "A String", # The type of interaction needs to be tracked by the tracking URL - "url": "A String", # Tracking URL used to track the interaction. Provide a URL with optional path or query string, beginning with `https:`. For example, https://www.example.com/path + "type": "A String", # Optional. The type of interaction needs to be tracked by the tracking URL + "url": "A String", # Optional. Tracking URL used to track the interaction. Provide a URL with optional path or query string, beginning with `https:`. For example, `https://www.example.com/path` }, ], - "timerEvents": [ # Timer custom events for a rich media creative. Timers track the time during which a user views and interacts with a specified part of a rich media creative. A creative can have multiple timer events, each timed independently. Leave it empty or unset for creatives containing image assets only. + "timerEvents": [ # Optional. Timer custom events for a rich media creative. Timers track the time during which a user views and interacts with a specified part of a rich media creative. A creative can have multiple timer events, each timed independently. Leave it empty or unset for creatives containing image assets only. { # Timer event of the creative. "name": "A String", # Required. The name of the timer event. "reportingName": "A String", # Required. The name used to identify this timer event in reports. }, ], - "trackerUrls": [ # Tracking URLs for analytics providers or third-party ad technology vendors. The URLs must start with https (except on inventory that doesn't require SSL compliance). If using macros in your URL, use only macros supported by Display & Video 360. Standard URLs only, no IMG or SCRIPT tags. This field is only writeable in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` + "trackerUrls": [ # Optional. Tracking URLs for analytics providers or third-party ad technology vendors. The URLs must start with `https:` (except on inventory that doesn't require SSL compliance). If using macros in your URL, use only macros supported by Display & Video 360. Standard URLs only, no IMG or SCRIPT tags. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` "A String", ], - "transcodes": [ # Output only. Audio/Video transcodes. Display & Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher's system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer’s connection and screen size. This field is only supported in following creative_type: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_AUDIO` + "transcodes": [ # Output only. Audio/Video transcodes. Display & Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher's system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer’s connection and screen size. This field is only supported in the following creative_type: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_AUDIO` { # Represents information about the transcoded audio or video file. - "audioBitRateKbps": "A String", # The bit rate for the audio stream of the transcoded video, or the bit rate for the transcoded audio, in kilobits per second. - "audioSampleRateHz": "A String", # The sample rate for the audio stream of the transcoded video, or the sample rate for the transcoded audio, in hertz. - "bitRateKbps": "A String", # The transcoding bit rate of the transcoded video, in kilobits per second. - "dimensions": { # Dimensions. # The dimensions of the transcoded video. + "audioBitRateKbps": "A String", # Optional. The bit rate for the audio stream of the transcoded video, or the bit rate for the transcoded audio, in kilobits per second. + "audioSampleRateHz": "A String", # Optional. The sample rate for the audio stream of the transcoded video, or the sample rate for the transcoded audio, in hertz. + "bitRateKbps": "A String", # Optional. The transcoding bit rate of the transcoded video, in kilobits per second. + "dimensions": { # Dimensions. # Optional. The dimensions of the transcoded video. "heightPixels": 42, # The height in pixels. "widthPixels": 42, # The width in pixels. }, - "fileSizeBytes": "A String", # The size of the transcoded file, in bytes. - "frameRate": 3.14, # The frame rate of the transcoded video, in frames per second. - "mimeType": "A String", # The MIME type of the transcoded file. - "name": "A String", # The name of the transcoded file. - "transcoded": True or False, # Indicates if the transcoding was successful. + "fileSizeBytes": "A String", # Optional. The size of the transcoded file, in bytes. + "frameRate": 3.14, # Optional. The frame rate of the transcoded video, in frames per second. + "mimeType": "A String", # Optional. The MIME type of the transcoded file. + "name": "A String", # Optional. The name of the transcoded file. + "transcoded": True or False, # Optional. Indicates if the transcoding was successful. }, ], "universalAdId": { # A creative identifier provided by a registry that is unique across all platforms. This is part of the VAST 4.0 standard. # Optional. An optional creative identifier provided by a registry that is unique across all platforms. Universal Ad ID is part of the VAST 4.0 standard. It can be modified after the creative is created. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` - "id": "A String", # The unique creative identifier. - "registry": "A String", # The registry provides unique creative identifiers. + "id": "A String", # Optional. The unique creative identifier. + "registry": "A String", # Optional. The registry provides unique creative identifiers. }, "updateTime": "A String", # Output only. The timestamp when the creative was last updated, either by the user or system (e.g. creative review). Assigned by the system. "vastTagUrl": "A String", # Optional. The URL of the VAST tag for a third-party VAST tag creative. Required and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` @@ -811,33 +811,33 @@

Method Details

The object takes the form of: { # A single Creative. - "additionalDimensions": [ # Additional dimensions. Applicable when creative_type is one of: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_LIGHTBOX` * `CREATIVE_TYPE_PUBLISHER_HOSTED` If this field is specified, width_pixels and height_pixels are both required and must be greater than or equal to 0. + "additionalDimensions": [ # Optional. Additional dimensions. Applicable when creative_type is one of: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_LIGHTBOX` * `CREATIVE_TYPE_PUBLISHER_HOSTED` If this field is specified, width_pixels and height_pixels are both required and must be greater than or equal to 0. { # Dimensions. "heightPixels": 42, # The height in pixels. "widthPixels": 42, # The width in pixels. }, ], "advertiserId": "A String", # Output only. The unique ID of the advertiser the creative belongs to. - "appendedTag": "A String", # Third-party HTML tracking tag to be appended to the creative tag. + "appendedTag": "A String", # Optional. Third-party HTML tracking tag to be appended to the creative tag. "assets": [ # Required. Assets associated to this creative. { # Asset association for the creative. - "asset": { # A single asset. # The associated asset. + "asset": { # A single asset. # Optional. The associated asset. "content": "A String", # The asset content. For uploaded assets, the content is the serving path. "mediaId": "A String", # Media ID of the uploaded asset. This is a unique identifier for the asset. This ID can be passed to other API calls, e.g. CreateCreative to associate the asset with a creative. The Media ID space updated on **April 5, 2023**. Update media IDs cached before **April 5, 2023** by retrieving the new media ID from associated creative resources or re-uploading the asset. }, - "role": "A String", # The role of this asset for the creative. + "role": "A String", # Optional. The role of this asset for the creative. }, ], "cmPlacementId": "A String", # Output only. The unique ID of the Campaign Manager 360 placement associated with the creative. This field is only applicable for creatives that are synced from Campaign Manager. - "cmTrackingAd": { # A Campaign Manager 360 tracking ad. # The Campaign Manager 360 tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager 360 and third-party ad serving: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` Output only for other cases. - "cmAdId": "A String", # The ad ID of the campaign manager 360 tracking Ad. - "cmCreativeId": "A String", # The creative ID of the campaign manager 360 tracking Ad. - "cmPlacementId": "A String", # The placement ID of the campaign manager 360 tracking Ad. + "cmTrackingAd": { # A Campaign Manager 360 tracking ad. # Optional. The Campaign Manager 360 tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager 360 and third-party ad serving: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` Output only for other cases. + "cmAdId": "A String", # Optional. The ad ID of the campaign manager 360 tracking Ad. + "cmCreativeId": "A String", # Optional. The creative ID of the campaign manager 360 tracking Ad. + "cmPlacementId": "A String", # Optional. The placement ID of the campaign manager 360 tracking Ad. }, - "companionCreativeIds": [ # The IDs of companion creatives for a video creative. You can assign existing display creatives (with image or HTML5 assets) to serve surrounding the publisher's video player. Companions display around the video player while the video is playing and remain after the video has completed. Creatives contain additional dimensions can not be companion creatives. This field is only supported for following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` + "companionCreativeIds": [ # Optional. The IDs of companion creatives for a video creative. You can assign existing display creatives (with image or HTML5 assets) to serve surrounding the publisher's video player. Companions display around the video player while the video is playing and remain after the video has completed. Creatives contain additional dimensions can not be companion creatives. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` "A String", ], - "counterEvents": [ # Counter events for a rich media creative. Counters track the number of times that a user interacts with any part of a rich media creative in a specified way (mouse-overs, mouse-outs, clicks, taps, data loading, keyboard entries, etc.). Any event that can be captured in the creative can be recorded as a counter. Leave it empty or unset for creatives containing image assets only. + "counterEvents": [ # Optional. Counter events for a rich media creative. Counters track the number of times that a user interacts with any part of a rich media creative in a specified way (mouse-overs, mouse-outs, clicks, taps, data loading, keyboard entries, etc.). Any event that can be captured in the creative can be recorded as a counter. Leave it empty or unset for creatives containing image assets only. { # Counter event of the creative. "name": "A String", # Required. The name of the counter event. "reportingName": "A String", # Required. The name used to identify this counter event in reports. @@ -858,8 +858,8 @@

Method Details

"entityStatus": "A String", # Required. Controls whether or not the creative can serve. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED` * `ENTITY_STATUS_PAUSED` "exitEvents": [ # Required. Exit events for this creative. An exit (also known as a click tag) is any area in your creative that someone can click or tap to open an advertiser's landing page. Every creative must include at least one exit. You can add an exit to your creative in any of the following ways: * Use Google Web Designer's tap area. * Define a JavaScript variable called "clickTag". * Use the Enabler (Enabler.exit()) to track exits in rich media formats. { # Exit event of the creative. - "name": "A String", # The name of the click tag of the exit event. The name must be unique within one creative. Leave it empty or unset for creatives containing image assets only. - "reportingName": "A String", # The name used to identify this event in reports. Leave it empty or unset for creatives containing image assets only. + "name": "A String", # Optional. The name of the click tag of the exit event. The name must be unique within one creative. Leave it empty or unset for creatives containing image assets only. + "reportingName": "A String", # Optional. The name used to identify this event in reports. Leave it empty or unset for creatives containing image assets only. "type": "A String", # Required. The type of the exit event. "url": "A String", # Required. The click through URL of the exit event. This is required when type is: * `EXIT_EVENT_TYPE_DEFAULT` * `EXIT_EVENT_TYPE_BACKUP` }, @@ -868,33 +868,33 @@

Method Details

"expandingDirection": "A String", # Optional. Specifies the expanding direction of the creative. Required and only valid for third-party expandable creatives. Third-party expandable creatives are creatives with following hosting source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_EXPANDABLE` "hostingSource": "A String", # Required. Indicates where the creative is hosted. "html5Video": True or False, # Output only. Indicates the third-party VAST tag creative requires HTML5 Video support. Output only and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_VIDEO` - "iasCampaignMonitoring": True or False, # Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. To enable this for the creative, make sure the Advertiser.creative_config.ias_client_id has been set to your IAS client ID. - "integrationCode": "A String", # ID information used to link this creative to an external system. Must be UTF-8 encoded with a length of no more than 10,000 characters. - "jsTrackerUrl": "A String", # JavaScript measurement URL from supported third-party verification providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not supported. This field is only writeable in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` + "iasCampaignMonitoring": True or False, # Optional. Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. To enable this for the creative, make sure the Advertiser.creative_config.ias_client_id has been set to your IAS client ID. + "integrationCode": "A String", # Optional. ID information used to link this creative to an external system. Must be UTF-8 encoded with a length of no more than 10,000 characters. + "jsTrackerUrl": "A String", # Optional. JavaScript measurement URL from supported third-party verification providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not supported. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` "lineItemIds": [ # Output only. The IDs of the line items this creative is associated with. To associate a creative to a line item, use LineItem.creative_ids instead. "A String", ], "mediaDuration": "A String", # Output only. Media duration of the creative. Applicable when creative_type is one of: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_PUBLISHER_HOSTED` "mp3Audio": True or False, # Output only. Indicates the third-party audio creative supports MP3. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` "name": "A String", # Output only. The resource name of the creative. - "notes": "A String", # User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters. - "obaIcon": { # OBA Icon for a Creative # Specifies the OBA icon for a video creative. This field is only supported in following creative_type: * `CREATIVE_TYPE_VIDEO` - "clickTrackingUrl": "A String", # Required. The click tracking URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com - "dimensions": { # Dimensions. # The dimensions of the OBA icon. + "notes": "A String", # Optional. User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters. + "obaIcon": { # OBA Icon for a Creative # Optional. Specifies the OBA icon for a video creative. This field is only supported in the following creative_type: * `CREATIVE_TYPE_VIDEO` + "clickTrackingUrl": "A String", # Required. The click tracking URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com` + "dimensions": { # Dimensions. # Optional. The dimensions of the OBA icon. "heightPixels": 42, # The height in pixels. "widthPixels": 42, # The width in pixels. }, - "landingPageUrl": "A String", # Required. The landing page URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com - "position": "A String", # The position of the OBA icon on the creative. - "program": "A String", # The program of the OBA icon. For example: “AdChoices”. - "resourceMimeType": "A String", # The MIME type of the OBA icon resource. - "resourceUrl": "A String", # The URL of the OBA icon resource. - "viewTrackingUrl": "A String", # Required. The view tracking URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com + "landingPageUrl": "A String", # Required. The landing page URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com` + "position": "A String", # Optional. The position of the OBA icon on the creative. + "program": "A String", # Optional. The program of the OBA icon. For example: “AdChoices”. + "resourceMimeType": "A String", # Optional. The MIME type of the OBA icon resource. + "resourceUrl": "A String", # Optional. The URL of the OBA icon resource. + "viewTrackingUrl": "A String", # Required. The view tracking URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com` }, "oggAudio": True or False, # Output only. Indicates the third-party audio creative supports OGG. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` - "progressOffset": { # The length an audio or a video has been played. # Amount of time to play the video before counting a view. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` - "percentage": "A String", # The offset in percentage of the audio or video duration. - "seconds": "A String", # The offset in seconds from the start of the audio or video. + "progressOffset": { # The length an audio or a video has been played. # Optional. Amount of time to play the video before counting a view. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + "percentage": "A String", # Optional. The offset in percentage of the audio or video duration. + "seconds": "A String", # Optional. The offset in seconds from the start of the audio or video. }, "requireHtml5": True or False, # Optional. Indicates that the creative relies on HTML5 to render properly. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` "requireMraid": True or False, # Optional. Indicates that the creative requires MRAID (Mobile Rich Media Ad Interface Definitions system). Set this if the creative relies on mobile gestures for interactivity, such as swiping or tapping. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` @@ -916,46 +916,46 @@

Method Details

}, ], }, - "skipOffset": { # The length an audio or a video has been played. # Amount of time to play the video before the skip button appears. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` - "percentage": "A String", # The offset in percentage of the audio or video duration. - "seconds": "A String", # The offset in seconds from the start of the audio or video. + "skipOffset": { # The length an audio or a video has been played. # Optional. Amount of time to play the video before the skip button appears. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + "percentage": "A String", # Optional. The offset in percentage of the audio or video duration. + "seconds": "A String", # Optional. The offset in seconds from the start of the audio or video. }, - "skippable": True or False, # Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + "skippable": True or False, # Optional. Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` "thirdPartyTag": "A String", # Optional. The original third-party tag used for the creative. Required and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` - "thirdPartyUrls": [ # Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` + "thirdPartyUrls": [ # Optional. Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` { # Tracking URLs from third parties to track interactions with an audio or a video creative. - "type": "A String", # The type of interaction needs to be tracked by the tracking URL - "url": "A String", # Tracking URL used to track the interaction. Provide a URL with optional path or query string, beginning with `https:`. For example, https://www.example.com/path + "type": "A String", # Optional. The type of interaction needs to be tracked by the tracking URL + "url": "A String", # Optional. Tracking URL used to track the interaction. Provide a URL with optional path or query string, beginning with `https:`. For example, `https://www.example.com/path` }, ], - "timerEvents": [ # Timer custom events for a rich media creative. Timers track the time during which a user views and interacts with a specified part of a rich media creative. A creative can have multiple timer events, each timed independently. Leave it empty or unset for creatives containing image assets only. + "timerEvents": [ # Optional. Timer custom events for a rich media creative. Timers track the time during which a user views and interacts with a specified part of a rich media creative. A creative can have multiple timer events, each timed independently. Leave it empty or unset for creatives containing image assets only. { # Timer event of the creative. "name": "A String", # Required. The name of the timer event. "reportingName": "A String", # Required. The name used to identify this timer event in reports. }, ], - "trackerUrls": [ # Tracking URLs for analytics providers or third-party ad technology vendors. The URLs must start with https (except on inventory that doesn't require SSL compliance). If using macros in your URL, use only macros supported by Display & Video 360. Standard URLs only, no IMG or SCRIPT tags. This field is only writeable in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` + "trackerUrls": [ # Optional. Tracking URLs for analytics providers or third-party ad technology vendors. The URLs must start with `https:` (except on inventory that doesn't require SSL compliance). If using macros in your URL, use only macros supported by Display & Video 360. Standard URLs only, no IMG or SCRIPT tags. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` "A String", ], - "transcodes": [ # Output only. Audio/Video transcodes. Display & Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher's system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer’s connection and screen size. This field is only supported in following creative_type: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_AUDIO` + "transcodes": [ # Output only. Audio/Video transcodes. Display & Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher's system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer’s connection and screen size. This field is only supported in the following creative_type: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_AUDIO` { # Represents information about the transcoded audio or video file. - "audioBitRateKbps": "A String", # The bit rate for the audio stream of the transcoded video, or the bit rate for the transcoded audio, in kilobits per second. - "audioSampleRateHz": "A String", # The sample rate for the audio stream of the transcoded video, or the sample rate for the transcoded audio, in hertz. - "bitRateKbps": "A String", # The transcoding bit rate of the transcoded video, in kilobits per second. - "dimensions": { # Dimensions. # The dimensions of the transcoded video. + "audioBitRateKbps": "A String", # Optional. The bit rate for the audio stream of the transcoded video, or the bit rate for the transcoded audio, in kilobits per second. + "audioSampleRateHz": "A String", # Optional. The sample rate for the audio stream of the transcoded video, or the sample rate for the transcoded audio, in hertz. + "bitRateKbps": "A String", # Optional. The transcoding bit rate of the transcoded video, in kilobits per second. + "dimensions": { # Dimensions. # Optional. The dimensions of the transcoded video. "heightPixels": 42, # The height in pixels. "widthPixels": 42, # The width in pixels. }, - "fileSizeBytes": "A String", # The size of the transcoded file, in bytes. - "frameRate": 3.14, # The frame rate of the transcoded video, in frames per second. - "mimeType": "A String", # The MIME type of the transcoded file. - "name": "A String", # The name of the transcoded file. - "transcoded": True or False, # Indicates if the transcoding was successful. + "fileSizeBytes": "A String", # Optional. The size of the transcoded file, in bytes. + "frameRate": 3.14, # Optional. The frame rate of the transcoded video, in frames per second. + "mimeType": "A String", # Optional. The MIME type of the transcoded file. + "name": "A String", # Optional. The name of the transcoded file. + "transcoded": True or False, # Optional. Indicates if the transcoding was successful. }, ], "universalAdId": { # A creative identifier provided by a registry that is unique across all platforms. This is part of the VAST 4.0 standard. # Optional. An optional creative identifier provided by a registry that is unique across all platforms. Universal Ad ID is part of the VAST 4.0 standard. It can be modified after the creative is created. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` - "id": "A String", # The unique creative identifier. - "registry": "A String", # The registry provides unique creative identifiers. + "id": "A String", # Optional. The unique creative identifier. + "registry": "A String", # Optional. The registry provides unique creative identifiers. }, "updateTime": "A String", # Output only. The timestamp when the creative was last updated, either by the user or system (e.g. creative review). Assigned by the system. "vastTagUrl": "A String", # Optional. The URL of the VAST tag for a third-party VAST tag creative. Required and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` @@ -972,33 +972,33 @@

Method Details

An object of the form: { # A single Creative. - "additionalDimensions": [ # Additional dimensions. Applicable when creative_type is one of: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_LIGHTBOX` * `CREATIVE_TYPE_PUBLISHER_HOSTED` If this field is specified, width_pixels and height_pixels are both required and must be greater than or equal to 0. + "additionalDimensions": [ # Optional. Additional dimensions. Applicable when creative_type is one of: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_LIGHTBOX` * `CREATIVE_TYPE_PUBLISHER_HOSTED` If this field is specified, width_pixels and height_pixels are both required and must be greater than or equal to 0. { # Dimensions. "heightPixels": 42, # The height in pixels. "widthPixels": 42, # The width in pixels. }, ], "advertiserId": "A String", # Output only. The unique ID of the advertiser the creative belongs to. - "appendedTag": "A String", # Third-party HTML tracking tag to be appended to the creative tag. + "appendedTag": "A String", # Optional. Third-party HTML tracking tag to be appended to the creative tag. "assets": [ # Required. Assets associated to this creative. { # Asset association for the creative. - "asset": { # A single asset. # The associated asset. + "asset": { # A single asset. # Optional. The associated asset. "content": "A String", # The asset content. For uploaded assets, the content is the serving path. "mediaId": "A String", # Media ID of the uploaded asset. This is a unique identifier for the asset. This ID can be passed to other API calls, e.g. CreateCreative to associate the asset with a creative. The Media ID space updated on **April 5, 2023**. Update media IDs cached before **April 5, 2023** by retrieving the new media ID from associated creative resources or re-uploading the asset. }, - "role": "A String", # The role of this asset for the creative. + "role": "A String", # Optional. The role of this asset for the creative. }, ], "cmPlacementId": "A String", # Output only. The unique ID of the Campaign Manager 360 placement associated with the creative. This field is only applicable for creatives that are synced from Campaign Manager. - "cmTrackingAd": { # A Campaign Manager 360 tracking ad. # The Campaign Manager 360 tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager 360 and third-party ad serving: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` Output only for other cases. - "cmAdId": "A String", # The ad ID of the campaign manager 360 tracking Ad. - "cmCreativeId": "A String", # The creative ID of the campaign manager 360 tracking Ad. - "cmPlacementId": "A String", # The placement ID of the campaign manager 360 tracking Ad. + "cmTrackingAd": { # A Campaign Manager 360 tracking ad. # Optional. The Campaign Manager 360 tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager 360 and third-party ad serving: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` Output only for other cases. + "cmAdId": "A String", # Optional. The ad ID of the campaign manager 360 tracking Ad. + "cmCreativeId": "A String", # Optional. The creative ID of the campaign manager 360 tracking Ad. + "cmPlacementId": "A String", # Optional. The placement ID of the campaign manager 360 tracking Ad. }, - "companionCreativeIds": [ # The IDs of companion creatives for a video creative. You can assign existing display creatives (with image or HTML5 assets) to serve surrounding the publisher's video player. Companions display around the video player while the video is playing and remain after the video has completed. Creatives contain additional dimensions can not be companion creatives. This field is only supported for following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` + "companionCreativeIds": [ # Optional. The IDs of companion creatives for a video creative. You can assign existing display creatives (with image or HTML5 assets) to serve surrounding the publisher's video player. Companions display around the video player while the video is playing and remain after the video has completed. Creatives contain additional dimensions can not be companion creatives. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` "A String", ], - "counterEvents": [ # Counter events for a rich media creative. Counters track the number of times that a user interacts with any part of a rich media creative in a specified way (mouse-overs, mouse-outs, clicks, taps, data loading, keyboard entries, etc.). Any event that can be captured in the creative can be recorded as a counter. Leave it empty or unset for creatives containing image assets only. + "counterEvents": [ # Optional. Counter events for a rich media creative. Counters track the number of times that a user interacts with any part of a rich media creative in a specified way (mouse-overs, mouse-outs, clicks, taps, data loading, keyboard entries, etc.). Any event that can be captured in the creative can be recorded as a counter. Leave it empty or unset for creatives containing image assets only. { # Counter event of the creative. "name": "A String", # Required. The name of the counter event. "reportingName": "A String", # Required. The name used to identify this counter event in reports. @@ -1019,8 +1019,8 @@

Method Details

"entityStatus": "A String", # Required. Controls whether or not the creative can serve. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED` * `ENTITY_STATUS_PAUSED` "exitEvents": [ # Required. Exit events for this creative. An exit (also known as a click tag) is any area in your creative that someone can click or tap to open an advertiser's landing page. Every creative must include at least one exit. You can add an exit to your creative in any of the following ways: * Use Google Web Designer's tap area. * Define a JavaScript variable called "clickTag". * Use the Enabler (Enabler.exit()) to track exits in rich media formats. { # Exit event of the creative. - "name": "A String", # The name of the click tag of the exit event. The name must be unique within one creative. Leave it empty or unset for creatives containing image assets only. - "reportingName": "A String", # The name used to identify this event in reports. Leave it empty or unset for creatives containing image assets only. + "name": "A String", # Optional. The name of the click tag of the exit event. The name must be unique within one creative. Leave it empty or unset for creatives containing image assets only. + "reportingName": "A String", # Optional. The name used to identify this event in reports. Leave it empty or unset for creatives containing image assets only. "type": "A String", # Required. The type of the exit event. "url": "A String", # Required. The click through URL of the exit event. This is required when type is: * `EXIT_EVENT_TYPE_DEFAULT` * `EXIT_EVENT_TYPE_BACKUP` }, @@ -1029,33 +1029,33 @@

Method Details

"expandingDirection": "A String", # Optional. Specifies the expanding direction of the creative. Required and only valid for third-party expandable creatives. Third-party expandable creatives are creatives with following hosting source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_EXPANDABLE` "hostingSource": "A String", # Required. Indicates where the creative is hosted. "html5Video": True or False, # Output only. Indicates the third-party VAST tag creative requires HTML5 Video support. Output only and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_VIDEO` - "iasCampaignMonitoring": True or False, # Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. To enable this for the creative, make sure the Advertiser.creative_config.ias_client_id has been set to your IAS client ID. - "integrationCode": "A String", # ID information used to link this creative to an external system. Must be UTF-8 encoded with a length of no more than 10,000 characters. - "jsTrackerUrl": "A String", # JavaScript measurement URL from supported third-party verification providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not supported. This field is only writeable in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` + "iasCampaignMonitoring": True or False, # Optional. Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. To enable this for the creative, make sure the Advertiser.creative_config.ias_client_id has been set to your IAS client ID. + "integrationCode": "A String", # Optional. ID information used to link this creative to an external system. Must be UTF-8 encoded with a length of no more than 10,000 characters. + "jsTrackerUrl": "A String", # Optional. JavaScript measurement URL from supported third-party verification providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not supported. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` "lineItemIds": [ # Output only. The IDs of the line items this creative is associated with. To associate a creative to a line item, use LineItem.creative_ids instead. "A String", ], "mediaDuration": "A String", # Output only. Media duration of the creative. Applicable when creative_type is one of: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_PUBLISHER_HOSTED` "mp3Audio": True or False, # Output only. Indicates the third-party audio creative supports MP3. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` "name": "A String", # Output only. The resource name of the creative. - "notes": "A String", # User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters. - "obaIcon": { # OBA Icon for a Creative # Specifies the OBA icon for a video creative. This field is only supported in following creative_type: * `CREATIVE_TYPE_VIDEO` - "clickTrackingUrl": "A String", # Required. The click tracking URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com - "dimensions": { # Dimensions. # The dimensions of the OBA icon. + "notes": "A String", # Optional. User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters. + "obaIcon": { # OBA Icon for a Creative # Optional. Specifies the OBA icon for a video creative. This field is only supported in the following creative_type: * `CREATIVE_TYPE_VIDEO` + "clickTrackingUrl": "A String", # Required. The click tracking URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com` + "dimensions": { # Dimensions. # Optional. The dimensions of the OBA icon. "heightPixels": 42, # The height in pixels. "widthPixels": 42, # The width in pixels. }, - "landingPageUrl": "A String", # Required. The landing page URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com - "position": "A String", # The position of the OBA icon on the creative. - "program": "A String", # The program of the OBA icon. For example: “AdChoices”. - "resourceMimeType": "A String", # The MIME type of the OBA icon resource. - "resourceUrl": "A String", # The URL of the OBA icon resource. - "viewTrackingUrl": "A String", # Required. The view tracking URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com + "landingPageUrl": "A String", # Required. The landing page URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com` + "position": "A String", # Optional. The position of the OBA icon on the creative. + "program": "A String", # Optional. The program of the OBA icon. For example: “AdChoices”. + "resourceMimeType": "A String", # Optional. The MIME type of the OBA icon resource. + "resourceUrl": "A String", # Optional. The URL of the OBA icon resource. + "viewTrackingUrl": "A String", # Required. The view tracking URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com` }, "oggAudio": True or False, # Output only. Indicates the third-party audio creative supports OGG. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` - "progressOffset": { # The length an audio or a video has been played. # Amount of time to play the video before counting a view. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` - "percentage": "A String", # The offset in percentage of the audio or video duration. - "seconds": "A String", # The offset in seconds from the start of the audio or video. + "progressOffset": { # The length an audio or a video has been played. # Optional. Amount of time to play the video before counting a view. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + "percentage": "A String", # Optional. The offset in percentage of the audio or video duration. + "seconds": "A String", # Optional. The offset in seconds from the start of the audio or video. }, "requireHtml5": True or False, # Optional. Indicates that the creative relies on HTML5 to render properly. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` "requireMraid": True or False, # Optional. Indicates that the creative requires MRAID (Mobile Rich Media Ad Interface Definitions system). Set this if the creative relies on mobile gestures for interactivity, such as swiping or tapping. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` @@ -1077,46 +1077,46 @@

Method Details

}, ], }, - "skipOffset": { # The length an audio or a video has been played. # Amount of time to play the video before the skip button appears. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` - "percentage": "A String", # The offset in percentage of the audio or video duration. - "seconds": "A String", # The offset in seconds from the start of the audio or video. + "skipOffset": { # The length an audio or a video has been played. # Optional. Amount of time to play the video before the skip button appears. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + "percentage": "A String", # Optional. The offset in percentage of the audio or video duration. + "seconds": "A String", # Optional. The offset in seconds from the start of the audio or video. }, - "skippable": True or False, # Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + "skippable": True or False, # Optional. Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` "thirdPartyTag": "A String", # Optional. The original third-party tag used for the creative. Required and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` - "thirdPartyUrls": [ # Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` + "thirdPartyUrls": [ # Optional. Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` { # Tracking URLs from third parties to track interactions with an audio or a video creative. - "type": "A String", # The type of interaction needs to be tracked by the tracking URL - "url": "A String", # Tracking URL used to track the interaction. Provide a URL with optional path or query string, beginning with `https:`. For example, https://www.example.com/path + "type": "A String", # Optional. The type of interaction needs to be tracked by the tracking URL + "url": "A String", # Optional. Tracking URL used to track the interaction. Provide a URL with optional path or query string, beginning with `https:`. For example, `https://www.example.com/path` }, ], - "timerEvents": [ # Timer custom events for a rich media creative. Timers track the time during which a user views and interacts with a specified part of a rich media creative. A creative can have multiple timer events, each timed independently. Leave it empty or unset for creatives containing image assets only. + "timerEvents": [ # Optional. Timer custom events for a rich media creative. Timers track the time during which a user views and interacts with a specified part of a rich media creative. A creative can have multiple timer events, each timed independently. Leave it empty or unset for creatives containing image assets only. { # Timer event of the creative. "name": "A String", # Required. The name of the timer event. "reportingName": "A String", # Required. The name used to identify this timer event in reports. }, ], - "trackerUrls": [ # Tracking URLs for analytics providers or third-party ad technology vendors. The URLs must start with https (except on inventory that doesn't require SSL compliance). If using macros in your URL, use only macros supported by Display & Video 360. Standard URLs only, no IMG or SCRIPT tags. This field is only writeable in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` + "trackerUrls": [ # Optional. Tracking URLs for analytics providers or third-party ad technology vendors. The URLs must start with `https:` (except on inventory that doesn't require SSL compliance). If using macros in your URL, use only macros supported by Display & Video 360. Standard URLs only, no IMG or SCRIPT tags. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` "A String", ], - "transcodes": [ # Output only. Audio/Video transcodes. Display & Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher's system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer’s connection and screen size. This field is only supported in following creative_type: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_AUDIO` + "transcodes": [ # Output only. Audio/Video transcodes. Display & Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher's system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer’s connection and screen size. This field is only supported in the following creative_type: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_AUDIO` { # Represents information about the transcoded audio or video file. - "audioBitRateKbps": "A String", # The bit rate for the audio stream of the transcoded video, or the bit rate for the transcoded audio, in kilobits per second. - "audioSampleRateHz": "A String", # The sample rate for the audio stream of the transcoded video, or the sample rate for the transcoded audio, in hertz. - "bitRateKbps": "A String", # The transcoding bit rate of the transcoded video, in kilobits per second. - "dimensions": { # Dimensions. # The dimensions of the transcoded video. + "audioBitRateKbps": "A String", # Optional. The bit rate for the audio stream of the transcoded video, or the bit rate for the transcoded audio, in kilobits per second. + "audioSampleRateHz": "A String", # Optional. The sample rate for the audio stream of the transcoded video, or the sample rate for the transcoded audio, in hertz. + "bitRateKbps": "A String", # Optional. The transcoding bit rate of the transcoded video, in kilobits per second. + "dimensions": { # Dimensions. # Optional. The dimensions of the transcoded video. "heightPixels": 42, # The height in pixels. "widthPixels": 42, # The width in pixels. }, - "fileSizeBytes": "A String", # The size of the transcoded file, in bytes. - "frameRate": 3.14, # The frame rate of the transcoded video, in frames per second. - "mimeType": "A String", # The MIME type of the transcoded file. - "name": "A String", # The name of the transcoded file. - "transcoded": True or False, # Indicates if the transcoding was successful. + "fileSizeBytes": "A String", # Optional. The size of the transcoded file, in bytes. + "frameRate": 3.14, # Optional. The frame rate of the transcoded video, in frames per second. + "mimeType": "A String", # Optional. The MIME type of the transcoded file. + "name": "A String", # Optional. The name of the transcoded file. + "transcoded": True or False, # Optional. Indicates if the transcoding was successful. }, ], "universalAdId": { # A creative identifier provided by a registry that is unique across all platforms. This is part of the VAST 4.0 standard. # Optional. An optional creative identifier provided by a registry that is unique across all platforms. Universal Ad ID is part of the VAST 4.0 standard. It can be modified after the creative is created. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` - "id": "A String", # The unique creative identifier. - "registry": "A String", # The registry provides unique creative identifiers. + "id": "A String", # Optional. The unique creative identifier. + "registry": "A String", # Optional. The registry provides unique creative identifiers. }, "updateTime": "A String", # Output only. The timestamp when the creative was last updated, either by the user or system (e.g. creative review). Assigned by the system. "vastTagUrl": "A String", # Optional. The URL of the VAST tag for a third-party VAST tag creative. Required and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` diff --git a/docs/dyn/displayvideo_v2.advertisers.html b/docs/dyn/displayvideo_v2.advertisers.html index fa7233e265a..22d0a1d1276 100644 --- a/docs/dyn/displayvideo_v2.advertisers.html +++ b/docs/dyn/displayvideo_v2.advertisers.html @@ -380,30 +380,30 @@

Method Details

}, "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts. "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` - "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. NEXT_ID: 9 # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. - "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. + "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, ], }, - "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # The combined audience ids of the included combined audience group. Contains combined audience ids only. - "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. + "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only. + "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. { # Details of combined audience targeting setting. "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. }, ], }, - "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # The custom list ids of the included custom list group. Contains custom list ids only. - "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. + "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only. + "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored. { # Details of custom list targeting setting. "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id. }, ], }, - "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the included Google audience group. Contains Google audience ids only. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, @@ -686,30 +686,30 @@

Method Details

}, "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts. "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` - "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. NEXT_ID: 9 # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. - "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. + "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, ], }, - "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # The combined audience ids of the included combined audience group. Contains combined audience ids only. - "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. + "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only. + "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. { # Details of combined audience targeting setting. "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. }, ], }, - "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # The custom list ids of the included custom list group. Contains custom list ids only. - "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. + "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only. + "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored. { # Details of custom list targeting setting. "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id. }, ], }, - "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the included Google audience group. Contains Google audience ids only. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, @@ -1141,30 +1141,30 @@

Method Details

}, "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts. "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` - "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. NEXT_ID: 9 # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. - "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. + "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, ], }, - "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # The combined audience ids of the included combined audience group. Contains combined audience ids only. - "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. + "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only. + "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. { # Details of combined audience targeting setting. "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. }, ], }, - "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # The custom list ids of the included custom list group. Contains custom list ids only. - "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. + "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only. + "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored. { # Details of custom list targeting setting. "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id. }, ], }, - "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the included Google audience group. Contains Google audience ids only. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, diff --git a/docs/dyn/displayvideo_v2.advertisers.insertionOrders.html b/docs/dyn/displayvideo_v2.advertisers.insertionOrders.html index 50fd9ea7720..539d0fda8d8 100644 --- a/docs/dyn/displayvideo_v2.advertisers.insertionOrders.html +++ b/docs/dyn/displayvideo_v2.advertisers.insertionOrders.html @@ -112,18 +112,18 @@

Method Details

{ # A single insertion order. "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. - "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # The bidding strategy of the insertion order. By default, fixed_bid is set. + "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, when performance_goal_type is one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , the line_item_type of the insertion order line items must be either: * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , and when performance_goal_type is either: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` the line_item_type of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy. "raiseBidForDeals": True or False, # Whether the strategy takes deal floor prices into account. }, "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. @@ -131,11 +131,11 @@

Method Details

}, "billableOutcome": "A String", # Immutable. The billable outcome of the insertion order. Outcome based buying is deprecated. `BILLABLE_OUTCOME_PAY_PER_IMPRESSION` is the only valid value. "budget": { # Settings that control how insertion order budget is allocated. # Required. The budget allocation settings of the insertion order. - "automationType": "A String", # The type of automation used to manage bid and budget for the insertion order. If this field is unspecified in creation, the value defaults to `INSERTION_ORDER_AUTOMATION_TYPE_NONE`. + "automationType": "A String", # Optional. The type of automation used to manage bid and budget for the insertion order. If this field is unspecified in creation, the value defaults to `INSERTION_ORDER_AUTOMATION_TYPE_NONE`. "budgetSegments": [ # Required. The list of budget segments. Use a budget segment to specify a specific budget for a given period of time an insertion order is running. { # Settings that control the budget of a single budget segment. "budgetAmountMicros": "A String", # Required. The budget amount the insertion order will spend for the given date_range. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency. - "campaignBudgetId": "A String", # The budget_id of the campaign budget that this insertion order budget segment is a part of. + "campaignBudgetId": "A String", # Optional. The budget_id of the campaign budget that this insertion order budget segment is a part of. "dateRange": { # A date range. # Required. The start and end date settings of the budget segment. They are resolved relative to the parent advertiser's time zone. * When creating a new budget segment, both `start_date` and `end_date` must be in the future. * An existing budget segment with a `start_date` in the past has a mutable `end_date` but an immutable `start_date`. * `end_date` must be the `start_date` or later, both before the year 2037. "endDate": { # 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 # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`. "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. @@ -148,7 +148,7 @@

Method Details

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, }, - "description": "A String", # The budget segment description. It can be used to enter Purchase Order information for each budget segment and have that information printed on the invoices. Must be UTF-8 encoded. + "description": "A String", # Optional. The budget segment description. It can be used to enter Purchase Order information for each budget segment and have that information printed on the invoices. Must be UTF-8 encoded. }, ], "budgetUnit": "A String", # Required. Immutable. The budget unit specifies whether the budget is currency based or impression based. @@ -156,16 +156,16 @@

Method Details

"campaignId": "A String", # Required. Immutable. The unique ID of the campaign that the insertion order belongs to. "displayName": "A String", # Required. The display name of the insertion order. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not the insertion order can spend its budget and bid on inventory. * For CreateInsertionOrder method, only `ENTITY_STATUS_DRAFT` is allowed. To activate an insertion order, use UpdateInsertionOrder method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * An insertion order cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * An insertion order cannot be set to `ENTITY_STATUS_ACTIVE` if its parent campaign is not active. - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency capping setting of the insertion order. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency capping setting of the insertion order. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap) "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. - "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. - "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). + "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. }, "insertionOrderId": "A String", # Output only. The unique ID of the insertion order. Assigned by the system. - "insertionOrderType": "A String", # The type of insertion order. If this field is unspecified in creation, the value defaults to `RTB`. - "integrationDetails": { # Integration details of an entry. # Additional integration details of the insertion order. + "insertionOrderType": "A String", # Optional. The type of insertion order. If this field is unspecified in creation, the value defaults to `RTB`. + "integrationDetails": { # Integration details of an entry. # Optional. Additional integration details of the insertion order. "details": "A String", # Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters. "integrationCode": "A String", # An external identifier to be associated with the entry. The integration code will show up together with the entry in many places in the system, for example, reporting. Must be UTF-8 encoded with a length of no more than 500 characters. }, @@ -176,7 +176,7 @@

Method Details

"pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent. When automatic budget allocation is enabled at the insertion order via automationType, this field is output only and defaults to `PACING_PERIOD_FLIGHT`. "pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be spent across the pacing_period. `PACING_TYPE_ASAP` is not compatible with pacing_period `PACING_PERIOD_FLIGHT` for insertion orders. }, - "partnerCosts": [ # The partner costs associated with the insertion order. If absent or empty in CreateInsertionOrder method, the newly created insertion order will inherit partner costs from the partner settings. + "partnerCosts": [ # Optional. The partner costs associated with the insertion order. If absent or empty in CreateInsertionOrder method, the newly created insertion order will inherit partner costs from the partner settings. { # Settings that control a partner cost. A partner cost is any type of expense involved in running a campaign, other than the costs of purchasing impressions (which is called the media cost) and using third-party audience segment data (data fee). Some examples of partner costs include the fees for using DV360, a third-party ad server, or a third-party ad serving verification service. "costType": "A String", # Required. The type of the partner cost. "feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency. Applicable when the fee_type is `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0. For example, for 1.5 standard unit of the advertiser's currency, set this field to 1500000. @@ -205,18 +205,18 @@

Method Details

{ # A single insertion order. "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. - "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # The bidding strategy of the insertion order. By default, fixed_bid is set. + "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, when performance_goal_type is one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , the line_item_type of the insertion order line items must be either: * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , and when performance_goal_type is either: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` the line_item_type of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy. "raiseBidForDeals": True or False, # Whether the strategy takes deal floor prices into account. }, "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. @@ -224,11 +224,11 @@

Method Details

}, "billableOutcome": "A String", # Immutable. The billable outcome of the insertion order. Outcome based buying is deprecated. `BILLABLE_OUTCOME_PAY_PER_IMPRESSION` is the only valid value. "budget": { # Settings that control how insertion order budget is allocated. # Required. The budget allocation settings of the insertion order. - "automationType": "A String", # The type of automation used to manage bid and budget for the insertion order. If this field is unspecified in creation, the value defaults to `INSERTION_ORDER_AUTOMATION_TYPE_NONE`. + "automationType": "A String", # Optional. The type of automation used to manage bid and budget for the insertion order. If this field is unspecified in creation, the value defaults to `INSERTION_ORDER_AUTOMATION_TYPE_NONE`. "budgetSegments": [ # Required. The list of budget segments. Use a budget segment to specify a specific budget for a given period of time an insertion order is running. { # Settings that control the budget of a single budget segment. "budgetAmountMicros": "A String", # Required. The budget amount the insertion order will spend for the given date_range. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency. - "campaignBudgetId": "A String", # The budget_id of the campaign budget that this insertion order budget segment is a part of. + "campaignBudgetId": "A String", # Optional. The budget_id of the campaign budget that this insertion order budget segment is a part of. "dateRange": { # A date range. # Required. The start and end date settings of the budget segment. They are resolved relative to the parent advertiser's time zone. * When creating a new budget segment, both `start_date` and `end_date` must be in the future. * An existing budget segment with a `start_date` in the past has a mutable `end_date` but an immutable `start_date`. * `end_date` must be the `start_date` or later, both before the year 2037. "endDate": { # 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 # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`. "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. @@ -241,7 +241,7 @@

Method Details

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, }, - "description": "A String", # The budget segment description. It can be used to enter Purchase Order information for each budget segment and have that information printed on the invoices. Must be UTF-8 encoded. + "description": "A String", # Optional. The budget segment description. It can be used to enter Purchase Order information for each budget segment and have that information printed on the invoices. Must be UTF-8 encoded. }, ], "budgetUnit": "A String", # Required. Immutable. The budget unit specifies whether the budget is currency based or impression based. @@ -249,16 +249,16 @@

Method Details

"campaignId": "A String", # Required. Immutable. The unique ID of the campaign that the insertion order belongs to. "displayName": "A String", # Required. The display name of the insertion order. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not the insertion order can spend its budget and bid on inventory. * For CreateInsertionOrder method, only `ENTITY_STATUS_DRAFT` is allowed. To activate an insertion order, use UpdateInsertionOrder method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * An insertion order cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * An insertion order cannot be set to `ENTITY_STATUS_ACTIVE` if its parent campaign is not active. - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency capping setting of the insertion order. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency capping setting of the insertion order. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap) "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. - "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. - "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). + "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. }, "insertionOrderId": "A String", # Output only. The unique ID of the insertion order. Assigned by the system. - "insertionOrderType": "A String", # The type of insertion order. If this field is unspecified in creation, the value defaults to `RTB`. - "integrationDetails": { # Integration details of an entry. # Additional integration details of the insertion order. + "insertionOrderType": "A String", # Optional. The type of insertion order. If this field is unspecified in creation, the value defaults to `RTB`. + "integrationDetails": { # Integration details of an entry. # Optional. Additional integration details of the insertion order. "details": "A String", # Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters. "integrationCode": "A String", # An external identifier to be associated with the entry. The integration code will show up together with the entry in many places in the system, for example, reporting. Must be UTF-8 encoded with a length of no more than 500 characters. }, @@ -269,7 +269,7 @@

Method Details

"pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent. When automatic budget allocation is enabled at the insertion order via automationType, this field is output only and defaults to `PACING_PERIOD_FLIGHT`. "pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be spent across the pacing_period. `PACING_TYPE_ASAP` is not compatible with pacing_period `PACING_PERIOD_FLIGHT` for insertion orders. }, - "partnerCosts": [ # The partner costs associated with the insertion order. If absent or empty in CreateInsertionOrder method, the newly created insertion order will inherit partner costs from the partner settings. + "partnerCosts": [ # Optional. The partner costs associated with the insertion order. If absent or empty in CreateInsertionOrder method, the newly created insertion order will inherit partner costs from the partner settings. { # Settings that control a partner cost. A partner cost is any type of expense involved in running a campaign, other than the costs of purchasing impressions (which is called the media cost) and using third-party audience segment data (data fee). Some examples of partner costs include the fees for using DV360, a third-party ad server, or a third-party ad serving verification service. "costType": "A String", # Required. The type of the partner cost. "feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency. Applicable when the fee_type is `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0. For example, for 1.5 standard unit of the advertiser's currency, set this field to 1500000. @@ -325,18 +325,18 @@

Method Details

{ # A single insertion order. "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. - "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # The bidding strategy of the insertion order. By default, fixed_bid is set. + "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, when performance_goal_type is one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , the line_item_type of the insertion order line items must be either: * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , and when performance_goal_type is either: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` the line_item_type of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy. "raiseBidForDeals": True or False, # Whether the strategy takes deal floor prices into account. }, "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. @@ -344,11 +344,11 @@

Method Details

}, "billableOutcome": "A String", # Immutable. The billable outcome of the insertion order. Outcome based buying is deprecated. `BILLABLE_OUTCOME_PAY_PER_IMPRESSION` is the only valid value. "budget": { # Settings that control how insertion order budget is allocated. # Required. The budget allocation settings of the insertion order. - "automationType": "A String", # The type of automation used to manage bid and budget for the insertion order. If this field is unspecified in creation, the value defaults to `INSERTION_ORDER_AUTOMATION_TYPE_NONE`. + "automationType": "A String", # Optional. The type of automation used to manage bid and budget for the insertion order. If this field is unspecified in creation, the value defaults to `INSERTION_ORDER_AUTOMATION_TYPE_NONE`. "budgetSegments": [ # Required. The list of budget segments. Use a budget segment to specify a specific budget for a given period of time an insertion order is running. { # Settings that control the budget of a single budget segment. "budgetAmountMicros": "A String", # Required. The budget amount the insertion order will spend for the given date_range. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency. - "campaignBudgetId": "A String", # The budget_id of the campaign budget that this insertion order budget segment is a part of. + "campaignBudgetId": "A String", # Optional. The budget_id of the campaign budget that this insertion order budget segment is a part of. "dateRange": { # A date range. # Required. The start and end date settings of the budget segment. They are resolved relative to the parent advertiser's time zone. * When creating a new budget segment, both `start_date` and `end_date` must be in the future. * An existing budget segment with a `start_date` in the past has a mutable `end_date` but an immutable `start_date`. * `end_date` must be the `start_date` or later, both before the year 2037. "endDate": { # 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 # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`. "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. @@ -361,7 +361,7 @@

Method Details

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, }, - "description": "A String", # The budget segment description. It can be used to enter Purchase Order information for each budget segment and have that information printed on the invoices. Must be UTF-8 encoded. + "description": "A String", # Optional. The budget segment description. It can be used to enter Purchase Order information for each budget segment and have that information printed on the invoices. Must be UTF-8 encoded. }, ], "budgetUnit": "A String", # Required. Immutable. The budget unit specifies whether the budget is currency based or impression based. @@ -369,16 +369,16 @@

Method Details

"campaignId": "A String", # Required. Immutable. The unique ID of the campaign that the insertion order belongs to. "displayName": "A String", # Required. The display name of the insertion order. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not the insertion order can spend its budget and bid on inventory. * For CreateInsertionOrder method, only `ENTITY_STATUS_DRAFT` is allowed. To activate an insertion order, use UpdateInsertionOrder method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * An insertion order cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * An insertion order cannot be set to `ENTITY_STATUS_ACTIVE` if its parent campaign is not active. - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency capping setting of the insertion order. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency capping setting of the insertion order. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap) "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. - "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. - "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). + "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. }, "insertionOrderId": "A String", # Output only. The unique ID of the insertion order. Assigned by the system. - "insertionOrderType": "A String", # The type of insertion order. If this field is unspecified in creation, the value defaults to `RTB`. - "integrationDetails": { # Integration details of an entry. # Additional integration details of the insertion order. + "insertionOrderType": "A String", # Optional. The type of insertion order. If this field is unspecified in creation, the value defaults to `RTB`. + "integrationDetails": { # Integration details of an entry. # Optional. Additional integration details of the insertion order. "details": "A String", # Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters. "integrationCode": "A String", # An external identifier to be associated with the entry. The integration code will show up together with the entry in many places in the system, for example, reporting. Must be UTF-8 encoded with a length of no more than 500 characters. }, @@ -389,7 +389,7 @@

Method Details

"pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent. When automatic budget allocation is enabled at the insertion order via automationType, this field is output only and defaults to `PACING_PERIOD_FLIGHT`. "pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be spent across the pacing_period. `PACING_TYPE_ASAP` is not compatible with pacing_period `PACING_PERIOD_FLIGHT` for insertion orders. }, - "partnerCosts": [ # The partner costs associated with the insertion order. If absent or empty in CreateInsertionOrder method, the newly created insertion order will inherit partner costs from the partner settings. + "partnerCosts": [ # Optional. The partner costs associated with the insertion order. If absent or empty in CreateInsertionOrder method, the newly created insertion order will inherit partner costs from the partner settings. { # Settings that control a partner cost. A partner cost is any type of expense involved in running a campaign, other than the costs of purchasing impressions (which is called the media cost) and using third-party audience segment data (data fee). Some examples of partner costs include the fees for using DV360, a third-party ad server, or a third-party ad serving verification service. "costType": "A String", # Required. The type of the partner cost. "feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency. Applicable when the fee_type is `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0. For example, for 1.5 standard unit of the advertiser's currency, set this field to 1500000. @@ -431,18 +431,18 @@

Method Details

"insertionOrders": [ # The list of insertion orders. This list will be absent if empty. { # A single insertion order. "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. - "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # The bidding strategy of the insertion order. By default, fixed_bid is set. + "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, when performance_goal_type is one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , the line_item_type of the insertion order line items must be either: * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , and when performance_goal_type is either: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` the line_item_type of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy. "raiseBidForDeals": True or False, # Whether the strategy takes deal floor prices into account. }, "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. @@ -450,11 +450,11 @@

Method Details

}, "billableOutcome": "A String", # Immutable. The billable outcome of the insertion order. Outcome based buying is deprecated. `BILLABLE_OUTCOME_PAY_PER_IMPRESSION` is the only valid value. "budget": { # Settings that control how insertion order budget is allocated. # Required. The budget allocation settings of the insertion order. - "automationType": "A String", # The type of automation used to manage bid and budget for the insertion order. If this field is unspecified in creation, the value defaults to `INSERTION_ORDER_AUTOMATION_TYPE_NONE`. + "automationType": "A String", # Optional. The type of automation used to manage bid and budget for the insertion order. If this field is unspecified in creation, the value defaults to `INSERTION_ORDER_AUTOMATION_TYPE_NONE`. "budgetSegments": [ # Required. The list of budget segments. Use a budget segment to specify a specific budget for a given period of time an insertion order is running. { # Settings that control the budget of a single budget segment. "budgetAmountMicros": "A String", # Required. The budget amount the insertion order will spend for the given date_range. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency. - "campaignBudgetId": "A String", # The budget_id of the campaign budget that this insertion order budget segment is a part of. + "campaignBudgetId": "A String", # Optional. The budget_id of the campaign budget that this insertion order budget segment is a part of. "dateRange": { # A date range. # Required. The start and end date settings of the budget segment. They are resolved relative to the parent advertiser's time zone. * When creating a new budget segment, both `start_date` and `end_date` must be in the future. * An existing budget segment with a `start_date` in the past has a mutable `end_date` but an immutable `start_date`. * `end_date` must be the `start_date` or later, both before the year 2037. "endDate": { # 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 # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`. "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. @@ -467,7 +467,7 @@

Method Details

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, }, - "description": "A String", # The budget segment description. It can be used to enter Purchase Order information for each budget segment and have that information printed on the invoices. Must be UTF-8 encoded. + "description": "A String", # Optional. The budget segment description. It can be used to enter Purchase Order information for each budget segment and have that information printed on the invoices. Must be UTF-8 encoded. }, ], "budgetUnit": "A String", # Required. Immutable. The budget unit specifies whether the budget is currency based or impression based. @@ -475,16 +475,16 @@

Method Details

"campaignId": "A String", # Required. Immutable. The unique ID of the campaign that the insertion order belongs to. "displayName": "A String", # Required. The display name of the insertion order. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not the insertion order can spend its budget and bid on inventory. * For CreateInsertionOrder method, only `ENTITY_STATUS_DRAFT` is allowed. To activate an insertion order, use UpdateInsertionOrder method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * An insertion order cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * An insertion order cannot be set to `ENTITY_STATUS_ACTIVE` if its parent campaign is not active. - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency capping setting of the insertion order. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency capping setting of the insertion order. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap) "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. - "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. - "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). + "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. }, "insertionOrderId": "A String", # Output only. The unique ID of the insertion order. Assigned by the system. - "insertionOrderType": "A String", # The type of insertion order. If this field is unspecified in creation, the value defaults to `RTB`. - "integrationDetails": { # Integration details of an entry. # Additional integration details of the insertion order. + "insertionOrderType": "A String", # Optional. The type of insertion order. If this field is unspecified in creation, the value defaults to `RTB`. + "integrationDetails": { # Integration details of an entry. # Optional. Additional integration details of the insertion order. "details": "A String", # Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters. "integrationCode": "A String", # An external identifier to be associated with the entry. The integration code will show up together with the entry in many places in the system, for example, reporting. Must be UTF-8 encoded with a length of no more than 500 characters. }, @@ -495,7 +495,7 @@

Method Details

"pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent. When automatic budget allocation is enabled at the insertion order via automationType, this field is output only and defaults to `PACING_PERIOD_FLIGHT`. "pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be spent across the pacing_period. `PACING_TYPE_ASAP` is not compatible with pacing_period `PACING_PERIOD_FLIGHT` for insertion orders. }, - "partnerCosts": [ # The partner costs associated with the insertion order. If absent or empty in CreateInsertionOrder method, the newly created insertion order will inherit partner costs from the partner settings. + "partnerCosts": [ # Optional. The partner costs associated with the insertion order. If absent or empty in CreateInsertionOrder method, the newly created insertion order will inherit partner costs from the partner settings. { # Settings that control a partner cost. A partner cost is any type of expense involved in running a campaign, other than the costs of purchasing impressions (which is called the media cost) and using third-party audience segment data (data fee). Some examples of partner costs include the fees for using DV360, a third-party ad server, or a third-party ad serving verification service. "costType": "A String", # Required. The type of the partner cost. "feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency. Applicable when the fee_type is `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0. For example, for 1.5 standard unit of the advertiser's currency, set this field to 1500000. @@ -544,18 +544,18 @@

Method Details

{ # A single insertion order. "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. - "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # The bidding strategy of the insertion order. By default, fixed_bid is set. + "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, when performance_goal_type is one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , the line_item_type of the insertion order line items must be either: * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , and when performance_goal_type is either: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` the line_item_type of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy. "raiseBidForDeals": True or False, # Whether the strategy takes deal floor prices into account. }, "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. @@ -563,11 +563,11 @@

Method Details

}, "billableOutcome": "A String", # Immutable. The billable outcome of the insertion order. Outcome based buying is deprecated. `BILLABLE_OUTCOME_PAY_PER_IMPRESSION` is the only valid value. "budget": { # Settings that control how insertion order budget is allocated. # Required. The budget allocation settings of the insertion order. - "automationType": "A String", # The type of automation used to manage bid and budget for the insertion order. If this field is unspecified in creation, the value defaults to `INSERTION_ORDER_AUTOMATION_TYPE_NONE`. + "automationType": "A String", # Optional. The type of automation used to manage bid and budget for the insertion order. If this field is unspecified in creation, the value defaults to `INSERTION_ORDER_AUTOMATION_TYPE_NONE`. "budgetSegments": [ # Required. The list of budget segments. Use a budget segment to specify a specific budget for a given period of time an insertion order is running. { # Settings that control the budget of a single budget segment. "budgetAmountMicros": "A String", # Required. The budget amount the insertion order will spend for the given date_range. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency. - "campaignBudgetId": "A String", # The budget_id of the campaign budget that this insertion order budget segment is a part of. + "campaignBudgetId": "A String", # Optional. The budget_id of the campaign budget that this insertion order budget segment is a part of. "dateRange": { # A date range. # Required. The start and end date settings of the budget segment. They are resolved relative to the parent advertiser's time zone. * When creating a new budget segment, both `start_date` and `end_date` must be in the future. * An existing budget segment with a `start_date` in the past has a mutable `end_date` but an immutable `start_date`. * `end_date` must be the `start_date` or later, both before the year 2037. "endDate": { # 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 # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`. "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. @@ -580,7 +580,7 @@

Method Details

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, }, - "description": "A String", # The budget segment description. It can be used to enter Purchase Order information for each budget segment and have that information printed on the invoices. Must be UTF-8 encoded. + "description": "A String", # Optional. The budget segment description. It can be used to enter Purchase Order information for each budget segment and have that information printed on the invoices. Must be UTF-8 encoded. }, ], "budgetUnit": "A String", # Required. Immutable. The budget unit specifies whether the budget is currency based or impression based. @@ -588,16 +588,16 @@

Method Details

"campaignId": "A String", # Required. Immutable. The unique ID of the campaign that the insertion order belongs to. "displayName": "A String", # Required. The display name of the insertion order. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not the insertion order can spend its budget and bid on inventory. * For CreateInsertionOrder method, only `ENTITY_STATUS_DRAFT` is allowed. To activate an insertion order, use UpdateInsertionOrder method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * An insertion order cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * An insertion order cannot be set to `ENTITY_STATUS_ACTIVE` if its parent campaign is not active. - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency capping setting of the insertion order. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency capping setting of the insertion order. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap) "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. - "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. - "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). + "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. }, "insertionOrderId": "A String", # Output only. The unique ID of the insertion order. Assigned by the system. - "insertionOrderType": "A String", # The type of insertion order. If this field is unspecified in creation, the value defaults to `RTB`. - "integrationDetails": { # Integration details of an entry. # Additional integration details of the insertion order. + "insertionOrderType": "A String", # Optional. The type of insertion order. If this field is unspecified in creation, the value defaults to `RTB`. + "integrationDetails": { # Integration details of an entry. # Optional. Additional integration details of the insertion order. "details": "A String", # Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters. "integrationCode": "A String", # An external identifier to be associated with the entry. The integration code will show up together with the entry in many places in the system, for example, reporting. Must be UTF-8 encoded with a length of no more than 500 characters. }, @@ -608,7 +608,7 @@

Method Details

"pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent. When automatic budget allocation is enabled at the insertion order via automationType, this field is output only and defaults to `PACING_PERIOD_FLIGHT`. "pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be spent across the pacing_period. `PACING_TYPE_ASAP` is not compatible with pacing_period `PACING_PERIOD_FLIGHT` for insertion orders. }, - "partnerCosts": [ # The partner costs associated with the insertion order. If absent or empty in CreateInsertionOrder method, the newly created insertion order will inherit partner costs from the partner settings. + "partnerCosts": [ # Optional. The partner costs associated with the insertion order. If absent or empty in CreateInsertionOrder method, the newly created insertion order will inherit partner costs from the partner settings. { # Settings that control a partner cost. A partner cost is any type of expense involved in running a campaign, other than the costs of purchasing impressions (which is called the media cost) and using third-party audience segment data (data fee). Some examples of partner costs include the fees for using DV360, a third-party ad server, or a third-party ad serving verification service. "costType": "A String", # Required. The type of the partner cost. "feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency. Applicable when the fee_type is `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0. For example, for 1.5 standard unit of the advertiser's currency, set this field to 1500000. @@ -638,18 +638,18 @@

Method Details

{ # A single insertion order. "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. - "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # The bidding strategy of the insertion order. By default, fixed_bid is set. + "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, when performance_goal_type is one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , the line_item_type of the insertion order line items must be either: * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , and when performance_goal_type is either: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` the line_item_type of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy. "raiseBidForDeals": True or False, # Whether the strategy takes deal floor prices into account. }, "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. @@ -657,11 +657,11 @@

Method Details

}, "billableOutcome": "A String", # Immutable. The billable outcome of the insertion order. Outcome based buying is deprecated. `BILLABLE_OUTCOME_PAY_PER_IMPRESSION` is the only valid value. "budget": { # Settings that control how insertion order budget is allocated. # Required. The budget allocation settings of the insertion order. - "automationType": "A String", # The type of automation used to manage bid and budget for the insertion order. If this field is unspecified in creation, the value defaults to `INSERTION_ORDER_AUTOMATION_TYPE_NONE`. + "automationType": "A String", # Optional. The type of automation used to manage bid and budget for the insertion order. If this field is unspecified in creation, the value defaults to `INSERTION_ORDER_AUTOMATION_TYPE_NONE`. "budgetSegments": [ # Required. The list of budget segments. Use a budget segment to specify a specific budget for a given period of time an insertion order is running. { # Settings that control the budget of a single budget segment. "budgetAmountMicros": "A String", # Required. The budget amount the insertion order will spend for the given date_range. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency. - "campaignBudgetId": "A String", # The budget_id of the campaign budget that this insertion order budget segment is a part of. + "campaignBudgetId": "A String", # Optional. The budget_id of the campaign budget that this insertion order budget segment is a part of. "dateRange": { # A date range. # Required. The start and end date settings of the budget segment. They are resolved relative to the parent advertiser's time zone. * When creating a new budget segment, both `start_date` and `end_date` must be in the future. * An existing budget segment with a `start_date` in the past has a mutable `end_date` but an immutable `start_date`. * `end_date` must be the `start_date` or later, both before the year 2037. "endDate": { # 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 # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`. "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. @@ -674,7 +674,7 @@

Method Details

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, }, - "description": "A String", # The budget segment description. It can be used to enter Purchase Order information for each budget segment and have that information printed on the invoices. Must be UTF-8 encoded. + "description": "A String", # Optional. The budget segment description. It can be used to enter Purchase Order information for each budget segment and have that information printed on the invoices. Must be UTF-8 encoded. }, ], "budgetUnit": "A String", # Required. Immutable. The budget unit specifies whether the budget is currency based or impression based. @@ -682,16 +682,16 @@

Method Details

"campaignId": "A String", # Required. Immutable. The unique ID of the campaign that the insertion order belongs to. "displayName": "A String", # Required. The display name of the insertion order. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not the insertion order can spend its budget and bid on inventory. * For CreateInsertionOrder method, only `ENTITY_STATUS_DRAFT` is allowed. To activate an insertion order, use UpdateInsertionOrder method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * An insertion order cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * An insertion order cannot be set to `ENTITY_STATUS_ACTIVE` if its parent campaign is not active. - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency capping setting of the insertion order. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency capping setting of the insertion order. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap) "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. - "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. - "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). + "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. }, "insertionOrderId": "A String", # Output only. The unique ID of the insertion order. Assigned by the system. - "insertionOrderType": "A String", # The type of insertion order. If this field is unspecified in creation, the value defaults to `RTB`. - "integrationDetails": { # Integration details of an entry. # Additional integration details of the insertion order. + "insertionOrderType": "A String", # Optional. The type of insertion order. If this field is unspecified in creation, the value defaults to `RTB`. + "integrationDetails": { # Integration details of an entry. # Optional. Additional integration details of the insertion order. "details": "A String", # Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters. "integrationCode": "A String", # An external identifier to be associated with the entry. The integration code will show up together with the entry in many places in the system, for example, reporting. Must be UTF-8 encoded with a length of no more than 500 characters. }, @@ -702,7 +702,7 @@

Method Details

"pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent. When automatic budget allocation is enabled at the insertion order via automationType, this field is output only and defaults to `PACING_PERIOD_FLIGHT`. "pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be spent across the pacing_period. `PACING_TYPE_ASAP` is not compatible with pacing_period `PACING_PERIOD_FLIGHT` for insertion orders. }, - "partnerCosts": [ # The partner costs associated with the insertion order. If absent or empty in CreateInsertionOrder method, the newly created insertion order will inherit partner costs from the partner settings. + "partnerCosts": [ # Optional. The partner costs associated with the insertion order. If absent or empty in CreateInsertionOrder method, the newly created insertion order will inherit partner costs from the partner settings. { # Settings that control a partner cost. A partner cost is any type of expense involved in running a campaign, other than the costs of purchasing impressions (which is called the media cost) and using third-party audience segment data (data fee). Some examples of partner costs include the fees for using DV360, a third-party ad server, or a third-party ad serving verification service. "costType": "A String", # Required. The type of the partner cost. "feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency. Applicable when the fee_type is `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0. For example, for 1.5 standard unit of the advertiser's currency, set this field to 1500000. diff --git a/docs/dyn/displayvideo_v2.advertisers.lineItems.html b/docs/dyn/displayvideo_v2.advertisers.lineItems.html index d6bc9e229a8..ac886354b58 100644 --- a/docs/dyn/displayvideo_v2.advertisers.lineItems.html +++ b/docs/dyn/displayvideo_v2.advertisers.lineItems.html @@ -149,30 +149,30 @@

Method Details

}, "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts. "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` - "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. NEXT_ID: 9 # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. - "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. + "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, ], }, - "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # The combined audience ids of the included combined audience group. Contains combined audience ids only. - "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. + "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only. + "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. { # Details of combined audience targeting setting. "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. }, ], }, - "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # The custom list ids of the included custom list group. Contains custom list ids only. - "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. + "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only. + "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored. { # Details of custom list targeting setting. "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id. }, ], }, - "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the included Google audience group. Contains Google audience ids only. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, @@ -499,30 +499,30 @@

Method Details

}, "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts. "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` - "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. NEXT_ID: 9 # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. - "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. + "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, ], }, - "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # The combined audience ids of the included combined audience group. Contains combined audience ids only. - "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. + "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only. + "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. { # Details of combined audience targeting setting. "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. }, ], }, - "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # The custom list ids of the included custom list group. Contains custom list ids only. - "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. + "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only. + "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored. { # Details of custom list targeting setting. "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id. }, ], }, - "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the included Google audience group. Contains Google audience ids only. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, @@ -805,13 +805,13 @@

Method Details

"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, when performance_goal_type is one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , the line_item_type of the insertion order line items must be either: * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , and when performance_goal_type is either: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` the line_item_type of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy. "raiseBidForDeals": True or False, # Whether the strategy takes deal floor prices into account. }, "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. @@ -823,8 +823,8 @@

Method Details

"maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. }, "campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to. - "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item. - "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. + "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item. *Warning*: Starting **April 1, 2025**, the floodlight_activity_configs field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). + "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. *Warning*: Starting **April 1, 2025**, this field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). { # Settings that control the behavior of a single Floodlight activity config. "floodlightActivityId": "A String", # Required. The ID of the Floodlight activity. "postClickLookbackWindowDays": 42, # Required. The number of days after an ad has been clicked in which a conversion may be counted. Must be between 0 and 90 inclusive. @@ -854,11 +854,11 @@

Method Details

}, "flightDateType": "A String", # Required. The type of the line item's flight dates. }, - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap) "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. - "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. - "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). + "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. }, "insertionOrderId": "A String", # Required. Immutable. The unique ID of the insertion order that the line item belongs to. @@ -965,11 +965,11 @@

Method Details

}, ], }, - "viewFrequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # The view frequency cap settings of the line item. The max_views field in this settings object must be used if assigning a limited cap. + "viewFrequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # The view frequency cap settings of the line item. The max_views field in this settings object must be used if assigning a limited cap. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap) "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. - "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. - "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). + "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. }, }, @@ -1030,13 +1030,13 @@

Method Details

"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, when performance_goal_type is one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , the line_item_type of the insertion order line items must be either: * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , and when performance_goal_type is either: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` the line_item_type of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy. "raiseBidForDeals": True or False, # Whether the strategy takes deal floor prices into account. }, "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. @@ -1048,8 +1048,8 @@

Method Details

"maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. }, "campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to. - "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item. - "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. + "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item. *Warning*: Starting **April 1, 2025**, the floodlight_activity_configs field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). + "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. *Warning*: Starting **April 1, 2025**, this field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). { # Settings that control the behavior of a single Floodlight activity config. "floodlightActivityId": "A String", # Required. The ID of the Floodlight activity. "postClickLookbackWindowDays": 42, # Required. The number of days after an ad has been clicked in which a conversion may be counted. Must be between 0 and 90 inclusive. @@ -1079,11 +1079,11 @@

Method Details

}, "flightDateType": "A String", # Required. The type of the line item's flight dates. }, - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap) "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. - "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. - "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). + "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. }, "insertionOrderId": "A String", # Required. Immutable. The unique ID of the insertion order that the line item belongs to. @@ -1190,11 +1190,11 @@

Method Details

}, ], }, - "viewFrequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # The view frequency cap settings of the line item. The max_views field in this settings object must be used if assigning a limited cap. + "viewFrequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # The view frequency cap settings of the line item. The max_views field in this settings object must be used if assigning a limited cap. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap) "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. - "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. - "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). + "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. }, }, @@ -1215,13 +1215,13 @@

Method Details

"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, when performance_goal_type is one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , the line_item_type of the insertion order line items must be either: * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , and when performance_goal_type is either: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` the line_item_type of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy. "raiseBidForDeals": True or False, # Whether the strategy takes deal floor prices into account. }, "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. @@ -1233,8 +1233,8 @@

Method Details

"maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. }, "campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to. - "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item. - "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. + "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item. *Warning*: Starting **April 1, 2025**, the floodlight_activity_configs field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). + "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. *Warning*: Starting **April 1, 2025**, this field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). { # Settings that control the behavior of a single Floodlight activity config. "floodlightActivityId": "A String", # Required. The ID of the Floodlight activity. "postClickLookbackWindowDays": 42, # Required. The number of days after an ad has been clicked in which a conversion may be counted. Must be between 0 and 90 inclusive. @@ -1264,11 +1264,11 @@

Method Details

}, "flightDateType": "A String", # Required. The type of the line item's flight dates. }, - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap) "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. - "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. - "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). + "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. }, "insertionOrderId": "A String", # Required. Immutable. The unique ID of the insertion order that the line item belongs to. @@ -1375,11 +1375,11 @@

Method Details

}, ], }, - "viewFrequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # The view frequency cap settings of the line item. The max_views field in this settings object must be used if assigning a limited cap. + "viewFrequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # The view frequency cap settings of the line item. The max_views field in this settings object must be used if assigning a limited cap. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap) "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. - "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. - "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). + "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. }, }, @@ -1468,13 +1468,13 @@

Method Details

"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, when performance_goal_type is one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , the line_item_type of the insertion order line items must be either: * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , and when performance_goal_type is either: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` the line_item_type of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy. "raiseBidForDeals": True or False, # Whether the strategy takes deal floor prices into account. }, "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. @@ -1486,8 +1486,8 @@

Method Details

"maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. }, "campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to. - "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item. - "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. + "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item. *Warning*: Starting **April 1, 2025**, the floodlight_activity_configs field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). + "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. *Warning*: Starting **April 1, 2025**, this field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). { # Settings that control the behavior of a single Floodlight activity config. "floodlightActivityId": "A String", # Required. The ID of the Floodlight activity. "postClickLookbackWindowDays": 42, # Required. The number of days after an ad has been clicked in which a conversion may be counted. Must be between 0 and 90 inclusive. @@ -1517,11 +1517,11 @@

Method Details

}, "flightDateType": "A String", # Required. The type of the line item's flight dates. }, - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap) "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. - "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. - "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). + "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. }, "insertionOrderId": "A String", # Required. Immutable. The unique ID of the insertion order that the line item belongs to. @@ -1628,11 +1628,11 @@

Method Details

}, ], }, - "viewFrequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # The view frequency cap settings of the line item. The max_views field in this settings object must be used if assigning a limited cap. + "viewFrequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # The view frequency cap settings of the line item. The max_views field in this settings object must be used if assigning a limited cap. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap) "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. - "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. - "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). + "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. }, }, @@ -1661,13 +1661,13 @@

Method Details

"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, when performance_goal_type is one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , the line_item_type of the insertion order line items must be either: * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , and when performance_goal_type is either: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` the line_item_type of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy. "raiseBidForDeals": True or False, # Whether the strategy takes deal floor prices into account. }, "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. @@ -1679,8 +1679,8 @@

Method Details

"maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. }, "campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to. - "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item. - "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. + "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item. *Warning*: Starting **April 1, 2025**, the floodlight_activity_configs field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). + "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. *Warning*: Starting **April 1, 2025**, this field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). { # Settings that control the behavior of a single Floodlight activity config. "floodlightActivityId": "A String", # Required. The ID of the Floodlight activity. "postClickLookbackWindowDays": 42, # Required. The number of days after an ad has been clicked in which a conversion may be counted. Must be between 0 and 90 inclusive. @@ -1710,11 +1710,11 @@

Method Details

}, "flightDateType": "A String", # Required. The type of the line item's flight dates. }, - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap) "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. - "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. - "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). + "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. }, "insertionOrderId": "A String", # Required. Immutable. The unique ID of the insertion order that the line item belongs to. @@ -1821,11 +1821,11 @@

Method Details

}, ], }, - "viewFrequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # The view frequency cap settings of the line item. The max_views field in this settings object must be used if assigning a limited cap. + "viewFrequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # The view frequency cap settings of the line item. The max_views field in this settings object must be used if assigning a limited cap. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap) "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. - "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. - "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). + "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. }, }, @@ -1859,13 +1859,13 @@

Method Details

"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, when performance_goal_type is one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , the line_item_type of the insertion order line items must be either: * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , and when performance_goal_type is either: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` the line_item_type of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy. "raiseBidForDeals": True or False, # Whether the strategy takes deal floor prices into account. }, "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. @@ -1877,8 +1877,8 @@

Method Details

"maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. }, "campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to. - "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item. - "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. + "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item. *Warning*: Starting **April 1, 2025**, the floodlight_activity_configs field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). + "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. *Warning*: Starting **April 1, 2025**, this field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). { # Settings that control the behavior of a single Floodlight activity config. "floodlightActivityId": "A String", # Required. The ID of the Floodlight activity. "postClickLookbackWindowDays": 42, # Required. The number of days after an ad has been clicked in which a conversion may be counted. Must be between 0 and 90 inclusive. @@ -1908,11 +1908,11 @@

Method Details

}, "flightDateType": "A String", # Required. The type of the line item's flight dates. }, - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap) "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. - "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. - "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). + "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. }, "insertionOrderId": "A String", # Required. Immutable. The unique ID of the insertion order that the line item belongs to. @@ -2019,11 +2019,11 @@

Method Details

}, ], }, - "viewFrequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # The view frequency cap settings of the line item. The max_views field in this settings object must be used if assigning a limited cap. + "viewFrequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # The view frequency cap settings of the line item. The max_views field in this settings object must be used if assigning a limited cap. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap) "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. - "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. - "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). + "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. }, }, @@ -2064,13 +2064,13 @@

Method Details

"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, when performance_goal_type is one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , the line_item_type of the insertion order line items must be either: * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , and when performance_goal_type is either: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` the line_item_type of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy. "raiseBidForDeals": True or False, # Whether the strategy takes deal floor prices into account. }, "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. @@ -2082,8 +2082,8 @@

Method Details

"maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. }, "campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to. - "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item. - "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. + "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item. *Warning*: Starting **April 1, 2025**, the floodlight_activity_configs field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). + "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. *Warning*: Starting **April 1, 2025**, this field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). { # Settings that control the behavior of a single Floodlight activity config. "floodlightActivityId": "A String", # Required. The ID of the Floodlight activity. "postClickLookbackWindowDays": 42, # Required. The number of days after an ad has been clicked in which a conversion may be counted. Must be between 0 and 90 inclusive. @@ -2113,11 +2113,11 @@

Method Details

}, "flightDateType": "A String", # Required. The type of the line item's flight dates. }, - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap) "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. - "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. - "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). + "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. }, "insertionOrderId": "A String", # Required. Immutable. The unique ID of the insertion order that the line item belongs to. @@ -2224,11 +2224,11 @@

Method Details

}, ], }, - "viewFrequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # The view frequency cap settings of the line item. The max_views field in this settings object must be used if assigning a limited cap. + "viewFrequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # The view frequency cap settings of the line item. The max_views field in this settings object must be used if assigning a limited cap. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap) "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. - "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. - "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). + "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. }, }, @@ -2250,13 +2250,13 @@

Method Details

"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, when performance_goal_type is one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , the line_item_type of the insertion order line items must be either: * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , and when performance_goal_type is either: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` the line_item_type of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy. "raiseBidForDeals": True or False, # Whether the strategy takes deal floor prices into account. }, "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. @@ -2268,8 +2268,8 @@

Method Details

"maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. }, "campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to. - "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item. - "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. + "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item. *Warning*: Starting **April 1, 2025**, the floodlight_activity_configs field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). + "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. *Warning*: Starting **April 1, 2025**, this field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). { # Settings that control the behavior of a single Floodlight activity config. "floodlightActivityId": "A String", # Required. The ID of the Floodlight activity. "postClickLookbackWindowDays": 42, # Required. The number of days after an ad has been clicked in which a conversion may be counted. Must be between 0 and 90 inclusive. @@ -2299,11 +2299,11 @@

Method Details

}, "flightDateType": "A String", # Required. The type of the line item's flight dates. }, - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap) "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. - "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. - "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). + "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. }, "insertionOrderId": "A String", # Required. Immutable. The unique ID of the insertion order that the line item belongs to. @@ -2410,11 +2410,11 @@

Method Details

}, ], }, - "viewFrequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # The view frequency cap settings of the line item. The max_views field in this settings object must be used if assigning a limited cap. + "viewFrequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # The view frequency cap settings of the line item. The max_views field in this settings object must be used if assigning a limited cap. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap) "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. - "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. - "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). + "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. }, }, diff --git a/docs/dyn/displayvideo_v2.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v2.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html index 5bbcbd9679c..15314ce2ae4 100644 --- a/docs/dyn/displayvideo_v2.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v2.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html @@ -176,30 +176,30 @@

Method Details

}, "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts. "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` - "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. NEXT_ID: 9 # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. - "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. + "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, ], }, - "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # The combined audience ids of the included combined audience group. Contains combined audience ids only. - "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. + "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only. + "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. { # Details of combined audience targeting setting. "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. }, ], }, - "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # The custom list ids of the included custom list group. Contains custom list ids only. - "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. + "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only. + "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored. { # Details of custom list targeting setting. "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id. }, ], }, - "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the included Google audience group. Contains Google audience ids only. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, @@ -467,30 +467,30 @@

Method Details

}, "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts. "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` - "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. NEXT_ID: 9 # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. - "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. + "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, ], }, - "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # The combined audience ids of the included combined audience group. Contains combined audience ids only. - "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. + "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only. + "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. { # Details of combined audience targeting setting. "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. }, ], }, - "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # The custom list ids of the included custom list group. Contains custom list ids only. - "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. + "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only. + "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored. { # Details of custom list targeting setting. "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id. }, ], }, - "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the included Google audience group. Contains Google audience ids only. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, @@ -889,30 +889,30 @@

Method Details

}, "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts. "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` - "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. NEXT_ID: 9 # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. - "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. + "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, ], }, - "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # The combined audience ids of the included combined audience group. Contains combined audience ids only. - "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. + "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only. + "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. { # Details of combined audience targeting setting. "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. }, ], }, - "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # The custom list ids of the included custom list group. Contains custom list ids only. - "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. + "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only. + "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored. { # Details of custom list targeting setting. "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id. }, ], }, - "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the included Google audience group. Contains Google audience ids only. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, @@ -1245,30 +1245,30 @@

Method Details

}, "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts. "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` - "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. NEXT_ID: 9 # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. - "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. + "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, ], }, - "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # The combined audience ids of the included combined audience group. Contains combined audience ids only. - "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. + "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only. + "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. { # Details of combined audience targeting setting. "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. }, ], }, - "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # The custom list ids of the included custom list group. Contains custom list ids only. - "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. + "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only. + "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored. { # Details of custom list targeting setting. "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id. }, ], }, - "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the included Google audience group. Contains Google audience ids only. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, diff --git a/docs/dyn/displayvideo_v2.advertisers.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v2.advertisers.targetingTypes.assignedTargetingOptions.html index 8b94f70a013..3e72bdef208 100644 --- a/docs/dyn/displayvideo_v2.advertisers.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v2.advertisers.targetingTypes.assignedTargetingOptions.html @@ -175,30 +175,30 @@

Method Details

}, "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts. "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` - "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. NEXT_ID: 9 # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. - "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. + "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, ], }, - "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # The combined audience ids of the included combined audience group. Contains combined audience ids only. - "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. + "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only. + "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. { # Details of combined audience targeting setting. "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. }, ], }, - "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # The custom list ids of the included custom list group. Contains custom list ids only. - "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. + "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only. + "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored. { # Details of custom list targeting setting. "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id. }, ], }, - "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the included Google audience group. Contains Google audience ids only. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, @@ -466,30 +466,30 @@

Method Details

}, "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts. "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` - "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. NEXT_ID: 9 # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. - "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. + "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, ], }, - "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # The combined audience ids of the included combined audience group. Contains combined audience ids only. - "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. + "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only. + "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. { # Details of combined audience targeting setting. "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. }, ], }, - "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # The custom list ids of the included custom list group. Contains custom list ids only. - "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. + "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only. + "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored. { # Details of custom list targeting setting. "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id. }, ], }, - "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the included Google audience group. Contains Google audience ids only. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, @@ -886,30 +886,30 @@

Method Details

}, "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts. "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` - "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. NEXT_ID: 9 # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. - "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. + "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, ], }, - "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # The combined audience ids of the included combined audience group. Contains combined audience ids only. - "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. + "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only. + "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. { # Details of combined audience targeting setting. "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. }, ], }, - "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # The custom list ids of the included custom list group. Contains custom list ids only. - "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. + "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only. + "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored. { # Details of custom list targeting setting. "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id. }, ], }, - "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the included Google audience group. Contains Google audience ids only. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, @@ -1241,30 +1241,30 @@

Method Details

}, "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts. "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` - "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. NEXT_ID: 9 # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. - "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. + "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, ], }, - "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # The combined audience ids of the included combined audience group. Contains combined audience ids only. - "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. + "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only. + "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. { # Details of combined audience targeting setting. "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. }, ], }, - "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # The custom list ids of the included custom list group. Contains custom list ids only. - "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. + "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only. + "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored. { # Details of custom list targeting setting. "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id. }, ], }, - "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the included Google audience group. Contains Google audience ids only. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, diff --git a/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.html b/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.html index 9f193119d40..d321f62ea32 100644 --- a/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.html +++ b/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.html @@ -138,30 +138,30 @@

Method Details

}, "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts. "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` - "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. NEXT_ID: 9 # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. - "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. + "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, ], }, - "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # The combined audience ids of the included combined audience group. Contains combined audience ids only. - "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. + "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only. + "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. { # Details of combined audience targeting setting. "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. }, ], }, - "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # The custom list ids of the included custom list group. Contains custom list ids only. - "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. + "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only. + "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored. { # Details of custom list targeting setting. "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id. }, ], }, - "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the included Google audience group. Contains Google audience ids only. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, diff --git a/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.targetingTypes.assignedTargetingOptions.html index 5910e0c8301..99c9cfb6eab 100644 --- a/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.targetingTypes.assignedTargetingOptions.html @@ -176,30 +176,30 @@

Method Details

}, "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts. "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` - "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. NEXT_ID: 9 # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. - "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. + "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, ], }, - "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # The combined audience ids of the included combined audience group. Contains combined audience ids only. - "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. + "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only. + "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. { # Details of combined audience targeting setting. "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. }, ], }, - "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # The custom list ids of the included custom list group. Contains custom list ids only. - "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. + "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only. + "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored. { # Details of custom list targeting setting. "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id. }, ], }, - "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the included Google audience group. Contains Google audience ids only. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, @@ -532,30 +532,30 @@

Method Details

}, "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts. "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` - "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. NEXT_ID: 9 # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. - "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. + "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, ], }, - "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # The combined audience ids of the included combined audience group. Contains combined audience ids only. - "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. + "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only. + "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. { # Details of combined audience targeting setting. "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. }, ], }, - "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # The custom list ids of the included custom list group. Contains custom list ids only. - "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. + "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only. + "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored. { # Details of custom list targeting setting. "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id. }, ], }, - "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the included Google audience group. Contains Google audience ids only. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, diff --git a/docs/dyn/displayvideo_v2.customBiddingAlgorithms.html b/docs/dyn/displayvideo_v2.customBiddingAlgorithms.html index 7f8ddb6f305..4b1f79946b6 100644 --- a/docs/dyn/displayvideo_v2.customBiddingAlgorithms.html +++ b/docs/dyn/displayvideo_v2.customBiddingAlgorithms.html @@ -96,7 +96,7 @@

Instance Methods

Retrieves the next page of results.

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

-

Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful.

+

Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful. *Warning*: Starting **April 1, 2025**, requests updating custom bidding algorithms that are assigned to line items will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).

uploadScript(customBiddingAlgorithmId, advertiserId=None, partnerId=None, x__xgafv=None)

Creates a custom bidding script reference object for a script file. The resulting reference object provides a resource path to which the script file should be uploaded. This reference object should be included in when creating a new custom bidding script object.

@@ -261,7 +261,7 @@

Method Details

patch(customBiddingAlgorithmId, body=None, updateMask=None, x__xgafv=None) -
Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful.
+  
Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful. *Warning*: Starting **April 1, 2025**, requests updating custom bidding algorithms that are assigned to line items will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).
 
 Args:
   customBiddingAlgorithmId: string, Output only. The unique ID of the custom bidding algorithm. Assigned by the system. (required)
diff --git a/docs/dyn/displayvideo_v2.customBiddingAlgorithms.scripts.html b/docs/dyn/displayvideo_v2.customBiddingAlgorithms.scripts.html
index dd05e0b3b7f..b03870bf187 100644
--- a/docs/dyn/displayvideo_v2.customBiddingAlgorithms.scripts.html
+++ b/docs/dyn/displayvideo_v2.customBiddingAlgorithms.scripts.html
@@ -79,7 +79,7 @@ 

Instance Methods

Close httplib2 connections.

create(customBiddingAlgorithmId, advertiserId=None, body=None, partnerId=None, x__xgafv=None)

-

Creates a new custom bidding script. Returns the newly created script if successful.

+

Creates a new custom bidding script. Returns the newly created script if successful. *Warning*: Starting **April 1, 2025**, requests updating custom bidding algorithms that are assigned to line items will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).

get(customBiddingAlgorithmId, customBiddingScriptId, advertiserId=None, partnerId=None, x__xgafv=None)

Gets a custom bidding script.

@@ -97,7 +97,7 @@

Method Details

create(customBiddingAlgorithmId, advertiserId=None, body=None, partnerId=None, x__xgafv=None) -
Creates a new custom bidding script. Returns the newly created script if successful.
+  
Creates a new custom bidding script. Returns the newly created script if successful. *Warning*: Starting **April 1, 2025**, requests updating custom bidding algorithms that are assigned to line items will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).
 
 Args:
   customBiddingAlgorithmId: string, Required. The ID of the custom bidding algorithm that owns the script. (required)
diff --git a/docs/dyn/displayvideo_v2.partners.html b/docs/dyn/displayvideo_v2.partners.html
index 6af12f101ef..14d9120dd26 100644
--- a/docs/dyn/displayvideo_v2.partners.html
+++ b/docs/dyn/displayvideo_v2.partners.html
@@ -135,30 +135,30 @@ 

Method Details

}, "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts. "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` - "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. NEXT_ID: 9 # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. - "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. + "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, ], }, - "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # The combined audience ids of the included combined audience group. Contains combined audience ids only. - "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. + "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only. + "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. { # Details of combined audience targeting setting. "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. }, ], }, - "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # The custom list ids of the included custom list group. Contains custom list ids only. - "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. + "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only. + "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored. { # Details of custom list targeting setting. "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id. }, ], }, - "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the included Google audience group. Contains Google audience ids only. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, @@ -441,30 +441,30 @@

Method Details

}, "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts. "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` - "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. NEXT_ID: 9 # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. - "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. + "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, ], }, - "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # The combined audience ids of the included combined audience group. Contains combined audience ids only. - "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. + "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only. + "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. { # Details of combined audience targeting setting. "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. }, ], }, - "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # The custom list ids of the included custom list group. Contains custom list ids only. - "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. + "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only. + "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored. { # Details of custom list targeting setting. "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id. }, ], }, - "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the included Google audience group. Contains Google audience ids only. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, diff --git a/docs/dyn/displayvideo_v2.partners.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v2.partners.targetingTypes.assignedTargetingOptions.html index 3f1d5612208..ae51b99cf01 100644 --- a/docs/dyn/displayvideo_v2.partners.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v2.partners.targetingTypes.assignedTargetingOptions.html @@ -175,30 +175,30 @@

Method Details

}, "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts. "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` - "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. NEXT_ID: 9 # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. - "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. + "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, ], }, - "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # The combined audience ids of the included combined audience group. Contains combined audience ids only. - "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. + "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only. + "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. { # Details of combined audience targeting setting. "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. }, ], }, - "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # The custom list ids of the included custom list group. Contains custom list ids only. - "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. + "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only. + "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored. { # Details of custom list targeting setting. "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id. }, ], }, - "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the included Google audience group. Contains Google audience ids only. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, @@ -466,30 +466,30 @@

Method Details

}, "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts. "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` - "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. NEXT_ID: 9 # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. - "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. + "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, ], }, - "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # The combined audience ids of the included combined audience group. Contains combined audience ids only. - "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. + "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only. + "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. { # Details of combined audience targeting setting. "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. }, ], }, - "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # The custom list ids of the included custom list group. Contains custom list ids only. - "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. + "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only. + "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored. { # Details of custom list targeting setting. "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id. }, ], }, - "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the included Google audience group. Contains Google audience ids only. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, @@ -886,30 +886,30 @@

Method Details

}, "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts. "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` - "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. NEXT_ID: 9 # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. - "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. + "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, ], }, - "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # The combined audience ids of the included combined audience group. Contains combined audience ids only. - "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. + "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only. + "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. { # Details of combined audience targeting setting. "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. }, ], }, - "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # The custom list ids of the included custom list group. Contains custom list ids only. - "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. + "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only. + "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored. { # Details of custom list targeting setting. "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id. }, ], }, - "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the included Google audience group. Contains Google audience ids only. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, @@ -1241,30 +1241,30 @@

Method Details

}, "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts. "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` - "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. NEXT_ID: 9 # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. - "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. + "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, ], }, - "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # The combined audience ids of the included combined audience group. Contains combined audience ids only. - "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. + "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only. + "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. { # Details of combined audience targeting setting. "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. }, ], }, - "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # The custom list ids of the included custom list group. Contains custom list ids only. - "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. + "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only. + "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored. { # Details of custom list targeting setting. "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id. }, ], }, - "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the included Google audience group. Contains Google audience ids only. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, diff --git a/docs/dyn/displayvideo_v3.advertisers.adGroups.html b/docs/dyn/displayvideo_v3.advertisers.adGroups.html index 3afebb3c0d9..e747d307b90 100644 --- a/docs/dyn/displayvideo_v3.advertisers.adGroups.html +++ b/docs/dyn/displayvideo_v3.advertisers.adGroups.html @@ -138,48 +138,48 @@

Method Details

}, "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts. "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` - "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. NEXT_ID: 9 # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. - "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. + "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # Optional. The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, - "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, ], }, - "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # The combined audience ids of the included combined audience group. Contains combined audience ids only. - "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. + "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only. + "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. { # Details of combined audience targeting setting. "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. }, ], }, - "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # The custom list ids of the included custom list group. Contains custom list ids only. - "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. + "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only. + "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored. { # Details of custom list targeting setting. "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id. }, ], }, - "includedFirstAndThirdPartyAudienceGroups": [ # The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with same settings will be ignored. + "includedFirstAndThirdPartyAudienceGroups": [ # Optional. The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored. { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, ], - "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the included Google audience group. Contains Google audience ids only. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, @@ -490,13 +490,13 @@

Method Details

"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, when performance_goal_type is one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , the line_item_type of the insertion order line items must be either: * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , and when performance_goal_type is either: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` the line_item_type of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy. "raiseBidForDeals": True or False, # Whether the strategy takes deal floor prices into account. }, "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. @@ -528,7 +528,7 @@

Method Details

"targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the ad group. "audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. - "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` + "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` *Warning*: Starting **March 6, 2025**, this field will stop being compatible when using the BiddingStrategy field fixed_bid. [Read more about this announced change](/display-video/api/deprecations#features.ot_fixed_bid) }, }
@@ -562,13 +562,13 @@

Method Details

"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, when performance_goal_type is one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , the line_item_type of the insertion order line items must be either: * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , and when performance_goal_type is either: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` the line_item_type of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy. "raiseBidForDeals": True or False, # Whether the strategy takes deal floor prices into account. }, "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. @@ -600,7 +600,7 @@

Method Details

"targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the ad group. "audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. - "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` + "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` *Warning*: Starting **March 6, 2025**, this field will stop being compatible when using the BiddingStrategy field fixed_bid. [Read more about this announced change](/display-video/api/deprecations#features.ot_fixed_bid) }, }, ], diff --git a/docs/dyn/displayvideo_v3.advertisers.adGroups.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v3.advertisers.adGroups.targetingTypes.assignedTargetingOptions.html index 2db306ed483..eee1906bfcc 100644 --- a/docs/dyn/displayvideo_v3.advertisers.adGroups.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v3.advertisers.adGroups.targetingTypes.assignedTargetingOptions.html @@ -176,48 +176,48 @@

Method Details

}, "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts. "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` - "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. NEXT_ID: 9 # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. - "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. + "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # Optional. The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, - "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, ], }, - "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # The combined audience ids of the included combined audience group. Contains combined audience ids only. - "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. + "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only. + "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. { # Details of combined audience targeting setting. "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. }, ], }, - "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # The custom list ids of the included custom list group. Contains custom list ids only. - "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. + "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only. + "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored. { # Details of custom list targeting setting. "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id. }, ], }, - "includedFirstAndThirdPartyAudienceGroups": [ # The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with same settings will be ignored. + "includedFirstAndThirdPartyAudienceGroups": [ # Optional. The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored. { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, ], - "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the included Google audience group. Contains Google audience ids only. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, @@ -570,48 +570,48 @@

Method Details

}, "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts. "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` - "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. NEXT_ID: 9 # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. - "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. + "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # Optional. The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, - "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, ], }, - "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # The combined audience ids of the included combined audience group. Contains combined audience ids only. - "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. + "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only. + "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. { # Details of combined audience targeting setting. "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. }, ], }, - "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # The custom list ids of the included custom list group. Contains custom list ids only. - "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. + "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only. + "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored. { # Details of custom list targeting setting. "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id. }, ], }, - "includedFirstAndThirdPartyAudienceGroups": [ # The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with same settings will be ignored. + "includedFirstAndThirdPartyAudienceGroups": [ # Optional. The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored. { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, ], - "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the included Google audience group. Contains Google audience ids only. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, diff --git a/docs/dyn/displayvideo_v3.advertisers.campaigns.html b/docs/dyn/displayvideo_v3.advertisers.campaigns.html index 79258e3e126..831df3cfb64 100644 --- a/docs/dyn/displayvideo_v3.advertisers.campaigns.html +++ b/docs/dyn/displayvideo_v3.advertisers.campaigns.html @@ -182,11 +182,11 @@

Method Details

"campaignId": "A String", # Output only. The unique ID of the campaign. Assigned by the system. "displayName": "A String", # Required. The display name of the campaign. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not the insertion orders under this campaign can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. * For CreateCampaign method, `ENTITY_STATUS_ARCHIVED` is not allowed. - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency cap setting of the campaign. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency cap setting of the campaign. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap) "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. - "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. - "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). + "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. }, "name": "A String", # Output only. The resource name of the campaign. @@ -262,11 +262,11 @@

Method Details

"campaignId": "A String", # Output only. The unique ID of the campaign. Assigned by the system. "displayName": "A String", # Required. The display name of the campaign. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not the insertion orders under this campaign can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. * For CreateCampaign method, `ENTITY_STATUS_ARCHIVED` is not allowed. - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency cap setting of the campaign. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency cap setting of the campaign. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap) "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. - "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. - "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). + "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. }, "name": "A String", # Output only. The resource name of the campaign. @@ -369,11 +369,11 @@

Method Details

"campaignId": "A String", # Output only. The unique ID of the campaign. Assigned by the system. "displayName": "A String", # Required. The display name of the campaign. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not the insertion orders under this campaign can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. * For CreateCampaign method, `ENTITY_STATUS_ARCHIVED` is not allowed. - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency cap setting of the campaign. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency cap setting of the campaign. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap) "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. - "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. - "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). + "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. }, "name": "A String", # Output only. The resource name of the campaign. @@ -462,11 +462,11 @@

Method Details

"campaignId": "A String", # Output only. The unique ID of the campaign. Assigned by the system. "displayName": "A String", # Required. The display name of the campaign. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not the insertion orders under this campaign can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. * For CreateCampaign method, `ENTITY_STATUS_ARCHIVED` is not allowed. - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency cap setting of the campaign. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency cap setting of the campaign. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap) "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. - "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. - "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). + "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. }, "name": "A String", # Output only. The resource name of the campaign. @@ -515,48 +515,48 @@

Method Details

}, "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts. "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` - "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. NEXT_ID: 9 # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. - "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. + "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # Optional. The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, - "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, ], }, - "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # The combined audience ids of the included combined audience group. Contains combined audience ids only. - "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. + "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only. + "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. { # Details of combined audience targeting setting. "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. }, ], }, - "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # The custom list ids of the included custom list group. Contains custom list ids only. - "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. + "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only. + "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored. { # Details of custom list targeting setting. "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id. }, ], }, - "includedFirstAndThirdPartyAudienceGroups": [ # The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with same settings will be ignored. + "includedFirstAndThirdPartyAudienceGroups": [ # Optional. The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored. { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, ], - "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the included Google audience group. Contains Google audience ids only. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, @@ -922,11 +922,11 @@

Method Details

"campaignId": "A String", # Output only. The unique ID of the campaign. Assigned by the system. "displayName": "A String", # Required. The display name of the campaign. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not the insertion orders under this campaign can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. * For CreateCampaign method, `ENTITY_STATUS_ARCHIVED` is not allowed. - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency cap setting of the campaign. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency cap setting of the campaign. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap) "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. - "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. - "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). + "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. }, "name": "A String", # Output only. The resource name of the campaign. @@ -1003,11 +1003,11 @@

Method Details

"campaignId": "A String", # Output only. The unique ID of the campaign. Assigned by the system. "displayName": "A String", # Required. The display name of the campaign. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not the insertion orders under this campaign can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. * For CreateCampaign method, `ENTITY_STATUS_ARCHIVED` is not allowed. - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency cap setting of the campaign. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency cap setting of the campaign. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap) "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. - "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. - "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). + "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. }, "name": "A String", # Output only. The resource name of the campaign. diff --git a/docs/dyn/displayvideo_v3.advertisers.campaigns.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v3.advertisers.campaigns.targetingTypes.assignedTargetingOptions.html index ae339e6a300..bf4e8ca33d6 100644 --- a/docs/dyn/displayvideo_v3.advertisers.campaigns.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v3.advertisers.campaigns.targetingTypes.assignedTargetingOptions.html @@ -176,48 +176,48 @@

Method Details

}, "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts. "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` - "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. NEXT_ID: 9 # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. - "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. + "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # Optional. The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, - "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, ], }, - "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # The combined audience ids of the included combined audience group. Contains combined audience ids only. - "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. + "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only. + "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. { # Details of combined audience targeting setting. "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. }, ], }, - "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # The custom list ids of the included custom list group. Contains custom list ids only. - "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. + "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only. + "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored. { # Details of custom list targeting setting. "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id. }, ], }, - "includedFirstAndThirdPartyAudienceGroups": [ # The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with same settings will be ignored. + "includedFirstAndThirdPartyAudienceGroups": [ # Optional. The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored. { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, ], - "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the included Google audience group. Contains Google audience ids only. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, @@ -570,48 +570,48 @@

Method Details

}, "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts. "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` - "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. NEXT_ID: 9 # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. - "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. + "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # Optional. The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, - "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, ], }, - "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # The combined audience ids of the included combined audience group. Contains combined audience ids only. - "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. + "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only. + "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. { # Details of combined audience targeting setting. "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. }, ], }, - "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # The custom list ids of the included custom list group. Contains custom list ids only. - "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. + "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only. + "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored. { # Details of custom list targeting setting. "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id. }, ], }, - "includedFirstAndThirdPartyAudienceGroups": [ # The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with same settings will be ignored. + "includedFirstAndThirdPartyAudienceGroups": [ # Optional. The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored. { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, ], - "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the included Google audience group. Contains Google audience ids only. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, diff --git a/docs/dyn/displayvideo_v3.advertisers.creatives.html b/docs/dyn/displayvideo_v3.advertisers.creatives.html index 088c918405f..af1e834e4db 100644 --- a/docs/dyn/displayvideo_v3.advertisers.creatives.html +++ b/docs/dyn/displayvideo_v3.advertisers.creatives.html @@ -111,33 +111,33 @@

Method Details

The object takes the form of: { # A single Creative. - "additionalDimensions": [ # Additional dimensions. Applicable when creative_type is one of: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_LIGHTBOX` * `CREATIVE_TYPE_PUBLISHER_HOSTED` If this field is specified, width_pixels and height_pixels are both required and must be greater than or equal to 0. + "additionalDimensions": [ # Optional. Additional dimensions. Applicable when creative_type is one of: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_LIGHTBOX` * `CREATIVE_TYPE_PUBLISHER_HOSTED` If this field is specified, width_pixels and height_pixels are both required and must be greater than or equal to 0. { # Dimensions. "heightPixels": 42, # The height in pixels. "widthPixels": 42, # The width in pixels. }, ], "advertiserId": "A String", # Output only. The unique ID of the advertiser the creative belongs to. - "appendedTag": "A String", # Third-party HTML tracking tag to be appended to the creative tag. + "appendedTag": "A String", # Optional. Third-party HTML tracking tag to be appended to the creative tag. "assets": [ # Required. Assets associated to this creative. { # Asset association for the creative. - "asset": { # A single asset. # The associated asset. + "asset": { # A single asset. # Optional. The associated asset. "content": "A String", # The asset content. For uploaded assets, the content is the serving path. "mediaId": "A String", # Media ID of the uploaded asset. This is a unique identifier for the asset. This ID can be passed to other API calls, e.g. CreateCreative to associate the asset with a creative. The Media ID space updated on **April 5, 2023**. Update media IDs cached before **April 5, 2023** by retrieving the new media ID from associated creative resources or re-uploading the asset. }, - "role": "A String", # The role of this asset for the creative. + "role": "A String", # Optional. The role of this asset for the creative. }, ], "cmPlacementId": "A String", # Output only. The unique ID of the Campaign Manager 360 placement associated with the creative. This field is only applicable for creatives that are synced from Campaign Manager. - "cmTrackingAd": { # A Campaign Manager 360 tracking ad. # The Campaign Manager 360 tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager 360 and third-party ad serving: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` Output only for other cases. - "cmAdId": "A String", # The ad ID of the campaign manager 360 tracking Ad. - "cmCreativeId": "A String", # The creative ID of the campaign manager 360 tracking Ad. - "cmPlacementId": "A String", # The placement ID of the campaign manager 360 tracking Ad. + "cmTrackingAd": { # A Campaign Manager 360 tracking ad. # Optional. The Campaign Manager 360 tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager 360 and third-party ad serving: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` Output only for other cases. + "cmAdId": "A String", # Optional. The ad ID of the campaign manager 360 tracking Ad. + "cmCreativeId": "A String", # Optional. The creative ID of the campaign manager 360 tracking Ad. + "cmPlacementId": "A String", # Optional. The placement ID of the campaign manager 360 tracking Ad. }, - "companionCreativeIds": [ # The IDs of companion creatives for a video creative. You can assign existing display creatives (with image or HTML5 assets) to serve surrounding the publisher's video player. Companions display around the video player while the video is playing and remain after the video has completed. Creatives contain additional dimensions can not be companion creatives. This field is only supported for following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` + "companionCreativeIds": [ # Optional. The IDs of companion creatives for a video creative. You can assign existing display creatives (with image or HTML5 assets) to serve surrounding the publisher's video player. Companions display around the video player while the video is playing and remain after the video has completed. Creatives contain additional dimensions can not be companion creatives. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` "A String", ], - "counterEvents": [ # Counter events for a rich media creative. Counters track the number of times that a user interacts with any part of a rich media creative in a specified way (mouse-overs, mouse-outs, clicks, taps, data loading, keyboard entries, etc.). Any event that can be captured in the creative can be recorded as a counter. Leave it empty or unset for creatives containing image assets only. + "counterEvents": [ # Optional. Counter events for a rich media creative. Counters track the number of times that a user interacts with any part of a rich media creative in a specified way (mouse-overs, mouse-outs, clicks, taps, data loading, keyboard entries, etc.). Any event that can be captured in the creative can be recorded as a counter. Leave it empty or unset for creatives containing image assets only. { # Counter event of the creative. "name": "A String", # Required. The name of the counter event. "reportingName": "A String", # Required. The name used to identify this counter event in reports. @@ -158,8 +158,8 @@

Method Details

"entityStatus": "A String", # Required. Controls whether or not the creative can serve. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED` * `ENTITY_STATUS_PAUSED` "exitEvents": [ # Required. Exit events for this creative. An exit (also known as a click tag) is any area in your creative that someone can click or tap to open an advertiser's landing page. Every creative must include at least one exit. You can add an exit to your creative in any of the following ways: * Use Google Web Designer's tap area. * Define a JavaScript variable called "clickTag". * Use the Enabler (Enabler.exit()) to track exits in rich media formats. { # Exit event of the creative. - "name": "A String", # The name of the click tag of the exit event. The name must be unique within one creative. Leave it empty or unset for creatives containing image assets only. - "reportingName": "A String", # The name used to identify this event in reports. Leave it empty or unset for creatives containing image assets only. + "name": "A String", # Optional. The name of the click tag of the exit event. The name must be unique within one creative. Leave it empty or unset for creatives containing image assets only. + "reportingName": "A String", # Optional. The name used to identify this event in reports. Leave it empty or unset for creatives containing image assets only. "type": "A String", # Required. The type of the exit event. "url": "A String", # Required. The click through URL of the exit event. This is required when type is: * `EXIT_EVENT_TYPE_DEFAULT` * `EXIT_EVENT_TYPE_BACKUP` }, @@ -168,33 +168,33 @@

Method Details

"expandingDirection": "A String", # Optional. Specifies the expanding direction of the creative. Required and only valid for third-party expandable creatives. Third-party expandable creatives are creatives with following hosting source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_EXPANDABLE` "hostingSource": "A String", # Required. Indicates where the creative is hosted. "html5Video": True or False, # Output only. Indicates the third-party VAST tag creative requires HTML5 Video support. Output only and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_VIDEO` - "iasCampaignMonitoring": True or False, # Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. To enable this for the creative, make sure the Advertiser.creative_config.ias_client_id has been set to your IAS client ID. - "integrationCode": "A String", # ID information used to link this creative to an external system. Must be UTF-8 encoded with a length of no more than 10,000 characters. - "jsTrackerUrl": "A String", # JavaScript measurement URL from supported third-party verification providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not supported. This field is only writeable in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` + "iasCampaignMonitoring": True or False, # Optional. Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. To enable this for the creative, make sure the Advertiser.creative_config.ias_client_id has been set to your IAS client ID. + "integrationCode": "A String", # Optional. ID information used to link this creative to an external system. Must be UTF-8 encoded with a length of no more than 10,000 characters. + "jsTrackerUrl": "A String", # Optional. JavaScript measurement URL from supported third-party verification providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not supported. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` "lineItemIds": [ # Output only. The IDs of the line items this creative is associated with. To associate a creative to a line item, use LineItem.creative_ids instead. "A String", ], "mediaDuration": "A String", # Output only. Media duration of the creative. Applicable when creative_type is one of: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_PUBLISHER_HOSTED` "mp3Audio": True or False, # Output only. Indicates the third-party audio creative supports MP3. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` "name": "A String", # Output only. The resource name of the creative. - "notes": "A String", # User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters. - "obaIcon": { # OBA Icon for a Creative # Specifies the OBA icon for a video creative. This field is only supported in following creative_type: * `CREATIVE_TYPE_VIDEO` - "clickTrackingUrl": "A String", # Required. The click tracking URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com - "dimensions": { # Dimensions. # The dimensions of the OBA icon. + "notes": "A String", # Optional. User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters. + "obaIcon": { # OBA Icon for a Creative # Optional. Specifies the OBA icon for a video creative. This field is only supported in the following creative_type: * `CREATIVE_TYPE_VIDEO` + "clickTrackingUrl": "A String", # Required. The click tracking URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com` + "dimensions": { # Dimensions. # Optional. The dimensions of the OBA icon. "heightPixels": 42, # The height in pixels. "widthPixels": 42, # The width in pixels. }, - "landingPageUrl": "A String", # Required. The landing page URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com - "position": "A String", # The position of the OBA icon on the creative. - "program": "A String", # The program of the OBA icon. For example: “AdChoices”. - "resourceMimeType": "A String", # The MIME type of the OBA icon resource. - "resourceUrl": "A String", # The URL of the OBA icon resource. - "viewTrackingUrl": "A String", # Required. The view tracking URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com + "landingPageUrl": "A String", # Required. The landing page URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com` + "position": "A String", # Optional. The position of the OBA icon on the creative. + "program": "A String", # Optional. The program of the OBA icon. For example: “AdChoices”. + "resourceMimeType": "A String", # Optional. The MIME type of the OBA icon resource. + "resourceUrl": "A String", # Optional. The URL of the OBA icon resource. + "viewTrackingUrl": "A String", # Required. The view tracking URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com` }, "oggAudio": True or False, # Output only. Indicates the third-party audio creative supports OGG. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` - "progressOffset": { # The length an audio or a video has been played. # Amount of time to play the video before counting a view. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` - "percentage": "A String", # The offset in percentage of the audio or video duration. - "seconds": "A String", # The offset in seconds from the start of the audio or video. + "progressOffset": { # The length an audio or a video has been played. # Optional. Amount of time to play the video before counting a view. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + "percentage": "A String", # Optional. The offset in percentage of the audio or video duration. + "seconds": "A String", # Optional. The offset in seconds from the start of the audio or video. }, "requireHtml5": True or False, # Optional. Indicates that the creative relies on HTML5 to render properly. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` "requireMraid": True or False, # Optional. Indicates that the creative requires MRAID (Mobile Rich Media Ad Interface Definitions system). Set this if the creative relies on mobile gestures for interactivity, such as swiping or tapping. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` @@ -216,46 +216,46 @@

Method Details

}, ], }, - "skipOffset": { # The length an audio or a video has been played. # Amount of time to play the video before the skip button appears. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` - "percentage": "A String", # The offset in percentage of the audio or video duration. - "seconds": "A String", # The offset in seconds from the start of the audio or video. + "skipOffset": { # The length an audio or a video has been played. # Optional. Amount of time to play the video before the skip button appears. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + "percentage": "A String", # Optional. The offset in percentage of the audio or video duration. + "seconds": "A String", # Optional. The offset in seconds from the start of the audio or video. }, - "skippable": True or False, # Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + "skippable": True or False, # Optional. Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` "thirdPartyTag": "A String", # Optional. The original third-party tag used for the creative. Required and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` - "thirdPartyUrls": [ # Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` + "thirdPartyUrls": [ # Optional. Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` { # Tracking URLs from third parties to track interactions with an audio or a video creative. - "type": "A String", # The type of interaction needs to be tracked by the tracking URL - "url": "A String", # Tracking URL used to track the interaction. Provide a URL with optional path or query string, beginning with `https:`. For example, https://www.example.com/path + "type": "A String", # Optional. The type of interaction needs to be tracked by the tracking URL + "url": "A String", # Optional. Tracking URL used to track the interaction. Provide a URL with optional path or query string, beginning with `https:`. For example, `https://www.example.com/path` }, ], - "timerEvents": [ # Timer custom events for a rich media creative. Timers track the time during which a user views and interacts with a specified part of a rich media creative. A creative can have multiple timer events, each timed independently. Leave it empty or unset for creatives containing image assets only. + "timerEvents": [ # Optional. Timer custom events for a rich media creative. Timers track the time during which a user views and interacts with a specified part of a rich media creative. A creative can have multiple timer events, each timed independently. Leave it empty or unset for creatives containing image assets only. { # Timer event of the creative. "name": "A String", # Required. The name of the timer event. "reportingName": "A String", # Required. The name used to identify this timer event in reports. }, ], - "trackerUrls": [ # Tracking URLs for analytics providers or third-party ad technology vendors. The URLs must start with https (except on inventory that doesn't require SSL compliance). If using macros in your URL, use only macros supported by Display & Video 360. Standard URLs only, no IMG or SCRIPT tags. This field is only writeable in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` + "trackerUrls": [ # Optional. Tracking URLs for analytics providers or third-party ad technology vendors. The URLs must start with `https:` (except on inventory that doesn't require SSL compliance). If using macros in your URL, use only macros supported by Display & Video 360. Standard URLs only, no IMG or SCRIPT tags. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` "A String", ], - "transcodes": [ # Output only. Audio/Video transcodes. Display & Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher's system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer’s connection and screen size. This field is only supported in following creative_type: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_AUDIO` + "transcodes": [ # Output only. Audio/Video transcodes. Display & Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher's system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer’s connection and screen size. This field is only supported in the following creative_type: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_AUDIO` { # Represents information about the transcoded audio or video file. - "audioBitRateKbps": "A String", # The bit rate for the audio stream of the transcoded video, or the bit rate for the transcoded audio, in kilobits per second. - "audioSampleRateHz": "A String", # The sample rate for the audio stream of the transcoded video, or the sample rate for the transcoded audio, in hertz. - "bitRateKbps": "A String", # The transcoding bit rate of the transcoded video, in kilobits per second. - "dimensions": { # Dimensions. # The dimensions of the transcoded video. + "audioBitRateKbps": "A String", # Optional. The bit rate for the audio stream of the transcoded video, or the bit rate for the transcoded audio, in kilobits per second. + "audioSampleRateHz": "A String", # Optional. The sample rate for the audio stream of the transcoded video, or the sample rate for the transcoded audio, in hertz. + "bitRateKbps": "A String", # Optional. The transcoding bit rate of the transcoded video, in kilobits per second. + "dimensions": { # Dimensions. # Optional. The dimensions of the transcoded video. "heightPixels": 42, # The height in pixels. "widthPixels": 42, # The width in pixels. }, - "fileSizeBytes": "A String", # The size of the transcoded file, in bytes. - "frameRate": 3.14, # The frame rate of the transcoded video, in frames per second. - "mimeType": "A String", # The MIME type of the transcoded file. - "name": "A String", # The name of the transcoded file. - "transcoded": True or False, # Indicates if the transcoding was successful. + "fileSizeBytes": "A String", # Optional. The size of the transcoded file, in bytes. + "frameRate": 3.14, # Optional. The frame rate of the transcoded video, in frames per second. + "mimeType": "A String", # Optional. The MIME type of the transcoded file. + "name": "A String", # Optional. The name of the transcoded file. + "transcoded": True or False, # Optional. Indicates if the transcoding was successful. }, ], "universalAdId": { # A creative identifier provided by a registry that is unique across all platforms. This is part of the VAST 4.0 standard. # Optional. An optional creative identifier provided by a registry that is unique across all platforms. Universal Ad ID is part of the VAST 4.0 standard. It can be modified after the creative is created. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` - "id": "A String", # The unique creative identifier. - "registry": "A String", # The registry provides unique creative identifiers. + "id": "A String", # Optional. The unique creative identifier. + "registry": "A String", # Optional. The registry provides unique creative identifiers. }, "updateTime": "A String", # Output only. The timestamp when the creative was last updated, either by the user or system (e.g. creative review). Assigned by the system. "vastTagUrl": "A String", # Optional. The URL of the VAST tag for a third-party VAST tag creative. Required and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` @@ -271,33 +271,33 @@

Method Details

An object of the form: { # A single Creative. - "additionalDimensions": [ # Additional dimensions. Applicable when creative_type is one of: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_LIGHTBOX` * `CREATIVE_TYPE_PUBLISHER_HOSTED` If this field is specified, width_pixels and height_pixels are both required and must be greater than or equal to 0. + "additionalDimensions": [ # Optional. Additional dimensions. Applicable when creative_type is one of: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_LIGHTBOX` * `CREATIVE_TYPE_PUBLISHER_HOSTED` If this field is specified, width_pixels and height_pixels are both required and must be greater than or equal to 0. { # Dimensions. "heightPixels": 42, # The height in pixels. "widthPixels": 42, # The width in pixels. }, ], "advertiserId": "A String", # Output only. The unique ID of the advertiser the creative belongs to. - "appendedTag": "A String", # Third-party HTML tracking tag to be appended to the creative tag. + "appendedTag": "A String", # Optional. Third-party HTML tracking tag to be appended to the creative tag. "assets": [ # Required. Assets associated to this creative. { # Asset association for the creative. - "asset": { # A single asset. # The associated asset. + "asset": { # A single asset. # Optional. The associated asset. "content": "A String", # The asset content. For uploaded assets, the content is the serving path. "mediaId": "A String", # Media ID of the uploaded asset. This is a unique identifier for the asset. This ID can be passed to other API calls, e.g. CreateCreative to associate the asset with a creative. The Media ID space updated on **April 5, 2023**. Update media IDs cached before **April 5, 2023** by retrieving the new media ID from associated creative resources or re-uploading the asset. }, - "role": "A String", # The role of this asset for the creative. + "role": "A String", # Optional. The role of this asset for the creative. }, ], "cmPlacementId": "A String", # Output only. The unique ID of the Campaign Manager 360 placement associated with the creative. This field is only applicable for creatives that are synced from Campaign Manager. - "cmTrackingAd": { # A Campaign Manager 360 tracking ad. # The Campaign Manager 360 tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager 360 and third-party ad serving: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` Output only for other cases. - "cmAdId": "A String", # The ad ID of the campaign manager 360 tracking Ad. - "cmCreativeId": "A String", # The creative ID of the campaign manager 360 tracking Ad. - "cmPlacementId": "A String", # The placement ID of the campaign manager 360 tracking Ad. + "cmTrackingAd": { # A Campaign Manager 360 tracking ad. # Optional. The Campaign Manager 360 tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager 360 and third-party ad serving: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` Output only for other cases. + "cmAdId": "A String", # Optional. The ad ID of the campaign manager 360 tracking Ad. + "cmCreativeId": "A String", # Optional. The creative ID of the campaign manager 360 tracking Ad. + "cmPlacementId": "A String", # Optional. The placement ID of the campaign manager 360 tracking Ad. }, - "companionCreativeIds": [ # The IDs of companion creatives for a video creative. You can assign existing display creatives (with image or HTML5 assets) to serve surrounding the publisher's video player. Companions display around the video player while the video is playing and remain after the video has completed. Creatives contain additional dimensions can not be companion creatives. This field is only supported for following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` + "companionCreativeIds": [ # Optional. The IDs of companion creatives for a video creative. You can assign existing display creatives (with image or HTML5 assets) to serve surrounding the publisher's video player. Companions display around the video player while the video is playing and remain after the video has completed. Creatives contain additional dimensions can not be companion creatives. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` "A String", ], - "counterEvents": [ # Counter events for a rich media creative. Counters track the number of times that a user interacts with any part of a rich media creative in a specified way (mouse-overs, mouse-outs, clicks, taps, data loading, keyboard entries, etc.). Any event that can be captured in the creative can be recorded as a counter. Leave it empty or unset for creatives containing image assets only. + "counterEvents": [ # Optional. Counter events for a rich media creative. Counters track the number of times that a user interacts with any part of a rich media creative in a specified way (mouse-overs, mouse-outs, clicks, taps, data loading, keyboard entries, etc.). Any event that can be captured in the creative can be recorded as a counter. Leave it empty or unset for creatives containing image assets only. { # Counter event of the creative. "name": "A String", # Required. The name of the counter event. "reportingName": "A String", # Required. The name used to identify this counter event in reports. @@ -318,8 +318,8 @@

Method Details

"entityStatus": "A String", # Required. Controls whether or not the creative can serve. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED` * `ENTITY_STATUS_PAUSED` "exitEvents": [ # Required. Exit events for this creative. An exit (also known as a click tag) is any area in your creative that someone can click or tap to open an advertiser's landing page. Every creative must include at least one exit. You can add an exit to your creative in any of the following ways: * Use Google Web Designer's tap area. * Define a JavaScript variable called "clickTag". * Use the Enabler (Enabler.exit()) to track exits in rich media formats. { # Exit event of the creative. - "name": "A String", # The name of the click tag of the exit event. The name must be unique within one creative. Leave it empty or unset for creatives containing image assets only. - "reportingName": "A String", # The name used to identify this event in reports. Leave it empty or unset for creatives containing image assets only. + "name": "A String", # Optional. The name of the click tag of the exit event. The name must be unique within one creative. Leave it empty or unset for creatives containing image assets only. + "reportingName": "A String", # Optional. The name used to identify this event in reports. Leave it empty or unset for creatives containing image assets only. "type": "A String", # Required. The type of the exit event. "url": "A String", # Required. The click through URL of the exit event. This is required when type is: * `EXIT_EVENT_TYPE_DEFAULT` * `EXIT_EVENT_TYPE_BACKUP` }, @@ -328,33 +328,33 @@

Method Details

"expandingDirection": "A String", # Optional. Specifies the expanding direction of the creative. Required and only valid for third-party expandable creatives. Third-party expandable creatives are creatives with following hosting source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_EXPANDABLE` "hostingSource": "A String", # Required. Indicates where the creative is hosted. "html5Video": True or False, # Output only. Indicates the third-party VAST tag creative requires HTML5 Video support. Output only and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_VIDEO` - "iasCampaignMonitoring": True or False, # Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. To enable this for the creative, make sure the Advertiser.creative_config.ias_client_id has been set to your IAS client ID. - "integrationCode": "A String", # ID information used to link this creative to an external system. Must be UTF-8 encoded with a length of no more than 10,000 characters. - "jsTrackerUrl": "A String", # JavaScript measurement URL from supported third-party verification providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not supported. This field is only writeable in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` + "iasCampaignMonitoring": True or False, # Optional. Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. To enable this for the creative, make sure the Advertiser.creative_config.ias_client_id has been set to your IAS client ID. + "integrationCode": "A String", # Optional. ID information used to link this creative to an external system. Must be UTF-8 encoded with a length of no more than 10,000 characters. + "jsTrackerUrl": "A String", # Optional. JavaScript measurement URL from supported third-party verification providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not supported. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` "lineItemIds": [ # Output only. The IDs of the line items this creative is associated with. To associate a creative to a line item, use LineItem.creative_ids instead. "A String", ], "mediaDuration": "A String", # Output only. Media duration of the creative. Applicable when creative_type is one of: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_PUBLISHER_HOSTED` "mp3Audio": True or False, # Output only. Indicates the third-party audio creative supports MP3. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` "name": "A String", # Output only. The resource name of the creative. - "notes": "A String", # User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters. - "obaIcon": { # OBA Icon for a Creative # Specifies the OBA icon for a video creative. This field is only supported in following creative_type: * `CREATIVE_TYPE_VIDEO` - "clickTrackingUrl": "A String", # Required. The click tracking URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com - "dimensions": { # Dimensions. # The dimensions of the OBA icon. + "notes": "A String", # Optional. User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters. + "obaIcon": { # OBA Icon for a Creative # Optional. Specifies the OBA icon for a video creative. This field is only supported in the following creative_type: * `CREATIVE_TYPE_VIDEO` + "clickTrackingUrl": "A String", # Required. The click tracking URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com` + "dimensions": { # Dimensions. # Optional. The dimensions of the OBA icon. "heightPixels": 42, # The height in pixels. "widthPixels": 42, # The width in pixels. }, - "landingPageUrl": "A String", # Required. The landing page URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com - "position": "A String", # The position of the OBA icon on the creative. - "program": "A String", # The program of the OBA icon. For example: “AdChoices”. - "resourceMimeType": "A String", # The MIME type of the OBA icon resource. - "resourceUrl": "A String", # The URL of the OBA icon resource. - "viewTrackingUrl": "A String", # Required. The view tracking URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com + "landingPageUrl": "A String", # Required. The landing page URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com` + "position": "A String", # Optional. The position of the OBA icon on the creative. + "program": "A String", # Optional. The program of the OBA icon. For example: “AdChoices”. + "resourceMimeType": "A String", # Optional. The MIME type of the OBA icon resource. + "resourceUrl": "A String", # Optional. The URL of the OBA icon resource. + "viewTrackingUrl": "A String", # Required. The view tracking URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com` }, "oggAudio": True or False, # Output only. Indicates the third-party audio creative supports OGG. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` - "progressOffset": { # The length an audio or a video has been played. # Amount of time to play the video before counting a view. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` - "percentage": "A String", # The offset in percentage of the audio or video duration. - "seconds": "A String", # The offset in seconds from the start of the audio or video. + "progressOffset": { # The length an audio or a video has been played. # Optional. Amount of time to play the video before counting a view. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + "percentage": "A String", # Optional. The offset in percentage of the audio or video duration. + "seconds": "A String", # Optional. The offset in seconds from the start of the audio or video. }, "requireHtml5": True or False, # Optional. Indicates that the creative relies on HTML5 to render properly. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` "requireMraid": True or False, # Optional. Indicates that the creative requires MRAID (Mobile Rich Media Ad Interface Definitions system). Set this if the creative relies on mobile gestures for interactivity, such as swiping or tapping. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` @@ -376,46 +376,46 @@

Method Details

}, ], }, - "skipOffset": { # The length an audio or a video has been played. # Amount of time to play the video before the skip button appears. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` - "percentage": "A String", # The offset in percentage of the audio or video duration. - "seconds": "A String", # The offset in seconds from the start of the audio or video. + "skipOffset": { # The length an audio or a video has been played. # Optional. Amount of time to play the video before the skip button appears. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + "percentage": "A String", # Optional. The offset in percentage of the audio or video duration. + "seconds": "A String", # Optional. The offset in seconds from the start of the audio or video. }, - "skippable": True or False, # Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + "skippable": True or False, # Optional. Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` "thirdPartyTag": "A String", # Optional. The original third-party tag used for the creative. Required and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` - "thirdPartyUrls": [ # Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` + "thirdPartyUrls": [ # Optional. Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` { # Tracking URLs from third parties to track interactions with an audio or a video creative. - "type": "A String", # The type of interaction needs to be tracked by the tracking URL - "url": "A String", # Tracking URL used to track the interaction. Provide a URL with optional path or query string, beginning with `https:`. For example, https://www.example.com/path + "type": "A String", # Optional. The type of interaction needs to be tracked by the tracking URL + "url": "A String", # Optional. Tracking URL used to track the interaction. Provide a URL with optional path or query string, beginning with `https:`. For example, `https://www.example.com/path` }, ], - "timerEvents": [ # Timer custom events for a rich media creative. Timers track the time during which a user views and interacts with a specified part of a rich media creative. A creative can have multiple timer events, each timed independently. Leave it empty or unset for creatives containing image assets only. + "timerEvents": [ # Optional. Timer custom events for a rich media creative. Timers track the time during which a user views and interacts with a specified part of a rich media creative. A creative can have multiple timer events, each timed independently. Leave it empty or unset for creatives containing image assets only. { # Timer event of the creative. "name": "A String", # Required. The name of the timer event. "reportingName": "A String", # Required. The name used to identify this timer event in reports. }, ], - "trackerUrls": [ # Tracking URLs for analytics providers or third-party ad technology vendors. The URLs must start with https (except on inventory that doesn't require SSL compliance). If using macros in your URL, use only macros supported by Display & Video 360. Standard URLs only, no IMG or SCRIPT tags. This field is only writeable in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` + "trackerUrls": [ # Optional. Tracking URLs for analytics providers or third-party ad technology vendors. The URLs must start with `https:` (except on inventory that doesn't require SSL compliance). If using macros in your URL, use only macros supported by Display & Video 360. Standard URLs only, no IMG or SCRIPT tags. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` "A String", ], - "transcodes": [ # Output only. Audio/Video transcodes. Display & Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher's system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer’s connection and screen size. This field is only supported in following creative_type: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_AUDIO` + "transcodes": [ # Output only. Audio/Video transcodes. Display & Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher's system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer’s connection and screen size. This field is only supported in the following creative_type: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_AUDIO` { # Represents information about the transcoded audio or video file. - "audioBitRateKbps": "A String", # The bit rate for the audio stream of the transcoded video, or the bit rate for the transcoded audio, in kilobits per second. - "audioSampleRateHz": "A String", # The sample rate for the audio stream of the transcoded video, or the sample rate for the transcoded audio, in hertz. - "bitRateKbps": "A String", # The transcoding bit rate of the transcoded video, in kilobits per second. - "dimensions": { # Dimensions. # The dimensions of the transcoded video. + "audioBitRateKbps": "A String", # Optional. The bit rate for the audio stream of the transcoded video, or the bit rate for the transcoded audio, in kilobits per second. + "audioSampleRateHz": "A String", # Optional. The sample rate for the audio stream of the transcoded video, or the sample rate for the transcoded audio, in hertz. + "bitRateKbps": "A String", # Optional. The transcoding bit rate of the transcoded video, in kilobits per second. + "dimensions": { # Dimensions. # Optional. The dimensions of the transcoded video. "heightPixels": 42, # The height in pixels. "widthPixels": 42, # The width in pixels. }, - "fileSizeBytes": "A String", # The size of the transcoded file, in bytes. - "frameRate": 3.14, # The frame rate of the transcoded video, in frames per second. - "mimeType": "A String", # The MIME type of the transcoded file. - "name": "A String", # The name of the transcoded file. - "transcoded": True or False, # Indicates if the transcoding was successful. + "fileSizeBytes": "A String", # Optional. The size of the transcoded file, in bytes. + "frameRate": 3.14, # Optional. The frame rate of the transcoded video, in frames per second. + "mimeType": "A String", # Optional. The MIME type of the transcoded file. + "name": "A String", # Optional. The name of the transcoded file. + "transcoded": True or False, # Optional. Indicates if the transcoding was successful. }, ], "universalAdId": { # A creative identifier provided by a registry that is unique across all platforms. This is part of the VAST 4.0 standard. # Optional. An optional creative identifier provided by a registry that is unique across all platforms. Universal Ad ID is part of the VAST 4.0 standard. It can be modified after the creative is created. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` - "id": "A String", # The unique creative identifier. - "registry": "A String", # The registry provides unique creative identifiers. + "id": "A String", # Optional. The unique creative identifier. + "registry": "A String", # Optional. The registry provides unique creative identifiers. }, "updateTime": "A String", # Output only. The timestamp when the creative was last updated, either by the user or system (e.g. creative review). Assigned by the system. "vastTagUrl": "A String", # Optional. The URL of the VAST tag for a third-party VAST tag creative. Required and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` @@ -458,33 +458,33 @@

Method Details

An object of the form: { # A single Creative. - "additionalDimensions": [ # Additional dimensions. Applicable when creative_type is one of: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_LIGHTBOX` * `CREATIVE_TYPE_PUBLISHER_HOSTED` If this field is specified, width_pixels and height_pixels are both required and must be greater than or equal to 0. + "additionalDimensions": [ # Optional. Additional dimensions. Applicable when creative_type is one of: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_LIGHTBOX` * `CREATIVE_TYPE_PUBLISHER_HOSTED` If this field is specified, width_pixels and height_pixels are both required and must be greater than or equal to 0. { # Dimensions. "heightPixels": 42, # The height in pixels. "widthPixels": 42, # The width in pixels. }, ], "advertiserId": "A String", # Output only. The unique ID of the advertiser the creative belongs to. - "appendedTag": "A String", # Third-party HTML tracking tag to be appended to the creative tag. + "appendedTag": "A String", # Optional. Third-party HTML tracking tag to be appended to the creative tag. "assets": [ # Required. Assets associated to this creative. { # Asset association for the creative. - "asset": { # A single asset. # The associated asset. + "asset": { # A single asset. # Optional. The associated asset. "content": "A String", # The asset content. For uploaded assets, the content is the serving path. "mediaId": "A String", # Media ID of the uploaded asset. This is a unique identifier for the asset. This ID can be passed to other API calls, e.g. CreateCreative to associate the asset with a creative. The Media ID space updated on **April 5, 2023**. Update media IDs cached before **April 5, 2023** by retrieving the new media ID from associated creative resources or re-uploading the asset. }, - "role": "A String", # The role of this asset for the creative. + "role": "A String", # Optional. The role of this asset for the creative. }, ], "cmPlacementId": "A String", # Output only. The unique ID of the Campaign Manager 360 placement associated with the creative. This field is only applicable for creatives that are synced from Campaign Manager. - "cmTrackingAd": { # A Campaign Manager 360 tracking ad. # The Campaign Manager 360 tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager 360 and third-party ad serving: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` Output only for other cases. - "cmAdId": "A String", # The ad ID of the campaign manager 360 tracking Ad. - "cmCreativeId": "A String", # The creative ID of the campaign manager 360 tracking Ad. - "cmPlacementId": "A String", # The placement ID of the campaign manager 360 tracking Ad. + "cmTrackingAd": { # A Campaign Manager 360 tracking ad. # Optional. The Campaign Manager 360 tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager 360 and third-party ad serving: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` Output only for other cases. + "cmAdId": "A String", # Optional. The ad ID of the campaign manager 360 tracking Ad. + "cmCreativeId": "A String", # Optional. The creative ID of the campaign manager 360 tracking Ad. + "cmPlacementId": "A String", # Optional. The placement ID of the campaign manager 360 tracking Ad. }, - "companionCreativeIds": [ # The IDs of companion creatives for a video creative. You can assign existing display creatives (with image or HTML5 assets) to serve surrounding the publisher's video player. Companions display around the video player while the video is playing and remain after the video has completed. Creatives contain additional dimensions can not be companion creatives. This field is only supported for following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` + "companionCreativeIds": [ # Optional. The IDs of companion creatives for a video creative. You can assign existing display creatives (with image or HTML5 assets) to serve surrounding the publisher's video player. Companions display around the video player while the video is playing and remain after the video has completed. Creatives contain additional dimensions can not be companion creatives. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` "A String", ], - "counterEvents": [ # Counter events for a rich media creative. Counters track the number of times that a user interacts with any part of a rich media creative in a specified way (mouse-overs, mouse-outs, clicks, taps, data loading, keyboard entries, etc.). Any event that can be captured in the creative can be recorded as a counter. Leave it empty or unset for creatives containing image assets only. + "counterEvents": [ # Optional. Counter events for a rich media creative. Counters track the number of times that a user interacts with any part of a rich media creative in a specified way (mouse-overs, mouse-outs, clicks, taps, data loading, keyboard entries, etc.). Any event that can be captured in the creative can be recorded as a counter. Leave it empty or unset for creatives containing image assets only. { # Counter event of the creative. "name": "A String", # Required. The name of the counter event. "reportingName": "A String", # Required. The name used to identify this counter event in reports. @@ -505,8 +505,8 @@

Method Details

"entityStatus": "A String", # Required. Controls whether or not the creative can serve. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED` * `ENTITY_STATUS_PAUSED` "exitEvents": [ # Required. Exit events for this creative. An exit (also known as a click tag) is any area in your creative that someone can click or tap to open an advertiser's landing page. Every creative must include at least one exit. You can add an exit to your creative in any of the following ways: * Use Google Web Designer's tap area. * Define a JavaScript variable called "clickTag". * Use the Enabler (Enabler.exit()) to track exits in rich media formats. { # Exit event of the creative. - "name": "A String", # The name of the click tag of the exit event. The name must be unique within one creative. Leave it empty or unset for creatives containing image assets only. - "reportingName": "A String", # The name used to identify this event in reports. Leave it empty or unset for creatives containing image assets only. + "name": "A String", # Optional. The name of the click tag of the exit event. The name must be unique within one creative. Leave it empty or unset for creatives containing image assets only. + "reportingName": "A String", # Optional. The name used to identify this event in reports. Leave it empty or unset for creatives containing image assets only. "type": "A String", # Required. The type of the exit event. "url": "A String", # Required. The click through URL of the exit event. This is required when type is: * `EXIT_EVENT_TYPE_DEFAULT` * `EXIT_EVENT_TYPE_BACKUP` }, @@ -515,33 +515,33 @@

Method Details

"expandingDirection": "A String", # Optional. Specifies the expanding direction of the creative. Required and only valid for third-party expandable creatives. Third-party expandable creatives are creatives with following hosting source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_EXPANDABLE` "hostingSource": "A String", # Required. Indicates where the creative is hosted. "html5Video": True or False, # Output only. Indicates the third-party VAST tag creative requires HTML5 Video support. Output only and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_VIDEO` - "iasCampaignMonitoring": True or False, # Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. To enable this for the creative, make sure the Advertiser.creative_config.ias_client_id has been set to your IAS client ID. - "integrationCode": "A String", # ID information used to link this creative to an external system. Must be UTF-8 encoded with a length of no more than 10,000 characters. - "jsTrackerUrl": "A String", # JavaScript measurement URL from supported third-party verification providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not supported. This field is only writeable in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` + "iasCampaignMonitoring": True or False, # Optional. Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. To enable this for the creative, make sure the Advertiser.creative_config.ias_client_id has been set to your IAS client ID. + "integrationCode": "A String", # Optional. ID information used to link this creative to an external system. Must be UTF-8 encoded with a length of no more than 10,000 characters. + "jsTrackerUrl": "A String", # Optional. JavaScript measurement URL from supported third-party verification providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not supported. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` "lineItemIds": [ # Output only. The IDs of the line items this creative is associated with. To associate a creative to a line item, use LineItem.creative_ids instead. "A String", ], "mediaDuration": "A String", # Output only. Media duration of the creative. Applicable when creative_type is one of: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_PUBLISHER_HOSTED` "mp3Audio": True or False, # Output only. Indicates the third-party audio creative supports MP3. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` "name": "A String", # Output only. The resource name of the creative. - "notes": "A String", # User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters. - "obaIcon": { # OBA Icon for a Creative # Specifies the OBA icon for a video creative. This field is only supported in following creative_type: * `CREATIVE_TYPE_VIDEO` - "clickTrackingUrl": "A String", # Required. The click tracking URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com - "dimensions": { # Dimensions. # The dimensions of the OBA icon. + "notes": "A String", # Optional. User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters. + "obaIcon": { # OBA Icon for a Creative # Optional. Specifies the OBA icon for a video creative. This field is only supported in the following creative_type: * `CREATIVE_TYPE_VIDEO` + "clickTrackingUrl": "A String", # Required. The click tracking URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com` + "dimensions": { # Dimensions. # Optional. The dimensions of the OBA icon. "heightPixels": 42, # The height in pixels. "widthPixels": 42, # The width in pixels. }, - "landingPageUrl": "A String", # Required. The landing page URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com - "position": "A String", # The position of the OBA icon on the creative. - "program": "A String", # The program of the OBA icon. For example: “AdChoices”. - "resourceMimeType": "A String", # The MIME type of the OBA icon resource. - "resourceUrl": "A String", # The URL of the OBA icon resource. - "viewTrackingUrl": "A String", # Required. The view tracking URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com + "landingPageUrl": "A String", # Required. The landing page URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com` + "position": "A String", # Optional. The position of the OBA icon on the creative. + "program": "A String", # Optional. The program of the OBA icon. For example: “AdChoices”. + "resourceMimeType": "A String", # Optional. The MIME type of the OBA icon resource. + "resourceUrl": "A String", # Optional. The URL of the OBA icon resource. + "viewTrackingUrl": "A String", # Required. The view tracking URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com` }, "oggAudio": True or False, # Output only. Indicates the third-party audio creative supports OGG. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` - "progressOffset": { # The length an audio or a video has been played. # Amount of time to play the video before counting a view. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` - "percentage": "A String", # The offset in percentage of the audio or video duration. - "seconds": "A String", # The offset in seconds from the start of the audio or video. + "progressOffset": { # The length an audio or a video has been played. # Optional. Amount of time to play the video before counting a view. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + "percentage": "A String", # Optional. The offset in percentage of the audio or video duration. + "seconds": "A String", # Optional. The offset in seconds from the start of the audio or video. }, "requireHtml5": True or False, # Optional. Indicates that the creative relies on HTML5 to render properly. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` "requireMraid": True or False, # Optional. Indicates that the creative requires MRAID (Mobile Rich Media Ad Interface Definitions system). Set this if the creative relies on mobile gestures for interactivity, such as swiping or tapping. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` @@ -563,46 +563,46 @@

Method Details

}, ], }, - "skipOffset": { # The length an audio or a video has been played. # Amount of time to play the video before the skip button appears. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` - "percentage": "A String", # The offset in percentage of the audio or video duration. - "seconds": "A String", # The offset in seconds from the start of the audio or video. + "skipOffset": { # The length an audio or a video has been played. # Optional. Amount of time to play the video before the skip button appears. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + "percentage": "A String", # Optional. The offset in percentage of the audio or video duration. + "seconds": "A String", # Optional. The offset in seconds from the start of the audio or video. }, - "skippable": True or False, # Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + "skippable": True or False, # Optional. Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` "thirdPartyTag": "A String", # Optional. The original third-party tag used for the creative. Required and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` - "thirdPartyUrls": [ # Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` + "thirdPartyUrls": [ # Optional. Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` { # Tracking URLs from third parties to track interactions with an audio or a video creative. - "type": "A String", # The type of interaction needs to be tracked by the tracking URL - "url": "A String", # Tracking URL used to track the interaction. Provide a URL with optional path or query string, beginning with `https:`. For example, https://www.example.com/path + "type": "A String", # Optional. The type of interaction needs to be tracked by the tracking URL + "url": "A String", # Optional. Tracking URL used to track the interaction. Provide a URL with optional path or query string, beginning with `https:`. For example, `https://www.example.com/path` }, ], - "timerEvents": [ # Timer custom events for a rich media creative. Timers track the time during which a user views and interacts with a specified part of a rich media creative. A creative can have multiple timer events, each timed independently. Leave it empty or unset for creatives containing image assets only. + "timerEvents": [ # Optional. Timer custom events for a rich media creative. Timers track the time during which a user views and interacts with a specified part of a rich media creative. A creative can have multiple timer events, each timed independently. Leave it empty or unset for creatives containing image assets only. { # Timer event of the creative. "name": "A String", # Required. The name of the timer event. "reportingName": "A String", # Required. The name used to identify this timer event in reports. }, ], - "trackerUrls": [ # Tracking URLs for analytics providers or third-party ad technology vendors. The URLs must start with https (except on inventory that doesn't require SSL compliance). If using macros in your URL, use only macros supported by Display & Video 360. Standard URLs only, no IMG or SCRIPT tags. This field is only writeable in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` + "trackerUrls": [ # Optional. Tracking URLs for analytics providers or third-party ad technology vendors. The URLs must start with `https:` (except on inventory that doesn't require SSL compliance). If using macros in your URL, use only macros supported by Display & Video 360. Standard URLs only, no IMG or SCRIPT tags. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` "A String", ], - "transcodes": [ # Output only. Audio/Video transcodes. Display & Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher's system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer’s connection and screen size. This field is only supported in following creative_type: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_AUDIO` + "transcodes": [ # Output only. Audio/Video transcodes. Display & Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher's system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer’s connection and screen size. This field is only supported in the following creative_type: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_AUDIO` { # Represents information about the transcoded audio or video file. - "audioBitRateKbps": "A String", # The bit rate for the audio stream of the transcoded video, or the bit rate for the transcoded audio, in kilobits per second. - "audioSampleRateHz": "A String", # The sample rate for the audio stream of the transcoded video, or the sample rate for the transcoded audio, in hertz. - "bitRateKbps": "A String", # The transcoding bit rate of the transcoded video, in kilobits per second. - "dimensions": { # Dimensions. # The dimensions of the transcoded video. + "audioBitRateKbps": "A String", # Optional. The bit rate for the audio stream of the transcoded video, or the bit rate for the transcoded audio, in kilobits per second. + "audioSampleRateHz": "A String", # Optional. The sample rate for the audio stream of the transcoded video, or the sample rate for the transcoded audio, in hertz. + "bitRateKbps": "A String", # Optional. The transcoding bit rate of the transcoded video, in kilobits per second. + "dimensions": { # Dimensions. # Optional. The dimensions of the transcoded video. "heightPixels": 42, # The height in pixels. "widthPixels": 42, # The width in pixels. }, - "fileSizeBytes": "A String", # The size of the transcoded file, in bytes. - "frameRate": 3.14, # The frame rate of the transcoded video, in frames per second. - "mimeType": "A String", # The MIME type of the transcoded file. - "name": "A String", # The name of the transcoded file. - "transcoded": True or False, # Indicates if the transcoding was successful. + "fileSizeBytes": "A String", # Optional. The size of the transcoded file, in bytes. + "frameRate": 3.14, # Optional. The frame rate of the transcoded video, in frames per second. + "mimeType": "A String", # Optional. The MIME type of the transcoded file. + "name": "A String", # Optional. The name of the transcoded file. + "transcoded": True or False, # Optional. Indicates if the transcoding was successful. }, ], "universalAdId": { # A creative identifier provided by a registry that is unique across all platforms. This is part of the VAST 4.0 standard. # Optional. An optional creative identifier provided by a registry that is unique across all platforms. Universal Ad ID is part of the VAST 4.0 standard. It can be modified after the creative is created. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` - "id": "A String", # The unique creative identifier. - "registry": "A String", # The registry provides unique creative identifiers. + "id": "A String", # Optional. The unique creative identifier. + "registry": "A String", # Optional. The registry provides unique creative identifiers. }, "updateTime": "A String", # Output only. The timestamp when the creative was last updated, either by the user or system (e.g. creative review). Assigned by the system. "vastTagUrl": "A String", # Optional. The URL of the VAST tag for a third-party VAST tag creative. Required and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` @@ -631,33 +631,33 @@

Method Details

{ "creatives": [ # The list of creatives. This list will be absent if empty. { # A single Creative. - "additionalDimensions": [ # Additional dimensions. Applicable when creative_type is one of: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_LIGHTBOX` * `CREATIVE_TYPE_PUBLISHER_HOSTED` If this field is specified, width_pixels and height_pixels are both required and must be greater than or equal to 0. + "additionalDimensions": [ # Optional. Additional dimensions. Applicable when creative_type is one of: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_LIGHTBOX` * `CREATIVE_TYPE_PUBLISHER_HOSTED` If this field is specified, width_pixels and height_pixels are both required and must be greater than or equal to 0. { # Dimensions. "heightPixels": 42, # The height in pixels. "widthPixels": 42, # The width in pixels. }, ], "advertiserId": "A String", # Output only. The unique ID of the advertiser the creative belongs to. - "appendedTag": "A String", # Third-party HTML tracking tag to be appended to the creative tag. + "appendedTag": "A String", # Optional. Third-party HTML tracking tag to be appended to the creative tag. "assets": [ # Required. Assets associated to this creative. { # Asset association for the creative. - "asset": { # A single asset. # The associated asset. + "asset": { # A single asset. # Optional. The associated asset. "content": "A String", # The asset content. For uploaded assets, the content is the serving path. "mediaId": "A String", # Media ID of the uploaded asset. This is a unique identifier for the asset. This ID can be passed to other API calls, e.g. CreateCreative to associate the asset with a creative. The Media ID space updated on **April 5, 2023**. Update media IDs cached before **April 5, 2023** by retrieving the new media ID from associated creative resources or re-uploading the asset. }, - "role": "A String", # The role of this asset for the creative. + "role": "A String", # Optional. The role of this asset for the creative. }, ], "cmPlacementId": "A String", # Output only. The unique ID of the Campaign Manager 360 placement associated with the creative. This field is only applicable for creatives that are synced from Campaign Manager. - "cmTrackingAd": { # A Campaign Manager 360 tracking ad. # The Campaign Manager 360 tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager 360 and third-party ad serving: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` Output only for other cases. - "cmAdId": "A String", # The ad ID of the campaign manager 360 tracking Ad. - "cmCreativeId": "A String", # The creative ID of the campaign manager 360 tracking Ad. - "cmPlacementId": "A String", # The placement ID of the campaign manager 360 tracking Ad. + "cmTrackingAd": { # A Campaign Manager 360 tracking ad. # Optional. The Campaign Manager 360 tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager 360 and third-party ad serving: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` Output only for other cases. + "cmAdId": "A String", # Optional. The ad ID of the campaign manager 360 tracking Ad. + "cmCreativeId": "A String", # Optional. The creative ID of the campaign manager 360 tracking Ad. + "cmPlacementId": "A String", # Optional. The placement ID of the campaign manager 360 tracking Ad. }, - "companionCreativeIds": [ # The IDs of companion creatives for a video creative. You can assign existing display creatives (with image or HTML5 assets) to serve surrounding the publisher's video player. Companions display around the video player while the video is playing and remain after the video has completed. Creatives contain additional dimensions can not be companion creatives. This field is only supported for following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` + "companionCreativeIds": [ # Optional. The IDs of companion creatives for a video creative. You can assign existing display creatives (with image or HTML5 assets) to serve surrounding the publisher's video player. Companions display around the video player while the video is playing and remain after the video has completed. Creatives contain additional dimensions can not be companion creatives. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` "A String", ], - "counterEvents": [ # Counter events for a rich media creative. Counters track the number of times that a user interacts with any part of a rich media creative in a specified way (mouse-overs, mouse-outs, clicks, taps, data loading, keyboard entries, etc.). Any event that can be captured in the creative can be recorded as a counter. Leave it empty or unset for creatives containing image assets only. + "counterEvents": [ # Optional. Counter events for a rich media creative. Counters track the number of times that a user interacts with any part of a rich media creative in a specified way (mouse-overs, mouse-outs, clicks, taps, data loading, keyboard entries, etc.). Any event that can be captured in the creative can be recorded as a counter. Leave it empty or unset for creatives containing image assets only. { # Counter event of the creative. "name": "A String", # Required. The name of the counter event. "reportingName": "A String", # Required. The name used to identify this counter event in reports. @@ -678,8 +678,8 @@

Method Details

"entityStatus": "A String", # Required. Controls whether or not the creative can serve. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED` * `ENTITY_STATUS_PAUSED` "exitEvents": [ # Required. Exit events for this creative. An exit (also known as a click tag) is any area in your creative that someone can click or tap to open an advertiser's landing page. Every creative must include at least one exit. You can add an exit to your creative in any of the following ways: * Use Google Web Designer's tap area. * Define a JavaScript variable called "clickTag". * Use the Enabler (Enabler.exit()) to track exits in rich media formats. { # Exit event of the creative. - "name": "A String", # The name of the click tag of the exit event. The name must be unique within one creative. Leave it empty or unset for creatives containing image assets only. - "reportingName": "A String", # The name used to identify this event in reports. Leave it empty or unset for creatives containing image assets only. + "name": "A String", # Optional. The name of the click tag of the exit event. The name must be unique within one creative. Leave it empty or unset for creatives containing image assets only. + "reportingName": "A String", # Optional. The name used to identify this event in reports. Leave it empty or unset for creatives containing image assets only. "type": "A String", # Required. The type of the exit event. "url": "A String", # Required. The click through URL of the exit event. This is required when type is: * `EXIT_EVENT_TYPE_DEFAULT` * `EXIT_EVENT_TYPE_BACKUP` }, @@ -688,33 +688,33 @@

Method Details

"expandingDirection": "A String", # Optional. Specifies the expanding direction of the creative. Required and only valid for third-party expandable creatives. Third-party expandable creatives are creatives with following hosting source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_EXPANDABLE` "hostingSource": "A String", # Required. Indicates where the creative is hosted. "html5Video": True or False, # Output only. Indicates the third-party VAST tag creative requires HTML5 Video support. Output only and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_VIDEO` - "iasCampaignMonitoring": True or False, # Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. To enable this for the creative, make sure the Advertiser.creative_config.ias_client_id has been set to your IAS client ID. - "integrationCode": "A String", # ID information used to link this creative to an external system. Must be UTF-8 encoded with a length of no more than 10,000 characters. - "jsTrackerUrl": "A String", # JavaScript measurement URL from supported third-party verification providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not supported. This field is only writeable in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` + "iasCampaignMonitoring": True or False, # Optional. Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. To enable this for the creative, make sure the Advertiser.creative_config.ias_client_id has been set to your IAS client ID. + "integrationCode": "A String", # Optional. ID information used to link this creative to an external system. Must be UTF-8 encoded with a length of no more than 10,000 characters. + "jsTrackerUrl": "A String", # Optional. JavaScript measurement URL from supported third-party verification providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not supported. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` "lineItemIds": [ # Output only. The IDs of the line items this creative is associated with. To associate a creative to a line item, use LineItem.creative_ids instead. "A String", ], "mediaDuration": "A String", # Output only. Media duration of the creative. Applicable when creative_type is one of: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_PUBLISHER_HOSTED` "mp3Audio": True or False, # Output only. Indicates the third-party audio creative supports MP3. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` "name": "A String", # Output only. The resource name of the creative. - "notes": "A String", # User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters. - "obaIcon": { # OBA Icon for a Creative # Specifies the OBA icon for a video creative. This field is only supported in following creative_type: * `CREATIVE_TYPE_VIDEO` - "clickTrackingUrl": "A String", # Required. The click tracking URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com - "dimensions": { # Dimensions. # The dimensions of the OBA icon. + "notes": "A String", # Optional. User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters. + "obaIcon": { # OBA Icon for a Creative # Optional. Specifies the OBA icon for a video creative. This field is only supported in the following creative_type: * `CREATIVE_TYPE_VIDEO` + "clickTrackingUrl": "A String", # Required. The click tracking URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com` + "dimensions": { # Dimensions. # Optional. The dimensions of the OBA icon. "heightPixels": 42, # The height in pixels. "widthPixels": 42, # The width in pixels. }, - "landingPageUrl": "A String", # Required. The landing page URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com - "position": "A String", # The position of the OBA icon on the creative. - "program": "A String", # The program of the OBA icon. For example: “AdChoices”. - "resourceMimeType": "A String", # The MIME type of the OBA icon resource. - "resourceUrl": "A String", # The URL of the OBA icon resource. - "viewTrackingUrl": "A String", # Required. The view tracking URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com + "landingPageUrl": "A String", # Required. The landing page URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com` + "position": "A String", # Optional. The position of the OBA icon on the creative. + "program": "A String", # Optional. The program of the OBA icon. For example: “AdChoices”. + "resourceMimeType": "A String", # Optional. The MIME type of the OBA icon resource. + "resourceUrl": "A String", # Optional. The URL of the OBA icon resource. + "viewTrackingUrl": "A String", # Required. The view tracking URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com` }, "oggAudio": True or False, # Output only. Indicates the third-party audio creative supports OGG. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` - "progressOffset": { # The length an audio or a video has been played. # Amount of time to play the video before counting a view. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` - "percentage": "A String", # The offset in percentage of the audio or video duration. - "seconds": "A String", # The offset in seconds from the start of the audio or video. + "progressOffset": { # The length an audio or a video has been played. # Optional. Amount of time to play the video before counting a view. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + "percentage": "A String", # Optional. The offset in percentage of the audio or video duration. + "seconds": "A String", # Optional. The offset in seconds from the start of the audio or video. }, "requireHtml5": True or False, # Optional. Indicates that the creative relies on HTML5 to render properly. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` "requireMraid": True or False, # Optional. Indicates that the creative requires MRAID (Mobile Rich Media Ad Interface Definitions system). Set this if the creative relies on mobile gestures for interactivity, such as swiping or tapping. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` @@ -736,46 +736,46 @@

Method Details

}, ], }, - "skipOffset": { # The length an audio or a video has been played. # Amount of time to play the video before the skip button appears. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` - "percentage": "A String", # The offset in percentage of the audio or video duration. - "seconds": "A String", # The offset in seconds from the start of the audio or video. + "skipOffset": { # The length an audio or a video has been played. # Optional. Amount of time to play the video before the skip button appears. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + "percentage": "A String", # Optional. The offset in percentage of the audio or video duration. + "seconds": "A String", # Optional. The offset in seconds from the start of the audio or video. }, - "skippable": True or False, # Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + "skippable": True or False, # Optional. Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` "thirdPartyTag": "A String", # Optional. The original third-party tag used for the creative. Required and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` - "thirdPartyUrls": [ # Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` + "thirdPartyUrls": [ # Optional. Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` { # Tracking URLs from third parties to track interactions with an audio or a video creative. - "type": "A String", # The type of interaction needs to be tracked by the tracking URL - "url": "A String", # Tracking URL used to track the interaction. Provide a URL with optional path or query string, beginning with `https:`. For example, https://www.example.com/path + "type": "A String", # Optional. The type of interaction needs to be tracked by the tracking URL + "url": "A String", # Optional. Tracking URL used to track the interaction. Provide a URL with optional path or query string, beginning with `https:`. For example, `https://www.example.com/path` }, ], - "timerEvents": [ # Timer custom events for a rich media creative. Timers track the time during which a user views and interacts with a specified part of a rich media creative. A creative can have multiple timer events, each timed independently. Leave it empty or unset for creatives containing image assets only. + "timerEvents": [ # Optional. Timer custom events for a rich media creative. Timers track the time during which a user views and interacts with a specified part of a rich media creative. A creative can have multiple timer events, each timed independently. Leave it empty or unset for creatives containing image assets only. { # Timer event of the creative. "name": "A String", # Required. The name of the timer event. "reportingName": "A String", # Required. The name used to identify this timer event in reports. }, ], - "trackerUrls": [ # Tracking URLs for analytics providers or third-party ad technology vendors. The URLs must start with https (except on inventory that doesn't require SSL compliance). If using macros in your URL, use only macros supported by Display & Video 360. Standard URLs only, no IMG or SCRIPT tags. This field is only writeable in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` + "trackerUrls": [ # Optional. Tracking URLs for analytics providers or third-party ad technology vendors. The URLs must start with `https:` (except on inventory that doesn't require SSL compliance). If using macros in your URL, use only macros supported by Display & Video 360. Standard URLs only, no IMG or SCRIPT tags. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` "A String", ], - "transcodes": [ # Output only. Audio/Video transcodes. Display & Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher's system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer’s connection and screen size. This field is only supported in following creative_type: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_AUDIO` + "transcodes": [ # Output only. Audio/Video transcodes. Display & Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher's system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer’s connection and screen size. This field is only supported in the following creative_type: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_AUDIO` { # Represents information about the transcoded audio or video file. - "audioBitRateKbps": "A String", # The bit rate for the audio stream of the transcoded video, or the bit rate for the transcoded audio, in kilobits per second. - "audioSampleRateHz": "A String", # The sample rate for the audio stream of the transcoded video, or the sample rate for the transcoded audio, in hertz. - "bitRateKbps": "A String", # The transcoding bit rate of the transcoded video, in kilobits per second. - "dimensions": { # Dimensions. # The dimensions of the transcoded video. + "audioBitRateKbps": "A String", # Optional. The bit rate for the audio stream of the transcoded video, or the bit rate for the transcoded audio, in kilobits per second. + "audioSampleRateHz": "A String", # Optional. The sample rate for the audio stream of the transcoded video, or the sample rate for the transcoded audio, in hertz. + "bitRateKbps": "A String", # Optional. The transcoding bit rate of the transcoded video, in kilobits per second. + "dimensions": { # Dimensions. # Optional. The dimensions of the transcoded video. "heightPixels": 42, # The height in pixels. "widthPixels": 42, # The width in pixels. }, - "fileSizeBytes": "A String", # The size of the transcoded file, in bytes. - "frameRate": 3.14, # The frame rate of the transcoded video, in frames per second. - "mimeType": "A String", # The MIME type of the transcoded file. - "name": "A String", # The name of the transcoded file. - "transcoded": True or False, # Indicates if the transcoding was successful. + "fileSizeBytes": "A String", # Optional. The size of the transcoded file, in bytes. + "frameRate": 3.14, # Optional. The frame rate of the transcoded video, in frames per second. + "mimeType": "A String", # Optional. The MIME type of the transcoded file. + "name": "A String", # Optional. The name of the transcoded file. + "transcoded": True or False, # Optional. Indicates if the transcoding was successful. }, ], "universalAdId": { # A creative identifier provided by a registry that is unique across all platforms. This is part of the VAST 4.0 standard. # Optional. An optional creative identifier provided by a registry that is unique across all platforms. Universal Ad ID is part of the VAST 4.0 standard. It can be modified after the creative is created. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` - "id": "A String", # The unique creative identifier. - "registry": "A String", # The registry provides unique creative identifiers. + "id": "A String", # Optional. The unique creative identifier. + "registry": "A String", # Optional. The registry provides unique creative identifiers. }, "updateTime": "A String", # Output only. The timestamp when the creative was last updated, either by the user or system (e.g. creative review). Assigned by the system. "vastTagUrl": "A String", # Optional. The URL of the VAST tag for a third-party VAST tag creative. Required and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` @@ -811,33 +811,33 @@

Method Details

The object takes the form of: { # A single Creative. - "additionalDimensions": [ # Additional dimensions. Applicable when creative_type is one of: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_LIGHTBOX` * `CREATIVE_TYPE_PUBLISHER_HOSTED` If this field is specified, width_pixels and height_pixels are both required and must be greater than or equal to 0. + "additionalDimensions": [ # Optional. Additional dimensions. Applicable when creative_type is one of: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_LIGHTBOX` * `CREATIVE_TYPE_PUBLISHER_HOSTED` If this field is specified, width_pixels and height_pixels are both required and must be greater than or equal to 0. { # Dimensions. "heightPixels": 42, # The height in pixels. "widthPixels": 42, # The width in pixels. }, ], "advertiserId": "A String", # Output only. The unique ID of the advertiser the creative belongs to. - "appendedTag": "A String", # Third-party HTML tracking tag to be appended to the creative tag. + "appendedTag": "A String", # Optional. Third-party HTML tracking tag to be appended to the creative tag. "assets": [ # Required. Assets associated to this creative. { # Asset association for the creative. - "asset": { # A single asset. # The associated asset. + "asset": { # A single asset. # Optional. The associated asset. "content": "A String", # The asset content. For uploaded assets, the content is the serving path. "mediaId": "A String", # Media ID of the uploaded asset. This is a unique identifier for the asset. This ID can be passed to other API calls, e.g. CreateCreative to associate the asset with a creative. The Media ID space updated on **April 5, 2023**. Update media IDs cached before **April 5, 2023** by retrieving the new media ID from associated creative resources or re-uploading the asset. }, - "role": "A String", # The role of this asset for the creative. + "role": "A String", # Optional. The role of this asset for the creative. }, ], "cmPlacementId": "A String", # Output only. The unique ID of the Campaign Manager 360 placement associated with the creative. This field is only applicable for creatives that are synced from Campaign Manager. - "cmTrackingAd": { # A Campaign Manager 360 tracking ad. # The Campaign Manager 360 tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager 360 and third-party ad serving: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` Output only for other cases. - "cmAdId": "A String", # The ad ID of the campaign manager 360 tracking Ad. - "cmCreativeId": "A String", # The creative ID of the campaign manager 360 tracking Ad. - "cmPlacementId": "A String", # The placement ID of the campaign manager 360 tracking Ad. + "cmTrackingAd": { # A Campaign Manager 360 tracking ad. # Optional. The Campaign Manager 360 tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager 360 and third-party ad serving: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` Output only for other cases. + "cmAdId": "A String", # Optional. The ad ID of the campaign manager 360 tracking Ad. + "cmCreativeId": "A String", # Optional. The creative ID of the campaign manager 360 tracking Ad. + "cmPlacementId": "A String", # Optional. The placement ID of the campaign manager 360 tracking Ad. }, - "companionCreativeIds": [ # The IDs of companion creatives for a video creative. You can assign existing display creatives (with image or HTML5 assets) to serve surrounding the publisher's video player. Companions display around the video player while the video is playing and remain after the video has completed. Creatives contain additional dimensions can not be companion creatives. This field is only supported for following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` + "companionCreativeIds": [ # Optional. The IDs of companion creatives for a video creative. You can assign existing display creatives (with image or HTML5 assets) to serve surrounding the publisher's video player. Companions display around the video player while the video is playing and remain after the video has completed. Creatives contain additional dimensions can not be companion creatives. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` "A String", ], - "counterEvents": [ # Counter events for a rich media creative. Counters track the number of times that a user interacts with any part of a rich media creative in a specified way (mouse-overs, mouse-outs, clicks, taps, data loading, keyboard entries, etc.). Any event that can be captured in the creative can be recorded as a counter. Leave it empty or unset for creatives containing image assets only. + "counterEvents": [ # Optional. Counter events for a rich media creative. Counters track the number of times that a user interacts with any part of a rich media creative in a specified way (mouse-overs, mouse-outs, clicks, taps, data loading, keyboard entries, etc.). Any event that can be captured in the creative can be recorded as a counter. Leave it empty or unset for creatives containing image assets only. { # Counter event of the creative. "name": "A String", # Required. The name of the counter event. "reportingName": "A String", # Required. The name used to identify this counter event in reports. @@ -858,8 +858,8 @@

Method Details

"entityStatus": "A String", # Required. Controls whether or not the creative can serve. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED` * `ENTITY_STATUS_PAUSED` "exitEvents": [ # Required. Exit events for this creative. An exit (also known as a click tag) is any area in your creative that someone can click or tap to open an advertiser's landing page. Every creative must include at least one exit. You can add an exit to your creative in any of the following ways: * Use Google Web Designer's tap area. * Define a JavaScript variable called "clickTag". * Use the Enabler (Enabler.exit()) to track exits in rich media formats. { # Exit event of the creative. - "name": "A String", # The name of the click tag of the exit event. The name must be unique within one creative. Leave it empty or unset for creatives containing image assets only. - "reportingName": "A String", # The name used to identify this event in reports. Leave it empty or unset for creatives containing image assets only. + "name": "A String", # Optional. The name of the click tag of the exit event. The name must be unique within one creative. Leave it empty or unset for creatives containing image assets only. + "reportingName": "A String", # Optional. The name used to identify this event in reports. Leave it empty or unset for creatives containing image assets only. "type": "A String", # Required. The type of the exit event. "url": "A String", # Required. The click through URL of the exit event. This is required when type is: * `EXIT_EVENT_TYPE_DEFAULT` * `EXIT_EVENT_TYPE_BACKUP` }, @@ -868,33 +868,33 @@

Method Details

"expandingDirection": "A String", # Optional. Specifies the expanding direction of the creative. Required and only valid for third-party expandable creatives. Third-party expandable creatives are creatives with following hosting source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_EXPANDABLE` "hostingSource": "A String", # Required. Indicates where the creative is hosted. "html5Video": True or False, # Output only. Indicates the third-party VAST tag creative requires HTML5 Video support. Output only and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_VIDEO` - "iasCampaignMonitoring": True or False, # Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. To enable this for the creative, make sure the Advertiser.creative_config.ias_client_id has been set to your IAS client ID. - "integrationCode": "A String", # ID information used to link this creative to an external system. Must be UTF-8 encoded with a length of no more than 10,000 characters. - "jsTrackerUrl": "A String", # JavaScript measurement URL from supported third-party verification providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not supported. This field is only writeable in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` + "iasCampaignMonitoring": True or False, # Optional. Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. To enable this for the creative, make sure the Advertiser.creative_config.ias_client_id has been set to your IAS client ID. + "integrationCode": "A String", # Optional. ID information used to link this creative to an external system. Must be UTF-8 encoded with a length of no more than 10,000 characters. + "jsTrackerUrl": "A String", # Optional. JavaScript measurement URL from supported third-party verification providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not supported. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` "lineItemIds": [ # Output only. The IDs of the line items this creative is associated with. To associate a creative to a line item, use LineItem.creative_ids instead. "A String", ], "mediaDuration": "A String", # Output only. Media duration of the creative. Applicable when creative_type is one of: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_PUBLISHER_HOSTED` "mp3Audio": True or False, # Output only. Indicates the third-party audio creative supports MP3. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` "name": "A String", # Output only. The resource name of the creative. - "notes": "A String", # User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters. - "obaIcon": { # OBA Icon for a Creative # Specifies the OBA icon for a video creative. This field is only supported in following creative_type: * `CREATIVE_TYPE_VIDEO` - "clickTrackingUrl": "A String", # Required. The click tracking URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com - "dimensions": { # Dimensions. # The dimensions of the OBA icon. + "notes": "A String", # Optional. User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters. + "obaIcon": { # OBA Icon for a Creative # Optional. Specifies the OBA icon for a video creative. This field is only supported in the following creative_type: * `CREATIVE_TYPE_VIDEO` + "clickTrackingUrl": "A String", # Required. The click tracking URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com` + "dimensions": { # Dimensions. # Optional. The dimensions of the OBA icon. "heightPixels": 42, # The height in pixels. "widthPixels": 42, # The width in pixels. }, - "landingPageUrl": "A String", # Required. The landing page URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com - "position": "A String", # The position of the OBA icon on the creative. - "program": "A String", # The program of the OBA icon. For example: “AdChoices”. - "resourceMimeType": "A String", # The MIME type of the OBA icon resource. - "resourceUrl": "A String", # The URL of the OBA icon resource. - "viewTrackingUrl": "A String", # Required. The view tracking URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com + "landingPageUrl": "A String", # Required. The landing page URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com` + "position": "A String", # Optional. The position of the OBA icon on the creative. + "program": "A String", # Optional. The program of the OBA icon. For example: “AdChoices”. + "resourceMimeType": "A String", # Optional. The MIME type of the OBA icon resource. + "resourceUrl": "A String", # Optional. The URL of the OBA icon resource. + "viewTrackingUrl": "A String", # Required. The view tracking URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com` }, "oggAudio": True or False, # Output only. Indicates the third-party audio creative supports OGG. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` - "progressOffset": { # The length an audio or a video has been played. # Amount of time to play the video before counting a view. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` - "percentage": "A String", # The offset in percentage of the audio or video duration. - "seconds": "A String", # The offset in seconds from the start of the audio or video. + "progressOffset": { # The length an audio or a video has been played. # Optional. Amount of time to play the video before counting a view. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + "percentage": "A String", # Optional. The offset in percentage of the audio or video duration. + "seconds": "A String", # Optional. The offset in seconds from the start of the audio or video. }, "requireHtml5": True or False, # Optional. Indicates that the creative relies on HTML5 to render properly. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` "requireMraid": True or False, # Optional. Indicates that the creative requires MRAID (Mobile Rich Media Ad Interface Definitions system). Set this if the creative relies on mobile gestures for interactivity, such as swiping or tapping. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` @@ -916,46 +916,46 @@

Method Details

}, ], }, - "skipOffset": { # The length an audio or a video has been played. # Amount of time to play the video before the skip button appears. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` - "percentage": "A String", # The offset in percentage of the audio or video duration. - "seconds": "A String", # The offset in seconds from the start of the audio or video. + "skipOffset": { # The length an audio or a video has been played. # Optional. Amount of time to play the video before the skip button appears. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + "percentage": "A String", # Optional. The offset in percentage of the audio or video duration. + "seconds": "A String", # Optional. The offset in seconds from the start of the audio or video. }, - "skippable": True or False, # Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + "skippable": True or False, # Optional. Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` "thirdPartyTag": "A String", # Optional. The original third-party tag used for the creative. Required and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` - "thirdPartyUrls": [ # Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` + "thirdPartyUrls": [ # Optional. Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` { # Tracking URLs from third parties to track interactions with an audio or a video creative. - "type": "A String", # The type of interaction needs to be tracked by the tracking URL - "url": "A String", # Tracking URL used to track the interaction. Provide a URL with optional path or query string, beginning with `https:`. For example, https://www.example.com/path + "type": "A String", # Optional. The type of interaction needs to be tracked by the tracking URL + "url": "A String", # Optional. Tracking URL used to track the interaction. Provide a URL with optional path or query string, beginning with `https:`. For example, `https://www.example.com/path` }, ], - "timerEvents": [ # Timer custom events for a rich media creative. Timers track the time during which a user views and interacts with a specified part of a rich media creative. A creative can have multiple timer events, each timed independently. Leave it empty or unset for creatives containing image assets only. + "timerEvents": [ # Optional. Timer custom events for a rich media creative. Timers track the time during which a user views and interacts with a specified part of a rich media creative. A creative can have multiple timer events, each timed independently. Leave it empty or unset for creatives containing image assets only. { # Timer event of the creative. "name": "A String", # Required. The name of the timer event. "reportingName": "A String", # Required. The name used to identify this timer event in reports. }, ], - "trackerUrls": [ # Tracking URLs for analytics providers or third-party ad technology vendors. The URLs must start with https (except on inventory that doesn't require SSL compliance). If using macros in your URL, use only macros supported by Display & Video 360. Standard URLs only, no IMG or SCRIPT tags. This field is only writeable in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` + "trackerUrls": [ # Optional. Tracking URLs for analytics providers or third-party ad technology vendors. The URLs must start with `https:` (except on inventory that doesn't require SSL compliance). If using macros in your URL, use only macros supported by Display & Video 360. Standard URLs only, no IMG or SCRIPT tags. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` "A String", ], - "transcodes": [ # Output only. Audio/Video transcodes. Display & Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher's system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer’s connection and screen size. This field is only supported in following creative_type: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_AUDIO` + "transcodes": [ # Output only. Audio/Video transcodes. Display & Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher's system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer’s connection and screen size. This field is only supported in the following creative_type: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_AUDIO` { # Represents information about the transcoded audio or video file. - "audioBitRateKbps": "A String", # The bit rate for the audio stream of the transcoded video, or the bit rate for the transcoded audio, in kilobits per second. - "audioSampleRateHz": "A String", # The sample rate for the audio stream of the transcoded video, or the sample rate for the transcoded audio, in hertz. - "bitRateKbps": "A String", # The transcoding bit rate of the transcoded video, in kilobits per second. - "dimensions": { # Dimensions. # The dimensions of the transcoded video. + "audioBitRateKbps": "A String", # Optional. The bit rate for the audio stream of the transcoded video, or the bit rate for the transcoded audio, in kilobits per second. + "audioSampleRateHz": "A String", # Optional. The sample rate for the audio stream of the transcoded video, or the sample rate for the transcoded audio, in hertz. + "bitRateKbps": "A String", # Optional. The transcoding bit rate of the transcoded video, in kilobits per second. + "dimensions": { # Dimensions. # Optional. The dimensions of the transcoded video. "heightPixels": 42, # The height in pixels. "widthPixels": 42, # The width in pixels. }, - "fileSizeBytes": "A String", # The size of the transcoded file, in bytes. - "frameRate": 3.14, # The frame rate of the transcoded video, in frames per second. - "mimeType": "A String", # The MIME type of the transcoded file. - "name": "A String", # The name of the transcoded file. - "transcoded": True or False, # Indicates if the transcoding was successful. + "fileSizeBytes": "A String", # Optional. The size of the transcoded file, in bytes. + "frameRate": 3.14, # Optional. The frame rate of the transcoded video, in frames per second. + "mimeType": "A String", # Optional. The MIME type of the transcoded file. + "name": "A String", # Optional. The name of the transcoded file. + "transcoded": True or False, # Optional. Indicates if the transcoding was successful. }, ], "universalAdId": { # A creative identifier provided by a registry that is unique across all platforms. This is part of the VAST 4.0 standard. # Optional. An optional creative identifier provided by a registry that is unique across all platforms. Universal Ad ID is part of the VAST 4.0 standard. It can be modified after the creative is created. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` - "id": "A String", # The unique creative identifier. - "registry": "A String", # The registry provides unique creative identifiers. + "id": "A String", # Optional. The unique creative identifier. + "registry": "A String", # Optional. The registry provides unique creative identifiers. }, "updateTime": "A String", # Output only. The timestamp when the creative was last updated, either by the user or system (e.g. creative review). Assigned by the system. "vastTagUrl": "A String", # Optional. The URL of the VAST tag for a third-party VAST tag creative. Required and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` @@ -972,33 +972,33 @@

Method Details

An object of the form: { # A single Creative. - "additionalDimensions": [ # Additional dimensions. Applicable when creative_type is one of: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_LIGHTBOX` * `CREATIVE_TYPE_PUBLISHER_HOSTED` If this field is specified, width_pixels and height_pixels are both required and must be greater than or equal to 0. + "additionalDimensions": [ # Optional. Additional dimensions. Applicable when creative_type is one of: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_LIGHTBOX` * `CREATIVE_TYPE_PUBLISHER_HOSTED` If this field is specified, width_pixels and height_pixels are both required and must be greater than or equal to 0. { # Dimensions. "heightPixels": 42, # The height in pixels. "widthPixels": 42, # The width in pixels. }, ], "advertiserId": "A String", # Output only. The unique ID of the advertiser the creative belongs to. - "appendedTag": "A String", # Third-party HTML tracking tag to be appended to the creative tag. + "appendedTag": "A String", # Optional. Third-party HTML tracking tag to be appended to the creative tag. "assets": [ # Required. Assets associated to this creative. { # Asset association for the creative. - "asset": { # A single asset. # The associated asset. + "asset": { # A single asset. # Optional. The associated asset. "content": "A String", # The asset content. For uploaded assets, the content is the serving path. "mediaId": "A String", # Media ID of the uploaded asset. This is a unique identifier for the asset. This ID can be passed to other API calls, e.g. CreateCreative to associate the asset with a creative. The Media ID space updated on **April 5, 2023**. Update media IDs cached before **April 5, 2023** by retrieving the new media ID from associated creative resources or re-uploading the asset. }, - "role": "A String", # The role of this asset for the creative. + "role": "A String", # Optional. The role of this asset for the creative. }, ], "cmPlacementId": "A String", # Output only. The unique ID of the Campaign Manager 360 placement associated with the creative. This field is only applicable for creatives that are synced from Campaign Manager. - "cmTrackingAd": { # A Campaign Manager 360 tracking ad. # The Campaign Manager 360 tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager 360 and third-party ad serving: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` Output only for other cases. - "cmAdId": "A String", # The ad ID of the campaign manager 360 tracking Ad. - "cmCreativeId": "A String", # The creative ID of the campaign manager 360 tracking Ad. - "cmPlacementId": "A String", # The placement ID of the campaign manager 360 tracking Ad. + "cmTrackingAd": { # A Campaign Manager 360 tracking ad. # Optional. The Campaign Manager 360 tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager 360 and third-party ad serving: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` Output only for other cases. + "cmAdId": "A String", # Optional. The ad ID of the campaign manager 360 tracking Ad. + "cmCreativeId": "A String", # Optional. The creative ID of the campaign manager 360 tracking Ad. + "cmPlacementId": "A String", # Optional. The placement ID of the campaign manager 360 tracking Ad. }, - "companionCreativeIds": [ # The IDs of companion creatives for a video creative. You can assign existing display creatives (with image or HTML5 assets) to serve surrounding the publisher's video player. Companions display around the video player while the video is playing and remain after the video has completed. Creatives contain additional dimensions can not be companion creatives. This field is only supported for following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` + "companionCreativeIds": [ # Optional. The IDs of companion creatives for a video creative. You can assign existing display creatives (with image or HTML5 assets) to serve surrounding the publisher's video player. Companions display around the video player while the video is playing and remain after the video has completed. Creatives contain additional dimensions can not be companion creatives. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` "A String", ], - "counterEvents": [ # Counter events for a rich media creative. Counters track the number of times that a user interacts with any part of a rich media creative in a specified way (mouse-overs, mouse-outs, clicks, taps, data loading, keyboard entries, etc.). Any event that can be captured in the creative can be recorded as a counter. Leave it empty or unset for creatives containing image assets only. + "counterEvents": [ # Optional. Counter events for a rich media creative. Counters track the number of times that a user interacts with any part of a rich media creative in a specified way (mouse-overs, mouse-outs, clicks, taps, data loading, keyboard entries, etc.). Any event that can be captured in the creative can be recorded as a counter. Leave it empty or unset for creatives containing image assets only. { # Counter event of the creative. "name": "A String", # Required. The name of the counter event. "reportingName": "A String", # Required. The name used to identify this counter event in reports. @@ -1019,8 +1019,8 @@

Method Details

"entityStatus": "A String", # Required. Controls whether or not the creative can serve. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED` * `ENTITY_STATUS_PAUSED` "exitEvents": [ # Required. Exit events for this creative. An exit (also known as a click tag) is any area in your creative that someone can click or tap to open an advertiser's landing page. Every creative must include at least one exit. You can add an exit to your creative in any of the following ways: * Use Google Web Designer's tap area. * Define a JavaScript variable called "clickTag". * Use the Enabler (Enabler.exit()) to track exits in rich media formats. { # Exit event of the creative. - "name": "A String", # The name of the click tag of the exit event. The name must be unique within one creative. Leave it empty or unset for creatives containing image assets only. - "reportingName": "A String", # The name used to identify this event in reports. Leave it empty or unset for creatives containing image assets only. + "name": "A String", # Optional. The name of the click tag of the exit event. The name must be unique within one creative. Leave it empty or unset for creatives containing image assets only. + "reportingName": "A String", # Optional. The name used to identify this event in reports. Leave it empty or unset for creatives containing image assets only. "type": "A String", # Required. The type of the exit event. "url": "A String", # Required. The click through URL of the exit event. This is required when type is: * `EXIT_EVENT_TYPE_DEFAULT` * `EXIT_EVENT_TYPE_BACKUP` }, @@ -1029,33 +1029,33 @@

Method Details

"expandingDirection": "A String", # Optional. Specifies the expanding direction of the creative. Required and only valid for third-party expandable creatives. Third-party expandable creatives are creatives with following hosting source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_EXPANDABLE` "hostingSource": "A String", # Required. Indicates where the creative is hosted. "html5Video": True or False, # Output only. Indicates the third-party VAST tag creative requires HTML5 Video support. Output only and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_VIDEO` - "iasCampaignMonitoring": True or False, # Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. To enable this for the creative, make sure the Advertiser.creative_config.ias_client_id has been set to your IAS client ID. - "integrationCode": "A String", # ID information used to link this creative to an external system. Must be UTF-8 encoded with a length of no more than 10,000 characters. - "jsTrackerUrl": "A String", # JavaScript measurement URL from supported third-party verification providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not supported. This field is only writeable in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` + "iasCampaignMonitoring": True or False, # Optional. Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. To enable this for the creative, make sure the Advertiser.creative_config.ias_client_id has been set to your IAS client ID. + "integrationCode": "A String", # Optional. ID information used to link this creative to an external system. Must be UTF-8 encoded with a length of no more than 10,000 characters. + "jsTrackerUrl": "A String", # Optional. JavaScript measurement URL from supported third-party verification providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not supported. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` "lineItemIds": [ # Output only. The IDs of the line items this creative is associated with. To associate a creative to a line item, use LineItem.creative_ids instead. "A String", ], "mediaDuration": "A String", # Output only. Media duration of the creative. Applicable when creative_type is one of: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_PUBLISHER_HOSTED` "mp3Audio": True or False, # Output only. Indicates the third-party audio creative supports MP3. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` "name": "A String", # Output only. The resource name of the creative. - "notes": "A String", # User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters. - "obaIcon": { # OBA Icon for a Creative # Specifies the OBA icon for a video creative. This field is only supported in following creative_type: * `CREATIVE_TYPE_VIDEO` - "clickTrackingUrl": "A String", # Required. The click tracking URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com - "dimensions": { # Dimensions. # The dimensions of the OBA icon. + "notes": "A String", # Optional. User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters. + "obaIcon": { # OBA Icon for a Creative # Optional. Specifies the OBA icon for a video creative. This field is only supported in the following creative_type: * `CREATIVE_TYPE_VIDEO` + "clickTrackingUrl": "A String", # Required. The click tracking URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com` + "dimensions": { # Dimensions. # Optional. The dimensions of the OBA icon. "heightPixels": 42, # The height in pixels. "widthPixels": 42, # The width in pixels. }, - "landingPageUrl": "A String", # Required. The landing page URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com - "position": "A String", # The position of the OBA icon on the creative. - "program": "A String", # The program of the OBA icon. For example: “AdChoices”. - "resourceMimeType": "A String", # The MIME type of the OBA icon resource. - "resourceUrl": "A String", # The URL of the OBA icon resource. - "viewTrackingUrl": "A String", # Required. The view tracking URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com + "landingPageUrl": "A String", # Required. The landing page URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com` + "position": "A String", # Optional. The position of the OBA icon on the creative. + "program": "A String", # Optional. The program of the OBA icon. For example: “AdChoices”. + "resourceMimeType": "A String", # Optional. The MIME type of the OBA icon resource. + "resourceUrl": "A String", # Optional. The URL of the OBA icon resource. + "viewTrackingUrl": "A String", # Required. The view tracking URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com` }, "oggAudio": True or False, # Output only. Indicates the third-party audio creative supports OGG. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` - "progressOffset": { # The length an audio or a video has been played. # Amount of time to play the video before counting a view. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` - "percentage": "A String", # The offset in percentage of the audio or video duration. - "seconds": "A String", # The offset in seconds from the start of the audio or video. + "progressOffset": { # The length an audio or a video has been played. # Optional. Amount of time to play the video before counting a view. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + "percentage": "A String", # Optional. The offset in percentage of the audio or video duration. + "seconds": "A String", # Optional. The offset in seconds from the start of the audio or video. }, "requireHtml5": True or False, # Optional. Indicates that the creative relies on HTML5 to render properly. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` "requireMraid": True or False, # Optional. Indicates that the creative requires MRAID (Mobile Rich Media Ad Interface Definitions system). Set this if the creative relies on mobile gestures for interactivity, such as swiping or tapping. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` @@ -1077,46 +1077,46 @@

Method Details

}, ], }, - "skipOffset": { # The length an audio or a video has been played. # Amount of time to play the video before the skip button appears. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` - "percentage": "A String", # The offset in percentage of the audio or video duration. - "seconds": "A String", # The offset in seconds from the start of the audio or video. + "skipOffset": { # The length an audio or a video has been played. # Optional. Amount of time to play the video before the skip button appears. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + "percentage": "A String", # Optional. The offset in percentage of the audio or video duration. + "seconds": "A String", # Optional. The offset in seconds from the start of the audio or video. }, - "skippable": True or False, # Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + "skippable": True or False, # Optional. Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` "thirdPartyTag": "A String", # Optional. The original third-party tag used for the creative. Required and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` - "thirdPartyUrls": [ # Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` + "thirdPartyUrls": [ # Optional. Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` { # Tracking URLs from third parties to track interactions with an audio or a video creative. - "type": "A String", # The type of interaction needs to be tracked by the tracking URL - "url": "A String", # Tracking URL used to track the interaction. Provide a URL with optional path or query string, beginning with `https:`. For example, https://www.example.com/path + "type": "A String", # Optional. The type of interaction needs to be tracked by the tracking URL + "url": "A String", # Optional. Tracking URL used to track the interaction. Provide a URL with optional path or query string, beginning with `https:`. For example, `https://www.example.com/path` }, ], - "timerEvents": [ # Timer custom events for a rich media creative. Timers track the time during which a user views and interacts with a specified part of a rich media creative. A creative can have multiple timer events, each timed independently. Leave it empty or unset for creatives containing image assets only. + "timerEvents": [ # Optional. Timer custom events for a rich media creative. Timers track the time during which a user views and interacts with a specified part of a rich media creative. A creative can have multiple timer events, each timed independently. Leave it empty or unset for creatives containing image assets only. { # Timer event of the creative. "name": "A String", # Required. The name of the timer event. "reportingName": "A String", # Required. The name used to identify this timer event in reports. }, ], - "trackerUrls": [ # Tracking URLs for analytics providers or third-party ad technology vendors. The URLs must start with https (except on inventory that doesn't require SSL compliance). If using macros in your URL, use only macros supported by Display & Video 360. Standard URLs only, no IMG or SCRIPT tags. This field is only writeable in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` + "trackerUrls": [ # Optional. Tracking URLs for analytics providers or third-party ad technology vendors. The URLs must start with `https:` (except on inventory that doesn't require SSL compliance). If using macros in your URL, use only macros supported by Display & Video 360. Standard URLs only, no IMG or SCRIPT tags. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` "A String", ], - "transcodes": [ # Output only. Audio/Video transcodes. Display & Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher's system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer’s connection and screen size. This field is only supported in following creative_type: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_AUDIO` + "transcodes": [ # Output only. Audio/Video transcodes. Display & Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher's system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer’s connection and screen size. This field is only supported in the following creative_type: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_AUDIO` { # Represents information about the transcoded audio or video file. - "audioBitRateKbps": "A String", # The bit rate for the audio stream of the transcoded video, or the bit rate for the transcoded audio, in kilobits per second. - "audioSampleRateHz": "A String", # The sample rate for the audio stream of the transcoded video, or the sample rate for the transcoded audio, in hertz. - "bitRateKbps": "A String", # The transcoding bit rate of the transcoded video, in kilobits per second. - "dimensions": { # Dimensions. # The dimensions of the transcoded video. + "audioBitRateKbps": "A String", # Optional. The bit rate for the audio stream of the transcoded video, or the bit rate for the transcoded audio, in kilobits per second. + "audioSampleRateHz": "A String", # Optional. The sample rate for the audio stream of the transcoded video, or the sample rate for the transcoded audio, in hertz. + "bitRateKbps": "A String", # Optional. The transcoding bit rate of the transcoded video, in kilobits per second. + "dimensions": { # Dimensions. # Optional. The dimensions of the transcoded video. "heightPixels": 42, # The height in pixels. "widthPixels": 42, # The width in pixels. }, - "fileSizeBytes": "A String", # The size of the transcoded file, in bytes. - "frameRate": 3.14, # The frame rate of the transcoded video, in frames per second. - "mimeType": "A String", # The MIME type of the transcoded file. - "name": "A String", # The name of the transcoded file. - "transcoded": True or False, # Indicates if the transcoding was successful. + "fileSizeBytes": "A String", # Optional. The size of the transcoded file, in bytes. + "frameRate": 3.14, # Optional. The frame rate of the transcoded video, in frames per second. + "mimeType": "A String", # Optional. The MIME type of the transcoded file. + "name": "A String", # Optional. The name of the transcoded file. + "transcoded": True or False, # Optional. Indicates if the transcoding was successful. }, ], "universalAdId": { # A creative identifier provided by a registry that is unique across all platforms. This is part of the VAST 4.0 standard. # Optional. An optional creative identifier provided by a registry that is unique across all platforms. Universal Ad ID is part of the VAST 4.0 standard. It can be modified after the creative is created. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` - "id": "A String", # The unique creative identifier. - "registry": "A String", # The registry provides unique creative identifiers. + "id": "A String", # Optional. The unique creative identifier. + "registry": "A String", # Optional. The registry provides unique creative identifiers. }, "updateTime": "A String", # Output only. The timestamp when the creative was last updated, either by the user or system (e.g. creative review). Assigned by the system. "vastTagUrl": "A String", # Optional. The URL of the VAST tag for a third-party VAST tag creative. Required and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` diff --git a/docs/dyn/displayvideo_v3.advertisers.html b/docs/dyn/displayvideo_v3.advertisers.html index b50fcb22539..e936d1d1f1b 100644 --- a/docs/dyn/displayvideo_v3.advertisers.html +++ b/docs/dyn/displayvideo_v3.advertisers.html @@ -381,48 +381,48 @@

Method Details

}, "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts. "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` - "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. NEXT_ID: 9 # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. - "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. + "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # Optional. The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, - "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, ], }, - "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # The combined audience ids of the included combined audience group. Contains combined audience ids only. - "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. + "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only. + "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. { # Details of combined audience targeting setting. "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. }, ], }, - "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # The custom list ids of the included custom list group. Contains custom list ids only. - "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. + "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only. + "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored. { # Details of custom list targeting setting. "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id. }, ], }, - "includedFirstAndThirdPartyAudienceGroups": [ # The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with same settings will be ignored. + "includedFirstAndThirdPartyAudienceGroups": [ # Optional. The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored. { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, ], - "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the included Google audience group. Contains Google audience ids only. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, @@ -725,48 +725,48 @@

Method Details

}, "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts. "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` - "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. NEXT_ID: 9 # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. - "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. + "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # Optional. The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, - "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, ], }, - "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # The combined audience ids of the included combined audience group. Contains combined audience ids only. - "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. + "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only. + "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. { # Details of combined audience targeting setting. "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. }, ], }, - "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # The custom list ids of the included custom list group. Contains custom list ids only. - "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. + "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only. + "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored. { # Details of custom list targeting setting. "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id. }, ], }, - "includedFirstAndThirdPartyAudienceGroups": [ # The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with same settings will be ignored. + "includedFirstAndThirdPartyAudienceGroups": [ # Optional. The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored. { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, ], - "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the included Google audience group. Contains Google audience ids only. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, @@ -1224,48 +1224,48 @@

Method Details

}, "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts. "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` - "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. NEXT_ID: 9 # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. - "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. + "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # Optional. The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, - "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, ], }, - "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # The combined audience ids of the included combined audience group. Contains combined audience ids only. - "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. + "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only. + "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. { # Details of combined audience targeting setting. "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. }, ], }, - "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # The custom list ids of the included custom list group. Contains custom list ids only. - "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. + "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only. + "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored. { # Details of custom list targeting setting. "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id. }, ], }, - "includedFirstAndThirdPartyAudienceGroups": [ # The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with same settings will be ignored. + "includedFirstAndThirdPartyAudienceGroups": [ # Optional. The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored. { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, ], - "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the included Google audience group. Contains Google audience ids only. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, diff --git a/docs/dyn/displayvideo_v3.advertisers.insertionOrders.html b/docs/dyn/displayvideo_v3.advertisers.insertionOrders.html index c681f73f2bf..8bb7be53848 100644 --- a/docs/dyn/displayvideo_v3.advertisers.insertionOrders.html +++ b/docs/dyn/displayvideo_v3.advertisers.insertionOrders.html @@ -123,18 +123,18 @@

Method Details

{ # A single insertion order. "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. - "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # The bidding strategy of the insertion order. By default, fixed_bid is set. + "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, when performance_goal_type is one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , the line_item_type of the insertion order line items must be either: * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , and when performance_goal_type is either: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` the line_item_type of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy. "raiseBidForDeals": True or False, # Whether the strategy takes deal floor prices into account. }, "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. @@ -147,11 +147,11 @@

Method Details

}, }, "budget": { # Settings that control how insertion order budget is allocated. # Required. The budget allocation settings of the insertion order. - "automationType": "A String", # The type of automation used to manage bid and budget for the insertion order. If this field is unspecified in creation, the value defaults to `INSERTION_ORDER_AUTOMATION_TYPE_NONE`. + "automationType": "A String", # Optional. The type of automation used to manage bid and budget for the insertion order. If this field is unspecified in creation, the value defaults to `INSERTION_ORDER_AUTOMATION_TYPE_NONE`. "budgetSegments": [ # Required. The list of budget segments. Use a budget segment to specify a specific budget for a given period of time an insertion order is running. { # Settings that control the budget of a single budget segment. "budgetAmountMicros": "A String", # Required. The budget amount the insertion order will spend for the given date_range. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency. - "campaignBudgetId": "A String", # The budget_id of the campaign budget that this insertion order budget segment is a part of. + "campaignBudgetId": "A String", # Optional. The budget_id of the campaign budget that this insertion order budget segment is a part of. "dateRange": { # A date range. # Required. The start and end date settings of the budget segment. They are resolved relative to the parent advertiser's time zone. * When creating a new budget segment, both `start_date` and `end_date` must be in the future. * An existing budget segment with a `start_date` in the past has a mutable `end_date` but an immutable `start_date`. * `end_date` must be the `start_date` or later, both before the year 2037. "endDate": { # 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 # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`. "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. @@ -164,7 +164,7 @@

Method Details

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, }, - "description": "A String", # The budget segment description. It can be used to enter Purchase Order information for each budget segment and have that information printed on the invoices. Must be UTF-8 encoded. + "description": "A String", # Optional. The budget segment description. It can be used to enter Purchase Order information for each budget segment and have that information printed on the invoices. Must be UTF-8 encoded. }, ], "budgetUnit": "A String", # Required. Immutable. The budget unit specifies whether the budget is currency based or impression based. @@ -172,16 +172,16 @@

Method Details

"campaignId": "A String", # Required. Immutable. The unique ID of the campaign that the insertion order belongs to. "displayName": "A String", # Required. The display name of the insertion order. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not the insertion order can spend its budget and bid on inventory. * For CreateInsertionOrder method, only `ENTITY_STATUS_DRAFT` is allowed. To activate an insertion order, use UpdateInsertionOrder method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * An insertion order cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * An insertion order cannot be set to `ENTITY_STATUS_ACTIVE` if its parent campaign is not active. - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency capping setting of the insertion order. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency capping setting of the insertion order. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap) "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. - "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. - "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). + "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. }, "insertionOrderId": "A String", # Output only. The unique ID of the insertion order. Assigned by the system. - "insertionOrderType": "A String", # The type of insertion order. If this field is unspecified in creation, the value defaults to `RTB`. - "integrationDetails": { # Integration details of an entry. # Additional integration details of the insertion order. + "insertionOrderType": "A String", # Optional. The type of insertion order. If this field is unspecified in creation, the value defaults to `RTB`. + "integrationDetails": { # Integration details of an entry. # Optional. Additional integration details of the insertion order. "details": "A String", # Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters. "integrationCode": "A String", # An external identifier to be associated with the entry. The integration code will show up together with the entry in many places in the system, for example, reporting. Must be UTF-8 encoded with a length of no more than 500 characters. }, @@ -193,14 +193,14 @@

Method Details

"kpiType": "A String", # Required. The type of KPI. }, "name": "A String", # Output only. The resource name of the insertion order. - "optimizationObjective": "A String", # Optional. The optimization objective of the insertion order. + "optimizationObjective": "A String", # Optional. Required. The optimization objective of the insertion order. "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the insertion order. pacing_type `PACING_TYPE_ASAP` is not compatible with pacing_period `PACING_PERIOD_FLIGHT`. "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0. "dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of advertiser's currency. Applicable when the budget is currency based. Must be greater than 0. For example, for 1.5 standard unit of the currency, set this field to 1500000. The value assigned will be rounded to whole billable units for the relevant currency by the following rules: any positive value less than a single billable unit will be rounded up to one billable unit and any value larger than a single billable unit will be rounded down to the nearest billable value. For example, if the currency's billable unit is 0.01, and this field is set to 10257770, it will round down to 10250000, a value of 10.25. If set to 505, it will round up to 10000, a value of 0.01. "pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent. When automatic budget allocation is enabled at the insertion order via automationType, this field is output only and defaults to `PACING_PERIOD_FLIGHT`. "pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be spent across the pacing_period. `PACING_TYPE_ASAP` is not compatible with pacing_period `PACING_PERIOD_FLIGHT` for insertion orders. }, - "partnerCosts": [ # The partner costs associated with the insertion order. If absent or empty in CreateInsertionOrder method, the newly created insertion order will inherit partner costs from the partner settings. + "partnerCosts": [ # Optional. The partner costs associated with the insertion order. If absent or empty in CreateInsertionOrder method, the newly created insertion order will inherit partner costs from the partner settings. { # Settings that control a partner cost. A partner cost is any type of expense involved in running a campaign, other than the costs of purchasing impressions (which is called the media cost) and using third-party audience segment data (data fee). Some examples of partner costs include the fees for using DV360, a third-party ad server, or a third-party ad serving verification service. "costType": "A String", # Required. The type of the partner cost. "feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency. Applicable when the fee_type is `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0. For example, for 1.5 standard unit of the advertiser's currency, set this field to 1500000. @@ -223,18 +223,18 @@

Method Details

{ # A single insertion order. "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. - "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # The bidding strategy of the insertion order. By default, fixed_bid is set. + "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, when performance_goal_type is one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , the line_item_type of the insertion order line items must be either: * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , and when performance_goal_type is either: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` the line_item_type of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy. "raiseBidForDeals": True or False, # Whether the strategy takes deal floor prices into account. }, "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. @@ -247,11 +247,11 @@

Method Details

}, }, "budget": { # Settings that control how insertion order budget is allocated. # Required. The budget allocation settings of the insertion order. - "automationType": "A String", # The type of automation used to manage bid and budget for the insertion order. If this field is unspecified in creation, the value defaults to `INSERTION_ORDER_AUTOMATION_TYPE_NONE`. + "automationType": "A String", # Optional. The type of automation used to manage bid and budget for the insertion order. If this field is unspecified in creation, the value defaults to `INSERTION_ORDER_AUTOMATION_TYPE_NONE`. "budgetSegments": [ # Required. The list of budget segments. Use a budget segment to specify a specific budget for a given period of time an insertion order is running. { # Settings that control the budget of a single budget segment. "budgetAmountMicros": "A String", # Required. The budget amount the insertion order will spend for the given date_range. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency. - "campaignBudgetId": "A String", # The budget_id of the campaign budget that this insertion order budget segment is a part of. + "campaignBudgetId": "A String", # Optional. The budget_id of the campaign budget that this insertion order budget segment is a part of. "dateRange": { # A date range. # Required. The start and end date settings of the budget segment. They are resolved relative to the parent advertiser's time zone. * When creating a new budget segment, both `start_date` and `end_date` must be in the future. * An existing budget segment with a `start_date` in the past has a mutable `end_date` but an immutable `start_date`. * `end_date` must be the `start_date` or later, both before the year 2037. "endDate": { # 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 # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`. "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. @@ -264,7 +264,7 @@

Method Details

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, }, - "description": "A String", # The budget segment description. It can be used to enter Purchase Order information for each budget segment and have that information printed on the invoices. Must be UTF-8 encoded. + "description": "A String", # Optional. The budget segment description. It can be used to enter Purchase Order information for each budget segment and have that information printed on the invoices. Must be UTF-8 encoded. }, ], "budgetUnit": "A String", # Required. Immutable. The budget unit specifies whether the budget is currency based or impression based. @@ -272,16 +272,16 @@

Method Details

"campaignId": "A String", # Required. Immutable. The unique ID of the campaign that the insertion order belongs to. "displayName": "A String", # Required. The display name of the insertion order. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not the insertion order can spend its budget and bid on inventory. * For CreateInsertionOrder method, only `ENTITY_STATUS_DRAFT` is allowed. To activate an insertion order, use UpdateInsertionOrder method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * An insertion order cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * An insertion order cannot be set to `ENTITY_STATUS_ACTIVE` if its parent campaign is not active. - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency capping setting of the insertion order. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency capping setting of the insertion order. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap) "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. - "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. - "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). + "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. }, "insertionOrderId": "A String", # Output only. The unique ID of the insertion order. Assigned by the system. - "insertionOrderType": "A String", # The type of insertion order. If this field is unspecified in creation, the value defaults to `RTB`. - "integrationDetails": { # Integration details of an entry. # Additional integration details of the insertion order. + "insertionOrderType": "A String", # Optional. The type of insertion order. If this field is unspecified in creation, the value defaults to `RTB`. + "integrationDetails": { # Integration details of an entry. # Optional. Additional integration details of the insertion order. "details": "A String", # Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters. "integrationCode": "A String", # An external identifier to be associated with the entry. The integration code will show up together with the entry in many places in the system, for example, reporting. Must be UTF-8 encoded with a length of no more than 500 characters. }, @@ -293,14 +293,14 @@

Method Details

"kpiType": "A String", # Required. The type of KPI. }, "name": "A String", # Output only. The resource name of the insertion order. - "optimizationObjective": "A String", # Optional. The optimization objective of the insertion order. + "optimizationObjective": "A String", # Optional. Required. The optimization objective of the insertion order. "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the insertion order. pacing_type `PACING_TYPE_ASAP` is not compatible with pacing_period `PACING_PERIOD_FLIGHT`. "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0. "dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of advertiser's currency. Applicable when the budget is currency based. Must be greater than 0. For example, for 1.5 standard unit of the currency, set this field to 1500000. The value assigned will be rounded to whole billable units for the relevant currency by the following rules: any positive value less than a single billable unit will be rounded up to one billable unit and any value larger than a single billable unit will be rounded down to the nearest billable value. For example, if the currency's billable unit is 0.01, and this field is set to 10257770, it will round down to 10250000, a value of 10.25. If set to 505, it will round up to 10000, a value of 0.01. "pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent. When automatic budget allocation is enabled at the insertion order via automationType, this field is output only and defaults to `PACING_PERIOD_FLIGHT`. "pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be spent across the pacing_period. `PACING_TYPE_ASAP` is not compatible with pacing_period `PACING_PERIOD_FLIGHT` for insertion orders. }, - "partnerCosts": [ # The partner costs associated with the insertion order. If absent or empty in CreateInsertionOrder method, the newly created insertion order will inherit partner costs from the partner settings. + "partnerCosts": [ # Optional. The partner costs associated with the insertion order. If absent or empty in CreateInsertionOrder method, the newly created insertion order will inherit partner costs from the partner settings. { # Settings that control a partner cost. A partner cost is any type of expense involved in running a campaign, other than the costs of purchasing impressions (which is called the media cost) and using third-party audience segment data (data fee). Some examples of partner costs include the fees for using DV360, a third-party ad server, or a third-party ad serving verification service. "costType": "A String", # Required. The type of the partner cost. "feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency. Applicable when the fee_type is `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0. For example, for 1.5 standard unit of the advertiser's currency, set this field to 1500000. @@ -350,18 +350,18 @@

Method Details

{ # A single insertion order. "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. - "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # The bidding strategy of the insertion order. By default, fixed_bid is set. + "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, when performance_goal_type is one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , the line_item_type of the insertion order line items must be either: * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , and when performance_goal_type is either: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` the line_item_type of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy. "raiseBidForDeals": True or False, # Whether the strategy takes deal floor prices into account. }, "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. @@ -374,11 +374,11 @@

Method Details

}, }, "budget": { # Settings that control how insertion order budget is allocated. # Required. The budget allocation settings of the insertion order. - "automationType": "A String", # The type of automation used to manage bid and budget for the insertion order. If this field is unspecified in creation, the value defaults to `INSERTION_ORDER_AUTOMATION_TYPE_NONE`. + "automationType": "A String", # Optional. The type of automation used to manage bid and budget for the insertion order. If this field is unspecified in creation, the value defaults to `INSERTION_ORDER_AUTOMATION_TYPE_NONE`. "budgetSegments": [ # Required. The list of budget segments. Use a budget segment to specify a specific budget for a given period of time an insertion order is running. { # Settings that control the budget of a single budget segment. "budgetAmountMicros": "A String", # Required. The budget amount the insertion order will spend for the given date_range. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency. - "campaignBudgetId": "A String", # The budget_id of the campaign budget that this insertion order budget segment is a part of. + "campaignBudgetId": "A String", # Optional. The budget_id of the campaign budget that this insertion order budget segment is a part of. "dateRange": { # A date range. # Required. The start and end date settings of the budget segment. They are resolved relative to the parent advertiser's time zone. * When creating a new budget segment, both `start_date` and `end_date` must be in the future. * An existing budget segment with a `start_date` in the past has a mutable `end_date` but an immutable `start_date`. * `end_date` must be the `start_date` or later, both before the year 2037. "endDate": { # 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 # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`. "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. @@ -391,7 +391,7 @@

Method Details

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, }, - "description": "A String", # The budget segment description. It can be used to enter Purchase Order information for each budget segment and have that information printed on the invoices. Must be UTF-8 encoded. + "description": "A String", # Optional. The budget segment description. It can be used to enter Purchase Order information for each budget segment and have that information printed on the invoices. Must be UTF-8 encoded. }, ], "budgetUnit": "A String", # Required. Immutable. The budget unit specifies whether the budget is currency based or impression based. @@ -399,16 +399,16 @@

Method Details

"campaignId": "A String", # Required. Immutable. The unique ID of the campaign that the insertion order belongs to. "displayName": "A String", # Required. The display name of the insertion order. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not the insertion order can spend its budget and bid on inventory. * For CreateInsertionOrder method, only `ENTITY_STATUS_DRAFT` is allowed. To activate an insertion order, use UpdateInsertionOrder method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * An insertion order cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * An insertion order cannot be set to `ENTITY_STATUS_ACTIVE` if its parent campaign is not active. - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency capping setting of the insertion order. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency capping setting of the insertion order. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap) "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. - "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. - "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). + "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. }, "insertionOrderId": "A String", # Output only. The unique ID of the insertion order. Assigned by the system. - "insertionOrderType": "A String", # The type of insertion order. If this field is unspecified in creation, the value defaults to `RTB`. - "integrationDetails": { # Integration details of an entry. # Additional integration details of the insertion order. + "insertionOrderType": "A String", # Optional. The type of insertion order. If this field is unspecified in creation, the value defaults to `RTB`. + "integrationDetails": { # Integration details of an entry. # Optional. Additional integration details of the insertion order. "details": "A String", # Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters. "integrationCode": "A String", # An external identifier to be associated with the entry. The integration code will show up together with the entry in many places in the system, for example, reporting. Must be UTF-8 encoded with a length of no more than 500 characters. }, @@ -420,14 +420,14 @@

Method Details

"kpiType": "A String", # Required. The type of KPI. }, "name": "A String", # Output only. The resource name of the insertion order. - "optimizationObjective": "A String", # Optional. The optimization objective of the insertion order. + "optimizationObjective": "A String", # Optional. Required. The optimization objective of the insertion order. "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the insertion order. pacing_type `PACING_TYPE_ASAP` is not compatible with pacing_period `PACING_PERIOD_FLIGHT`. "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0. "dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of advertiser's currency. Applicable when the budget is currency based. Must be greater than 0. For example, for 1.5 standard unit of the currency, set this field to 1500000. The value assigned will be rounded to whole billable units for the relevant currency by the following rules: any positive value less than a single billable unit will be rounded up to one billable unit and any value larger than a single billable unit will be rounded down to the nearest billable value. For example, if the currency's billable unit is 0.01, and this field is set to 10257770, it will round down to 10250000, a value of 10.25. If set to 505, it will round up to 10000, a value of 0.01. "pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent. When automatic budget allocation is enabled at the insertion order via automationType, this field is output only and defaults to `PACING_PERIOD_FLIGHT`. "pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be spent across the pacing_period. `PACING_TYPE_ASAP` is not compatible with pacing_period `PACING_PERIOD_FLIGHT` for insertion orders. }, - "partnerCosts": [ # The partner costs associated with the insertion order. If absent or empty in CreateInsertionOrder method, the newly created insertion order will inherit partner costs from the partner settings. + "partnerCosts": [ # Optional. The partner costs associated with the insertion order. If absent or empty in CreateInsertionOrder method, the newly created insertion order will inherit partner costs from the partner settings. { # Settings that control a partner cost. A partner cost is any type of expense involved in running a campaign, other than the costs of purchasing impressions (which is called the media cost) and using third-party audience segment data (data fee). Some examples of partner costs include the fees for using DV360, a third-party ad server, or a third-party ad serving verification service. "costType": "A String", # Required. The type of the partner cost. "feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency. Applicable when the fee_type is `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0. For example, for 1.5 standard unit of the advertiser's currency, set this field to 1500000. @@ -463,18 +463,18 @@

Method Details

"insertionOrders": [ # The list of insertion orders. This list will be absent if empty. { # A single insertion order. "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. - "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # The bidding strategy of the insertion order. By default, fixed_bid is set. + "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, when performance_goal_type is one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , the line_item_type of the insertion order line items must be either: * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , and when performance_goal_type is either: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` the line_item_type of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy. "raiseBidForDeals": True or False, # Whether the strategy takes deal floor prices into account. }, "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. @@ -487,11 +487,11 @@

Method Details

}, }, "budget": { # Settings that control how insertion order budget is allocated. # Required. The budget allocation settings of the insertion order. - "automationType": "A String", # The type of automation used to manage bid and budget for the insertion order. If this field is unspecified in creation, the value defaults to `INSERTION_ORDER_AUTOMATION_TYPE_NONE`. + "automationType": "A String", # Optional. The type of automation used to manage bid and budget for the insertion order. If this field is unspecified in creation, the value defaults to `INSERTION_ORDER_AUTOMATION_TYPE_NONE`. "budgetSegments": [ # Required. The list of budget segments. Use a budget segment to specify a specific budget for a given period of time an insertion order is running. { # Settings that control the budget of a single budget segment. "budgetAmountMicros": "A String", # Required. The budget amount the insertion order will spend for the given date_range. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency. - "campaignBudgetId": "A String", # The budget_id of the campaign budget that this insertion order budget segment is a part of. + "campaignBudgetId": "A String", # Optional. The budget_id of the campaign budget that this insertion order budget segment is a part of. "dateRange": { # A date range. # Required. The start and end date settings of the budget segment. They are resolved relative to the parent advertiser's time zone. * When creating a new budget segment, both `start_date` and `end_date` must be in the future. * An existing budget segment with a `start_date` in the past has a mutable `end_date` but an immutable `start_date`. * `end_date` must be the `start_date` or later, both before the year 2037. "endDate": { # 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 # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`. "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. @@ -504,7 +504,7 @@

Method Details

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, }, - "description": "A String", # The budget segment description. It can be used to enter Purchase Order information for each budget segment and have that information printed on the invoices. Must be UTF-8 encoded. + "description": "A String", # Optional. The budget segment description. It can be used to enter Purchase Order information for each budget segment and have that information printed on the invoices. Must be UTF-8 encoded. }, ], "budgetUnit": "A String", # Required. Immutable. The budget unit specifies whether the budget is currency based or impression based. @@ -512,16 +512,16 @@

Method Details

"campaignId": "A String", # Required. Immutable. The unique ID of the campaign that the insertion order belongs to. "displayName": "A String", # Required. The display name of the insertion order. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not the insertion order can spend its budget and bid on inventory. * For CreateInsertionOrder method, only `ENTITY_STATUS_DRAFT` is allowed. To activate an insertion order, use UpdateInsertionOrder method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * An insertion order cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * An insertion order cannot be set to `ENTITY_STATUS_ACTIVE` if its parent campaign is not active. - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency capping setting of the insertion order. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency capping setting of the insertion order. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap) "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. - "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. - "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). + "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. }, "insertionOrderId": "A String", # Output only. The unique ID of the insertion order. Assigned by the system. - "insertionOrderType": "A String", # The type of insertion order. If this field is unspecified in creation, the value defaults to `RTB`. - "integrationDetails": { # Integration details of an entry. # Additional integration details of the insertion order. + "insertionOrderType": "A String", # Optional. The type of insertion order. If this field is unspecified in creation, the value defaults to `RTB`. + "integrationDetails": { # Integration details of an entry. # Optional. Additional integration details of the insertion order. "details": "A String", # Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters. "integrationCode": "A String", # An external identifier to be associated with the entry. The integration code will show up together with the entry in many places in the system, for example, reporting. Must be UTF-8 encoded with a length of no more than 500 characters. }, @@ -533,14 +533,14 @@

Method Details

"kpiType": "A String", # Required. The type of KPI. }, "name": "A String", # Output only. The resource name of the insertion order. - "optimizationObjective": "A String", # Optional. The optimization objective of the insertion order. + "optimizationObjective": "A String", # Optional. Required. The optimization objective of the insertion order. "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the insertion order. pacing_type `PACING_TYPE_ASAP` is not compatible with pacing_period `PACING_PERIOD_FLIGHT`. "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0. "dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of advertiser's currency. Applicable when the budget is currency based. Must be greater than 0. For example, for 1.5 standard unit of the currency, set this field to 1500000. The value assigned will be rounded to whole billable units for the relevant currency by the following rules: any positive value less than a single billable unit will be rounded up to one billable unit and any value larger than a single billable unit will be rounded down to the nearest billable value. For example, if the currency's billable unit is 0.01, and this field is set to 10257770, it will round down to 10250000, a value of 10.25. If set to 505, it will round up to 10000, a value of 0.01. "pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent. When automatic budget allocation is enabled at the insertion order via automationType, this field is output only and defaults to `PACING_PERIOD_FLIGHT`. "pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be spent across the pacing_period. `PACING_TYPE_ASAP` is not compatible with pacing_period `PACING_PERIOD_FLIGHT` for insertion orders. }, - "partnerCosts": [ # The partner costs associated with the insertion order. If absent or empty in CreateInsertionOrder method, the newly created insertion order will inherit partner costs from the partner settings. + "partnerCosts": [ # Optional. The partner costs associated with the insertion order. If absent or empty in CreateInsertionOrder method, the newly created insertion order will inherit partner costs from the partner settings. { # Settings that control a partner cost. A partner cost is any type of expense involved in running a campaign, other than the costs of purchasing impressions (which is called the media cost) and using third-party audience segment data (data fee). Some examples of partner costs include the fees for using DV360, a third-party ad server, or a third-party ad serving verification service. "costType": "A String", # Required. The type of the partner cost. "feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency. Applicable when the fee_type is `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0. For example, for 1.5 standard unit of the advertiser's currency, set this field to 1500000. @@ -595,48 +595,48 @@

Method Details

}, "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts. "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` - "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. NEXT_ID: 9 # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. - "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. + "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # Optional. The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, - "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, ], }, - "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # The combined audience ids of the included combined audience group. Contains combined audience ids only. - "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. + "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only. + "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. { # Details of combined audience targeting setting. "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. }, ], }, - "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # The custom list ids of the included custom list group. Contains custom list ids only. - "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. + "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only. + "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored. { # Details of custom list targeting setting. "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id. }, ], }, - "includedFirstAndThirdPartyAudienceGroups": [ # The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with same settings will be ignored. + "includedFirstAndThirdPartyAudienceGroups": [ # Optional. The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored. { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, ], - "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the included Google audience group. Contains Google audience ids only. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, @@ -943,18 +943,18 @@

Method Details

{ # A single insertion order. "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. - "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # The bidding strategy of the insertion order. By default, fixed_bid is set. + "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, when performance_goal_type is one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , the line_item_type of the insertion order line items must be either: * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , and when performance_goal_type is either: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` the line_item_type of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy. "raiseBidForDeals": True or False, # Whether the strategy takes deal floor prices into account. }, "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. @@ -967,11 +967,11 @@

Method Details

}, }, "budget": { # Settings that control how insertion order budget is allocated. # Required. The budget allocation settings of the insertion order. - "automationType": "A String", # The type of automation used to manage bid and budget for the insertion order. If this field is unspecified in creation, the value defaults to `INSERTION_ORDER_AUTOMATION_TYPE_NONE`. + "automationType": "A String", # Optional. The type of automation used to manage bid and budget for the insertion order. If this field is unspecified in creation, the value defaults to `INSERTION_ORDER_AUTOMATION_TYPE_NONE`. "budgetSegments": [ # Required. The list of budget segments. Use a budget segment to specify a specific budget for a given period of time an insertion order is running. { # Settings that control the budget of a single budget segment. "budgetAmountMicros": "A String", # Required. The budget amount the insertion order will spend for the given date_range. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency. - "campaignBudgetId": "A String", # The budget_id of the campaign budget that this insertion order budget segment is a part of. + "campaignBudgetId": "A String", # Optional. The budget_id of the campaign budget that this insertion order budget segment is a part of. "dateRange": { # A date range. # Required. The start and end date settings of the budget segment. They are resolved relative to the parent advertiser's time zone. * When creating a new budget segment, both `start_date` and `end_date` must be in the future. * An existing budget segment with a `start_date` in the past has a mutable `end_date` but an immutable `start_date`. * `end_date` must be the `start_date` or later, both before the year 2037. "endDate": { # 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 # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`. "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. @@ -984,7 +984,7 @@

Method Details

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, }, - "description": "A String", # The budget segment description. It can be used to enter Purchase Order information for each budget segment and have that information printed on the invoices. Must be UTF-8 encoded. + "description": "A String", # Optional. The budget segment description. It can be used to enter Purchase Order information for each budget segment and have that information printed on the invoices. Must be UTF-8 encoded. }, ], "budgetUnit": "A String", # Required. Immutable. The budget unit specifies whether the budget is currency based or impression based. @@ -992,16 +992,16 @@

Method Details

"campaignId": "A String", # Required. Immutable. The unique ID of the campaign that the insertion order belongs to. "displayName": "A String", # Required. The display name of the insertion order. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not the insertion order can spend its budget and bid on inventory. * For CreateInsertionOrder method, only `ENTITY_STATUS_DRAFT` is allowed. To activate an insertion order, use UpdateInsertionOrder method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * An insertion order cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * An insertion order cannot be set to `ENTITY_STATUS_ACTIVE` if its parent campaign is not active. - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency capping setting of the insertion order. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency capping setting of the insertion order. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap) "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. - "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. - "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). + "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. }, "insertionOrderId": "A String", # Output only. The unique ID of the insertion order. Assigned by the system. - "insertionOrderType": "A String", # The type of insertion order. If this field is unspecified in creation, the value defaults to `RTB`. - "integrationDetails": { # Integration details of an entry. # Additional integration details of the insertion order. + "insertionOrderType": "A String", # Optional. The type of insertion order. If this field is unspecified in creation, the value defaults to `RTB`. + "integrationDetails": { # Integration details of an entry. # Optional. Additional integration details of the insertion order. "details": "A String", # Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters. "integrationCode": "A String", # An external identifier to be associated with the entry. The integration code will show up together with the entry in many places in the system, for example, reporting. Must be UTF-8 encoded with a length of no more than 500 characters. }, @@ -1013,14 +1013,14 @@

Method Details

"kpiType": "A String", # Required. The type of KPI. }, "name": "A String", # Output only. The resource name of the insertion order. - "optimizationObjective": "A String", # Optional. The optimization objective of the insertion order. + "optimizationObjective": "A String", # Optional. Required. The optimization objective of the insertion order. "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the insertion order. pacing_type `PACING_TYPE_ASAP` is not compatible with pacing_period `PACING_PERIOD_FLIGHT`. "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0. "dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of advertiser's currency. Applicable when the budget is currency based. Must be greater than 0. For example, for 1.5 standard unit of the currency, set this field to 1500000. The value assigned will be rounded to whole billable units for the relevant currency by the following rules: any positive value less than a single billable unit will be rounded up to one billable unit and any value larger than a single billable unit will be rounded down to the nearest billable value. For example, if the currency's billable unit is 0.01, and this field is set to 10257770, it will round down to 10250000, a value of 10.25. If set to 505, it will round up to 10000, a value of 0.01. "pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent. When automatic budget allocation is enabled at the insertion order via automationType, this field is output only and defaults to `PACING_PERIOD_FLIGHT`. "pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be spent across the pacing_period. `PACING_TYPE_ASAP` is not compatible with pacing_period `PACING_PERIOD_FLIGHT` for insertion orders. }, - "partnerCosts": [ # The partner costs associated with the insertion order. If absent or empty in CreateInsertionOrder method, the newly created insertion order will inherit partner costs from the partner settings. + "partnerCosts": [ # Optional. The partner costs associated with the insertion order. If absent or empty in CreateInsertionOrder method, the newly created insertion order will inherit partner costs from the partner settings. { # Settings that control a partner cost. A partner cost is any type of expense involved in running a campaign, other than the costs of purchasing impressions (which is called the media cost) and using third-party audience segment data (data fee). Some examples of partner costs include the fees for using DV360, a third-party ad server, or a third-party ad serving verification service. "costType": "A String", # Required. The type of the partner cost. "feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency. Applicable when the fee_type is `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0. For example, for 1.5 standard unit of the advertiser's currency, set this field to 1500000. @@ -1044,18 +1044,18 @@

Method Details

{ # A single insertion order. "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. - "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # The bidding strategy of the insertion order. By default, fixed_bid is set. + "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, when performance_goal_type is one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , the line_item_type of the insertion order line items must be either: * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , and when performance_goal_type is either: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` the line_item_type of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy. "raiseBidForDeals": True or False, # Whether the strategy takes deal floor prices into account. }, "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. @@ -1068,11 +1068,11 @@

Method Details

}, }, "budget": { # Settings that control how insertion order budget is allocated. # Required. The budget allocation settings of the insertion order. - "automationType": "A String", # The type of automation used to manage bid and budget for the insertion order. If this field is unspecified in creation, the value defaults to `INSERTION_ORDER_AUTOMATION_TYPE_NONE`. + "automationType": "A String", # Optional. The type of automation used to manage bid and budget for the insertion order. If this field is unspecified in creation, the value defaults to `INSERTION_ORDER_AUTOMATION_TYPE_NONE`. "budgetSegments": [ # Required. The list of budget segments. Use a budget segment to specify a specific budget for a given period of time an insertion order is running. { # Settings that control the budget of a single budget segment. "budgetAmountMicros": "A String", # Required. The budget amount the insertion order will spend for the given date_range. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency. - "campaignBudgetId": "A String", # The budget_id of the campaign budget that this insertion order budget segment is a part of. + "campaignBudgetId": "A String", # Optional. The budget_id of the campaign budget that this insertion order budget segment is a part of. "dateRange": { # A date range. # Required. The start and end date settings of the budget segment. They are resolved relative to the parent advertiser's time zone. * When creating a new budget segment, both `start_date` and `end_date` must be in the future. * An existing budget segment with a `start_date` in the past has a mutable `end_date` but an immutable `start_date`. * `end_date` must be the `start_date` or later, both before the year 2037. "endDate": { # 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 # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`. "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. @@ -1085,7 +1085,7 @@

Method Details

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, }, - "description": "A String", # The budget segment description. It can be used to enter Purchase Order information for each budget segment and have that information printed on the invoices. Must be UTF-8 encoded. + "description": "A String", # Optional. The budget segment description. It can be used to enter Purchase Order information for each budget segment and have that information printed on the invoices. Must be UTF-8 encoded. }, ], "budgetUnit": "A String", # Required. Immutable. The budget unit specifies whether the budget is currency based or impression based. @@ -1093,16 +1093,16 @@

Method Details

"campaignId": "A String", # Required. Immutable. The unique ID of the campaign that the insertion order belongs to. "displayName": "A String", # Required. The display name of the insertion order. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not the insertion order can spend its budget and bid on inventory. * For CreateInsertionOrder method, only `ENTITY_STATUS_DRAFT` is allowed. To activate an insertion order, use UpdateInsertionOrder method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * An insertion order cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * An insertion order cannot be set to `ENTITY_STATUS_ACTIVE` if its parent campaign is not active. - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency capping setting of the insertion order. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency capping setting of the insertion order. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap) "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. - "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. - "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). + "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. }, "insertionOrderId": "A String", # Output only. The unique ID of the insertion order. Assigned by the system. - "insertionOrderType": "A String", # The type of insertion order. If this field is unspecified in creation, the value defaults to `RTB`. - "integrationDetails": { # Integration details of an entry. # Additional integration details of the insertion order. + "insertionOrderType": "A String", # Optional. The type of insertion order. If this field is unspecified in creation, the value defaults to `RTB`. + "integrationDetails": { # Integration details of an entry. # Optional. Additional integration details of the insertion order. "details": "A String", # Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters. "integrationCode": "A String", # An external identifier to be associated with the entry. The integration code will show up together with the entry in many places in the system, for example, reporting. Must be UTF-8 encoded with a length of no more than 500 characters. }, @@ -1114,14 +1114,14 @@

Method Details

"kpiType": "A String", # Required. The type of KPI. }, "name": "A String", # Output only. The resource name of the insertion order. - "optimizationObjective": "A String", # Optional. The optimization objective of the insertion order. + "optimizationObjective": "A String", # Optional. Required. The optimization objective of the insertion order. "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the insertion order. pacing_type `PACING_TYPE_ASAP` is not compatible with pacing_period `PACING_PERIOD_FLIGHT`. "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0. "dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of advertiser's currency. Applicable when the budget is currency based. Must be greater than 0. For example, for 1.5 standard unit of the currency, set this field to 1500000. The value assigned will be rounded to whole billable units for the relevant currency by the following rules: any positive value less than a single billable unit will be rounded up to one billable unit and any value larger than a single billable unit will be rounded down to the nearest billable value. For example, if the currency's billable unit is 0.01, and this field is set to 10257770, it will round down to 10250000, a value of 10.25. If set to 505, it will round up to 10000, a value of 0.01. "pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent. When automatic budget allocation is enabled at the insertion order via automationType, this field is output only and defaults to `PACING_PERIOD_FLIGHT`. "pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be spent across the pacing_period. `PACING_TYPE_ASAP` is not compatible with pacing_period `PACING_PERIOD_FLIGHT` for insertion orders. }, - "partnerCosts": [ # The partner costs associated with the insertion order. If absent or empty in CreateInsertionOrder method, the newly created insertion order will inherit partner costs from the partner settings. + "partnerCosts": [ # Optional. The partner costs associated with the insertion order. If absent or empty in CreateInsertionOrder method, the newly created insertion order will inherit partner costs from the partner settings. { # Settings that control a partner cost. A partner cost is any type of expense involved in running a campaign, other than the costs of purchasing impressions (which is called the media cost) and using third-party audience segment data (data fee). Some examples of partner costs include the fees for using DV360, a third-party ad server, or a third-party ad serving verification service. "costType": "A String", # Required. The type of the partner cost. "feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency. Applicable when the fee_type is `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0. For example, for 1.5 standard unit of the advertiser's currency, set this field to 1500000. diff --git a/docs/dyn/displayvideo_v3.advertisers.insertionOrders.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v3.advertisers.insertionOrders.targetingTypes.assignedTargetingOptions.html index 2f78a98d7e2..6ec208602ea 100644 --- a/docs/dyn/displayvideo_v3.advertisers.insertionOrders.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v3.advertisers.insertionOrders.targetingTypes.assignedTargetingOptions.html @@ -176,48 +176,48 @@

Method Details

}, "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts. "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` - "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. NEXT_ID: 9 # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. - "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. + "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # Optional. The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, - "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, ], }, - "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # The combined audience ids of the included combined audience group. Contains combined audience ids only. - "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. + "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only. + "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. { # Details of combined audience targeting setting. "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. }, ], }, - "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # The custom list ids of the included custom list group. Contains custom list ids only. - "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. + "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only. + "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored. { # Details of custom list targeting setting. "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id. }, ], }, - "includedFirstAndThirdPartyAudienceGroups": [ # The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with same settings will be ignored. + "includedFirstAndThirdPartyAudienceGroups": [ # Optional. The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored. { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, ], - "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the included Google audience group. Contains Google audience ids only. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, @@ -505,48 +505,48 @@

Method Details

}, "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts. "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` - "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. NEXT_ID: 9 # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. - "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. + "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # Optional. The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, - "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, ], }, - "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # The combined audience ids of the included combined audience group. Contains combined audience ids only. - "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. + "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only. + "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. { # Details of combined audience targeting setting. "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. }, ], }, - "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # The custom list ids of the included custom list group. Contains custom list ids only. - "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. + "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only. + "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored. { # Details of custom list targeting setting. "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id. }, ], }, - "includedFirstAndThirdPartyAudienceGroups": [ # The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with same settings will be ignored. + "includedFirstAndThirdPartyAudienceGroups": [ # Optional. The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored. { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, ], - "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the included Google audience group. Contains Google audience ids only. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, @@ -965,48 +965,48 @@

Method Details

}, "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts. "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` - "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. NEXT_ID: 9 # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. - "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. + "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # Optional. The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, - "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, ], }, - "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # The combined audience ids of the included combined audience group. Contains combined audience ids only. - "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. + "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only. + "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. { # Details of combined audience targeting setting. "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. }, ], }, - "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # The custom list ids of the included custom list group. Contains custom list ids only. - "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. + "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only. + "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored. { # Details of custom list targeting setting. "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id. }, ], }, - "includedFirstAndThirdPartyAudienceGroups": [ # The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with same settings will be ignored. + "includedFirstAndThirdPartyAudienceGroups": [ # Optional. The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored. { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, ], - "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the included Google audience group. Contains Google audience ids only. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, @@ -1359,48 +1359,48 @@

Method Details

}, "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts. "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` - "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. NEXT_ID: 9 # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. - "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. + "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # Optional. The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, - "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, ], }, - "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # The combined audience ids of the included combined audience group. Contains combined audience ids only. - "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. + "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only. + "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. { # Details of combined audience targeting setting. "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. }, ], }, - "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # The custom list ids of the included custom list group. Contains custom list ids only. - "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. + "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only. + "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored. { # Details of custom list targeting setting. "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id. }, ], }, - "includedFirstAndThirdPartyAudienceGroups": [ # The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with same settings will be ignored. + "includedFirstAndThirdPartyAudienceGroups": [ # Optional. The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored. { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, ], - "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the included Google audience group. Contains Google audience ids only. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, diff --git a/docs/dyn/displayvideo_v3.advertisers.lineItems.html b/docs/dyn/displayvideo_v3.advertisers.lineItems.html index 18c9f19939e..336b9a6ea21 100644 --- a/docs/dyn/displayvideo_v3.advertisers.lineItems.html +++ b/docs/dyn/displayvideo_v3.advertisers.lineItems.html @@ -149,48 +149,48 @@

Method Details

}, "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts. "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` - "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. NEXT_ID: 9 # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. - "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. + "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # Optional. The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, - "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, ], }, - "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # The combined audience ids of the included combined audience group. Contains combined audience ids only. - "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. + "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only. + "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. { # Details of combined audience targeting setting. "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. }, ], }, - "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # The custom list ids of the included custom list group. Contains custom list ids only. - "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. + "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only. + "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored. { # Details of custom list targeting setting. "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id. }, ], }, - "includedFirstAndThirdPartyAudienceGroups": [ # The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with same settings will be ignored. + "includedFirstAndThirdPartyAudienceGroups": [ # Optional. The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored. { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, ], - "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the included Google audience group. Contains Google audience ids only. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, @@ -537,48 +537,48 @@

Method Details

}, "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts. "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` - "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. NEXT_ID: 9 # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. - "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. + "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # Optional. The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, - "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, ], }, - "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # The combined audience ids of the included combined audience group. Contains combined audience ids only. - "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. + "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only. + "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. { # Details of combined audience targeting setting. "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. }, ], }, - "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # The custom list ids of the included custom list group. Contains custom list ids only. - "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. + "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only. + "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored. { # Details of custom list targeting setting. "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id. }, ], }, - "includedFirstAndThirdPartyAudienceGroups": [ # The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with same settings will be ignored. + "includedFirstAndThirdPartyAudienceGroups": [ # Optional. The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored. { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, ], - "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the included Google audience group. Contains Google audience ids only. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, @@ -881,13 +881,13 @@

Method Details

"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, when performance_goal_type is one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , the line_item_type of the insertion order line items must be either: * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , and when performance_goal_type is either: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` the line_item_type of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy. "raiseBidForDeals": True or False, # Whether the strategy takes deal floor prices into account. }, "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. @@ -905,8 +905,8 @@

Method Details

"maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. }, "campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to. - "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item. - "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. + "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item. *Warning*: Starting **April 1, 2025**, the floodlight_activity_configs field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). + "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. *Warning*: Starting **April 1, 2025**, this field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). { # Settings that control the behavior of a single Floodlight activity config. "floodlightActivityId": "A String", # Required. The ID of the Floodlight activity. "postClickLookbackWindowDays": 42, # Required. The number of days after an ad has been clicked in which a conversion may be counted. Must be between 0 and 90 inclusive. @@ -936,11 +936,11 @@

Method Details

}, "flightDateType": "A String", # Required. The type of the line item's flight dates. }, - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap) "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. - "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. - "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). + "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. }, "insertionOrderId": "A String", # Required. Immutable. The unique ID of the insertion order that the line item belongs to. @@ -980,7 +980,7 @@

Method Details

"targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. "audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. - "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` + "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` *Warning*: Starting **March 6, 2025**, this field will stop being compatible when using the BiddingStrategy field fixed_bid. [Read more about this announced change](/display-video/api/deprecations#features.ot_fixed_bid) }, "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. @@ -1041,11 +1041,11 @@

Method Details

}, ], }, - "viewFrequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # The view frequency cap settings of the line item. The max_views field in this settings object must be used if assigning a limited cap. + "viewFrequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # The view frequency cap settings of the line item. The max_views field in this settings object must be used if assigning a limited cap. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap) "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. - "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. - "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). + "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. }, }, @@ -1106,13 +1106,13 @@

Method Details

"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, when performance_goal_type is one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , the line_item_type of the insertion order line items must be either: * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , and when performance_goal_type is either: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` the line_item_type of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy. "raiseBidForDeals": True or False, # Whether the strategy takes deal floor prices into account. }, "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. @@ -1130,8 +1130,8 @@

Method Details

"maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. }, "campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to. - "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item. - "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. + "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item. *Warning*: Starting **April 1, 2025**, the floodlight_activity_configs field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). + "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. *Warning*: Starting **April 1, 2025**, this field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). { # Settings that control the behavior of a single Floodlight activity config. "floodlightActivityId": "A String", # Required. The ID of the Floodlight activity. "postClickLookbackWindowDays": 42, # Required. The number of days after an ad has been clicked in which a conversion may be counted. Must be between 0 and 90 inclusive. @@ -1161,11 +1161,11 @@

Method Details

}, "flightDateType": "A String", # Required. The type of the line item's flight dates. }, - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap) "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. - "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. - "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). + "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. }, "insertionOrderId": "A String", # Required. Immutable. The unique ID of the insertion order that the line item belongs to. @@ -1205,7 +1205,7 @@

Method Details

"targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. "audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. - "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` + "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` *Warning*: Starting **March 6, 2025**, this field will stop being compatible when using the BiddingStrategy field fixed_bid. [Read more about this announced change](/display-video/api/deprecations#features.ot_fixed_bid) }, "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. @@ -1266,11 +1266,11 @@

Method Details

}, ], }, - "viewFrequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # The view frequency cap settings of the line item. The max_views field in this settings object must be used if assigning a limited cap. + "viewFrequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # The view frequency cap settings of the line item. The max_views field in this settings object must be used if assigning a limited cap. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap) "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. - "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. - "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). + "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. }, }, @@ -1291,13 +1291,13 @@

Method Details

"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, when performance_goal_type is one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , the line_item_type of the insertion order line items must be either: * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , and when performance_goal_type is either: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` the line_item_type of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy. "raiseBidForDeals": True or False, # Whether the strategy takes deal floor prices into account. }, "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. @@ -1315,8 +1315,8 @@

Method Details

"maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. }, "campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to. - "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item. - "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. + "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item. *Warning*: Starting **April 1, 2025**, the floodlight_activity_configs field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). + "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. *Warning*: Starting **April 1, 2025**, this field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). { # Settings that control the behavior of a single Floodlight activity config. "floodlightActivityId": "A String", # Required. The ID of the Floodlight activity. "postClickLookbackWindowDays": 42, # Required. The number of days after an ad has been clicked in which a conversion may be counted. Must be between 0 and 90 inclusive. @@ -1346,11 +1346,11 @@

Method Details

}, "flightDateType": "A String", # Required. The type of the line item's flight dates. }, - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap) "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. - "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. - "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). + "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. }, "insertionOrderId": "A String", # Required. Immutable. The unique ID of the insertion order that the line item belongs to. @@ -1390,7 +1390,7 @@

Method Details

"targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. "audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. - "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` + "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` *Warning*: Starting **March 6, 2025**, this field will stop being compatible when using the BiddingStrategy field fixed_bid. [Read more about this announced change](/display-video/api/deprecations#features.ot_fixed_bid) }, "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. @@ -1451,11 +1451,11 @@

Method Details

}, ], }, - "viewFrequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # The view frequency cap settings of the line item. The max_views field in this settings object must be used if assigning a limited cap. + "viewFrequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # The view frequency cap settings of the line item. The max_views field in this settings object must be used if assigning a limited cap. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap) "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. - "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. - "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). + "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. }, }, @@ -1544,13 +1544,13 @@

Method Details

"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, when performance_goal_type is one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , the line_item_type of the insertion order line items must be either: * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , and when performance_goal_type is either: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` the line_item_type of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy. "raiseBidForDeals": True or False, # Whether the strategy takes deal floor prices into account. }, "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. @@ -1568,8 +1568,8 @@

Method Details

"maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. }, "campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to. - "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item. - "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. + "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item. *Warning*: Starting **April 1, 2025**, the floodlight_activity_configs field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). + "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. *Warning*: Starting **April 1, 2025**, this field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). { # Settings that control the behavior of a single Floodlight activity config. "floodlightActivityId": "A String", # Required. The ID of the Floodlight activity. "postClickLookbackWindowDays": 42, # Required. The number of days after an ad has been clicked in which a conversion may be counted. Must be between 0 and 90 inclusive. @@ -1599,11 +1599,11 @@

Method Details

}, "flightDateType": "A String", # Required. The type of the line item's flight dates. }, - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap) "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. - "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. - "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). + "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. }, "insertionOrderId": "A String", # Required. Immutable. The unique ID of the insertion order that the line item belongs to. @@ -1643,7 +1643,7 @@

Method Details

"targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. "audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. - "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` + "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` *Warning*: Starting **March 6, 2025**, this field will stop being compatible when using the BiddingStrategy field fixed_bid. [Read more about this announced change](/display-video/api/deprecations#features.ot_fixed_bid) }, "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. @@ -1704,11 +1704,11 @@

Method Details

}, ], }, - "viewFrequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # The view frequency cap settings of the line item. The max_views field in this settings object must be used if assigning a limited cap. + "viewFrequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # The view frequency cap settings of the line item. The max_views field in this settings object must be used if assigning a limited cap. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap) "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. - "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. - "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). + "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. }, }, @@ -1737,13 +1737,13 @@

Method Details

"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, when performance_goal_type is one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , the line_item_type of the insertion order line items must be either: * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , and when performance_goal_type is either: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` the line_item_type of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy. "raiseBidForDeals": True or False, # Whether the strategy takes deal floor prices into account. }, "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. @@ -1761,8 +1761,8 @@

Method Details

"maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. }, "campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to. - "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item. - "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. + "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item. *Warning*: Starting **April 1, 2025**, the floodlight_activity_configs field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). + "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. *Warning*: Starting **April 1, 2025**, this field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). { # Settings that control the behavior of a single Floodlight activity config. "floodlightActivityId": "A String", # Required. The ID of the Floodlight activity. "postClickLookbackWindowDays": 42, # Required. The number of days after an ad has been clicked in which a conversion may be counted. Must be between 0 and 90 inclusive. @@ -1792,11 +1792,11 @@

Method Details

}, "flightDateType": "A String", # Required. The type of the line item's flight dates. }, - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap) "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. - "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. - "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). + "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. }, "insertionOrderId": "A String", # Required. Immutable. The unique ID of the insertion order that the line item belongs to. @@ -1836,7 +1836,7 @@

Method Details

"targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. "audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. - "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` + "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` *Warning*: Starting **March 6, 2025**, this field will stop being compatible when using the BiddingStrategy field fixed_bid. [Read more about this announced change](/display-video/api/deprecations#features.ot_fixed_bid) }, "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. @@ -1897,11 +1897,11 @@

Method Details

}, ], }, - "viewFrequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # The view frequency cap settings of the line item. The max_views field in this settings object must be used if assigning a limited cap. + "viewFrequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # The view frequency cap settings of the line item. The max_views field in this settings object must be used if assigning a limited cap. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap) "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. - "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. - "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). + "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. }, }, @@ -1935,13 +1935,13 @@

Method Details

"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, when performance_goal_type is one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , the line_item_type of the insertion order line items must be either: * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , and when performance_goal_type is either: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` the line_item_type of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy. "raiseBidForDeals": True or False, # Whether the strategy takes deal floor prices into account. }, "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. @@ -1959,8 +1959,8 @@

Method Details

"maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. }, "campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to. - "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item. - "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. + "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item. *Warning*: Starting **April 1, 2025**, the floodlight_activity_configs field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). + "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. *Warning*: Starting **April 1, 2025**, this field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). { # Settings that control the behavior of a single Floodlight activity config. "floodlightActivityId": "A String", # Required. The ID of the Floodlight activity. "postClickLookbackWindowDays": 42, # Required. The number of days after an ad has been clicked in which a conversion may be counted. Must be between 0 and 90 inclusive. @@ -1990,11 +1990,11 @@

Method Details

}, "flightDateType": "A String", # Required. The type of the line item's flight dates. }, - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap) "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. - "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. - "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). + "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. }, "insertionOrderId": "A String", # Required. Immutable. The unique ID of the insertion order that the line item belongs to. @@ -2034,7 +2034,7 @@

Method Details

"targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. "audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. - "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` + "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` *Warning*: Starting **March 6, 2025**, this field will stop being compatible when using the BiddingStrategy field fixed_bid. [Read more about this announced change](/display-video/api/deprecations#features.ot_fixed_bid) }, "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. @@ -2095,11 +2095,11 @@

Method Details

}, ], }, - "viewFrequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # The view frequency cap settings of the line item. The max_views field in this settings object must be used if assigning a limited cap. + "viewFrequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # The view frequency cap settings of the line item. The max_views field in this settings object must be used if assigning a limited cap. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap) "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. - "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. - "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). + "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. }, }, @@ -2140,13 +2140,13 @@

Method Details

"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, when performance_goal_type is one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , the line_item_type of the insertion order line items must be either: * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , and when performance_goal_type is either: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` the line_item_type of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy. "raiseBidForDeals": True or False, # Whether the strategy takes deal floor prices into account. }, "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. @@ -2164,8 +2164,8 @@

Method Details

"maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. }, "campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to. - "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item. - "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. + "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item. *Warning*: Starting **April 1, 2025**, the floodlight_activity_configs field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). + "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. *Warning*: Starting **April 1, 2025**, this field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). { # Settings that control the behavior of a single Floodlight activity config. "floodlightActivityId": "A String", # Required. The ID of the Floodlight activity. "postClickLookbackWindowDays": 42, # Required. The number of days after an ad has been clicked in which a conversion may be counted. Must be between 0 and 90 inclusive. @@ -2195,11 +2195,11 @@

Method Details

}, "flightDateType": "A String", # Required. The type of the line item's flight dates. }, - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap) "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. - "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. - "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). + "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. }, "insertionOrderId": "A String", # Required. Immutable. The unique ID of the insertion order that the line item belongs to. @@ -2239,7 +2239,7 @@

Method Details

"targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. "audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. - "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` + "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` *Warning*: Starting **March 6, 2025**, this field will stop being compatible when using the BiddingStrategy field fixed_bid. [Read more about this announced change](/display-video/api/deprecations#features.ot_fixed_bid) }, "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. @@ -2300,11 +2300,11 @@

Method Details

}, ], }, - "viewFrequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # The view frequency cap settings of the line item. The max_views field in this settings object must be used if assigning a limited cap. + "viewFrequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # The view frequency cap settings of the line item. The max_views field in this settings object must be used if assigning a limited cap. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap) "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. - "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. - "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). + "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. }, }, @@ -2326,13 +2326,13 @@

Method Details

"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, when performance_goal_type is one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , the line_item_type of the insertion order line items must be either: * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , and when performance_goal_type is either: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` the line_item_type of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy. "raiseBidForDeals": True or False, # Whether the strategy takes deal floor prices into account. }, "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity. - "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. @@ -2350,8 +2350,8 @@

Method Details

"maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. }, "campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to. - "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item. - "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. + "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item. *Warning*: Starting **April 1, 2025**, the floodlight_activity_configs field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). + "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. *Warning*: Starting **April 1, 2025**, this field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). { # Settings that control the behavior of a single Floodlight activity config. "floodlightActivityId": "A String", # Required. The ID of the Floodlight activity. "postClickLookbackWindowDays": 42, # Required. The number of days after an ad has been clicked in which a conversion may be counted. Must be between 0 and 90 inclusive. @@ -2381,11 +2381,11 @@

Method Details

}, "flightDateType": "A String", # Required. The type of the line item's flight dates. }, - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap) "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. - "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. - "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). + "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. }, "insertionOrderId": "A String", # Required. Immutable. The unique ID of the insertion order that the line item belongs to. @@ -2425,7 +2425,7 @@

Method Details

"targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. "audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. - "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` + "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` *Warning*: Starting **March 6, 2025**, this field will stop being compatible when using the BiddingStrategy field fixed_bid. [Read more about this announced change](/display-video/api/deprecations#features.ot_fixed_bid) }, "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. @@ -2486,11 +2486,11 @@

Method Details

}, ], }, - "viewFrequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # The view frequency cap settings of the line item. The max_views field in this settings object must be used if assigning a limited cap. + "viewFrequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # The view frequency cap settings of the line item. The max_views field in this settings object must be used if assigning a limited cap. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap) "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. - "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. - "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). + "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap). "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. }, }, diff --git a/docs/dyn/displayvideo_v3.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v3.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html index a8b41350c55..30ed655dd43 100644 --- a/docs/dyn/displayvideo_v3.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v3.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html @@ -176,48 +176,48 @@

Method Details

}, "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts. "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` - "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. NEXT_ID: 9 # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. - "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. + "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # Optional. The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, - "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, ], }, - "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # The combined audience ids of the included combined audience group. Contains combined audience ids only. - "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. + "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only. + "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. { # Details of combined audience targeting setting. "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. }, ], }, - "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # The custom list ids of the included custom list group. Contains custom list ids only. - "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. + "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only. + "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored. { # Details of custom list targeting setting. "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id. }, ], }, - "includedFirstAndThirdPartyAudienceGroups": [ # The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with same settings will be ignored. + "includedFirstAndThirdPartyAudienceGroups": [ # Optional. The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored. { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, ], - "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the included Google audience group. Contains Google audience ids only. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, @@ -505,48 +505,48 @@

Method Details

}, "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts. "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` - "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. NEXT_ID: 9 # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. - "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. + "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # Optional. The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, - "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, ], }, - "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # The combined audience ids of the included combined audience group. Contains combined audience ids only. - "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. + "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only. + "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. { # Details of combined audience targeting setting. "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. }, ], }, - "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # The custom list ids of the included custom list group. Contains custom list ids only. - "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. + "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only. + "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored. { # Details of custom list targeting setting. "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id. }, ], }, - "includedFirstAndThirdPartyAudienceGroups": [ # The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with same settings will be ignored. + "includedFirstAndThirdPartyAudienceGroups": [ # Optional. The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored. { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, ], - "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the included Google audience group. Contains Google audience ids only. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, @@ -965,48 +965,48 @@

Method Details

}, "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts. "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` - "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. NEXT_ID: 9 # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. - "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. + "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # Optional. The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, - "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, ], }, - "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # The combined audience ids of the included combined audience group. Contains combined audience ids only. - "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. + "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only. + "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. { # Details of combined audience targeting setting. "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. }, ], }, - "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # The custom list ids of the included custom list group. Contains custom list ids only. - "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. + "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only. + "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored. { # Details of custom list targeting setting. "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id. }, ], }, - "includedFirstAndThirdPartyAudienceGroups": [ # The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with same settings will be ignored. + "includedFirstAndThirdPartyAudienceGroups": [ # Optional. The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored. { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, ], - "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the included Google audience group. Contains Google audience ids only. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, @@ -1359,48 +1359,48 @@

Method Details

}, "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts. "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` - "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. NEXT_ID: 9 # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. - "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. + "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # Optional. The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, - "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, ], }, - "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # The combined audience ids of the included combined audience group. Contains combined audience ids only. - "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. + "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only. + "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. { # Details of combined audience targeting setting. "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. }, ], }, - "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # The custom list ids of the included custom list group. Contains custom list ids only. - "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. + "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only. + "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored. { # Details of custom list targeting setting. "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id. }, ], }, - "includedFirstAndThirdPartyAudienceGroups": [ # The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with same settings will be ignored. + "includedFirstAndThirdPartyAudienceGroups": [ # Optional. The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored. { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, ], - "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the included Google audience group. Contains Google audience ids only. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, diff --git a/docs/dyn/displayvideo_v3.advertisers.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v3.advertisers.targetingTypes.assignedTargetingOptions.html index 1a40f66ec18..562bfd325eb 100644 --- a/docs/dyn/displayvideo_v3.advertisers.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v3.advertisers.targetingTypes.assignedTargetingOptions.html @@ -175,48 +175,48 @@

Method Details

}, "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts. "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` - "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. NEXT_ID: 9 # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. - "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. + "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # Optional. The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, - "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, ], }, - "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # The combined audience ids of the included combined audience group. Contains combined audience ids only. - "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. + "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only. + "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. { # Details of combined audience targeting setting. "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. }, ], }, - "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # The custom list ids of the included custom list group. Contains custom list ids only. - "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. + "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only. + "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored. { # Details of custom list targeting setting. "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id. }, ], }, - "includedFirstAndThirdPartyAudienceGroups": [ # The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with same settings will be ignored. + "includedFirstAndThirdPartyAudienceGroups": [ # Optional. The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored. { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, ], - "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the included Google audience group. Contains Google audience ids only. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, @@ -504,48 +504,48 @@

Method Details

}, "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts. "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` - "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. NEXT_ID: 9 # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. - "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. + "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # Optional. The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, - "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, ], }, - "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # The combined audience ids of the included combined audience group. Contains combined audience ids only. - "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. + "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only. + "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. { # Details of combined audience targeting setting. "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. }, ], }, - "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # The custom list ids of the included custom list group. Contains custom list ids only. - "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. + "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only. + "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored. { # Details of custom list targeting setting. "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id. }, ], }, - "includedFirstAndThirdPartyAudienceGroups": [ # The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with same settings will be ignored. + "includedFirstAndThirdPartyAudienceGroups": [ # Optional. The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored. { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, ], - "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the included Google audience group. Contains Google audience ids only. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, @@ -962,48 +962,48 @@

Method Details

}, "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts. "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` - "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. NEXT_ID: 9 # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. - "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. + "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # Optional. The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, - "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, ], }, - "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # The combined audience ids of the included combined audience group. Contains combined audience ids only. - "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. + "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only. + "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. { # Details of combined audience targeting setting. "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. }, ], }, - "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # The custom list ids of the included custom list group. Contains custom list ids only. - "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. + "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only. + "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored. { # Details of custom list targeting setting. "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id. }, ], }, - "includedFirstAndThirdPartyAudienceGroups": [ # The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with same settings will be ignored. + "includedFirstAndThirdPartyAudienceGroups": [ # Optional. The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored. { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, ], - "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the included Google audience group. Contains Google audience ids only. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, @@ -1355,48 +1355,48 @@

Method Details

}, "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts. "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` - "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. NEXT_ID: 9 # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. - "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. + "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # Optional. The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, - "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, ], }, - "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # The combined audience ids of the included combined audience group. Contains combined audience ids only. - "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. + "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only. + "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. { # Details of combined audience targeting setting. "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. }, ], }, - "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # The custom list ids of the included custom list group. Contains custom list ids only. - "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. + "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only. + "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored. { # Details of custom list targeting setting. "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id. }, ], }, - "includedFirstAndThirdPartyAudienceGroups": [ # The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with same settings will be ignored. + "includedFirstAndThirdPartyAudienceGroups": [ # Optional. The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored. { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, ], - "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the included Google audience group. Contains Google audience ids only. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, diff --git a/docs/dyn/displayvideo_v3.customBiddingAlgorithms.html b/docs/dyn/displayvideo_v3.customBiddingAlgorithms.html index 8b9fa541964..3805e9ace64 100644 --- a/docs/dyn/displayvideo_v3.customBiddingAlgorithms.html +++ b/docs/dyn/displayvideo_v3.customBiddingAlgorithms.html @@ -101,7 +101,7 @@

Instance Methods

Retrieves the next page of results.

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

-

Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful.

+

Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful. *Warning*: Starting **April 1, 2025**, requests updating custom bidding algorithms that are assigned to line items will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).

uploadRules(customBiddingAlgorithmId, advertiserId=None, partnerId=None, x__xgafv=None)

Creates a rules reference object for an AlgorithmRules file. The resulting reference object provides a resource path where the AlgorithmRules file should be uploaded. This reference object should be included when creating a new CustomBiddingAlgorithmRules resource.

@@ -269,7 +269,7 @@

Method Details

patch(customBiddingAlgorithmId, body=None, updateMask=None, x__xgafv=None) -
Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful.
+  
Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful. *Warning*: Starting **April 1, 2025**, requests updating custom bidding algorithms that are assigned to line items will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).
 
 Args:
   customBiddingAlgorithmId: string, Output only. The unique ID of the custom bidding algorithm. Assigned by the system. (required)
diff --git a/docs/dyn/displayvideo_v3.customBiddingAlgorithms.rules.html b/docs/dyn/displayvideo_v3.customBiddingAlgorithms.rules.html
index 4e847d50242..84949c28e8d 100644
--- a/docs/dyn/displayvideo_v3.customBiddingAlgorithms.rules.html
+++ b/docs/dyn/displayvideo_v3.customBiddingAlgorithms.rules.html
@@ -79,7 +79,7 @@ 

Instance Methods

Close httplib2 connections.

create(customBiddingAlgorithmId, advertiserId=None, body=None, partnerId=None, x__xgafv=None)

-

Creates a new rules resource. Returns the newly created rules resource if successful.

+

Creates a new rules resource. Returns the newly created rules resource if successful. *Warning*: Starting **April 1, 2025**, requests updating custom bidding algorithms that are assigned to line items will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).

get(customBiddingAlgorithmId, customBiddingAlgorithmRulesId, advertiserId=None, partnerId=None, x__xgafv=None)

Retrieves a rules resource.

@@ -97,7 +97,7 @@

Method Details

create(customBiddingAlgorithmId, advertiserId=None, body=None, partnerId=None, x__xgafv=None) -
Creates a new rules resource. Returns the newly created rules resource if successful.
+  
Creates a new rules resource. Returns the newly created rules resource if successful. *Warning*: Starting **April 1, 2025**, requests updating custom bidding algorithms that are assigned to line items will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).
 
 Args:
   customBiddingAlgorithmId: string, Required. The ID of the custom bidding algorithm that owns the rules resource. (required)
diff --git a/docs/dyn/displayvideo_v3.customBiddingAlgorithms.scripts.html b/docs/dyn/displayvideo_v3.customBiddingAlgorithms.scripts.html
index 9cca0614003..36478f13069 100644
--- a/docs/dyn/displayvideo_v3.customBiddingAlgorithms.scripts.html
+++ b/docs/dyn/displayvideo_v3.customBiddingAlgorithms.scripts.html
@@ -79,7 +79,7 @@ 

Instance Methods

Close httplib2 connections.

create(customBiddingAlgorithmId, advertiserId=None, body=None, partnerId=None, x__xgafv=None)

-

Creates a new custom bidding script. Returns the newly created script if successful.

+

Creates a new custom bidding script. Returns the newly created script if successful. *Warning*: Starting **April 1, 2025**, requests updating custom bidding algorithms that are assigned to line items will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).

get(customBiddingAlgorithmId, customBiddingScriptId, advertiserId=None, partnerId=None, x__xgafv=None)

Gets a custom bidding script.

@@ -97,7 +97,7 @@

Method Details

create(customBiddingAlgorithmId, advertiserId=None, body=None, partnerId=None, x__xgafv=None) -
Creates a new custom bidding script. Returns the newly created script if successful.
+  
Creates a new custom bidding script. Returns the newly created script if successful. *Warning*: Starting **April 1, 2025**, requests updating custom bidding algorithms that are assigned to line items will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).
 
 Args:
   customBiddingAlgorithmId: string, Required. The ID of the custom bidding algorithm that owns the script. (required)
diff --git a/docs/dyn/displayvideo_v3.firstAndThirdPartyAudiences.html b/docs/dyn/displayvideo_v3.firstAndThirdPartyAudiences.html
index deb47e2ae72..089e3ec3694 100644
--- a/docs/dyn/displayvideo_v3.firstAndThirdPartyAudiences.html
+++ b/docs/dyn/displayvideo_v3.firstAndThirdPartyAudiences.html
@@ -145,7 +145,7 @@ 

Method Details

"firstAndThirdPartyAudienceId": "A String", # Output only. The unique ID of the first and third party audience. Assigned by the system. "firstAndThirdPartyAudienceType": "A String", # Whether the audience is a first or third party audience. "gmailAudienceSize": "A String", # Output only. The estimated audience size for Gmail network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request. - "membershipDurationDays": "A String", # The duration in days that an entry remains in the audience after the qualifying event. If the audience has no expiration, set the value of this field to 10000. Otherwise, the set value must be greater than 0 and less than or equal to 540. Only applicable to first party audiences. This field is required if one of the following audience_type is used: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID` + "membershipDurationDays": "A String", # The duration in days that an entry remains in the audience after the qualifying event. If the audience has no expiration, set the value of this field to 10000. Otherwise, the set value must be greater than 0 and less than or equal to 540. Only applicable to first party audiences. This field is required if one of the following audience_type is used: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID` *Warning*: Starting on **April 7, 2025**, audiences will no longer be able to have infinite membership duration. This field will no longer accept the value 10000 and all audiences with membership durations greater than 540 days will be updated to a membership duration of 540 days. [Read more about this announced change](/display-video/api/deprecations#features.audience_duration). "mobileDeviceIdList": { # Wrapper message for a list of mobile device IDs defining Customer Match audience members. # Input only. A list of mobile device IDs to define the initial audience members. Only applicable to audience_type `CUSTOMER_MATCH_DEVICE_ID` "consent": { # User consent status. # Input only. The consent setting for the users in mobile_device_ids. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error. "adPersonalization": "A String", # Represents consent for ad personalization. @@ -204,7 +204,7 @@

Method Details

"firstAndThirdPartyAudienceId": "A String", # Output only. The unique ID of the first and third party audience. Assigned by the system. "firstAndThirdPartyAudienceType": "A String", # Whether the audience is a first or third party audience. "gmailAudienceSize": "A String", # Output only. The estimated audience size for Gmail network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request. - "membershipDurationDays": "A String", # The duration in days that an entry remains in the audience after the qualifying event. If the audience has no expiration, set the value of this field to 10000. Otherwise, the set value must be greater than 0 and less than or equal to 540. Only applicable to first party audiences. This field is required if one of the following audience_type is used: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID` + "membershipDurationDays": "A String", # The duration in days that an entry remains in the audience after the qualifying event. If the audience has no expiration, set the value of this field to 10000. Otherwise, the set value must be greater than 0 and less than or equal to 540. Only applicable to first party audiences. This field is required if one of the following audience_type is used: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID` *Warning*: Starting on **April 7, 2025**, audiences will no longer be able to have infinite membership duration. This field will no longer accept the value 10000 and all audiences with membership durations greater than 540 days will be updated to a membership duration of 540 days. [Read more about this announced change](/display-video/api/deprecations#features.audience_duration). "mobileDeviceIdList": { # Wrapper message for a list of mobile device IDs defining Customer Match audience members. # Input only. A list of mobile device IDs to define the initial audience members. Only applicable to audience_type `CUSTOMER_MATCH_DEVICE_ID` "consent": { # User consent status. # Input only. The consent setting for the users in mobile_device_ids. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error. "adPersonalization": "A String", # Represents consent for ad personalization. @@ -359,7 +359,7 @@

Method Details

"firstAndThirdPartyAudienceId": "A String", # Output only. The unique ID of the first and third party audience. Assigned by the system. "firstAndThirdPartyAudienceType": "A String", # Whether the audience is a first or third party audience. "gmailAudienceSize": "A String", # Output only. The estimated audience size for Gmail network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request. - "membershipDurationDays": "A String", # The duration in days that an entry remains in the audience after the qualifying event. If the audience has no expiration, set the value of this field to 10000. Otherwise, the set value must be greater than 0 and less than or equal to 540. Only applicable to first party audiences. This field is required if one of the following audience_type is used: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID` + "membershipDurationDays": "A String", # The duration in days that an entry remains in the audience after the qualifying event. If the audience has no expiration, set the value of this field to 10000. Otherwise, the set value must be greater than 0 and less than or equal to 540. Only applicable to first party audiences. This field is required if one of the following audience_type is used: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID` *Warning*: Starting on **April 7, 2025**, audiences will no longer be able to have infinite membership duration. This field will no longer accept the value 10000 and all audiences with membership durations greater than 540 days will be updated to a membership duration of 540 days. [Read more about this announced change](/display-video/api/deprecations#features.audience_duration). "mobileDeviceIdList": { # Wrapper message for a list of mobile device IDs defining Customer Match audience members. # Input only. A list of mobile device IDs to define the initial audience members. Only applicable to audience_type `CUSTOMER_MATCH_DEVICE_ID` "consent": { # User consent status. # Input only. The consent setting for the users in mobile_device_ids. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error. "adPersonalization": "A String", # Represents consent for ad personalization. @@ -382,7 +382,7 @@

Method Details

advertiserId: string, The ID of the advertiser that has access to the fetched first and third party audiences. filter: string, Allows filtering by first and third party audience fields. Supported syntax: * Filter expressions for first and third party audiences can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All first and third party audiences for which the display name contains "Google": `displayName:"Google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. orderBy: string, Field by which to sort the list. Acceptable values are: * `firstAndThirdPartyAudienceId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. - pageSize: integer, Requested page size. Must be between `1` and `5000`. If unspecified, this value defaults to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + pageSize: integer, Requested page size. Must be between `1` and `5000`. If unspecified, this value defaults to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. *Warning*: Starting **March 6, 2025**, this value will default to `5000` if not set. pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListFirstAndThirdPartyAudiences` method. If not specified, the first page of results will be returned. partnerId: string, The ID of the partner that has access to the fetched first and third party audiences. x__xgafv: string, V1 error format. @@ -431,7 +431,7 @@

Method Details

"firstAndThirdPartyAudienceId": "A String", # Output only. The unique ID of the first and third party audience. Assigned by the system. "firstAndThirdPartyAudienceType": "A String", # Whether the audience is a first or third party audience. "gmailAudienceSize": "A String", # Output only. The estimated audience size for Gmail network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request. - "membershipDurationDays": "A String", # The duration in days that an entry remains in the audience after the qualifying event. If the audience has no expiration, set the value of this field to 10000. Otherwise, the set value must be greater than 0 and less than or equal to 540. Only applicable to first party audiences. This field is required if one of the following audience_type is used: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID` + "membershipDurationDays": "A String", # The duration in days that an entry remains in the audience after the qualifying event. If the audience has no expiration, set the value of this field to 10000. Otherwise, the set value must be greater than 0 and less than or equal to 540. Only applicable to first party audiences. This field is required if one of the following audience_type is used: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID` *Warning*: Starting on **April 7, 2025**, audiences will no longer be able to have infinite membership duration. This field will no longer accept the value 10000 and all audiences with membership durations greater than 540 days will be updated to a membership duration of 540 days. [Read more about this announced change](/display-video/api/deprecations#features.audience_duration). "mobileDeviceIdList": { # Wrapper message for a list of mobile device IDs defining Customer Match audience members. # Input only. A list of mobile device IDs to define the initial audience members. Only applicable to audience_type `CUSTOMER_MATCH_DEVICE_ID` "consent": { # User consent status. # Input only. The consent setting for the users in mobile_device_ids. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error. "adPersonalization": "A String", # Represents consent for ad personalization. @@ -508,7 +508,7 @@

Method Details

"firstAndThirdPartyAudienceId": "A String", # Output only. The unique ID of the first and third party audience. Assigned by the system. "firstAndThirdPartyAudienceType": "A String", # Whether the audience is a first or third party audience. "gmailAudienceSize": "A String", # Output only. The estimated audience size for Gmail network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request. - "membershipDurationDays": "A String", # The duration in days that an entry remains in the audience after the qualifying event. If the audience has no expiration, set the value of this field to 10000. Otherwise, the set value must be greater than 0 and less than or equal to 540. Only applicable to first party audiences. This field is required if one of the following audience_type is used: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID` + "membershipDurationDays": "A String", # The duration in days that an entry remains in the audience after the qualifying event. If the audience has no expiration, set the value of this field to 10000. Otherwise, the set value must be greater than 0 and less than or equal to 540. Only applicable to first party audiences. This field is required if one of the following audience_type is used: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID` *Warning*: Starting on **April 7, 2025**, audiences will no longer be able to have infinite membership duration. This field will no longer accept the value 10000 and all audiences with membership durations greater than 540 days will be updated to a membership duration of 540 days. [Read more about this announced change](/display-video/api/deprecations#features.audience_duration). "mobileDeviceIdList": { # Wrapper message for a list of mobile device IDs defining Customer Match audience members. # Input only. A list of mobile device IDs to define the initial audience members. Only applicable to audience_type `CUSTOMER_MATCH_DEVICE_ID` "consent": { # User consent status. # Input only. The consent setting for the users in mobile_device_ids. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error. "adPersonalization": "A String", # Represents consent for ad personalization. @@ -568,7 +568,7 @@

Method Details

"firstAndThirdPartyAudienceId": "A String", # Output only. The unique ID of the first and third party audience. Assigned by the system. "firstAndThirdPartyAudienceType": "A String", # Whether the audience is a first or third party audience. "gmailAudienceSize": "A String", # Output only. The estimated audience size for Gmail network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request. - "membershipDurationDays": "A String", # The duration in days that an entry remains in the audience after the qualifying event. If the audience has no expiration, set the value of this field to 10000. Otherwise, the set value must be greater than 0 and less than or equal to 540. Only applicable to first party audiences. This field is required if one of the following audience_type is used: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID` + "membershipDurationDays": "A String", # The duration in days that an entry remains in the audience after the qualifying event. If the audience has no expiration, set the value of this field to 10000. Otherwise, the set value must be greater than 0 and less than or equal to 540. Only applicable to first party audiences. This field is required if one of the following audience_type is used: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID` *Warning*: Starting on **April 7, 2025**, audiences will no longer be able to have infinite membership duration. This field will no longer accept the value 10000 and all audiences with membership durations greater than 540 days will be updated to a membership duration of 540 days. [Read more about this announced change](/display-video/api/deprecations#features.audience_duration). "mobileDeviceIdList": { # Wrapper message for a list of mobile device IDs defining Customer Match audience members. # Input only. A list of mobile device IDs to define the initial audience members. Only applicable to audience_type `CUSTOMER_MATCH_DEVICE_ID` "consent": { # User consent status. # Input only. The consent setting for the users in mobile_device_ids. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error. "adPersonalization": "A String", # Represents consent for ad personalization. diff --git a/docs/dyn/displayvideo_v3.partners.html b/docs/dyn/displayvideo_v3.partners.html index f48aa5a7f7a..2aa7835e10d 100644 --- a/docs/dyn/displayvideo_v3.partners.html +++ b/docs/dyn/displayvideo_v3.partners.html @@ -135,48 +135,48 @@

Method Details

}, "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts. "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` - "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. NEXT_ID: 9 # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. - "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. + "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # Optional. The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, - "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, ], }, - "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # The combined audience ids of the included combined audience group. Contains combined audience ids only. - "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. + "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only. + "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. { # Details of combined audience targeting setting. "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. }, ], }, - "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # The custom list ids of the included custom list group. Contains custom list ids only. - "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. + "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only. + "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored. { # Details of custom list targeting setting. "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id. }, ], }, - "includedFirstAndThirdPartyAudienceGroups": [ # The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with same settings will be ignored. + "includedFirstAndThirdPartyAudienceGroups": [ # Optional. The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored. { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, ], - "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the included Google audience group. Contains Google audience ids only. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, @@ -479,48 +479,48 @@

Method Details

}, "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts. "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` - "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. NEXT_ID: 9 # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. - "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. + "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # Optional. The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, - "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, ], }, - "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # The combined audience ids of the included combined audience group. Contains combined audience ids only. - "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. + "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only. + "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. { # Details of combined audience targeting setting. "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. }, ], }, - "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # The custom list ids of the included custom list group. Contains custom list ids only. - "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. + "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only. + "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored. { # Details of custom list targeting setting. "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id. }, ], }, - "includedFirstAndThirdPartyAudienceGroups": [ # The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with same settings will be ignored. + "includedFirstAndThirdPartyAudienceGroups": [ # Optional. The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored. { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, ], - "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the included Google audience group. Contains Google audience ids only. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, diff --git a/docs/dyn/displayvideo_v3.partners.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v3.partners.targetingTypes.assignedTargetingOptions.html index 4a22a3e2bfc..6efb1df063a 100644 --- a/docs/dyn/displayvideo_v3.partners.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v3.partners.targetingTypes.assignedTargetingOptions.html @@ -175,48 +175,48 @@

Method Details

}, "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts. "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` - "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. NEXT_ID: 9 # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. - "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. + "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # Optional. The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, - "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, ], }, - "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # The combined audience ids of the included combined audience group. Contains combined audience ids only. - "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. + "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only. + "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. { # Details of combined audience targeting setting. "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. }, ], }, - "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # The custom list ids of the included custom list group. Contains custom list ids only. - "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. + "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only. + "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored. { # Details of custom list targeting setting. "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id. }, ], }, - "includedFirstAndThirdPartyAudienceGroups": [ # The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with same settings will be ignored. + "includedFirstAndThirdPartyAudienceGroups": [ # Optional. The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored. { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, ], - "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the included Google audience group. Contains Google audience ids only. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, @@ -504,48 +504,48 @@

Method Details

}, "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts. "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` - "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. NEXT_ID: 9 # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. - "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. + "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # Optional. The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, - "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, ], }, - "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # The combined audience ids of the included combined audience group. Contains combined audience ids only. - "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. + "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only. + "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. { # Details of combined audience targeting setting. "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. }, ], }, - "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # The custom list ids of the included custom list group. Contains custom list ids only. - "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. + "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only. + "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored. { # Details of custom list targeting setting. "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id. }, ], }, - "includedFirstAndThirdPartyAudienceGroups": [ # The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with same settings will be ignored. + "includedFirstAndThirdPartyAudienceGroups": [ # Optional. The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored. { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, ], - "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the included Google audience group. Contains Google audience ids only. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, @@ -962,48 +962,48 @@

Method Details

}, "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts. "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` - "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. NEXT_ID: 9 # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. - "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. + "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # Optional. The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, - "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, ], }, - "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # The combined audience ids of the included combined audience group. Contains combined audience ids only. - "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. + "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only. + "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. { # Details of combined audience targeting setting. "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. }, ], }, - "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # The custom list ids of the included custom list group. Contains custom list ids only. - "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. + "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only. + "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored. { # Details of custom list targeting setting. "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id. }, ], }, - "includedFirstAndThirdPartyAudienceGroups": [ # The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with same settings will be ignored. + "includedFirstAndThirdPartyAudienceGroups": [ # Optional. The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored. { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, ], - "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the included Google audience group. Contains Google audience ids only. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, @@ -1355,48 +1355,48 @@

Method Details

}, "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts. "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` - "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. NEXT_ID: 9 # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. - "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. + "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # Optional. The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, - "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, ], }, - "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # The combined audience ids of the included combined audience group. Contains combined audience ids only. - "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. + "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only. + "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. { # Details of combined audience targeting setting. "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. }, ], }, - "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # The custom list ids of the included custom list group. Contains custom list ids only. - "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. + "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only. + "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored. { # Details of custom list targeting setting. "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id. }, ], }, - "includedFirstAndThirdPartyAudienceGroups": [ # The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with same settings will be ignored. + "includedFirstAndThirdPartyAudienceGroups": [ # Optional. The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored. { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. - "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. { # Details of first and third party audience targeting setting. "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. - "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. }, ], }, ], - "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the included Google audience group. Contains Google audience ids only. - "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only. + "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. { # Details of Google audience targeting setting. "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. }, diff --git a/docs/dyn/displayvideo_v4.advertisers.adGroupAds.html b/docs/dyn/displayvideo_v4.advertisers.adGroupAds.html new file mode 100644 index 00000000000..16a5eddf7ad --- /dev/null +++ b/docs/dyn/displayvideo_v4.advertisers.adGroupAds.html @@ -0,0 +1,479 @@ + + + +

Display & Video 360 API . advertisers . adGroupAds

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(advertiserId, adGroupAdId, x__xgafv=None)

+

Gets an ad group ad.

+

+ list(advertiserId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists ad group ads.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(advertiserId, adGroupAdId, x__xgafv=None) +
Gets an ad group ad.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser this ad group ad belongs to. (required)
+  adGroupAdId: string, Required. The ID of the ad group ad to fetch. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single ad associated with an ad group.
+  "adGroupAdId": "A String", # The unique ID of the ad. Assigned by the system.
+  "adGroupId": "A String", # The unique ID of the ad group that the ad belongs to.
+  "adUrls": [ # List of URLs used by the ad.
+    { # Additional URLs related to the ad, including beacons.
+      "type": "A String", # The type of the Ad URL.
+      "url": "A String", # The URL string value.
+    },
+  ],
+  "advertiserId": "A String", # The unique ID of the advertiser the ad belongs to.
+  "audioAd": { # Details for an audio ad. # Details of an [audio ad](//support.google.com/displayvideo/answer/6274216) used for reach marketing objectives.
+    "displayUrl": "A String", # The webpage address that appears with the ad.
+    "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
+    "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
+    "video": { # Details of a YouTube video. # The YouTube video of the ad.
+      "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+      "unavailableReason": "A String", # The reason why the video data is not available.
+    },
+  },
+  "bumperAd": { # Details for a bumper ad. # Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach.
+    "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes.
+      "actionButtonLabel": "A String", # The text on the call-to-action button.
+      "actionHeadline": "A String", # The headline of the call-to-action banner.
+      "companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad.
+        "fileSize": "A String", # File size of the image asset in bytes.
+        "fullSize": { # Dimensions. # Metadata for this image at its original size.
+          "heightPixels": 42, # The height in pixels.
+          "widthPixels": 42, # The width in pixels.
+        },
+        "mimeType": "A String", # MIME type of the image asset.
+      },
+      "displayUrl": "A String", # The webpage address that appears with the ad.
+      "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
+      "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
+      "video": { # Details of a YouTube video. # The YouTube video of the ad.
+        "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+        "unavailableReason": "A String", # The reason why the video data is not available.
+      },
+    },
+  },
+  "displayName": "A String", # The display name of the ad. Must be UTF-8 encoded with a maximum size of 255 bytes.
+  "displayVideoSourceAd": { # The ad sourced from a DV360 creative. # Details of an ad sourced from a Display & Video 360 creative.
+    "creativeId": "A String", # The ID of the source creative.
+  },
+  "entityStatus": "A String", # The entity status of the ad.
+  "inStreamAd": { # Details for an in-stream ad. # Details of an [in-stream ad skippable after 5 seconds](//support.google.com/displayvideo/answer/6274216), used for brand awareness or reach marketing objectives.
+    "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes.
+      "actionButtonLabel": "A String", # The text on the call-to-action button.
+      "actionHeadline": "A String", # The headline of the call-to-action banner.
+      "companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad.
+        "fileSize": "A String", # File size of the image asset in bytes.
+        "fullSize": { # Dimensions. # Metadata for this image at its original size.
+          "heightPixels": 42, # The height in pixels.
+          "widthPixels": 42, # The width in pixels.
+        },
+        "mimeType": "A String", # MIME type of the image asset.
+      },
+      "displayUrl": "A String", # The webpage address that appears with the ad.
+      "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
+      "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
+      "video": { # Details of a YouTube video. # The YouTube video of the ad.
+        "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+        "unavailableReason": "A String", # The reason why the video data is not available.
+      },
+    },
+    "customParameters": { # The custom parameters to pass custom values to tracking URL template.
+      "a_key": "A String",
+    },
+  },
+  "mastheadAd": { # Details for a Masthead Ad. # Details of an [ad served on the YouTube Home feed](//support.google.com/google-ads/answer/9709826).
+    "autoplayVideoDuration": "A String", # The duration of time the video will autoplay.
+    "autoplayVideoStartMillisecond": "A String", # The amount of time in milliseconds after which the video will start to play.
+    "callToActionButtonLabel": "A String", # The text on the call-to-action button.
+    "callToActionFinalUrl": "A String", # The destination URL for the call-to-action button.
+    "callToActionTrackingUrl": "A String", # The tracking URL for the call-to-action button.
+    "companionYoutubeVideos": [ # The videos that appear next to the Masthead Ad on desktop. Can be no more than two.
+      { # Details of a YouTube video.
+        "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+        "unavailableReason": "A String", # The reason why the video data is not available.
+      },
+    ],
+    "description": "A String", # The description of the ad.
+    "headline": "A String", # The headline of the ad.
+    "showChannelArt": True or False, # Whether to show a background or banner that appears at the top of a YouTube page.
+    "video": { # Details of a YouTube video. # The YouTube video used by the ad.
+      "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+      "unavailableReason": "A String", # The reason why the video data is not available.
+    },
+    "videoAspectRatio": "A String", # The aspect ratio of the autoplaying YouTube video on the Masthead.
+  },
+  "name": "A String", # The resource name of the ad.
+  "nonSkippableAd": { # Details for a non-skippable ad. # Details of a [non-skippable short in-stream video ad](//support.google.com/displayvideo/answer/6274216), between 6 and 15 seconds, used for reach marketing objectives.
+    "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes.
+      "actionButtonLabel": "A String", # The text on the call-to-action button.
+      "actionHeadline": "A String", # The headline of the call-to-action banner.
+      "companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad.
+        "fileSize": "A String", # File size of the image asset in bytes.
+        "fullSize": { # Dimensions. # Metadata for this image at its original size.
+          "heightPixels": 42, # The height in pixels.
+          "widthPixels": 42, # The width in pixels.
+        },
+        "mimeType": "A String", # MIME type of the image asset.
+      },
+      "displayUrl": "A String", # The webpage address that appears with the ad.
+      "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
+      "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
+      "video": { # Details of a YouTube video. # The YouTube video of the ad.
+        "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+        "unavailableReason": "A String", # The reason why the video data is not available.
+      },
+    },
+    "customParameters": { # The custom parameters to pass custom values to tracking URL template.
+      "a_key": "A String",
+    },
+  },
+  "videoDiscoverAd": { # Details for a video discovery ad. # Details of an [ad promoting a video](//support.google.com/displayvideo/answer/6274216) that shows in places of discovery.
+    "description1": "A String", # First text line for the ad.
+    "description2": "A String", # Second text line for the ad.
+    "headline": "A String", # The headline of ad.
+    "thumbnail": "A String", # Thumbnail image used in the ad.
+    "video": { # Details of a YouTube video. # The YouTube video the ad promotes.
+      "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+      "unavailableReason": "A String", # The reason why the video data is not available.
+    },
+  },
+  "videoPerformanceAd": { # Details for a video performance ad. # Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product.
+    "actionButtonLabels": [ # The list of text assets shown on the call-to-action button.
+      "A String",
+    ],
+    "companionBanners": [ # The list of companion banners used by this ad.
+      { # Meta data of an image asset.
+        "fileSize": "A String", # File size of the image asset in bytes.
+        "fullSize": { # Dimensions. # Metadata for this image at its original size.
+          "heightPixels": 42, # The height in pixels.
+          "widthPixels": 42, # The width in pixels.
+        },
+        "mimeType": "A String", # MIME type of the image asset.
+      },
+    ],
+    "customParameters": { # The custom parameters to pass custom values to tracking URL template.
+      "a_key": "A String",
+    },
+    "descriptions": [ # The list of descriptions shown on the call-to-action banner.
+      "A String",
+    ],
+    "displayUrlBreadcrumb1": "A String", # The first piece after the domain in the display URL.
+    "displayUrlBreadcrumb2": "A String", # The second piece after the domain in the display URL.
+    "domain": "A String", # The domain of the display URL.
+    "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
+    "headlines": [ # The list of headlines shown on the call-to-action banner.
+      "A String",
+    ],
+    "longHeadlines": [ # The list of lone headlines shown on the call-to-action banner.
+      "A String",
+    ],
+    "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
+    "videos": [ # The list of YouTube video assets used by this ad.
+      { # Details of a YouTube video.
+        "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+        "unavailableReason": "A String", # The reason why the video data is not available.
+      },
+    ],
+  },
+}
+
+ +
+ list(advertiserId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists ad group ads.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser the ad groups belongs to. (required)
+  filter: string, Optional. Allows filtering by custom ad group ad fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` and `OR`. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `adGroupId` * `displayName` * `entityStatus` * `adGroupAdId` Examples: * All ad group ads under an ad group: `adGroupId="1234"` * All ad group ads under an ad group with an entityStatus of `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED`: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupId="12345"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
+  orderBy: string, Optional. Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.
+  pageSize: integer, Optional. Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
+  pageToken: string, Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdGroupAds` method. If not specified, the first page of results 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:
+
+    {
+  "adGroupAds": [ # The list of ad group ads. This list will be absent if empty.
+    { # A single ad associated with an ad group.
+      "adGroupAdId": "A String", # The unique ID of the ad. Assigned by the system.
+      "adGroupId": "A String", # The unique ID of the ad group that the ad belongs to.
+      "adUrls": [ # List of URLs used by the ad.
+        { # Additional URLs related to the ad, including beacons.
+          "type": "A String", # The type of the Ad URL.
+          "url": "A String", # The URL string value.
+        },
+      ],
+      "advertiserId": "A String", # The unique ID of the advertiser the ad belongs to.
+      "audioAd": { # Details for an audio ad. # Details of an [audio ad](//support.google.com/displayvideo/answer/6274216) used for reach marketing objectives.
+        "displayUrl": "A String", # The webpage address that appears with the ad.
+        "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
+        "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
+        "video": { # Details of a YouTube video. # The YouTube video of the ad.
+          "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+          "unavailableReason": "A String", # The reason why the video data is not available.
+        },
+      },
+      "bumperAd": { # Details for a bumper ad. # Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach.
+        "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes.
+          "actionButtonLabel": "A String", # The text on the call-to-action button.
+          "actionHeadline": "A String", # The headline of the call-to-action banner.
+          "companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad.
+            "fileSize": "A String", # File size of the image asset in bytes.
+            "fullSize": { # Dimensions. # Metadata for this image at its original size.
+              "heightPixels": 42, # The height in pixels.
+              "widthPixels": 42, # The width in pixels.
+            },
+            "mimeType": "A String", # MIME type of the image asset.
+          },
+          "displayUrl": "A String", # The webpage address that appears with the ad.
+          "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
+          "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
+          "video": { # Details of a YouTube video. # The YouTube video of the ad.
+            "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+            "unavailableReason": "A String", # The reason why the video data is not available.
+          },
+        },
+      },
+      "displayName": "A String", # The display name of the ad. Must be UTF-8 encoded with a maximum size of 255 bytes.
+      "displayVideoSourceAd": { # The ad sourced from a DV360 creative. # Details of an ad sourced from a Display & Video 360 creative.
+        "creativeId": "A String", # The ID of the source creative.
+      },
+      "entityStatus": "A String", # The entity status of the ad.
+      "inStreamAd": { # Details for an in-stream ad. # Details of an [in-stream ad skippable after 5 seconds](//support.google.com/displayvideo/answer/6274216), used for brand awareness or reach marketing objectives.
+        "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes.
+          "actionButtonLabel": "A String", # The text on the call-to-action button.
+          "actionHeadline": "A String", # The headline of the call-to-action banner.
+          "companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad.
+            "fileSize": "A String", # File size of the image asset in bytes.
+            "fullSize": { # Dimensions. # Metadata for this image at its original size.
+              "heightPixels": 42, # The height in pixels.
+              "widthPixels": 42, # The width in pixels.
+            },
+            "mimeType": "A String", # MIME type of the image asset.
+          },
+          "displayUrl": "A String", # The webpage address that appears with the ad.
+          "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
+          "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
+          "video": { # Details of a YouTube video. # The YouTube video of the ad.
+            "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+            "unavailableReason": "A String", # The reason why the video data is not available.
+          },
+        },
+        "customParameters": { # The custom parameters to pass custom values to tracking URL template.
+          "a_key": "A String",
+        },
+      },
+      "mastheadAd": { # Details for a Masthead Ad. # Details of an [ad served on the YouTube Home feed](//support.google.com/google-ads/answer/9709826).
+        "autoplayVideoDuration": "A String", # The duration of time the video will autoplay.
+        "autoplayVideoStartMillisecond": "A String", # The amount of time in milliseconds after which the video will start to play.
+        "callToActionButtonLabel": "A String", # The text on the call-to-action button.
+        "callToActionFinalUrl": "A String", # The destination URL for the call-to-action button.
+        "callToActionTrackingUrl": "A String", # The tracking URL for the call-to-action button.
+        "companionYoutubeVideos": [ # The videos that appear next to the Masthead Ad on desktop. Can be no more than two.
+          { # Details of a YouTube video.
+            "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+            "unavailableReason": "A String", # The reason why the video data is not available.
+          },
+        ],
+        "description": "A String", # The description of the ad.
+        "headline": "A String", # The headline of the ad.
+        "showChannelArt": True or False, # Whether to show a background or banner that appears at the top of a YouTube page.
+        "video": { # Details of a YouTube video. # The YouTube video used by the ad.
+          "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+          "unavailableReason": "A String", # The reason why the video data is not available.
+        },
+        "videoAspectRatio": "A String", # The aspect ratio of the autoplaying YouTube video on the Masthead.
+      },
+      "name": "A String", # The resource name of the ad.
+      "nonSkippableAd": { # Details for a non-skippable ad. # Details of a [non-skippable short in-stream video ad](//support.google.com/displayvideo/answer/6274216), between 6 and 15 seconds, used for reach marketing objectives.
+        "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes.
+          "actionButtonLabel": "A String", # The text on the call-to-action button.
+          "actionHeadline": "A String", # The headline of the call-to-action banner.
+          "companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad.
+            "fileSize": "A String", # File size of the image asset in bytes.
+            "fullSize": { # Dimensions. # Metadata for this image at its original size.
+              "heightPixels": 42, # The height in pixels.
+              "widthPixels": 42, # The width in pixels.
+            },
+            "mimeType": "A String", # MIME type of the image asset.
+          },
+          "displayUrl": "A String", # The webpage address that appears with the ad.
+          "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
+          "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
+          "video": { # Details of a YouTube video. # The YouTube video of the ad.
+            "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+            "unavailableReason": "A String", # The reason why the video data is not available.
+          },
+        },
+        "customParameters": { # The custom parameters to pass custom values to tracking URL template.
+          "a_key": "A String",
+        },
+      },
+      "videoDiscoverAd": { # Details for a video discovery ad. # Details of an [ad promoting a video](//support.google.com/displayvideo/answer/6274216) that shows in places of discovery.
+        "description1": "A String", # First text line for the ad.
+        "description2": "A String", # Second text line for the ad.
+        "headline": "A String", # The headline of ad.
+        "thumbnail": "A String", # Thumbnail image used in the ad.
+        "video": { # Details of a YouTube video. # The YouTube video the ad promotes.
+          "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+          "unavailableReason": "A String", # The reason why the video data is not available.
+        },
+      },
+      "videoPerformanceAd": { # Details for a video performance ad. # Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product.
+        "actionButtonLabels": [ # The list of text assets shown on the call-to-action button.
+          "A String",
+        ],
+        "companionBanners": [ # The list of companion banners used by this ad.
+          { # Meta data of an image asset.
+            "fileSize": "A String", # File size of the image asset in bytes.
+            "fullSize": { # Dimensions. # Metadata for this image at its original size.
+              "heightPixels": 42, # The height in pixels.
+              "widthPixels": 42, # The width in pixels.
+            },
+            "mimeType": "A String", # MIME type of the image asset.
+          },
+        ],
+        "customParameters": { # The custom parameters to pass custom values to tracking URL template.
+          "a_key": "A String",
+        },
+        "descriptions": [ # The list of descriptions shown on the call-to-action banner.
+          "A String",
+        ],
+        "displayUrlBreadcrumb1": "A String", # The first piece after the domain in the display URL.
+        "displayUrlBreadcrumb2": "A String", # The second piece after the domain in the display URL.
+        "domain": "A String", # The domain of the display URL.
+        "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
+        "headlines": [ # The list of headlines shown on the call-to-action banner.
+          "A String",
+        ],
+        "longHeadlines": [ # The list of lone headlines shown on the call-to-action banner.
+          "A String",
+        ],
+        "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
+        "videos": [ # The list of YouTube video assets used by this ad.
+          { # Details of a YouTube video.
+            "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+            "unavailableReason": "A String", # The reason why the video data is not available.
+          },
+        ],
+      },
+    },
+  ],
+  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListAdGroupAds` method to retrieve the next page of results.
+}
+
+ +
+ 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/displayvideo_v4.advertisers.adGroups.html b/docs/dyn/displayvideo_v4.advertisers.adGroups.html new file mode 100644 index 00000000000..223d7ef6368 --- /dev/null +++ b/docs/dyn/displayvideo_v4.advertisers.adGroups.html @@ -0,0 +1,625 @@ + + + +

Display & Video 360 API . advertisers . adGroups

+

Instance Methods

+

+ targetingTypes() +

+

Returns the targetingTypes Resource.

+ +

+ bulkListAssignedTargetingOptions(advertiserId, adGroupIds=None, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists assigned targeting options for multiple ad groups across targeting types. Inherited assigned targeting options are not included.

+

+ bulkListAssignedTargetingOptions_next()

+

Retrieves the next page of results.

+

+ close()

+

Close httplib2 connections.

+

+ get(advertiserId, adGroupId, x__xgafv=None)

+

Gets an ad group.

+

+ list(advertiserId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists ad groups.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ bulkListAssignedTargetingOptions(advertiserId, adGroupIds=None, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists assigned targeting options for multiple ad groups across targeting types. Inherited assigned targeting options are not included.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser the line items belongs to. (required)
+  adGroupIds: string, Required. The IDs of the ad groups to list assigned targeting options for. (repeated)
+  filter: string, Optional. Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `targetingType` Examples: * `AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_YOUTUBE_VIDEO` or `TARGETING_TYPE_YOUTUBE_CHANNEL`: `targetingType="TARGETING_TYPE_YOUTUBE_VIDEO" OR targetingType="TARGETING_TYPE_YOUTUBE_CHANNEL"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
+  orderBy: string, Optional. Field by which to sort the list. Acceptable values are: * `adGroupId` (default) * `assignedTargetingOption.targetingType` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `targetingType desc`.
+  pageSize: integer, Optional. Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
+  pageToken: string, Optional. A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to the `BulkListAdGroupAssignedTargetingOptions` method. If not specified, the first page of results 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:
+
+    {
+  "adGroupAssignedTargetingOptions": [ # The list of wrapper objects, each providing an assigned targeting option and the ad group it is assigned to. This list will be absent if empty.
+    { # Wrapper object associating an AssignedTargetingOption resource and the ad group it is assigned to.
+      "adGroupId": "A String", # The ID of the ad group the assigned targeting option is assigned to.
+      "assignedTargetingOption": { # A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings. # The assigned targeting option resource.
+        "ageRangeDetails": { # Represents a targetable age range. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AGE_RANGE`. # Age range details. This field will be populated when the targeting_type is `TARGETING_TYPE_AGE_RANGE`.
+          "ageRange": "A String", # Required. The age range of an audience. We only support targeting a continuous age range of an audience. Thus, the age range represented in this field can be 1) targeted solely, or, 2) part of a larger continuous age range. The reach of a continuous age range targeting can be expanded by also targeting an audience of an unknown age.
+        },
+        "appCategoryDetails": { # Details for assigned app category targeting option. This will be populated in the app_category_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. # App category details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
+          "displayName": "A String", # Output only. The display name of the app category.
+          "negative": True or False, # Indicates if this option is being negatively targeted.
+          "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
+        },
+        "appDetails": { # Details for assigned app targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP`. # App details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP`.
+          "appId": "A String", # Required. The ID of the app. Android's Play store app uses bundle ID, for example `com.google.android.gm`. Apple's App store app ID uses 9 digit string, for example `422689480`.
+          "appPlatform": "A String", # Indicates the platform of the targeted app. If this field is not specified, the app platform will be assumed to be mobile (i.e., Android or iOS), and we will derive the appropriate mobile platform from the app ID.
+          "displayName": "A String", # Output only. The display name of the app.
+          "negative": True or False, # Indicates if this option is being negatively targeted.
+        },
+        "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts.
+        "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`
+        "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource.
+          "excludedFirstPartyAndPartnerAudienceGroup": { # Details of first party and partner audience group. All first party and partner audience targeting settings are logically ‘OR’ of each other. # Optional. The first party and partner audience ids and recencies of the excluded first party and partner audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other.
+            "settings": [ # Required. All first party and partner audience targeting settings in first party and partner audience group. Repeated settings with the same id are not allowed.
+              { # Details of first party and partner audience targeting setting.
+                "firstPartyAndPartnerAudienceId": "A String", # Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.
+                "recency": "A String", # Required. The recency of the first party and partner audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
+              },
+            ],
+          },
+          "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other.
+            "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
+              { # Details of Google audience targeting setting.
+                "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
+              },
+            ],
+          },
+          "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only.
+            "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise.
+              { # Details of combined audience targeting setting.
+                "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id.
+              },
+            ],
+          },
+          "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only.
+            "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored.
+              { # Details of custom list targeting setting.
+                "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id.
+              },
+            ],
+          },
+          "includedFirstPartyAndPartnerAudienceGroups": [ # Optional. The first party and partner audience ids and recencies of included first party and partner audience groups. Each first party and partner audience group contains first party and partner audience ids only. The relation between each first party and partner audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored.
+            { # Details of first party and partner audience group. All first party and partner audience targeting settings are logically ‘OR’ of each other.
+              "settings": [ # Required. All first party and partner audience targeting settings in first party and partner audience group. Repeated settings with the same id are not allowed.
+                { # Details of first party and partner audience targeting setting.
+                  "firstPartyAndPartnerAudienceId": "A String", # Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.
+                  "recency": "A String", # Required. The recency of the first party and partner audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
+                },
+              ],
+            },
+          ],
+          "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only.
+            "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
+              { # Details of Google audience targeting setting.
+                "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
+              },
+            ],
+          },
+        },
+        "audioContentTypeDetails": { # Details for audio content type assigned targeting option. This will be populated in the audio_content_type_details field when targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`. Explicitly targeting all options is not supported. Remove all audio content type targeting options to achieve this effect. # Audio content type details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`.
+          "audioContentType": "A String", # Required. The audio content type.
+        },
+        "authorizedSellerStatusDetails": { # Represents an assigned authorized seller status. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. If a resource does not have an `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` assigned targeting option, it is using the "Authorized Direct Sellers and Resellers" option. # Authorized seller status details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. You can only target one authorized seller status option per resource. If a resource doesn't have an authorized seller status option, all authorized sellers indicated as DIRECT or RESELLER in the ads.txt file are targeted by default.
+          "authorizedSellerStatus": "A String", # Output only. The authorized seller status to target.
+          "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.
+        },
+        "browserDetails": { # Details for assigned browser targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BROWSER`. # Browser details. This field will be populated when the targeting_type is `TARGETING_TYPE_BROWSER`.
+          "displayName": "A String", # Output only. The display name of the browser.
+          "negative": True or False, # Indicates if this option is being negatively targeted. All assigned browser targeting options on the same resource must have the same value for this field.
+          "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BROWSER`.
+        },
+        "businessChainDetails": { # Details for assigned Business chain targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`. # Business chain details. This field will be populated when the targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`.
+          "displayName": "A String", # Output only. The display name of a business chain, e.g. "KFC", "Chase Bank".
+          "proximityRadiusAmount": 3.14, # Required. The radius of the area around the business chain that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`. The minimum increment for both cases is 0.1. Inputs will be rounded to the nearest acceptable value if it is too granular, e.g. 15.57 will become 15.6.
+          "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
+          "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BUSINESS_CHAIN`. Accepted business chain targeting option IDs can be retrieved using SearchTargetingOptions.
+        },
+        "carrierAndIspDetails": { # Details for assigned carrier and ISP targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`. # Carrier and ISP details. This field will be populated when the targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`.
+          "displayName": "A String", # Output only. The display name of the carrier or ISP.
+          "negative": True or False, # Indicates if this option is being negatively targeted. All assigned carrier and ISP targeting options on the same resource must have the same value for this field.
+          "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`.
+        },
+        "categoryDetails": { # Assigned category targeting option details. This will be populated in the category_details field when targeting_type is `TARGETING_TYPE_CATEGORY`. # Category details. This field will be populated when the targeting_type is `TARGETING_TYPE_CATEGORY`. Targeting a category will also target its subcategories. If a category is excluded from targeting and a subcategory is included, the exclusion will take precedence.
+          "displayName": "A String", # Output only. The display name of the category.
+          "negative": True or False, # Indicates if this option is being negatively targeted.
+          "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CATEGORY`.
+        },
+        "channelDetails": { # Details for assigned channel targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CHANNEL`. # Channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_CHANNEL`.
+          "channelId": "A String", # Required. ID of the channel. Should refer to the channel ID field on a [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id) resource.
+          "negative": True or False, # Indicates if this option is being negatively targeted. For advertiser level assigned targeting option, this field must be true.
+        },
+        "contentDurationDetails": { # Details for content duration assigned targeting option. This will be populated in the content_duration_details field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`. Explicitly targeting all options is not supported. Remove all content duration targeting options to achieve this effect. # Content duration details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
+          "contentDuration": "A String", # Output only. The content duration.
+          "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
+        },
+        "contentGenreDetails": { # Details for content genre assigned targeting option. This will be populated in the content_genre_details field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`. Explicitly targeting all options is not supported. Remove all content genre targeting options to achieve this effect. # Content genre details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
+          "displayName": "A String", # Output only. The display name of the content genre.
+          "negative": True or False, # Indicates if this option is being negatively targeted.
+          "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
+        },
+        "contentInstreamPositionDetails": { # Assigned content instream position targeting option details. This will be populated in the content_instream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. # Content instream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.
+          "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`. * `AD_TYPE_AUDIO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_AUDIO_DEFAULT`.
+          "contentInstreamPosition": "A String", # Required. The content instream position for video or audio ads.
+        },
+        "contentOutstreamPositionDetails": { # Assigned content outstream position targeting option details. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. # Content outstream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.
+          "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+          "contentOutstreamPosition": "A String", # Required. The content outstream position.
+        },
+        "contentStreamTypeDetails": { # Details for content stream type assigned targeting option. This will be populated in the content_stream_type_details field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`. Explicitly targeting all options is not supported. Remove all content stream type targeting options to achieve this effect. # Content duration details. This field will be populated when the TargetingType is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
+          "contentStreamType": "A String", # Output only. The content stream type.
+          "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
+        },
+        "dayAndTimeDetails": { # Representation of a segment of time defined on a specific day of the week and with a start and end time. The time represented by `start_hour` must be before the time represented by `end_hour`. # Day and time details. This field will be populated when the targeting_type is `TARGETING_TYPE_DAY_AND_TIME`.
+          "dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting.
+          "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day).
+          "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day).
+          "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting.
+        },
+        "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
+          "displayName": "A String", # Output only. The display name of the device make and model.
+          "negative": True or False, # Indicates if this option is being negatively targeted.
+          "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
+        },
+        "deviceTypeDetails": { # Targeting details for device type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`. # Device Type details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_TYPE`.
+          "deviceType": "A String", # Required. The display name of the device type.
+          "youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items.
+        },
+        "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded.
+          "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED.
+        },
+        "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`.
+          "environment": "A String", # Required. The serving environment.
+        },
+        "exchangeDetails": { # Details for assigned exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`. # Exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_EXCHANGE`.
+          "exchange": "A String", # Required. The enum value for the exchange.
+        },
+        "genderDetails": { # Details for assigned gender targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GENDER`. # Gender details. This field will be populated when the targeting_type is `TARGETING_TYPE_GENDER`.
+          "gender": "A String", # Required. The gender of the audience.
+        },
+        "geoRegionDetails": { # Details for assigned geographic region targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GEO_REGION`. # Geographic region details. This field will be populated when the targeting_type is `TARGETING_TYPE_GEO_REGION`.
+          "displayName": "A String", # Output only. The display name of the geographic region (e.g., "Ontario, Canada").
+          "geoRegionType": "A String", # Output only. The type of geographic region targeting.
+          "negative": True or False, # Indicates if this option is being negatively targeted.
+          "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GEO_REGION`.
+        },
+        "householdIncomeDetails": { # Details for assigned household income targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`. # Household income details. This field will be populated when the targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`.
+          "householdIncome": "A String", # Required. The household income of the audience.
+        },
+        "inheritance": "A String", # Output only. The inheritance status of the assigned targeting option.
+        "inventorySourceDetails": { # Targeting details for inventory source. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`. # Inventory source details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`.
+          "inventorySourceId": "A String", # Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource.
+        },
+        "inventorySourceGroupDetails": { # Targeting details for inventory source group. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`. # Inventory source group details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`.
+          "inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource.
+        },
+        "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned.
+          "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10.
+          "negative": True or False, # Indicates if this option is being negatively targeted.
+        },
+        "languageDetails": { # Details for assigned language targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_LANGUAGE`. # Language details. This field will be populated when the targeting_type is `TARGETING_TYPE_LANGUAGE`.
+          "displayName": "A String", # Output only. The display name of the language (e.g., "French").
+          "negative": True or False, # Indicates if this option is being negatively targeted. All assigned language targeting options on the same resource must have the same value for this field.
+          "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_LANGUAGE`.
+        },
+        "name": "A String", # Output only. The resource name for this assigned targeting option.
+        "nativeContentPositionDetails": { # Details for native content position assigned targeting option. This will be populated in the native_content_position_details field when targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`. Explicitly targeting all options is not supported. Remove all native content position targeting options to achieve this effect. # Native content position details. This field will be populated when the targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`.
+          "contentPosition": "A String", # Required. The content position.
+        },
+        "negativeKeywordListDetails": { # Targeting details for negative keyword list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. A maximum of 4 negative keyword lists can be assigned to a resource.
+          "negativeKeywordListId": "A String", # Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource.
+        },
+        "omidDetails": { # Represents a targetable Open Measurement enabled inventory type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_OMID`. # Open Measurement enabled inventory details. This field will be populated when the targeting_type is `TARGETING_TYPE_OMID`.
+          "omid": "A String", # Required. The type of Open Measurement enabled inventory.
+        },
+        "onScreenPositionDetails": { # On screen position targeting option details. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. # On screen position details. This field will be populated when the targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
+          "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+          "onScreenPosition": "A String", # Output only. The on screen position.
+          "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
+        },
+        "operatingSystemDetails": { # Assigned operating system targeting option details. This will be populated in the operating_system_details field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. # Operating system details. This field will be populated when the targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
+          "displayName": "A String", # Output only. The display name of the operating system.
+          "negative": True or False, # Indicates if this option is being negatively targeted.
+          "targetingOptionId": "A String", # Required. The targeting option ID populated in targeting_option_id field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
+        },
+        "parentalStatusDetails": { # Details for assigned parental status targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`. # Parental status details. This field will be populated when the targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`.
+          "parentalStatus": "A String", # Required. The parental status of the audience.
+        },
+        "poiDetails": { # Details for assigned POI targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_POI`. # POI details. This field will be populated when the targeting_type is `TARGETING_TYPE_POI`.
+          "displayName": "A String", # Output only. The display name of a POI, e.g. "Times Square", "Space Needle", followed by its full address if available.
+          "latitude": 3.14, # Output only. Latitude of the POI rounding to 6th decimal place.
+          "longitude": 3.14, # Output only. Longitude of the POI rounding to 6th decimal place.
+          "proximityRadiusAmount": 3.14, # Required. The radius of the area around the POI that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`.
+          "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
+          "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_POI`. Accepted POI targeting option IDs can be retrieved using `targetingTypes.targetingOptions.search`. If targeting a specific latitude/longitude coordinate removed from an address or POI name, you can generate the necessary targeting option ID by rounding the desired coordinate values to the 6th decimal place, removing the decimals, and concatenating the string values separated by a semicolon. For example, you can target the latitude/longitude pair of 40.7414691, -74.003387 using the targeting option ID "40741469;-74003387". **Upon** **creation, this field value will be updated to append a semicolon and** **alphanumerical hash value if only latitude/longitude coordinates are** **provided.**
+        },
+        "proximityLocationListDetails": { # Targeting details for proximity location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`. # Proximity location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`.
+          "proximityLocationListId": "A String", # Required. ID of the proximity location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_PROXIMITY`.
+          "proximityRadius": 3.14, # Required. Radius expressed in the distance units set in proximity_radius_unit. This represents the size of the area around a chosen location that will be targeted. Radius should be between 1 and 500 miles or 800 kilometers.
+          "proximityRadiusUnit": "A String", # Required. Radius distance units.
+        },
+        "regionalLocationListDetails": { # Targeting details for regional location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`. # Regional location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`.
+          "negative": True or False, # Indicates if this option is being negatively targeted.
+          "regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`.
+        },
+        "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them.
+          "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED.
+        },
+        "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`.
+          "sessionPosition": "A String", # The position where the ad will show in a session.
+        },
+        "subExchangeDetails": { # Details for assigned sub-exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`. # Sub-exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`.
+          "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`.
+        },
+        "targetingType": "A String", # Output only. Identifies the type of this assigned targeting option.
+        "thirdPartyVerifierDetails": { # Assigned third party verifier targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`. # Third party verification details. This field will be populated when the targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`.
+          "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox.
+            "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+            "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+            "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+            "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+            "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+            "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads.
+            "excludedAdlooxCategories": [ # Adloox categories to exclude.
+              "A String",
+            ],
+            "excludedFraudIvtMfaCategories": [ # Optional. Adloox's fraud IVT MFA categories to exclude.
+              "A String",
+            ],
+            "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+            "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+            "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+            "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+            "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+            "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+            "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+            "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads.
+          },
+          "doubleVerify": { # Details of DoubleVerify settings. # Third party brand verifier -- DoubleVerify.
+            "appStarRating": { # Details of DoubleVerify star ratings settings. # Avoid bidding on apps with the star ratings.
+              "avoidInsufficientStarRating": True or False, # Avoid bidding on apps with insufficient star ratings.
+              "avoidedStarRating": "A String", # Avoid bidding on apps with the star ratings.
+            },
+            "avoidedAgeRatings": [ # Avoid bidding on apps with the age rating.
+              "A String",
+            ],
+            "brandSafetyCategories": { # Settings for brand safety controls. # DV Brand Safety Controls.
+              "avoidUnknownBrandSafetyCategory": True or False, # Unknown or unrateable.
+              "avoidedHighSeverityCategories": [ # Brand safety high severity avoidance categories.
+                "A String",
+              ],
+              "avoidedMediumSeverityCategories": [ # Brand safety medium severity avoidance categories.
+                "A String",
+              ],
+            },
+            "customSegmentId": "A String", # The custom segment ID provided by DoubleVerify. The ID must start with "51" and consist of eight digits. Custom segment ID cannot be specified along with any of the following fields: * brand_safety_categories * avoided_age_ratings * app_star_rating * fraud_invalid_traffic
+            "displayViewability": { # Details of DoubleVerify display viewability settings. # Display viewability settings (applicable to display line items only).
+              "iab": "A String", # Target web and app inventory to maximize IAB viewable rate.
+              "viewableDuring": "A String", # Target web and app inventory to maximize 100% viewable duration.
+            },
+            "fraudInvalidTraffic": { # DoubleVerify Fraud & Invalid Traffic settings. # Avoid Sites and Apps with historical Fraud & IVT Rates.
+              "avoidInsufficientOption": True or False, # Insufficient Historical Fraud & IVT Stats.
+              "avoidedFraudOption": "A String", # Avoid Sites and Apps with historical Fraud & IVT.
+            },
+            "videoViewability": { # Details of DoubleVerify video viewability settings. # Video viewability settings (applicable to video line items only).
+              "playerImpressionRate": "A String", # Target inventory to maximize impressions with 400x300 or greater player size.
+              "videoIab": "A String", # Target web inventory to maximize IAB viewable rate.
+              "videoViewableRate": "A String", # Target web inventory to maximize fully viewable rate.
+            },
+          },
+          "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science.
+            "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive.
+              "A String",
+            ],
+            "displayViewability": "A String", # Display Viewability section (applicable to display line items only).
+            "excludeUnrateable": True or False, # Brand Safety - **Unrateable**.
+            "excludedAdFraudRisk": "A String", # Ad Fraud settings.
+            "excludedAdultRisk": "A String", # Brand Safety - **Adult content**.
+            "excludedAlcoholRisk": "A String", # Brand Safety - **Alcohol**.
+            "excludedDrugsRisk": "A String", # Brand Safety - **Drugs**.
+            "excludedGamblingRisk": "A String", # Brand Safety - **Gambling**.
+            "excludedHateSpeechRisk": "A String", # Brand Safety - **Hate speech**.
+            "excludedIllegalDownloadsRisk": "A String", # Brand Safety - **Illegal downloads**.
+            "excludedOffensiveLanguageRisk": "A String", # Brand Safety - **Offensive language**.
+            "excludedViolenceRisk": "A String", # Brand Safety - **Violence**.
+            "qualitySyncCustomSegmentId": [ # Optional. The quality sync custom segment ID provided by Integral Ad Science. The ID must be between `3000000` and `4999999`, inclusive.
+              "A String",
+            ],
+            "traqScoreOption": "A String", # True advertising quality (applicable to Display line items only).
+            "videoViewability": "A String", # Video Viewability Section (applicable to video line items only).
+          },
+        },
+        "urlDetails": { # Details for assigned URL targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_URL`. # URL details. This field will be populated when the targeting_type is `TARGETING_TYPE_URL`.
+          "negative": True or False, # Indicates if this option is being negatively targeted.
+          "url": "A String", # Required. The URL, for example `example.com`. DV360 supports two levels of subdirectory targeting, for example `www.example.com/one-subdirectory-level/second-level`, and five levels of subdomain targeting, for example `five.four.three.two.one.example.com`.
+        },
+        "userRewardedContentDetails": { # User rewarded content targeting option details. This will be populated in the user_rewarded_content_details field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. # User rewarded content details. This field will be populated when the targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
+          "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
+          "userRewardedContent": "A String", # Output only. User rewarded content status for video ads.
+        },
+        "videoPlayerSizeDetails": { # Video player size targeting option details. This will be populated in the video_player_size_details field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. Explicitly targeting all options is not supported. Remove all video player size targeting options to achieve this effect. # Video player size details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.
+          "videoPlayerSize": "A String", # Required. The video player size.
+        },
+        "viewabilityDetails": { # Assigned viewability targeting option details. This will be populated in the viewability_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`. # Viewability details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIEWABILITY`. You can only target one viewability option per resource.
+          "viewability": "A String", # Required. The predicted viewability percentage.
+        },
+        "youtubeChannelDetails": { # Details for YouTube channel assigned targeting option. This will be populated in the youtube_channel_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`. # YouTube channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`.
+          "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
+          "negative": True or False, # Indicates if this option is being negatively targeted.
+        },
+        "youtubeVideoDetails": { # Details for YouTube video assigned targeting option. This will be populated in the youtube_video_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`. # YouTube video details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`.
+          "negative": True or False, # Indicates if this option is being negatively targeted.
+          "videoId": "A String", # YouTube video id as it appears on the YouTube watch page.
+        },
+      },
+    },
+  ],
+  "nextPageToken": "A String", # A token identifying the next page of results. This value should be specified as the pageToken in a subsequent call to `BulkListAdGroupAssignedTargetingOptions` to fetch the next page of results. This token will be absent if there are no more AdGroupAssignedTargetingOption resources to return.
+}
+
+ +
+ bulkListAssignedTargetingOptions_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.
+        
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ get(advertiserId, adGroupId, x__xgafv=None) +
Gets an ad group.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser this ad group belongs to. (required)
+  adGroupId: string, Required. The ID of the ad group to fetch. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single ad group associated with a line item.
+  "adGroupFormat": "A String", # The format of the ads in the ad group.
+  "adGroupId": "A String", # The unique ID of the ad group. Assigned by the system.
+  "advertiserId": "A String", # The unique ID of the advertiser the ad group belongs to.
+  "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # The bidding strategy used by the ad group. Only the youtubeAndPartnersBid field can be used in the bidding strategy.
+    "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
+      "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
+    },
+    "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, when performance_goal_type is one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , the line_item_type of the insertion order line items must be either: * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , and when performance_goal_type is either: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` the line_item_type of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+      "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).
+      "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.
+      "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.
+      "raiseBidForDeals": True or False, # Whether the strategy takes deal floor prices into account.
+    },
+    "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity.
+      "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).
+      "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency.
+      "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value.
+      "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`.
+    },
+    "youtubeAndPartnersBid": { # Settings that control the bid strategy for YouTube and Partners resources. # A bid strategy used by YouTube and Partners resources. It can only be used for a YouTube and Partners line item or ad group entity.
+      "adGroupEffectiveTargetCpaSource": "A String", # Output only. Source of the effective target CPA value for ad group.
+      "adGroupEffectiveTargetCpaValue": "A String", # Output only. The effective target CPA for ad group, in micros of advertiser's currency.
+      "type": "A String", # The type of the bidding strategy.
+      "value": "A String", # The value used by the bidding strategy. When the bidding strategy is assigned at the line item level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` When the bidding strategy is assigned at the ad group level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPV` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` If not using an applicable strategy, the value of this field will be 0.
+    },
+  },
+  "displayName": "A String", # The display name of the ad group. Must be UTF-8 encoded with a maximum size of 255 bytes.
+  "entityStatus": "A String", # Controls whether or not the ad group can spend its budget and bid on inventory. If the ad group's parent line item is not active, the ad group can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.
+  "lineItemId": "A String", # The unique ID of the line item that the ad group belongs to.
+  "name": "A String", # The resource name of the ad group.
+  "productFeedData": { # The details of product feed. # The settings of the product feed in this ad group.
+    "isFeedDisabled": True or False, # Whether the product feed has opted-out of showing products.
+    "productMatchDimensions": [ # A list of dimensions used to match products.
+      { # A dimension used to match products.
+        "customLabel": { # The key and value of a custom label. # The custom label to match all the products with the label.
+          "key": "A String", # The key of the label.
+          "value": "A String", # The value of the label.
+        },
+        "productOfferId": "A String", # The ID of the product offer to match with a product with the same offer ID.
+      },
+    ],
+    "productMatchType": "A String", # How products are selected by the product feed.
+  },
+  "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the ad group.
+    "audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources.
+    "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources.
+    "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` *Warning*: Starting **March 6, 2025**, this field will stop being compatible when using the BiddingStrategy field fixed_bid. [Read more about this announced change](/display-video/api/deprecations#features.ot_fixed_bid)
+  },
+}
+
+ +
+ list(advertiserId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists ad groups.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser the ad groups belongs to. (required)
+  filter: string, Optional. Allows filtering by custom ad group fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` and `OR`. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported properties: * `adGroupId` * `displayName` * `entityStatus` * `lineItemId` * `adGroupFormat` Examples: * All ad groups under an line item: `lineItemId="1234"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` `AD_GROUP_FORMAT_IN_STREAM` ad groups under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupFormat="AD_GROUP_FORMAT_IN_STREAM"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
+  orderBy: string, Optional. Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.
+  pageSize: integer, Optional. Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
+  pageToken: string, Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdGroups` method. If not specified, the first page of results 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:
+
+    {
+  "adGroups": [ # The list of ad groups. This list will be absent if empty.
+    { # A single ad group associated with a line item.
+      "adGroupFormat": "A String", # The format of the ads in the ad group.
+      "adGroupId": "A String", # The unique ID of the ad group. Assigned by the system.
+      "advertiserId": "A String", # The unique ID of the advertiser the ad group belongs to.
+      "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # The bidding strategy used by the ad group. Only the youtubeAndPartnersBid field can be used in the bidding strategy.
+        "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
+          "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
+        },
+        "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, when performance_goal_type is one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , the line_item_type of the insertion order line items must be either: * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , and when performance_goal_type is either: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` the line_item_type of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+          "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).
+          "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.
+          "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.
+          "raiseBidForDeals": True or False, # Whether the strategy takes deal floor prices into account.
+        },
+        "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity.
+          "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).
+          "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency.
+          "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value.
+          "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`.
+        },
+        "youtubeAndPartnersBid": { # Settings that control the bid strategy for YouTube and Partners resources. # A bid strategy used by YouTube and Partners resources. It can only be used for a YouTube and Partners line item or ad group entity.
+          "adGroupEffectiveTargetCpaSource": "A String", # Output only. Source of the effective target CPA value for ad group.
+          "adGroupEffectiveTargetCpaValue": "A String", # Output only. The effective target CPA for ad group, in micros of advertiser's currency.
+          "type": "A String", # The type of the bidding strategy.
+          "value": "A String", # The value used by the bidding strategy. When the bidding strategy is assigned at the line item level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` When the bidding strategy is assigned at the ad group level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPV` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` If not using an applicable strategy, the value of this field will be 0.
+        },
+      },
+      "displayName": "A String", # The display name of the ad group. Must be UTF-8 encoded with a maximum size of 255 bytes.
+      "entityStatus": "A String", # Controls whether or not the ad group can spend its budget and bid on inventory. If the ad group's parent line item is not active, the ad group can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.
+      "lineItemId": "A String", # The unique ID of the line item that the ad group belongs to.
+      "name": "A String", # The resource name of the ad group.
+      "productFeedData": { # The details of product feed. # The settings of the product feed in this ad group.
+        "isFeedDisabled": True or False, # Whether the product feed has opted-out of showing products.
+        "productMatchDimensions": [ # A list of dimensions used to match products.
+          { # A dimension used to match products.
+            "customLabel": { # The key and value of a custom label. # The custom label to match all the products with the label.
+              "key": "A String", # The key of the label.
+              "value": "A String", # The value of the label.
+            },
+            "productOfferId": "A String", # The ID of the product offer to match with a product with the same offer ID.
+          },
+        ],
+        "productMatchType": "A String", # How products are selected by the product feed.
+      },
+      "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the ad group.
+        "audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources.
+        "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources.
+        "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` *Warning*: Starting **March 6, 2025**, this field will stop being compatible when using the BiddingStrategy field fixed_bid. [Read more about this announced change](/display-video/api/deprecations#features.ot_fixed_bid)
+      },
+    },
+  ],
+  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListAdGroups` method to retrieve the next page of results.
+}
+
+ +
+ 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/displayvideo_v4.advertisers.adGroups.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v4.advertisers.adGroups.targetingTypes.assignedTargetingOptions.html new file mode 100644 index 00000000000..15bd4643f66 --- /dev/null +++ b/docs/dyn/displayvideo_v4.advertisers.adGroups.targetingTypes.assignedTargetingOptions.html @@ -0,0 +1,895 @@ + + + +

Display & Video 360 API . advertisers . adGroups . targetingTypes . assignedTargetingOptions

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(advertiserId, adGroupId, targetingType, assignedTargetingOptionId, x__xgafv=None)

+

Gets a single targeting option assigned to an ad group. Inherited assigned targeting options are not included.

+

+ list(advertiserId, adGroupId, targetingType, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists the targeting options assigned to an ad group. Inherited assigned targeting options are not included.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(advertiserId, adGroupId, targetingType, assignedTargetingOptionId, x__xgafv=None) +
Gets a single targeting option assigned to an ad group. Inherited assigned targeting options are not included.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser the ad group belongs to. (required)
+  adGroupId: string, Required. The ID of the ad group the assigned targeting option belongs to. (required)
+  targetingType: string, Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO` (required)
+    Allowed values
+      TARGETING_TYPE_UNSPECIFIED - Default value when type is not specified or is unknown in this version.
+      TARGETING_TYPE_CHANNEL - Target a channel (a custom group of related websites or apps).
+      TARGETING_TYPE_APP_CATEGORY - Target an app category (for example, education or puzzle games).
+      TARGETING_TYPE_APP - Target a specific app (for example, Angry Birds).
+      TARGETING_TYPE_URL - Target a specific url (for example, quora.com).
+      TARGETING_TYPE_DAY_AND_TIME - Target ads during a chosen time period on a specific day.
+      TARGETING_TYPE_AGE_RANGE - Target ads to a specific age range (for example, 18-24).
+      TARGETING_TYPE_REGIONAL_LOCATION_LIST - Target ads to the specified regions on a regional location list.
+      TARGETING_TYPE_PROXIMITY_LOCATION_LIST - Target ads to the specified points of interest on a proximity location list.
+      TARGETING_TYPE_GENDER - Target ads to a specific gender (for example, female or male).
+      TARGETING_TYPE_VIDEO_PLAYER_SIZE - Target a specific video player size for video ads.
+      TARGETING_TYPE_USER_REWARDED_CONTENT - Target user rewarded content for video ads.
+      TARGETING_TYPE_PARENTAL_STATUS - Target ads to a specific parental status (for example, parent or not a parent).
+      TARGETING_TYPE_CONTENT_INSTREAM_POSITION - Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).
+      TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION - Target ads in a specific content outstream position.
+      TARGETING_TYPE_DEVICE_TYPE - Target ads to a specific device type (for example, tablet or connected TV).
+      TARGETING_TYPE_AUDIENCE_GROUP - Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.
+      TARGETING_TYPE_BROWSER - Target ads to specific web browsers (for example, Chrome).
+      TARGETING_TYPE_HOUSEHOLD_INCOME - Target ads to a specific household income range (for example, top 10%).
+      TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position.
+      TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify).
+      TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).
+      TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult).
+      TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app).
+      TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).
+      TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS).
+      TARGETING_TYPE_DEVICE_MAKE_MODEL - Target ads to a specific device make or model (for example, Roku or Samsung).
+      TARGETING_TYPE_KEYWORD - Target ads to a specific keyword (for example, dog or retriever).
+      TARGETING_TYPE_NEGATIVE_KEYWORD_LIST - Target ads to a specific negative keyword list.
+      TARGETING_TYPE_VIEWABILITY - Target ads to a specific viewability (for example, 80% viewable).
+      TARGETING_TYPE_CATEGORY - Target ads to a specific content category (for example, arts & entertainment).
+      TARGETING_TYPE_INVENTORY_SOURCE - Purchase impressions from specific deals and auction packages.
+      TARGETING_TYPE_LANGUAGE - Target ads to a specific language (for example, English or Japanese).
+      TARGETING_TYPE_AUTHORIZED_SELLER_STATUS - Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.
+      TARGETING_TYPE_GEO_REGION - Target ads to a specific regional location (for example, a city or state).
+      TARGETING_TYPE_INVENTORY_SOURCE_GROUP - Purchase impressions from a group of deals and auction packages.
+      TARGETING_TYPE_EXCHANGE - Purchase impressions from specific exchanges.
+      TARGETING_TYPE_SUB_EXCHANGE - Purchase impressions from specific sub-exchanges.
+      TARGETING_TYPE_POI - Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.
+      TARGETING_TYPE_BUSINESS_CHAIN - Target ads around locations of a business chain within a specific geo region.
+      TARGETING_TYPE_CONTENT_DURATION - Target ads to a specific video content duration.
+      TARGETING_TYPE_CONTENT_STREAM_TYPE - Target ads to a specific video content stream type.
+      TARGETING_TYPE_NATIVE_CONTENT_POSITION - Target ads to a specific native content position.
+      TARGETING_TYPE_OMID - Target ads in an Open Measurement enabled inventory.
+      TARGETING_TYPE_AUDIO_CONTENT_TYPE - Target ads to a specific audio content type.
+      TARGETING_TYPE_CONTENT_GENRE - Target ads to a specific content genre.
+      TARGETING_TYPE_YOUTUBE_VIDEO - Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
+      TARGETING_TYPE_YOUTUBE_CHANNEL - Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
+      TARGETING_TYPE_SESSION_POSITION - Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.
+  assignedTargetingOptionId: string, Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings.
+  "ageRangeDetails": { # Represents a targetable age range. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AGE_RANGE`. # Age range details. This field will be populated when the targeting_type is `TARGETING_TYPE_AGE_RANGE`.
+    "ageRange": "A String", # Required. The age range of an audience. We only support targeting a continuous age range of an audience. Thus, the age range represented in this field can be 1) targeted solely, or, 2) part of a larger continuous age range. The reach of a continuous age range targeting can be expanded by also targeting an audience of an unknown age.
+  },
+  "appCategoryDetails": { # Details for assigned app category targeting option. This will be populated in the app_category_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. # App category details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
+    "displayName": "A String", # Output only. The display name of the app category.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
+  },
+  "appDetails": { # Details for assigned app targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP`. # App details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP`.
+    "appId": "A String", # Required. The ID of the app. Android's Play store app uses bundle ID, for example `com.google.android.gm`. Apple's App store app ID uses 9 digit string, for example `422689480`.
+    "appPlatform": "A String", # Indicates the platform of the targeted app. If this field is not specified, the app platform will be assumed to be mobile (i.e., Android or iOS), and we will derive the appropriate mobile platform from the app ID.
+    "displayName": "A String", # Output only. The display name of the app.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+  },
+  "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts.
+  "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`
+  "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource.
+    "excludedFirstPartyAndPartnerAudienceGroup": { # Details of first party and partner audience group. All first party and partner audience targeting settings are logically ‘OR’ of each other. # Optional. The first party and partner audience ids and recencies of the excluded first party and partner audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other.
+      "settings": [ # Required. All first party and partner audience targeting settings in first party and partner audience group. Repeated settings with the same id are not allowed.
+        { # Details of first party and partner audience targeting setting.
+          "firstPartyAndPartnerAudienceId": "A String", # Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.
+          "recency": "A String", # Required. The recency of the first party and partner audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
+        },
+      ],
+    },
+    "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other.
+      "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
+        { # Details of Google audience targeting setting.
+          "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
+        },
+      ],
+    },
+    "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only.
+      "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise.
+        { # Details of combined audience targeting setting.
+          "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id.
+        },
+      ],
+    },
+    "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only.
+      "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored.
+        { # Details of custom list targeting setting.
+          "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id.
+        },
+      ],
+    },
+    "includedFirstPartyAndPartnerAudienceGroups": [ # Optional. The first party and partner audience ids and recencies of included first party and partner audience groups. Each first party and partner audience group contains first party and partner audience ids only. The relation between each first party and partner audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored.
+      { # Details of first party and partner audience group. All first party and partner audience targeting settings are logically ‘OR’ of each other.
+        "settings": [ # Required. All first party and partner audience targeting settings in first party and partner audience group. Repeated settings with the same id are not allowed.
+          { # Details of first party and partner audience targeting setting.
+            "firstPartyAndPartnerAudienceId": "A String", # Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.
+            "recency": "A String", # Required. The recency of the first party and partner audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
+          },
+        ],
+      },
+    ],
+    "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only.
+      "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
+        { # Details of Google audience targeting setting.
+          "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
+        },
+      ],
+    },
+  },
+  "audioContentTypeDetails": { # Details for audio content type assigned targeting option. This will be populated in the audio_content_type_details field when targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`. Explicitly targeting all options is not supported. Remove all audio content type targeting options to achieve this effect. # Audio content type details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`.
+    "audioContentType": "A String", # Required. The audio content type.
+  },
+  "authorizedSellerStatusDetails": { # Represents an assigned authorized seller status. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. If a resource does not have an `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` assigned targeting option, it is using the "Authorized Direct Sellers and Resellers" option. # Authorized seller status details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. You can only target one authorized seller status option per resource. If a resource doesn't have an authorized seller status option, all authorized sellers indicated as DIRECT or RESELLER in the ads.txt file are targeted by default.
+    "authorizedSellerStatus": "A String", # Output only. The authorized seller status to target.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.
+  },
+  "browserDetails": { # Details for assigned browser targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BROWSER`. # Browser details. This field will be populated when the targeting_type is `TARGETING_TYPE_BROWSER`.
+    "displayName": "A String", # Output only. The display name of the browser.
+    "negative": True or False, # Indicates if this option is being negatively targeted. All assigned browser targeting options on the same resource must have the same value for this field.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BROWSER`.
+  },
+  "businessChainDetails": { # Details for assigned Business chain targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`. # Business chain details. This field will be populated when the targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`.
+    "displayName": "A String", # Output only. The display name of a business chain, e.g. "KFC", "Chase Bank".
+    "proximityRadiusAmount": 3.14, # Required. The radius of the area around the business chain that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`. The minimum increment for both cases is 0.1. Inputs will be rounded to the nearest acceptable value if it is too granular, e.g. 15.57 will become 15.6.
+    "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BUSINESS_CHAIN`. Accepted business chain targeting option IDs can be retrieved using SearchTargetingOptions.
+  },
+  "carrierAndIspDetails": { # Details for assigned carrier and ISP targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`. # Carrier and ISP details. This field will be populated when the targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`.
+    "displayName": "A String", # Output only. The display name of the carrier or ISP.
+    "negative": True or False, # Indicates if this option is being negatively targeted. All assigned carrier and ISP targeting options on the same resource must have the same value for this field.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`.
+  },
+  "categoryDetails": { # Assigned category targeting option details. This will be populated in the category_details field when targeting_type is `TARGETING_TYPE_CATEGORY`. # Category details. This field will be populated when the targeting_type is `TARGETING_TYPE_CATEGORY`. Targeting a category will also target its subcategories. If a category is excluded from targeting and a subcategory is included, the exclusion will take precedence.
+    "displayName": "A String", # Output only. The display name of the category.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CATEGORY`.
+  },
+  "channelDetails": { # Details for assigned channel targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CHANNEL`. # Channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_CHANNEL`.
+    "channelId": "A String", # Required. ID of the channel. Should refer to the channel ID field on a [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id) resource.
+    "negative": True or False, # Indicates if this option is being negatively targeted. For advertiser level assigned targeting option, this field must be true.
+  },
+  "contentDurationDetails": { # Details for content duration assigned targeting option. This will be populated in the content_duration_details field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`. Explicitly targeting all options is not supported. Remove all content duration targeting options to achieve this effect. # Content duration details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
+    "contentDuration": "A String", # Output only. The content duration.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
+  },
+  "contentGenreDetails": { # Details for content genre assigned targeting option. This will be populated in the content_genre_details field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`. Explicitly targeting all options is not supported. Remove all content genre targeting options to achieve this effect. # Content genre details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
+    "displayName": "A String", # Output only. The display name of the content genre.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
+  },
+  "contentInstreamPositionDetails": { # Assigned content instream position targeting option details. This will be populated in the content_instream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. # Content instream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.
+    "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`. * `AD_TYPE_AUDIO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_AUDIO_DEFAULT`.
+    "contentInstreamPosition": "A String", # Required. The content instream position for video or audio ads.
+  },
+  "contentOutstreamPositionDetails": { # Assigned content outstream position targeting option details. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. # Content outstream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.
+    "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+    "contentOutstreamPosition": "A String", # Required. The content outstream position.
+  },
+  "contentStreamTypeDetails": { # Details for content stream type assigned targeting option. This will be populated in the content_stream_type_details field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`. Explicitly targeting all options is not supported. Remove all content stream type targeting options to achieve this effect. # Content duration details. This field will be populated when the TargetingType is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
+    "contentStreamType": "A String", # Output only. The content stream type.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
+  },
+  "dayAndTimeDetails": { # Representation of a segment of time defined on a specific day of the week and with a start and end time. The time represented by `start_hour` must be before the time represented by `end_hour`. # Day and time details. This field will be populated when the targeting_type is `TARGETING_TYPE_DAY_AND_TIME`.
+    "dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting.
+    "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day).
+    "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day).
+    "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting.
+  },
+  "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
+    "displayName": "A String", # Output only. The display name of the device make and model.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
+  },
+  "deviceTypeDetails": { # Targeting details for device type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`. # Device Type details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_TYPE`.
+    "deviceType": "A String", # Required. The display name of the device type.
+    "youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items.
+  },
+  "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded.
+    "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED.
+  },
+  "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`.
+    "environment": "A String", # Required. The serving environment.
+  },
+  "exchangeDetails": { # Details for assigned exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`. # Exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_EXCHANGE`.
+    "exchange": "A String", # Required. The enum value for the exchange.
+  },
+  "genderDetails": { # Details for assigned gender targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GENDER`. # Gender details. This field will be populated when the targeting_type is `TARGETING_TYPE_GENDER`.
+    "gender": "A String", # Required. The gender of the audience.
+  },
+  "geoRegionDetails": { # Details for assigned geographic region targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GEO_REGION`. # Geographic region details. This field will be populated when the targeting_type is `TARGETING_TYPE_GEO_REGION`.
+    "displayName": "A String", # Output only. The display name of the geographic region (e.g., "Ontario, Canada").
+    "geoRegionType": "A String", # Output only. The type of geographic region targeting.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GEO_REGION`.
+  },
+  "householdIncomeDetails": { # Details for assigned household income targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`. # Household income details. This field will be populated when the targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`.
+    "householdIncome": "A String", # Required. The household income of the audience.
+  },
+  "inheritance": "A String", # Output only. The inheritance status of the assigned targeting option.
+  "inventorySourceDetails": { # Targeting details for inventory source. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`. # Inventory source details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`.
+    "inventorySourceId": "A String", # Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource.
+  },
+  "inventorySourceGroupDetails": { # Targeting details for inventory source group. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`. # Inventory source group details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`.
+    "inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource.
+  },
+  "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned.
+    "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+  },
+  "languageDetails": { # Details for assigned language targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_LANGUAGE`. # Language details. This field will be populated when the targeting_type is `TARGETING_TYPE_LANGUAGE`.
+    "displayName": "A String", # Output only. The display name of the language (e.g., "French").
+    "negative": True or False, # Indicates if this option is being negatively targeted. All assigned language targeting options on the same resource must have the same value for this field.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_LANGUAGE`.
+  },
+  "name": "A String", # Output only. The resource name for this assigned targeting option.
+  "nativeContentPositionDetails": { # Details for native content position assigned targeting option. This will be populated in the native_content_position_details field when targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`. Explicitly targeting all options is not supported. Remove all native content position targeting options to achieve this effect. # Native content position details. This field will be populated when the targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`.
+    "contentPosition": "A String", # Required. The content position.
+  },
+  "negativeKeywordListDetails": { # Targeting details for negative keyword list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. A maximum of 4 negative keyword lists can be assigned to a resource.
+    "negativeKeywordListId": "A String", # Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource.
+  },
+  "omidDetails": { # Represents a targetable Open Measurement enabled inventory type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_OMID`. # Open Measurement enabled inventory details. This field will be populated when the targeting_type is `TARGETING_TYPE_OMID`.
+    "omid": "A String", # Required. The type of Open Measurement enabled inventory.
+  },
+  "onScreenPositionDetails": { # On screen position targeting option details. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. # On screen position details. This field will be populated when the targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
+    "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+    "onScreenPosition": "A String", # Output only. The on screen position.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
+  },
+  "operatingSystemDetails": { # Assigned operating system targeting option details. This will be populated in the operating_system_details field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. # Operating system details. This field will be populated when the targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
+    "displayName": "A String", # Output only. The display name of the operating system.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting option ID populated in targeting_option_id field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
+  },
+  "parentalStatusDetails": { # Details for assigned parental status targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`. # Parental status details. This field will be populated when the targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`.
+    "parentalStatus": "A String", # Required. The parental status of the audience.
+  },
+  "poiDetails": { # Details for assigned POI targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_POI`. # POI details. This field will be populated when the targeting_type is `TARGETING_TYPE_POI`.
+    "displayName": "A String", # Output only. The display name of a POI, e.g. "Times Square", "Space Needle", followed by its full address if available.
+    "latitude": 3.14, # Output only. Latitude of the POI rounding to 6th decimal place.
+    "longitude": 3.14, # Output only. Longitude of the POI rounding to 6th decimal place.
+    "proximityRadiusAmount": 3.14, # Required. The radius of the area around the POI that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`.
+    "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_POI`. Accepted POI targeting option IDs can be retrieved using `targetingTypes.targetingOptions.search`. If targeting a specific latitude/longitude coordinate removed from an address or POI name, you can generate the necessary targeting option ID by rounding the desired coordinate values to the 6th decimal place, removing the decimals, and concatenating the string values separated by a semicolon. For example, you can target the latitude/longitude pair of 40.7414691, -74.003387 using the targeting option ID "40741469;-74003387". **Upon** **creation, this field value will be updated to append a semicolon and** **alphanumerical hash value if only latitude/longitude coordinates are** **provided.**
+  },
+  "proximityLocationListDetails": { # Targeting details for proximity location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`. # Proximity location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`.
+    "proximityLocationListId": "A String", # Required. ID of the proximity location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_PROXIMITY`.
+    "proximityRadius": 3.14, # Required. Radius expressed in the distance units set in proximity_radius_unit. This represents the size of the area around a chosen location that will be targeted. Radius should be between 1 and 500 miles or 800 kilometers.
+    "proximityRadiusUnit": "A String", # Required. Radius distance units.
+  },
+  "regionalLocationListDetails": { # Targeting details for regional location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`. # Regional location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`.
+  },
+  "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them.
+    "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED.
+  },
+  "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`.
+    "sessionPosition": "A String", # The position where the ad will show in a session.
+  },
+  "subExchangeDetails": { # Details for assigned sub-exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`. # Sub-exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`.
+  },
+  "targetingType": "A String", # Output only. Identifies the type of this assigned targeting option.
+  "thirdPartyVerifierDetails": { # Assigned third party verifier targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`. # Third party verification details. This field will be populated when the targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`.
+    "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox.
+      "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads.
+      "excludedAdlooxCategories": [ # Adloox categories to exclude.
+        "A String",
+      ],
+      "excludedFraudIvtMfaCategories": [ # Optional. Adloox's fraud IVT MFA categories to exclude.
+        "A String",
+      ],
+      "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads.
+    },
+    "doubleVerify": { # Details of DoubleVerify settings. # Third party brand verifier -- DoubleVerify.
+      "appStarRating": { # Details of DoubleVerify star ratings settings. # Avoid bidding on apps with the star ratings.
+        "avoidInsufficientStarRating": True or False, # Avoid bidding on apps with insufficient star ratings.
+        "avoidedStarRating": "A String", # Avoid bidding on apps with the star ratings.
+      },
+      "avoidedAgeRatings": [ # Avoid bidding on apps with the age rating.
+        "A String",
+      ],
+      "brandSafetyCategories": { # Settings for brand safety controls. # DV Brand Safety Controls.
+        "avoidUnknownBrandSafetyCategory": True or False, # Unknown or unrateable.
+        "avoidedHighSeverityCategories": [ # Brand safety high severity avoidance categories.
+          "A String",
+        ],
+        "avoidedMediumSeverityCategories": [ # Brand safety medium severity avoidance categories.
+          "A String",
+        ],
+      },
+      "customSegmentId": "A String", # The custom segment ID provided by DoubleVerify. The ID must start with "51" and consist of eight digits. Custom segment ID cannot be specified along with any of the following fields: * brand_safety_categories * avoided_age_ratings * app_star_rating * fraud_invalid_traffic
+      "displayViewability": { # Details of DoubleVerify display viewability settings. # Display viewability settings (applicable to display line items only).
+        "iab": "A String", # Target web and app inventory to maximize IAB viewable rate.
+        "viewableDuring": "A String", # Target web and app inventory to maximize 100% viewable duration.
+      },
+      "fraudInvalidTraffic": { # DoubleVerify Fraud & Invalid Traffic settings. # Avoid Sites and Apps with historical Fraud & IVT Rates.
+        "avoidInsufficientOption": True or False, # Insufficient Historical Fraud & IVT Stats.
+        "avoidedFraudOption": "A String", # Avoid Sites and Apps with historical Fraud & IVT.
+      },
+      "videoViewability": { # Details of DoubleVerify video viewability settings. # Video viewability settings (applicable to video line items only).
+        "playerImpressionRate": "A String", # Target inventory to maximize impressions with 400x300 or greater player size.
+        "videoIab": "A String", # Target web inventory to maximize IAB viewable rate.
+        "videoViewableRate": "A String", # Target web inventory to maximize fully viewable rate.
+      },
+    },
+    "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science.
+      "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive.
+        "A String",
+      ],
+      "displayViewability": "A String", # Display Viewability section (applicable to display line items only).
+      "excludeUnrateable": True or False, # Brand Safety - **Unrateable**.
+      "excludedAdFraudRisk": "A String", # Ad Fraud settings.
+      "excludedAdultRisk": "A String", # Brand Safety - **Adult content**.
+      "excludedAlcoholRisk": "A String", # Brand Safety - **Alcohol**.
+      "excludedDrugsRisk": "A String", # Brand Safety - **Drugs**.
+      "excludedGamblingRisk": "A String", # Brand Safety - **Gambling**.
+      "excludedHateSpeechRisk": "A String", # Brand Safety - **Hate speech**.
+      "excludedIllegalDownloadsRisk": "A String", # Brand Safety - **Illegal downloads**.
+      "excludedOffensiveLanguageRisk": "A String", # Brand Safety - **Offensive language**.
+      "excludedViolenceRisk": "A String", # Brand Safety - **Violence**.
+      "qualitySyncCustomSegmentId": [ # Optional. The quality sync custom segment ID provided by Integral Ad Science. The ID must be between `3000000` and `4999999`, inclusive.
+        "A String",
+      ],
+      "traqScoreOption": "A String", # True advertising quality (applicable to Display line items only).
+      "videoViewability": "A String", # Video Viewability Section (applicable to video line items only).
+    },
+  },
+  "urlDetails": { # Details for assigned URL targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_URL`. # URL details. This field will be populated when the targeting_type is `TARGETING_TYPE_URL`.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "url": "A String", # Required. The URL, for example `example.com`. DV360 supports two levels of subdirectory targeting, for example `www.example.com/one-subdirectory-level/second-level`, and five levels of subdomain targeting, for example `five.four.three.two.one.example.com`.
+  },
+  "userRewardedContentDetails": { # User rewarded content targeting option details. This will be populated in the user_rewarded_content_details field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. # User rewarded content details. This field will be populated when the targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
+    "userRewardedContent": "A String", # Output only. User rewarded content status for video ads.
+  },
+  "videoPlayerSizeDetails": { # Video player size targeting option details. This will be populated in the video_player_size_details field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. Explicitly targeting all options is not supported. Remove all video player size targeting options to achieve this effect. # Video player size details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.
+    "videoPlayerSize": "A String", # Required. The video player size.
+  },
+  "viewabilityDetails": { # Assigned viewability targeting option details. This will be populated in the viewability_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`. # Viewability details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIEWABILITY`. You can only target one viewability option per resource.
+    "viewability": "A String", # Required. The predicted viewability percentage.
+  },
+  "youtubeChannelDetails": { # Details for YouTube channel assigned targeting option. This will be populated in the youtube_channel_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`. # YouTube channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`.
+    "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+  },
+  "youtubeVideoDetails": { # Details for YouTube video assigned targeting option. This will be populated in the youtube_video_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`. # YouTube video details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "videoId": "A String", # YouTube video id as it appears on the YouTube watch page.
+  },
+}
+
+ +
+ list(advertiserId, adGroupId, targetingType, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists the targeting options assigned to an ad group. Inherited assigned targeting options are not included.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser the ad group belongs to. (required)
+  adGroupId: string, Required. The ID of the ad group to list assigned targeting options for. (required)
+  targetingType: string, Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO` (required)
+    Allowed values
+      TARGETING_TYPE_UNSPECIFIED - Default value when type is not specified or is unknown in this version.
+      TARGETING_TYPE_CHANNEL - Target a channel (a custom group of related websites or apps).
+      TARGETING_TYPE_APP_CATEGORY - Target an app category (for example, education or puzzle games).
+      TARGETING_TYPE_APP - Target a specific app (for example, Angry Birds).
+      TARGETING_TYPE_URL - Target a specific url (for example, quora.com).
+      TARGETING_TYPE_DAY_AND_TIME - Target ads during a chosen time period on a specific day.
+      TARGETING_TYPE_AGE_RANGE - Target ads to a specific age range (for example, 18-24).
+      TARGETING_TYPE_REGIONAL_LOCATION_LIST - Target ads to the specified regions on a regional location list.
+      TARGETING_TYPE_PROXIMITY_LOCATION_LIST - Target ads to the specified points of interest on a proximity location list.
+      TARGETING_TYPE_GENDER - Target ads to a specific gender (for example, female or male).
+      TARGETING_TYPE_VIDEO_PLAYER_SIZE - Target a specific video player size for video ads.
+      TARGETING_TYPE_USER_REWARDED_CONTENT - Target user rewarded content for video ads.
+      TARGETING_TYPE_PARENTAL_STATUS - Target ads to a specific parental status (for example, parent or not a parent).
+      TARGETING_TYPE_CONTENT_INSTREAM_POSITION - Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).
+      TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION - Target ads in a specific content outstream position.
+      TARGETING_TYPE_DEVICE_TYPE - Target ads to a specific device type (for example, tablet or connected TV).
+      TARGETING_TYPE_AUDIENCE_GROUP - Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.
+      TARGETING_TYPE_BROWSER - Target ads to specific web browsers (for example, Chrome).
+      TARGETING_TYPE_HOUSEHOLD_INCOME - Target ads to a specific household income range (for example, top 10%).
+      TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position.
+      TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify).
+      TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).
+      TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult).
+      TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app).
+      TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).
+      TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS).
+      TARGETING_TYPE_DEVICE_MAKE_MODEL - Target ads to a specific device make or model (for example, Roku or Samsung).
+      TARGETING_TYPE_KEYWORD - Target ads to a specific keyword (for example, dog or retriever).
+      TARGETING_TYPE_NEGATIVE_KEYWORD_LIST - Target ads to a specific negative keyword list.
+      TARGETING_TYPE_VIEWABILITY - Target ads to a specific viewability (for example, 80% viewable).
+      TARGETING_TYPE_CATEGORY - Target ads to a specific content category (for example, arts & entertainment).
+      TARGETING_TYPE_INVENTORY_SOURCE - Purchase impressions from specific deals and auction packages.
+      TARGETING_TYPE_LANGUAGE - Target ads to a specific language (for example, English or Japanese).
+      TARGETING_TYPE_AUTHORIZED_SELLER_STATUS - Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.
+      TARGETING_TYPE_GEO_REGION - Target ads to a specific regional location (for example, a city or state).
+      TARGETING_TYPE_INVENTORY_SOURCE_GROUP - Purchase impressions from a group of deals and auction packages.
+      TARGETING_TYPE_EXCHANGE - Purchase impressions from specific exchanges.
+      TARGETING_TYPE_SUB_EXCHANGE - Purchase impressions from specific sub-exchanges.
+      TARGETING_TYPE_POI - Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.
+      TARGETING_TYPE_BUSINESS_CHAIN - Target ads around locations of a business chain within a specific geo region.
+      TARGETING_TYPE_CONTENT_DURATION - Target ads to a specific video content duration.
+      TARGETING_TYPE_CONTENT_STREAM_TYPE - Target ads to a specific video content stream type.
+      TARGETING_TYPE_NATIVE_CONTENT_POSITION - Target ads to a specific native content position.
+      TARGETING_TYPE_OMID - Target ads in an Open Measurement enabled inventory.
+      TARGETING_TYPE_AUDIO_CONTENT_TYPE - Target ads to a specific audio content type.
+      TARGETING_TYPE_CONTENT_GENRE - Target ads to a specific content genre.
+      TARGETING_TYPE_YOUTUBE_VIDEO - Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
+      TARGETING_TYPE_YOUTUBE_CHANNEL - Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
+      TARGETING_TYPE_SESSION_POSITION - Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.
+  filter: string, Optional. Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` Examples: * `AssignedTargetingOption` resources with ID 1 or 2: `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
+  orderBy: string, Optional. Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`.
+  pageSize: integer, Optional. Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
+  pageToken: string, Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdGroupAssignedTargetingOptions` method. If not specified, the first page of results 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:
+
+    { # Response message for ListAdGroupAssignedTargetingOptions.
+  "assignedTargetingOptions": [ # The list of assigned targeting options. This list will be absent if empty.
+    { # A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings.
+      "ageRangeDetails": { # Represents a targetable age range. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AGE_RANGE`. # Age range details. This field will be populated when the targeting_type is `TARGETING_TYPE_AGE_RANGE`.
+        "ageRange": "A String", # Required. The age range of an audience. We only support targeting a continuous age range of an audience. Thus, the age range represented in this field can be 1) targeted solely, or, 2) part of a larger continuous age range. The reach of a continuous age range targeting can be expanded by also targeting an audience of an unknown age.
+      },
+      "appCategoryDetails": { # Details for assigned app category targeting option. This will be populated in the app_category_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. # App category details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
+        "displayName": "A String", # Output only. The display name of the app category.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
+      },
+      "appDetails": { # Details for assigned app targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP`. # App details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP`.
+        "appId": "A String", # Required. The ID of the app. Android's Play store app uses bundle ID, for example `com.google.android.gm`. Apple's App store app ID uses 9 digit string, for example `422689480`.
+        "appPlatform": "A String", # Indicates the platform of the targeted app. If this field is not specified, the app platform will be assumed to be mobile (i.e., Android or iOS), and we will derive the appropriate mobile platform from the app ID.
+        "displayName": "A String", # Output only. The display name of the app.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+      },
+      "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts.
+      "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`
+      "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource.
+        "excludedFirstPartyAndPartnerAudienceGroup": { # Details of first party and partner audience group. All first party and partner audience targeting settings are logically ‘OR’ of each other. # Optional. The first party and partner audience ids and recencies of the excluded first party and partner audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other.
+          "settings": [ # Required. All first party and partner audience targeting settings in first party and partner audience group. Repeated settings with the same id are not allowed.
+            { # Details of first party and partner audience targeting setting.
+              "firstPartyAndPartnerAudienceId": "A String", # Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.
+              "recency": "A String", # Required. The recency of the first party and partner audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
+            },
+          ],
+        },
+        "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other.
+          "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
+            { # Details of Google audience targeting setting.
+              "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
+            },
+          ],
+        },
+        "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only.
+          "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise.
+            { # Details of combined audience targeting setting.
+              "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id.
+            },
+          ],
+        },
+        "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only.
+          "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored.
+            { # Details of custom list targeting setting.
+              "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id.
+            },
+          ],
+        },
+        "includedFirstPartyAndPartnerAudienceGroups": [ # Optional. The first party and partner audience ids and recencies of included first party and partner audience groups. Each first party and partner audience group contains first party and partner audience ids only. The relation between each first party and partner audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored.
+          { # Details of first party and partner audience group. All first party and partner audience targeting settings are logically ‘OR’ of each other.
+            "settings": [ # Required. All first party and partner audience targeting settings in first party and partner audience group. Repeated settings with the same id are not allowed.
+              { # Details of first party and partner audience targeting setting.
+                "firstPartyAndPartnerAudienceId": "A String", # Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.
+                "recency": "A String", # Required. The recency of the first party and partner audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
+              },
+            ],
+          },
+        ],
+        "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only.
+          "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
+            { # Details of Google audience targeting setting.
+              "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
+            },
+          ],
+        },
+      },
+      "audioContentTypeDetails": { # Details for audio content type assigned targeting option. This will be populated in the audio_content_type_details field when targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`. Explicitly targeting all options is not supported. Remove all audio content type targeting options to achieve this effect. # Audio content type details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`.
+        "audioContentType": "A String", # Required. The audio content type.
+      },
+      "authorizedSellerStatusDetails": { # Represents an assigned authorized seller status. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. If a resource does not have an `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` assigned targeting option, it is using the "Authorized Direct Sellers and Resellers" option. # Authorized seller status details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. You can only target one authorized seller status option per resource. If a resource doesn't have an authorized seller status option, all authorized sellers indicated as DIRECT or RESELLER in the ads.txt file are targeted by default.
+        "authorizedSellerStatus": "A String", # Output only. The authorized seller status to target.
+        "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.
+      },
+      "browserDetails": { # Details for assigned browser targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BROWSER`. # Browser details. This field will be populated when the targeting_type is `TARGETING_TYPE_BROWSER`.
+        "displayName": "A String", # Output only. The display name of the browser.
+        "negative": True or False, # Indicates if this option is being negatively targeted. All assigned browser targeting options on the same resource must have the same value for this field.
+        "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BROWSER`.
+      },
+      "businessChainDetails": { # Details for assigned Business chain targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`. # Business chain details. This field will be populated when the targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`.
+        "displayName": "A String", # Output only. The display name of a business chain, e.g. "KFC", "Chase Bank".
+        "proximityRadiusAmount": 3.14, # Required. The radius of the area around the business chain that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`. The minimum increment for both cases is 0.1. Inputs will be rounded to the nearest acceptable value if it is too granular, e.g. 15.57 will become 15.6.
+        "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
+        "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BUSINESS_CHAIN`. Accepted business chain targeting option IDs can be retrieved using SearchTargetingOptions.
+      },
+      "carrierAndIspDetails": { # Details for assigned carrier and ISP targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`. # Carrier and ISP details. This field will be populated when the targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`.
+        "displayName": "A String", # Output only. The display name of the carrier or ISP.
+        "negative": True or False, # Indicates if this option is being negatively targeted. All assigned carrier and ISP targeting options on the same resource must have the same value for this field.
+        "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`.
+      },
+      "categoryDetails": { # Assigned category targeting option details. This will be populated in the category_details field when targeting_type is `TARGETING_TYPE_CATEGORY`. # Category details. This field will be populated when the targeting_type is `TARGETING_TYPE_CATEGORY`. Targeting a category will also target its subcategories. If a category is excluded from targeting and a subcategory is included, the exclusion will take precedence.
+        "displayName": "A String", # Output only. The display name of the category.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CATEGORY`.
+      },
+      "channelDetails": { # Details for assigned channel targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CHANNEL`. # Channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_CHANNEL`.
+        "channelId": "A String", # Required. ID of the channel. Should refer to the channel ID field on a [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id) resource.
+        "negative": True or False, # Indicates if this option is being negatively targeted. For advertiser level assigned targeting option, this field must be true.
+      },
+      "contentDurationDetails": { # Details for content duration assigned targeting option. This will be populated in the content_duration_details field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`. Explicitly targeting all options is not supported. Remove all content duration targeting options to achieve this effect. # Content duration details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
+        "contentDuration": "A String", # Output only. The content duration.
+        "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
+      },
+      "contentGenreDetails": { # Details for content genre assigned targeting option. This will be populated in the content_genre_details field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`. Explicitly targeting all options is not supported. Remove all content genre targeting options to achieve this effect. # Content genre details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
+        "displayName": "A String", # Output only. The display name of the content genre.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
+      },
+      "contentInstreamPositionDetails": { # Assigned content instream position targeting option details. This will be populated in the content_instream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. # Content instream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.
+        "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`. * `AD_TYPE_AUDIO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_AUDIO_DEFAULT`.
+        "contentInstreamPosition": "A String", # Required. The content instream position for video or audio ads.
+      },
+      "contentOutstreamPositionDetails": { # Assigned content outstream position targeting option details. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. # Content outstream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.
+        "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+        "contentOutstreamPosition": "A String", # Required. The content outstream position.
+      },
+      "contentStreamTypeDetails": { # Details for content stream type assigned targeting option. This will be populated in the content_stream_type_details field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`. Explicitly targeting all options is not supported. Remove all content stream type targeting options to achieve this effect. # Content duration details. This field will be populated when the TargetingType is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
+        "contentStreamType": "A String", # Output only. The content stream type.
+        "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
+      },
+      "dayAndTimeDetails": { # Representation of a segment of time defined on a specific day of the week and with a start and end time. The time represented by `start_hour` must be before the time represented by `end_hour`. # Day and time details. This field will be populated when the targeting_type is `TARGETING_TYPE_DAY_AND_TIME`.
+        "dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting.
+        "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day).
+        "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day).
+        "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting.
+      },
+      "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
+        "displayName": "A String", # Output only. The display name of the device make and model.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
+      },
+      "deviceTypeDetails": { # Targeting details for device type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`. # Device Type details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_TYPE`.
+        "deviceType": "A String", # Required. The display name of the device type.
+        "youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items.
+      },
+      "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded.
+        "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED.
+      },
+      "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`.
+        "environment": "A String", # Required. The serving environment.
+      },
+      "exchangeDetails": { # Details for assigned exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`. # Exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_EXCHANGE`.
+        "exchange": "A String", # Required. The enum value for the exchange.
+      },
+      "genderDetails": { # Details for assigned gender targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GENDER`. # Gender details. This field will be populated when the targeting_type is `TARGETING_TYPE_GENDER`.
+        "gender": "A String", # Required. The gender of the audience.
+      },
+      "geoRegionDetails": { # Details for assigned geographic region targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GEO_REGION`. # Geographic region details. This field will be populated when the targeting_type is `TARGETING_TYPE_GEO_REGION`.
+        "displayName": "A String", # Output only. The display name of the geographic region (e.g., "Ontario, Canada").
+        "geoRegionType": "A String", # Output only. The type of geographic region targeting.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GEO_REGION`.
+      },
+      "householdIncomeDetails": { # Details for assigned household income targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`. # Household income details. This field will be populated when the targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`.
+        "householdIncome": "A String", # Required. The household income of the audience.
+      },
+      "inheritance": "A String", # Output only. The inheritance status of the assigned targeting option.
+      "inventorySourceDetails": { # Targeting details for inventory source. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`. # Inventory source details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`.
+        "inventorySourceId": "A String", # Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource.
+      },
+      "inventorySourceGroupDetails": { # Targeting details for inventory source group. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`. # Inventory source group details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`.
+        "inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource.
+      },
+      "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned.
+        "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+      },
+      "languageDetails": { # Details for assigned language targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_LANGUAGE`. # Language details. This field will be populated when the targeting_type is `TARGETING_TYPE_LANGUAGE`.
+        "displayName": "A String", # Output only. The display name of the language (e.g., "French").
+        "negative": True or False, # Indicates if this option is being negatively targeted. All assigned language targeting options on the same resource must have the same value for this field.
+        "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_LANGUAGE`.
+      },
+      "name": "A String", # Output only. The resource name for this assigned targeting option.
+      "nativeContentPositionDetails": { # Details for native content position assigned targeting option. This will be populated in the native_content_position_details field when targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`. Explicitly targeting all options is not supported. Remove all native content position targeting options to achieve this effect. # Native content position details. This field will be populated when the targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`.
+        "contentPosition": "A String", # Required. The content position.
+      },
+      "negativeKeywordListDetails": { # Targeting details for negative keyword list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. A maximum of 4 negative keyword lists can be assigned to a resource.
+        "negativeKeywordListId": "A String", # Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource.
+      },
+      "omidDetails": { # Represents a targetable Open Measurement enabled inventory type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_OMID`. # Open Measurement enabled inventory details. This field will be populated when the targeting_type is `TARGETING_TYPE_OMID`.
+        "omid": "A String", # Required. The type of Open Measurement enabled inventory.
+      },
+      "onScreenPositionDetails": { # On screen position targeting option details. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. # On screen position details. This field will be populated when the targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
+        "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+        "onScreenPosition": "A String", # Output only. The on screen position.
+        "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
+      },
+      "operatingSystemDetails": { # Assigned operating system targeting option details. This will be populated in the operating_system_details field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. # Operating system details. This field will be populated when the targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
+        "displayName": "A String", # Output only. The display name of the operating system.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "targetingOptionId": "A String", # Required. The targeting option ID populated in targeting_option_id field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
+      },
+      "parentalStatusDetails": { # Details for assigned parental status targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`. # Parental status details. This field will be populated when the targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`.
+        "parentalStatus": "A String", # Required. The parental status of the audience.
+      },
+      "poiDetails": { # Details for assigned POI targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_POI`. # POI details. This field will be populated when the targeting_type is `TARGETING_TYPE_POI`.
+        "displayName": "A String", # Output only. The display name of a POI, e.g. "Times Square", "Space Needle", followed by its full address if available.
+        "latitude": 3.14, # Output only. Latitude of the POI rounding to 6th decimal place.
+        "longitude": 3.14, # Output only. Longitude of the POI rounding to 6th decimal place.
+        "proximityRadiusAmount": 3.14, # Required. The radius of the area around the POI that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`.
+        "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
+        "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_POI`. Accepted POI targeting option IDs can be retrieved using `targetingTypes.targetingOptions.search`. If targeting a specific latitude/longitude coordinate removed from an address or POI name, you can generate the necessary targeting option ID by rounding the desired coordinate values to the 6th decimal place, removing the decimals, and concatenating the string values separated by a semicolon. For example, you can target the latitude/longitude pair of 40.7414691, -74.003387 using the targeting option ID "40741469;-74003387". **Upon** **creation, this field value will be updated to append a semicolon and** **alphanumerical hash value if only latitude/longitude coordinates are** **provided.**
+      },
+      "proximityLocationListDetails": { # Targeting details for proximity location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`. # Proximity location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`.
+        "proximityLocationListId": "A String", # Required. ID of the proximity location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_PROXIMITY`.
+        "proximityRadius": 3.14, # Required. Radius expressed in the distance units set in proximity_radius_unit. This represents the size of the area around a chosen location that will be targeted. Radius should be between 1 and 500 miles or 800 kilometers.
+        "proximityRadiusUnit": "A String", # Required. Radius distance units.
+      },
+      "regionalLocationListDetails": { # Targeting details for regional location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`. # Regional location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`.
+      },
+      "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them.
+        "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED.
+      },
+      "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`.
+        "sessionPosition": "A String", # The position where the ad will show in a session.
+      },
+      "subExchangeDetails": { # Details for assigned sub-exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`. # Sub-exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`.
+        "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`.
+      },
+      "targetingType": "A String", # Output only. Identifies the type of this assigned targeting option.
+      "thirdPartyVerifierDetails": { # Assigned third party verifier targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`. # Third party verification details. This field will be populated when the targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`.
+        "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox.
+          "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads.
+          "excludedAdlooxCategories": [ # Adloox categories to exclude.
+            "A String",
+          ],
+          "excludedFraudIvtMfaCategories": [ # Optional. Adloox's fraud IVT MFA categories to exclude.
+            "A String",
+          ],
+          "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads.
+        },
+        "doubleVerify": { # Details of DoubleVerify settings. # Third party brand verifier -- DoubleVerify.
+          "appStarRating": { # Details of DoubleVerify star ratings settings. # Avoid bidding on apps with the star ratings.
+            "avoidInsufficientStarRating": True or False, # Avoid bidding on apps with insufficient star ratings.
+            "avoidedStarRating": "A String", # Avoid bidding on apps with the star ratings.
+          },
+          "avoidedAgeRatings": [ # Avoid bidding on apps with the age rating.
+            "A String",
+          ],
+          "brandSafetyCategories": { # Settings for brand safety controls. # DV Brand Safety Controls.
+            "avoidUnknownBrandSafetyCategory": True or False, # Unknown or unrateable.
+            "avoidedHighSeverityCategories": [ # Brand safety high severity avoidance categories.
+              "A String",
+            ],
+            "avoidedMediumSeverityCategories": [ # Brand safety medium severity avoidance categories.
+              "A String",
+            ],
+          },
+          "customSegmentId": "A String", # The custom segment ID provided by DoubleVerify. The ID must start with "51" and consist of eight digits. Custom segment ID cannot be specified along with any of the following fields: * brand_safety_categories * avoided_age_ratings * app_star_rating * fraud_invalid_traffic
+          "displayViewability": { # Details of DoubleVerify display viewability settings. # Display viewability settings (applicable to display line items only).
+            "iab": "A String", # Target web and app inventory to maximize IAB viewable rate.
+            "viewableDuring": "A String", # Target web and app inventory to maximize 100% viewable duration.
+          },
+          "fraudInvalidTraffic": { # DoubleVerify Fraud & Invalid Traffic settings. # Avoid Sites and Apps with historical Fraud & IVT Rates.
+            "avoidInsufficientOption": True or False, # Insufficient Historical Fraud & IVT Stats.
+            "avoidedFraudOption": "A String", # Avoid Sites and Apps with historical Fraud & IVT.
+          },
+          "videoViewability": { # Details of DoubleVerify video viewability settings. # Video viewability settings (applicable to video line items only).
+            "playerImpressionRate": "A String", # Target inventory to maximize impressions with 400x300 or greater player size.
+            "videoIab": "A String", # Target web inventory to maximize IAB viewable rate.
+            "videoViewableRate": "A String", # Target web inventory to maximize fully viewable rate.
+          },
+        },
+        "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science.
+          "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive.
+            "A String",
+          ],
+          "displayViewability": "A String", # Display Viewability section (applicable to display line items only).
+          "excludeUnrateable": True or False, # Brand Safety - **Unrateable**.
+          "excludedAdFraudRisk": "A String", # Ad Fraud settings.
+          "excludedAdultRisk": "A String", # Brand Safety - **Adult content**.
+          "excludedAlcoholRisk": "A String", # Brand Safety - **Alcohol**.
+          "excludedDrugsRisk": "A String", # Brand Safety - **Drugs**.
+          "excludedGamblingRisk": "A String", # Brand Safety - **Gambling**.
+          "excludedHateSpeechRisk": "A String", # Brand Safety - **Hate speech**.
+          "excludedIllegalDownloadsRisk": "A String", # Brand Safety - **Illegal downloads**.
+          "excludedOffensiveLanguageRisk": "A String", # Brand Safety - **Offensive language**.
+          "excludedViolenceRisk": "A String", # Brand Safety - **Violence**.
+          "qualitySyncCustomSegmentId": [ # Optional. The quality sync custom segment ID provided by Integral Ad Science. The ID must be between `3000000` and `4999999`, inclusive.
+            "A String",
+          ],
+          "traqScoreOption": "A String", # True advertising quality (applicable to Display line items only).
+          "videoViewability": "A String", # Video Viewability Section (applicable to video line items only).
+        },
+      },
+      "urlDetails": { # Details for assigned URL targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_URL`. # URL details. This field will be populated when the targeting_type is `TARGETING_TYPE_URL`.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "url": "A String", # Required. The URL, for example `example.com`. DV360 supports two levels of subdirectory targeting, for example `www.example.com/one-subdirectory-level/second-level`, and five levels of subdomain targeting, for example `five.four.three.two.one.example.com`.
+      },
+      "userRewardedContentDetails": { # User rewarded content targeting option details. This will be populated in the user_rewarded_content_details field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. # User rewarded content details. This field will be populated when the targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
+        "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
+        "userRewardedContent": "A String", # Output only. User rewarded content status for video ads.
+      },
+      "videoPlayerSizeDetails": { # Video player size targeting option details. This will be populated in the video_player_size_details field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. Explicitly targeting all options is not supported. Remove all video player size targeting options to achieve this effect. # Video player size details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.
+        "videoPlayerSize": "A String", # Required. The video player size.
+      },
+      "viewabilityDetails": { # Assigned viewability targeting option details. This will be populated in the viewability_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`. # Viewability details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIEWABILITY`. You can only target one viewability option per resource.
+        "viewability": "A String", # Required. The predicted viewability percentage.
+      },
+      "youtubeChannelDetails": { # Details for YouTube channel assigned targeting option. This will be populated in the youtube_channel_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`. # YouTube channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`.
+        "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+      },
+      "youtubeVideoDetails": { # Details for YouTube video assigned targeting option. This will be populated in the youtube_video_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`. # YouTube video details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "videoId": "A String", # YouTube video id as it appears on the YouTube watch page.
+      },
+    },
+  ],
+  "nextPageToken": "A String", # A token identifying the next page of results. This value should be specified as the pageToken in a subsequent ListAdGroupAssignedTargetingOptionsRequest to fetch the next page of results. This token will be absent if there are no more AssignedTargetingOption resources to return.
+}
+
+ +
+ 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/displayvideo_v4.advertisers.adGroups.targetingTypes.html b/docs/dyn/displayvideo_v4.advertisers.adGroups.targetingTypes.html new file mode 100644 index 00000000000..24a3852cc64 --- /dev/null +++ b/docs/dyn/displayvideo_v4.advertisers.adGroups.targetingTypes.html @@ -0,0 +1,91 @@ + + + +

Display & Video 360 API . advertisers . adGroups . targetingTypes

+

Instance Methods

+

+ assignedTargetingOptions() +

+

Returns the assignedTargetingOptions Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/displayvideo_v4.advertisers.assets.html b/docs/dyn/displayvideo_v4.advertisers.assets.html new file mode 100644 index 00000000000..6bd60e0869f --- /dev/null +++ b/docs/dyn/displayvideo_v4.advertisers.assets.html @@ -0,0 +1,120 @@ + + + +

Display & Video 360 API . advertisers . assets

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ upload(advertiserId, body=None, media_body=None, media_mime_type=None, x__xgafv=None)

+

Uploads an asset. Returns the ID of the newly uploaded asset if successful. The asset file size should be no more than 10 MB for images, 200 MB for ZIP files, and 1 GB for videos. Must be used within the [multipart media upload process](/display-video/api/guides/how-tos/upload#multipart). Examples using provided client libraries can be found in our [Creating Creatives guide](/display-video/api/guides/creating-creatives/overview#upload_an_asset).

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ upload(advertiserId, body=None, media_body=None, media_mime_type=None, x__xgafv=None) +
Uploads an asset. Returns the ID of the newly uploaded asset if successful. The asset file size should be no more than 10 MB for images, 200 MB for ZIP files, and 1 GB for videos. Must be used within the [multipart media upload process](/display-video/api/guides/how-tos/upload#multipart). Examples using provided client libraries can be found in our [Creating Creatives guide](/display-video/api/guides/creating-creatives/overview#upload_an_asset).
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser this asset belongs to. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A request message for CreateAsset.
+  "filename": "A String", # Required. The filename of the asset, including the file extension. The filename must be UTF-8 encoded with a maximum size of 240 bytes.
+}
+
+  media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
+  media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A response message for CreateAsset.
+  "asset": { # A single asset. # The uploaded asset, if successful.
+    "content": "A String", # The asset content. For uploaded assets, the content is the serving path.
+    "mediaId": "A String", # Media ID of the uploaded asset. This is a unique identifier for the asset. This ID can be passed to other API calls, e.g. CreateCreative to associate the asset with a creative. The Media ID space updated on **April 5, 2023**. Update media IDs cached before **April 5, 2023** by retrieving the new media ID from associated creative resources or re-uploading the asset.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/displayvideo_v4.advertisers.campaigns.html b/docs/dyn/displayvideo_v4.advertisers.campaigns.html new file mode 100644 index 00000000000..777505c2b58 --- /dev/null +++ b/docs/dyn/displayvideo_v4.advertisers.campaigns.html @@ -0,0 +1,647 @@ + + + +

Display & Video 360 API . advertisers . campaigns

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(advertiserId, body=None, x__xgafv=None)

+

Creates a new campaign. Returns the newly created campaign if successful.

+

+ delete(advertiserId, campaignId, x__xgafv=None)

+

Permanently deletes a campaign. A deleted campaign cannot be recovered. The campaign should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.

+

+ get(advertiserId, campaignId, x__xgafv=None)

+

Gets a campaign.

+

+ list(advertiserId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists campaigns in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, campaigns with `ENTITY_STATUS_ARCHIVED` will not be included in the results.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(advertiserId, campaignId, body=None, updateMask=None, x__xgafv=None)

+

Updates an existing campaign. Returns the updated campaign if successful.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(advertiserId, body=None, x__xgafv=None) +
Creates a new campaign. Returns the newly created campaign if successful.
+
+Args:
+  advertiserId: string, Output only. The unique ID of the advertiser the campaign belongs to. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A single campaign.
+  "advertiserId": "A String", # Output only. The unique ID of the advertiser the campaign belongs to.
+  "campaignBudgets": [ # The list of budgets available to this campaign. If this field is not set, the campaign uses an unlimited budget.
+    { # Settings that control how the campaign budget is allocated.
+      "budgetAmountMicros": "A String", # Required. The total amount the linked insertion order segments can budget. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency.
+      "budgetId": "A String", # The unique ID of the campaign budget. Assigned by the system. Do not set for new budgets. Must be included when updating or adding budgets to campaign_budgets. Otherwise, a new ID will be generated and assigned.
+      "budgetUnit": "A String", # Required. Immutable. Specifies whether the budget is measured in currency or impressions.
+      "dateRange": { # A date range. # Required. The date range for the campaign budget. Linked budget segments may have a different date range. They are resolved relative to the parent advertiser's time zone. Both `start_date` and `end_date` must be before the year 2037.
+        "endDate": { # 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 # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
+          "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.
+        },
+        "startDate": { # 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 # The lower bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
+          "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.
+        },
+      },
+      "displayName": "A String", # Required. The display name of the budget. Must be UTF-8 encoded with a maximum size of 240 bytes.
+      "externalBudgetId": "A String", # Immutable. The ID identifying this budget to the external source. If this field is set and the invoice detail level of the corresponding billing profile is set to "Budget level PO", all impressions served against this budget will include this ID on the invoice. Must be unique under the campaign.
+      "externalBudgetSource": "A String", # Required. The external source of the budget.
+      "invoiceGroupingId": "A String", # Immutable. The ID used to group budgets to be included the same invoice. If this field is set and the invoice level of the corresponding billing profile is set to "Budget invoice grouping ID", all external_budget_id sharing the same invoice_grouping_id will be grouped in the same invoice.
+      "prismaConfig": { # Settings specific to the Mediaocean Prisma tool. # Additional metadata for use by the Mediaocean Prisma tool. Required for Mediaocean budgets. Only applicable to prisma_enabled advertisers.
+        "prismaCpeCode": { # Google Payments Center supports searching and filtering on the component fields of this code. # Required. Relevant client, product, and estimate codes from the Mediaocean Prisma tool.
+          "prismaClientCode": "A String", # The Prisma client code.
+          "prismaEstimateCode": "A String", # The Prisma estimate code.
+          "prismaProductCode": "A String", # The Prisma product code.
+        },
+        "prismaType": "A String", # Required. The Prisma type.
+        "supplier": "A String", # Required. The entity allocated this budget (DSP, site, etc.).
+      },
+    },
+  ],
+  "campaignFlight": { # Settings that track the planned spend and duration of a campaign. # Required. The planned spend and duration of the campaign.
+    "plannedDates": { # A date range. # Required. The dates that the campaign is expected to run. They are resolved relative to the parent advertiser's time zone. * The dates specified here will not affect serving. They are used to generate alerts and warnings. For example, if the flight date of any child insertion order is outside the range of these dates, the user interface will show a warning. * `start_date` is required and must be the current date or later. * `end_date` is optional. If specified, it must be the `start_date` or later. * Any specified date must be before the year 2037.
+      "endDate": { # 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 # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
+        "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.
+      },
+      "startDate": { # 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 # The lower bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
+        "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.
+      },
+    },
+    "plannedSpendAmountMicros": "A String", # The amount the campaign is expected to spend for its given planned_dates. This will not limit serving, but will be used for tracking spend in the DV360 UI. The amount is in micros. Must be greater than or equal to 0. For example, 500000000 represents 500 standard units of the currency.
+  },
+  "campaignGoal": { # Settings that control the goal of a campaign. # Required. The goal of the campaign.
+    "campaignGoalType": "A String", # Required. The type of the campaign goal.
+    "performanceGoal": { # Settings that control the performance goal of a campaign. # Required. The performance goal of the campaign. Acceptable values for performance_goal_type are: * `PERFORMANCE_GOAL_TYPE_CPM` * `PERFORMANCE_GOAL_TYPE_CPC` * `PERFORMANCE_GOAL_TYPE_CPA` * `PERFORMANCE_GOAL_TYPE_CPIAVC` * `PERFORMANCE_GOAL_TYPE_CTR` * `PERFORMANCE_GOAL_TYPE_VIEWABILITY` * `PERFORMANCE_GOAL_TYPE_OTHER`
+      "performanceGoalAmountMicros": "A String", # The goal amount, in micros of the advertiser's currency. Applicable when performance_goal_type is one of: * `PERFORMANCE_GOAL_TYPE_CPM` * `PERFORMANCE_GOAL_TYPE_CPC` * `PERFORMANCE_GOAL_TYPE_CPA` * `PERFORMANCE_GOAL_TYPE_CPIAVC` * `PERFORMANCE_GOAL_TYPE_VCPM` For example 1500000 represents 1.5 standard units of the currency.
+      "performanceGoalPercentageMicros": "A String", # The decimal representation of the goal percentage in micros. Applicable when performance_goal_type is one of: * `PERFORMANCE_GOAL_TYPE_CTR` * `PERFORMANCE_GOAL_TYPE_VIEWABILITY` * `PERFORMANCE_GOAL_TYPE_CLICK_CVR` * `PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR` * `PERFORMANCE_GOAL_TYPE_VTR` * `PERFORMANCE_GOAL_TYPE_AUDIO_COMPLETION_RATE` * `PERFORMANCE_GOAL_TYPE_VIDEO_COMPLETION_RATE` For example, 70000 represents 7% (decimal 0.07).
+      "performanceGoalString": "A String", # A key performance indicator (KPI) string, which can be empty. Must be UTF-8 encoded with a length of no more than 100 characters. Applicable when performance_goal_type is set to `PERFORMANCE_GOAL_TYPE_OTHER`.
+      "performanceGoalType": "A String", # Required. The type of the performance goal.
+    },
+  },
+  "campaignId": "A String", # Output only. The unique ID of the campaign. Assigned by the system.
+  "displayName": "A String", # Required. The display name of the campaign. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "entityStatus": "A String", # Required. Controls whether or not the insertion orders under this campaign can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. * For CreateCampaign method, `ENTITY_STATUS_ARCHIVED` is not allowed.
+  "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency cap setting of the campaign. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap)
+    "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set.
+    "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set.
+    "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).
+    "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).
+    "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable.
+  },
+  "name": "A String", # Output only. The resource name of the campaign.
+  "updateTime": "A String", # Output only. The timestamp when the campaign was last updated. Assigned by the system.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single campaign.
+  "advertiserId": "A String", # Output only. The unique ID of the advertiser the campaign belongs to.
+  "campaignBudgets": [ # The list of budgets available to this campaign. If this field is not set, the campaign uses an unlimited budget.
+    { # Settings that control how the campaign budget is allocated.
+      "budgetAmountMicros": "A String", # Required. The total amount the linked insertion order segments can budget. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency.
+      "budgetId": "A String", # The unique ID of the campaign budget. Assigned by the system. Do not set for new budgets. Must be included when updating or adding budgets to campaign_budgets. Otherwise, a new ID will be generated and assigned.
+      "budgetUnit": "A String", # Required. Immutable. Specifies whether the budget is measured in currency or impressions.
+      "dateRange": { # A date range. # Required. The date range for the campaign budget. Linked budget segments may have a different date range. They are resolved relative to the parent advertiser's time zone. Both `start_date` and `end_date` must be before the year 2037.
+        "endDate": { # 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 # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
+          "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.
+        },
+        "startDate": { # 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 # The lower bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
+          "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.
+        },
+      },
+      "displayName": "A String", # Required. The display name of the budget. Must be UTF-8 encoded with a maximum size of 240 bytes.
+      "externalBudgetId": "A String", # Immutable. The ID identifying this budget to the external source. If this field is set and the invoice detail level of the corresponding billing profile is set to "Budget level PO", all impressions served against this budget will include this ID on the invoice. Must be unique under the campaign.
+      "externalBudgetSource": "A String", # Required. The external source of the budget.
+      "invoiceGroupingId": "A String", # Immutable. The ID used to group budgets to be included the same invoice. If this field is set and the invoice level of the corresponding billing profile is set to "Budget invoice grouping ID", all external_budget_id sharing the same invoice_grouping_id will be grouped in the same invoice.
+      "prismaConfig": { # Settings specific to the Mediaocean Prisma tool. # Additional metadata for use by the Mediaocean Prisma tool. Required for Mediaocean budgets. Only applicable to prisma_enabled advertisers.
+        "prismaCpeCode": { # Google Payments Center supports searching and filtering on the component fields of this code. # Required. Relevant client, product, and estimate codes from the Mediaocean Prisma tool.
+          "prismaClientCode": "A String", # The Prisma client code.
+          "prismaEstimateCode": "A String", # The Prisma estimate code.
+          "prismaProductCode": "A String", # The Prisma product code.
+        },
+        "prismaType": "A String", # Required. The Prisma type.
+        "supplier": "A String", # Required. The entity allocated this budget (DSP, site, etc.).
+      },
+    },
+  ],
+  "campaignFlight": { # Settings that track the planned spend and duration of a campaign. # Required. The planned spend and duration of the campaign.
+    "plannedDates": { # A date range. # Required. The dates that the campaign is expected to run. They are resolved relative to the parent advertiser's time zone. * The dates specified here will not affect serving. They are used to generate alerts and warnings. For example, if the flight date of any child insertion order is outside the range of these dates, the user interface will show a warning. * `start_date` is required and must be the current date or later. * `end_date` is optional. If specified, it must be the `start_date` or later. * Any specified date must be before the year 2037.
+      "endDate": { # 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 # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
+        "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.
+      },
+      "startDate": { # 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 # The lower bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
+        "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.
+      },
+    },
+    "plannedSpendAmountMicros": "A String", # The amount the campaign is expected to spend for its given planned_dates. This will not limit serving, but will be used for tracking spend in the DV360 UI. The amount is in micros. Must be greater than or equal to 0. For example, 500000000 represents 500 standard units of the currency.
+  },
+  "campaignGoal": { # Settings that control the goal of a campaign. # Required. The goal of the campaign.
+    "campaignGoalType": "A String", # Required. The type of the campaign goal.
+    "performanceGoal": { # Settings that control the performance goal of a campaign. # Required. The performance goal of the campaign. Acceptable values for performance_goal_type are: * `PERFORMANCE_GOAL_TYPE_CPM` * `PERFORMANCE_GOAL_TYPE_CPC` * `PERFORMANCE_GOAL_TYPE_CPA` * `PERFORMANCE_GOAL_TYPE_CPIAVC` * `PERFORMANCE_GOAL_TYPE_CTR` * `PERFORMANCE_GOAL_TYPE_VIEWABILITY` * `PERFORMANCE_GOAL_TYPE_OTHER`
+      "performanceGoalAmountMicros": "A String", # The goal amount, in micros of the advertiser's currency. Applicable when performance_goal_type is one of: * `PERFORMANCE_GOAL_TYPE_CPM` * `PERFORMANCE_GOAL_TYPE_CPC` * `PERFORMANCE_GOAL_TYPE_CPA` * `PERFORMANCE_GOAL_TYPE_CPIAVC` * `PERFORMANCE_GOAL_TYPE_VCPM` For example 1500000 represents 1.5 standard units of the currency.
+      "performanceGoalPercentageMicros": "A String", # The decimal representation of the goal percentage in micros. Applicable when performance_goal_type is one of: * `PERFORMANCE_GOAL_TYPE_CTR` * `PERFORMANCE_GOAL_TYPE_VIEWABILITY` * `PERFORMANCE_GOAL_TYPE_CLICK_CVR` * `PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR` * `PERFORMANCE_GOAL_TYPE_VTR` * `PERFORMANCE_GOAL_TYPE_AUDIO_COMPLETION_RATE` * `PERFORMANCE_GOAL_TYPE_VIDEO_COMPLETION_RATE` For example, 70000 represents 7% (decimal 0.07).
+      "performanceGoalString": "A String", # A key performance indicator (KPI) string, which can be empty. Must be UTF-8 encoded with a length of no more than 100 characters. Applicable when performance_goal_type is set to `PERFORMANCE_GOAL_TYPE_OTHER`.
+      "performanceGoalType": "A String", # Required. The type of the performance goal.
+    },
+  },
+  "campaignId": "A String", # Output only. The unique ID of the campaign. Assigned by the system.
+  "displayName": "A String", # Required. The display name of the campaign. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "entityStatus": "A String", # Required. Controls whether or not the insertion orders under this campaign can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. * For CreateCampaign method, `ENTITY_STATUS_ARCHIVED` is not allowed.
+  "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency cap setting of the campaign. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap)
+    "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set.
+    "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set.
+    "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).
+    "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).
+    "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable.
+  },
+  "name": "A String", # Output only. The resource name of the campaign.
+  "updateTime": "A String", # Output only. The timestamp when the campaign was last updated. Assigned by the system.
+}
+
+ +
+ delete(advertiserId, campaignId, x__xgafv=None) +
Permanently deletes a campaign. A deleted campaign cannot be recovered. The campaign should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.
+
+Args:
+  advertiserId: string, The ID of the advertiser this campaign belongs to. (required)
+  campaignId: string, The ID of the campaign we need 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(advertiserId, campaignId, x__xgafv=None) +
Gets a campaign.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser this campaign belongs to. (required)
+  campaignId: string, Required. The ID of the campaign to fetch. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single campaign.
+  "advertiserId": "A String", # Output only. The unique ID of the advertiser the campaign belongs to.
+  "campaignBudgets": [ # The list of budgets available to this campaign. If this field is not set, the campaign uses an unlimited budget.
+    { # Settings that control how the campaign budget is allocated.
+      "budgetAmountMicros": "A String", # Required. The total amount the linked insertion order segments can budget. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency.
+      "budgetId": "A String", # The unique ID of the campaign budget. Assigned by the system. Do not set for new budgets. Must be included when updating or adding budgets to campaign_budgets. Otherwise, a new ID will be generated and assigned.
+      "budgetUnit": "A String", # Required. Immutable. Specifies whether the budget is measured in currency or impressions.
+      "dateRange": { # A date range. # Required. The date range for the campaign budget. Linked budget segments may have a different date range. They are resolved relative to the parent advertiser's time zone. Both `start_date` and `end_date` must be before the year 2037.
+        "endDate": { # 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 # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
+          "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.
+        },
+        "startDate": { # 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 # The lower bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
+          "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.
+        },
+      },
+      "displayName": "A String", # Required. The display name of the budget. Must be UTF-8 encoded with a maximum size of 240 bytes.
+      "externalBudgetId": "A String", # Immutable. The ID identifying this budget to the external source. If this field is set and the invoice detail level of the corresponding billing profile is set to "Budget level PO", all impressions served against this budget will include this ID on the invoice. Must be unique under the campaign.
+      "externalBudgetSource": "A String", # Required. The external source of the budget.
+      "invoiceGroupingId": "A String", # Immutable. The ID used to group budgets to be included the same invoice. If this field is set and the invoice level of the corresponding billing profile is set to "Budget invoice grouping ID", all external_budget_id sharing the same invoice_grouping_id will be grouped in the same invoice.
+      "prismaConfig": { # Settings specific to the Mediaocean Prisma tool. # Additional metadata for use by the Mediaocean Prisma tool. Required for Mediaocean budgets. Only applicable to prisma_enabled advertisers.
+        "prismaCpeCode": { # Google Payments Center supports searching and filtering on the component fields of this code. # Required. Relevant client, product, and estimate codes from the Mediaocean Prisma tool.
+          "prismaClientCode": "A String", # The Prisma client code.
+          "prismaEstimateCode": "A String", # The Prisma estimate code.
+          "prismaProductCode": "A String", # The Prisma product code.
+        },
+        "prismaType": "A String", # Required. The Prisma type.
+        "supplier": "A String", # Required. The entity allocated this budget (DSP, site, etc.).
+      },
+    },
+  ],
+  "campaignFlight": { # Settings that track the planned spend and duration of a campaign. # Required. The planned spend and duration of the campaign.
+    "plannedDates": { # A date range. # Required. The dates that the campaign is expected to run. They are resolved relative to the parent advertiser's time zone. * The dates specified here will not affect serving. They are used to generate alerts and warnings. For example, if the flight date of any child insertion order is outside the range of these dates, the user interface will show a warning. * `start_date` is required and must be the current date or later. * `end_date` is optional. If specified, it must be the `start_date` or later. * Any specified date must be before the year 2037.
+      "endDate": { # 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 # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
+        "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.
+      },
+      "startDate": { # 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 # The lower bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
+        "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.
+      },
+    },
+    "plannedSpendAmountMicros": "A String", # The amount the campaign is expected to spend for its given planned_dates. This will not limit serving, but will be used for tracking spend in the DV360 UI. The amount is in micros. Must be greater than or equal to 0. For example, 500000000 represents 500 standard units of the currency.
+  },
+  "campaignGoal": { # Settings that control the goal of a campaign. # Required. The goal of the campaign.
+    "campaignGoalType": "A String", # Required. The type of the campaign goal.
+    "performanceGoal": { # Settings that control the performance goal of a campaign. # Required. The performance goal of the campaign. Acceptable values for performance_goal_type are: * `PERFORMANCE_GOAL_TYPE_CPM` * `PERFORMANCE_GOAL_TYPE_CPC` * `PERFORMANCE_GOAL_TYPE_CPA` * `PERFORMANCE_GOAL_TYPE_CPIAVC` * `PERFORMANCE_GOAL_TYPE_CTR` * `PERFORMANCE_GOAL_TYPE_VIEWABILITY` * `PERFORMANCE_GOAL_TYPE_OTHER`
+      "performanceGoalAmountMicros": "A String", # The goal amount, in micros of the advertiser's currency. Applicable when performance_goal_type is one of: * `PERFORMANCE_GOAL_TYPE_CPM` * `PERFORMANCE_GOAL_TYPE_CPC` * `PERFORMANCE_GOAL_TYPE_CPA` * `PERFORMANCE_GOAL_TYPE_CPIAVC` * `PERFORMANCE_GOAL_TYPE_VCPM` For example 1500000 represents 1.5 standard units of the currency.
+      "performanceGoalPercentageMicros": "A String", # The decimal representation of the goal percentage in micros. Applicable when performance_goal_type is one of: * `PERFORMANCE_GOAL_TYPE_CTR` * `PERFORMANCE_GOAL_TYPE_VIEWABILITY` * `PERFORMANCE_GOAL_TYPE_CLICK_CVR` * `PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR` * `PERFORMANCE_GOAL_TYPE_VTR` * `PERFORMANCE_GOAL_TYPE_AUDIO_COMPLETION_RATE` * `PERFORMANCE_GOAL_TYPE_VIDEO_COMPLETION_RATE` For example, 70000 represents 7% (decimal 0.07).
+      "performanceGoalString": "A String", # A key performance indicator (KPI) string, which can be empty. Must be UTF-8 encoded with a length of no more than 100 characters. Applicable when performance_goal_type is set to `PERFORMANCE_GOAL_TYPE_OTHER`.
+      "performanceGoalType": "A String", # Required. The type of the performance goal.
+    },
+  },
+  "campaignId": "A String", # Output only. The unique ID of the campaign. Assigned by the system.
+  "displayName": "A String", # Required. The display name of the campaign. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "entityStatus": "A String", # Required. Controls whether or not the insertion orders under this campaign can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. * For CreateCampaign method, `ENTITY_STATUS_ARCHIVED` is not allowed.
+  "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency cap setting of the campaign. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap)
+    "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set.
+    "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set.
+    "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).
+    "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).
+    "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable.
+  },
+  "name": "A String", # Output only. The resource name of the campaign.
+  "updateTime": "A String", # Output only. The timestamp when the campaign was last updated. Assigned by the system.
+}
+
+ +
+ list(advertiserId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists campaigns in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, campaigns with `ENTITY_STATUS_ARCHIVED` will not be included in the results.
+
+Args:
+  advertiserId: string, The ID of the advertiser to list campaigns for. (required)
+  filter: string, Allows filtering by campaign fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` campaigns under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")` * All campaigns with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<="2020-11-04T18:54:47Z"` * All campaigns with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
+  orderBy: string, Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` * `updateTime` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.
+  pageSize: integer, Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
+  pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCampaigns` method. If not specified, the first page of results 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:
+
+    {
+  "campaigns": [ # The list of campaigns. This list will be absent if empty.
+    { # A single campaign.
+      "advertiserId": "A String", # Output only. The unique ID of the advertiser the campaign belongs to.
+      "campaignBudgets": [ # The list of budgets available to this campaign. If this field is not set, the campaign uses an unlimited budget.
+        { # Settings that control how the campaign budget is allocated.
+          "budgetAmountMicros": "A String", # Required. The total amount the linked insertion order segments can budget. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency.
+          "budgetId": "A String", # The unique ID of the campaign budget. Assigned by the system. Do not set for new budgets. Must be included when updating or adding budgets to campaign_budgets. Otherwise, a new ID will be generated and assigned.
+          "budgetUnit": "A String", # Required. Immutable. Specifies whether the budget is measured in currency or impressions.
+          "dateRange": { # A date range. # Required. The date range for the campaign budget. Linked budget segments may have a different date range. They are resolved relative to the parent advertiser's time zone. Both `start_date` and `end_date` must be before the year 2037.
+            "endDate": { # 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 # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
+              "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.
+            },
+            "startDate": { # 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 # The lower bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
+              "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.
+            },
+          },
+          "displayName": "A String", # Required. The display name of the budget. Must be UTF-8 encoded with a maximum size of 240 bytes.
+          "externalBudgetId": "A String", # Immutable. The ID identifying this budget to the external source. If this field is set and the invoice detail level of the corresponding billing profile is set to "Budget level PO", all impressions served against this budget will include this ID on the invoice. Must be unique under the campaign.
+          "externalBudgetSource": "A String", # Required. The external source of the budget.
+          "invoiceGroupingId": "A String", # Immutable. The ID used to group budgets to be included the same invoice. If this field is set and the invoice level of the corresponding billing profile is set to "Budget invoice grouping ID", all external_budget_id sharing the same invoice_grouping_id will be grouped in the same invoice.
+          "prismaConfig": { # Settings specific to the Mediaocean Prisma tool. # Additional metadata for use by the Mediaocean Prisma tool. Required for Mediaocean budgets. Only applicable to prisma_enabled advertisers.
+            "prismaCpeCode": { # Google Payments Center supports searching and filtering on the component fields of this code. # Required. Relevant client, product, and estimate codes from the Mediaocean Prisma tool.
+              "prismaClientCode": "A String", # The Prisma client code.
+              "prismaEstimateCode": "A String", # The Prisma estimate code.
+              "prismaProductCode": "A String", # The Prisma product code.
+            },
+            "prismaType": "A String", # Required. The Prisma type.
+            "supplier": "A String", # Required. The entity allocated this budget (DSP, site, etc.).
+          },
+        },
+      ],
+      "campaignFlight": { # Settings that track the planned spend and duration of a campaign. # Required. The planned spend and duration of the campaign.
+        "plannedDates": { # A date range. # Required. The dates that the campaign is expected to run. They are resolved relative to the parent advertiser's time zone. * The dates specified here will not affect serving. They are used to generate alerts and warnings. For example, if the flight date of any child insertion order is outside the range of these dates, the user interface will show a warning. * `start_date` is required and must be the current date or later. * `end_date` is optional. If specified, it must be the `start_date` or later. * Any specified date must be before the year 2037.
+          "endDate": { # 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 # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
+            "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.
+          },
+          "startDate": { # 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 # The lower bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
+            "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.
+          },
+        },
+        "plannedSpendAmountMicros": "A String", # The amount the campaign is expected to spend for its given planned_dates. This will not limit serving, but will be used for tracking spend in the DV360 UI. The amount is in micros. Must be greater than or equal to 0. For example, 500000000 represents 500 standard units of the currency.
+      },
+      "campaignGoal": { # Settings that control the goal of a campaign. # Required. The goal of the campaign.
+        "campaignGoalType": "A String", # Required. The type of the campaign goal.
+        "performanceGoal": { # Settings that control the performance goal of a campaign. # Required. The performance goal of the campaign. Acceptable values for performance_goal_type are: * `PERFORMANCE_GOAL_TYPE_CPM` * `PERFORMANCE_GOAL_TYPE_CPC` * `PERFORMANCE_GOAL_TYPE_CPA` * `PERFORMANCE_GOAL_TYPE_CPIAVC` * `PERFORMANCE_GOAL_TYPE_CTR` * `PERFORMANCE_GOAL_TYPE_VIEWABILITY` * `PERFORMANCE_GOAL_TYPE_OTHER`
+          "performanceGoalAmountMicros": "A String", # The goal amount, in micros of the advertiser's currency. Applicable when performance_goal_type is one of: * `PERFORMANCE_GOAL_TYPE_CPM` * `PERFORMANCE_GOAL_TYPE_CPC` * `PERFORMANCE_GOAL_TYPE_CPA` * `PERFORMANCE_GOAL_TYPE_CPIAVC` * `PERFORMANCE_GOAL_TYPE_VCPM` For example 1500000 represents 1.5 standard units of the currency.
+          "performanceGoalPercentageMicros": "A String", # The decimal representation of the goal percentage in micros. Applicable when performance_goal_type is one of: * `PERFORMANCE_GOAL_TYPE_CTR` * `PERFORMANCE_GOAL_TYPE_VIEWABILITY` * `PERFORMANCE_GOAL_TYPE_CLICK_CVR` * `PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR` * `PERFORMANCE_GOAL_TYPE_VTR` * `PERFORMANCE_GOAL_TYPE_AUDIO_COMPLETION_RATE` * `PERFORMANCE_GOAL_TYPE_VIDEO_COMPLETION_RATE` For example, 70000 represents 7% (decimal 0.07).
+          "performanceGoalString": "A String", # A key performance indicator (KPI) string, which can be empty. Must be UTF-8 encoded with a length of no more than 100 characters. Applicable when performance_goal_type is set to `PERFORMANCE_GOAL_TYPE_OTHER`.
+          "performanceGoalType": "A String", # Required. The type of the performance goal.
+        },
+      },
+      "campaignId": "A String", # Output only. The unique ID of the campaign. Assigned by the system.
+      "displayName": "A String", # Required. The display name of the campaign. Must be UTF-8 encoded with a maximum size of 240 bytes.
+      "entityStatus": "A String", # Required. Controls whether or not the insertion orders under this campaign can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. * For CreateCampaign method, `ENTITY_STATUS_ARCHIVED` is not allowed.
+      "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency cap setting of the campaign. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap)
+        "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set.
+        "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set.
+        "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).
+        "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).
+        "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable.
+      },
+      "name": "A String", # Output only. The resource name of the campaign.
+      "updateTime": "A String", # Output only. The timestamp when the campaign was last updated. Assigned by the system.
+    },
+  ],
+  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListCampaigns` method to retrieve the next page of results.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(advertiserId, campaignId, body=None, updateMask=None, x__xgafv=None) +
Updates an existing campaign. Returns the updated campaign if successful.
+
+Args:
+  advertiserId: string, Output only. The unique ID of the advertiser the campaign belongs to. (required)
+  campaignId: string, Output only. The unique ID of the campaign. Assigned by the system. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A single campaign.
+  "advertiserId": "A String", # Output only. The unique ID of the advertiser the campaign belongs to.
+  "campaignBudgets": [ # The list of budgets available to this campaign. If this field is not set, the campaign uses an unlimited budget.
+    { # Settings that control how the campaign budget is allocated.
+      "budgetAmountMicros": "A String", # Required. The total amount the linked insertion order segments can budget. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency.
+      "budgetId": "A String", # The unique ID of the campaign budget. Assigned by the system. Do not set for new budgets. Must be included when updating or adding budgets to campaign_budgets. Otherwise, a new ID will be generated and assigned.
+      "budgetUnit": "A String", # Required. Immutable. Specifies whether the budget is measured in currency or impressions.
+      "dateRange": { # A date range. # Required. The date range for the campaign budget. Linked budget segments may have a different date range. They are resolved relative to the parent advertiser's time zone. Both `start_date` and `end_date` must be before the year 2037.
+        "endDate": { # 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 # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
+          "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.
+        },
+        "startDate": { # 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 # The lower bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
+          "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.
+        },
+      },
+      "displayName": "A String", # Required. The display name of the budget. Must be UTF-8 encoded with a maximum size of 240 bytes.
+      "externalBudgetId": "A String", # Immutable. The ID identifying this budget to the external source. If this field is set and the invoice detail level of the corresponding billing profile is set to "Budget level PO", all impressions served against this budget will include this ID on the invoice. Must be unique under the campaign.
+      "externalBudgetSource": "A String", # Required. The external source of the budget.
+      "invoiceGroupingId": "A String", # Immutable. The ID used to group budgets to be included the same invoice. If this field is set and the invoice level of the corresponding billing profile is set to "Budget invoice grouping ID", all external_budget_id sharing the same invoice_grouping_id will be grouped in the same invoice.
+      "prismaConfig": { # Settings specific to the Mediaocean Prisma tool. # Additional metadata for use by the Mediaocean Prisma tool. Required for Mediaocean budgets. Only applicable to prisma_enabled advertisers.
+        "prismaCpeCode": { # Google Payments Center supports searching and filtering on the component fields of this code. # Required. Relevant client, product, and estimate codes from the Mediaocean Prisma tool.
+          "prismaClientCode": "A String", # The Prisma client code.
+          "prismaEstimateCode": "A String", # The Prisma estimate code.
+          "prismaProductCode": "A String", # The Prisma product code.
+        },
+        "prismaType": "A String", # Required. The Prisma type.
+        "supplier": "A String", # Required. The entity allocated this budget (DSP, site, etc.).
+      },
+    },
+  ],
+  "campaignFlight": { # Settings that track the planned spend and duration of a campaign. # Required. The planned spend and duration of the campaign.
+    "plannedDates": { # A date range. # Required. The dates that the campaign is expected to run. They are resolved relative to the parent advertiser's time zone. * The dates specified here will not affect serving. They are used to generate alerts and warnings. For example, if the flight date of any child insertion order is outside the range of these dates, the user interface will show a warning. * `start_date` is required and must be the current date or later. * `end_date` is optional. If specified, it must be the `start_date` or later. * Any specified date must be before the year 2037.
+      "endDate": { # 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 # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
+        "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.
+      },
+      "startDate": { # 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 # The lower bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
+        "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.
+      },
+    },
+    "plannedSpendAmountMicros": "A String", # The amount the campaign is expected to spend for its given planned_dates. This will not limit serving, but will be used for tracking spend in the DV360 UI. The amount is in micros. Must be greater than or equal to 0. For example, 500000000 represents 500 standard units of the currency.
+  },
+  "campaignGoal": { # Settings that control the goal of a campaign. # Required. The goal of the campaign.
+    "campaignGoalType": "A String", # Required. The type of the campaign goal.
+    "performanceGoal": { # Settings that control the performance goal of a campaign. # Required. The performance goal of the campaign. Acceptable values for performance_goal_type are: * `PERFORMANCE_GOAL_TYPE_CPM` * `PERFORMANCE_GOAL_TYPE_CPC` * `PERFORMANCE_GOAL_TYPE_CPA` * `PERFORMANCE_GOAL_TYPE_CPIAVC` * `PERFORMANCE_GOAL_TYPE_CTR` * `PERFORMANCE_GOAL_TYPE_VIEWABILITY` * `PERFORMANCE_GOAL_TYPE_OTHER`
+      "performanceGoalAmountMicros": "A String", # The goal amount, in micros of the advertiser's currency. Applicable when performance_goal_type is one of: * `PERFORMANCE_GOAL_TYPE_CPM` * `PERFORMANCE_GOAL_TYPE_CPC` * `PERFORMANCE_GOAL_TYPE_CPA` * `PERFORMANCE_GOAL_TYPE_CPIAVC` * `PERFORMANCE_GOAL_TYPE_VCPM` For example 1500000 represents 1.5 standard units of the currency.
+      "performanceGoalPercentageMicros": "A String", # The decimal representation of the goal percentage in micros. Applicable when performance_goal_type is one of: * `PERFORMANCE_GOAL_TYPE_CTR` * `PERFORMANCE_GOAL_TYPE_VIEWABILITY` * `PERFORMANCE_GOAL_TYPE_CLICK_CVR` * `PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR` * `PERFORMANCE_GOAL_TYPE_VTR` * `PERFORMANCE_GOAL_TYPE_AUDIO_COMPLETION_RATE` * `PERFORMANCE_GOAL_TYPE_VIDEO_COMPLETION_RATE` For example, 70000 represents 7% (decimal 0.07).
+      "performanceGoalString": "A String", # A key performance indicator (KPI) string, which can be empty. Must be UTF-8 encoded with a length of no more than 100 characters. Applicable when performance_goal_type is set to `PERFORMANCE_GOAL_TYPE_OTHER`.
+      "performanceGoalType": "A String", # Required. The type of the performance goal.
+    },
+  },
+  "campaignId": "A String", # Output only. The unique ID of the campaign. Assigned by the system.
+  "displayName": "A String", # Required. The display name of the campaign. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "entityStatus": "A String", # Required. Controls whether or not the insertion orders under this campaign can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. * For CreateCampaign method, `ENTITY_STATUS_ARCHIVED` is not allowed.
+  "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency cap setting of the campaign. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap)
+    "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set.
+    "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set.
+    "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).
+    "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).
+    "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable.
+  },
+  "name": "A String", # Output only. The resource name of the campaign.
+  "updateTime": "A String", # Output only. The timestamp when the campaign was last updated. Assigned by the system.
+}
+
+  updateMask: string, Required. The mask to control which fields to update.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single campaign.
+  "advertiserId": "A String", # Output only. The unique ID of the advertiser the campaign belongs to.
+  "campaignBudgets": [ # The list of budgets available to this campaign. If this field is not set, the campaign uses an unlimited budget.
+    { # Settings that control how the campaign budget is allocated.
+      "budgetAmountMicros": "A String", # Required. The total amount the linked insertion order segments can budget. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency.
+      "budgetId": "A String", # The unique ID of the campaign budget. Assigned by the system. Do not set for new budgets. Must be included when updating or adding budgets to campaign_budgets. Otherwise, a new ID will be generated and assigned.
+      "budgetUnit": "A String", # Required. Immutable. Specifies whether the budget is measured in currency or impressions.
+      "dateRange": { # A date range. # Required. The date range for the campaign budget. Linked budget segments may have a different date range. They are resolved relative to the parent advertiser's time zone. Both `start_date` and `end_date` must be before the year 2037.
+        "endDate": { # 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 # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
+          "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.
+        },
+        "startDate": { # 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 # The lower bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
+          "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.
+        },
+      },
+      "displayName": "A String", # Required. The display name of the budget. Must be UTF-8 encoded with a maximum size of 240 bytes.
+      "externalBudgetId": "A String", # Immutable. The ID identifying this budget to the external source. If this field is set and the invoice detail level of the corresponding billing profile is set to "Budget level PO", all impressions served against this budget will include this ID on the invoice. Must be unique under the campaign.
+      "externalBudgetSource": "A String", # Required. The external source of the budget.
+      "invoiceGroupingId": "A String", # Immutable. The ID used to group budgets to be included the same invoice. If this field is set and the invoice level of the corresponding billing profile is set to "Budget invoice grouping ID", all external_budget_id sharing the same invoice_grouping_id will be grouped in the same invoice.
+      "prismaConfig": { # Settings specific to the Mediaocean Prisma tool. # Additional metadata for use by the Mediaocean Prisma tool. Required for Mediaocean budgets. Only applicable to prisma_enabled advertisers.
+        "prismaCpeCode": { # Google Payments Center supports searching and filtering on the component fields of this code. # Required. Relevant client, product, and estimate codes from the Mediaocean Prisma tool.
+          "prismaClientCode": "A String", # The Prisma client code.
+          "prismaEstimateCode": "A String", # The Prisma estimate code.
+          "prismaProductCode": "A String", # The Prisma product code.
+        },
+        "prismaType": "A String", # Required. The Prisma type.
+        "supplier": "A String", # Required. The entity allocated this budget (DSP, site, etc.).
+      },
+    },
+  ],
+  "campaignFlight": { # Settings that track the planned spend and duration of a campaign. # Required. The planned spend and duration of the campaign.
+    "plannedDates": { # A date range. # Required. The dates that the campaign is expected to run. They are resolved relative to the parent advertiser's time zone. * The dates specified here will not affect serving. They are used to generate alerts and warnings. For example, if the flight date of any child insertion order is outside the range of these dates, the user interface will show a warning. * `start_date` is required and must be the current date or later. * `end_date` is optional. If specified, it must be the `start_date` or later. * Any specified date must be before the year 2037.
+      "endDate": { # 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 # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
+        "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.
+      },
+      "startDate": { # 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 # The lower bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
+        "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.
+      },
+    },
+    "plannedSpendAmountMicros": "A String", # The amount the campaign is expected to spend for its given planned_dates. This will not limit serving, but will be used for tracking spend in the DV360 UI. The amount is in micros. Must be greater than or equal to 0. For example, 500000000 represents 500 standard units of the currency.
+  },
+  "campaignGoal": { # Settings that control the goal of a campaign. # Required. The goal of the campaign.
+    "campaignGoalType": "A String", # Required. The type of the campaign goal.
+    "performanceGoal": { # Settings that control the performance goal of a campaign. # Required. The performance goal of the campaign. Acceptable values for performance_goal_type are: * `PERFORMANCE_GOAL_TYPE_CPM` * `PERFORMANCE_GOAL_TYPE_CPC` * `PERFORMANCE_GOAL_TYPE_CPA` * `PERFORMANCE_GOAL_TYPE_CPIAVC` * `PERFORMANCE_GOAL_TYPE_CTR` * `PERFORMANCE_GOAL_TYPE_VIEWABILITY` * `PERFORMANCE_GOAL_TYPE_OTHER`
+      "performanceGoalAmountMicros": "A String", # The goal amount, in micros of the advertiser's currency. Applicable when performance_goal_type is one of: * `PERFORMANCE_GOAL_TYPE_CPM` * `PERFORMANCE_GOAL_TYPE_CPC` * `PERFORMANCE_GOAL_TYPE_CPA` * `PERFORMANCE_GOAL_TYPE_CPIAVC` * `PERFORMANCE_GOAL_TYPE_VCPM` For example 1500000 represents 1.5 standard units of the currency.
+      "performanceGoalPercentageMicros": "A String", # The decimal representation of the goal percentage in micros. Applicable when performance_goal_type is one of: * `PERFORMANCE_GOAL_TYPE_CTR` * `PERFORMANCE_GOAL_TYPE_VIEWABILITY` * `PERFORMANCE_GOAL_TYPE_CLICK_CVR` * `PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR` * `PERFORMANCE_GOAL_TYPE_VTR` * `PERFORMANCE_GOAL_TYPE_AUDIO_COMPLETION_RATE` * `PERFORMANCE_GOAL_TYPE_VIDEO_COMPLETION_RATE` For example, 70000 represents 7% (decimal 0.07).
+      "performanceGoalString": "A String", # A key performance indicator (KPI) string, which can be empty. Must be UTF-8 encoded with a length of no more than 100 characters. Applicable when performance_goal_type is set to `PERFORMANCE_GOAL_TYPE_OTHER`.
+      "performanceGoalType": "A String", # Required. The type of the performance goal.
+    },
+  },
+  "campaignId": "A String", # Output only. The unique ID of the campaign. Assigned by the system.
+  "displayName": "A String", # Required. The display name of the campaign. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "entityStatus": "A String", # Required. Controls whether or not the insertion orders under this campaign can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. * For CreateCampaign method, `ENTITY_STATUS_ARCHIVED` is not allowed.
+  "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency cap setting of the campaign. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap)
+    "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set.
+    "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set.
+    "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).
+    "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).
+    "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable.
+  },
+  "name": "A String", # Output only. The resource name of the campaign.
+  "updateTime": "A String", # Output only. The timestamp when the campaign was last updated. Assigned by the system.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/displayvideo_v4.advertisers.channels.html b/docs/dyn/displayvideo_v4.advertisers.channels.html new file mode 100644 index 00000000000..7cfc1cc4392 --- /dev/null +++ b/docs/dyn/displayvideo_v4.advertisers.channels.html @@ -0,0 +1,262 @@ + + + +

Display & Video 360 API . advertisers . channels

+

Instance Methods

+

+ sites() +

+

Returns the sites Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ create(advertiserId, body=None, partnerId=None, x__xgafv=None)

+

Creates a new channel. Returns the newly created channel if successful.

+

+ get(advertiserId, channelId, partnerId=None, x__xgafv=None)

+

Gets a channel for a partner or advertiser.

+

+ list(advertiserId, filter=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None)

+

Lists channels for a partner or advertiser.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(advertiserId, channelId, body=None, partnerId=None, updateMask=None, x__xgafv=None)

+

Updates a channel. Returns the updated channel if successful.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(advertiserId, body=None, partnerId=None, x__xgafv=None) +
Creates a new channel. Returns the newly created channel if successful.
+
+Args:
+  advertiserId: string, The ID of the advertiser that owns the created channel. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A single channel. Channels are custom groups of related websites and apps.
+  "advertiserId": "A String", # The ID of the advertiser that owns the channel.
+  "channelId": "A String", # Output only. The unique ID of the channel. Assigned by the system.
+  "displayName": "A String", # Required. The display name of the channel. Must be UTF-8 encoded with a maximum length of 240 bytes.
+  "name": "A String", # Output only. The resource name of the channel.
+  "negativelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel negatively.
+  "partnerId": "A String", # The ID of the partner that owns the channel.
+  "positivelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel positively.
+}
+
+  partnerId: string, The ID of the partner that owns the created channel.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single channel. Channels are custom groups of related websites and apps.
+  "advertiserId": "A String", # The ID of the advertiser that owns the channel.
+  "channelId": "A String", # Output only. The unique ID of the channel. Assigned by the system.
+  "displayName": "A String", # Required. The display name of the channel. Must be UTF-8 encoded with a maximum length of 240 bytes.
+  "name": "A String", # Output only. The resource name of the channel.
+  "negativelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel negatively.
+  "partnerId": "A String", # The ID of the partner that owns the channel.
+  "positivelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel positively.
+}
+
+ +
+ get(advertiserId, channelId, partnerId=None, x__xgafv=None) +
Gets a channel for a partner or advertiser.
+
+Args:
+  advertiserId: string, The ID of the advertiser that owns the fetched channel. (required)
+  channelId: string, Required. The ID of the channel to fetch. (required)
+  partnerId: string, The ID of the partner that owns the fetched channel.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single channel. Channels are custom groups of related websites and apps.
+  "advertiserId": "A String", # The ID of the advertiser that owns the channel.
+  "channelId": "A String", # Output only. The unique ID of the channel. Assigned by the system.
+  "displayName": "A String", # Required. The display name of the channel. Must be UTF-8 encoded with a maximum length of 240 bytes.
+  "name": "A String", # Output only. The resource name of the channel.
+  "negativelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel negatively.
+  "partnerId": "A String", # The ID of the partner that owns the channel.
+  "positivelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel positively.
+}
+
+ +
+ list(advertiserId, filter=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None) +
Lists channels for a partner or advertiser.
+
+Args:
+  advertiserId: string, The ID of the advertiser that owns the channels. (required)
+  filter: string, Allows filtering by channel fields. Supported syntax: * Filter expressions for channel can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All channels for which the display name contains "google": `displayName : "google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
+  orderBy: string, Field by which to sort the list. Acceptable values are: * `displayName` (default) * `channelId` The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `displayName desc`.
+  pageSize: integer, Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
+  pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListChannels` method. If not specified, the first page of results will be returned.
+  partnerId: string, The ID of the partner that owns the channels.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "channels": [ # The list of channels. This list will be absent if empty.
+    { # A single channel. Channels are custom groups of related websites and apps.
+      "advertiserId": "A String", # The ID of the advertiser that owns the channel.
+      "channelId": "A String", # Output only. The unique ID of the channel. Assigned by the system.
+      "displayName": "A String", # Required. The display name of the channel. Must be UTF-8 encoded with a maximum length of 240 bytes.
+      "name": "A String", # Output only. The resource name of the channel.
+      "negativelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel negatively.
+      "partnerId": "A String", # The ID of the partner that owns the channel.
+      "positivelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel positively.
+    },
+  ],
+  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListChannels` method to retrieve the next page of results.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(advertiserId, channelId, body=None, partnerId=None, updateMask=None, x__xgafv=None) +
Updates a channel. Returns the updated channel if successful.
+
+Args:
+  advertiserId: string, The ID of the advertiser that owns the created channel. (required)
+  channelId: string, Output only. The unique ID of the channel. Assigned by the system. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A single channel. Channels are custom groups of related websites and apps.
+  "advertiserId": "A String", # The ID of the advertiser that owns the channel.
+  "channelId": "A String", # Output only. The unique ID of the channel. Assigned by the system.
+  "displayName": "A String", # Required. The display name of the channel. Must be UTF-8 encoded with a maximum length of 240 bytes.
+  "name": "A String", # Output only. The resource name of the channel.
+  "negativelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel negatively.
+  "partnerId": "A String", # The ID of the partner that owns the channel.
+  "positivelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel positively.
+}
+
+  partnerId: string, The ID of the partner that owns the created channel.
+  updateMask: string, Required. The mask to control which fields to update.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single channel. Channels are custom groups of related websites and apps.
+  "advertiserId": "A String", # The ID of the advertiser that owns the channel.
+  "channelId": "A String", # Output only. The unique ID of the channel. Assigned by the system.
+  "displayName": "A String", # Required. The display name of the channel. Must be UTF-8 encoded with a maximum length of 240 bytes.
+  "name": "A String", # Output only. The resource name of the channel.
+  "negativelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel negatively.
+  "partnerId": "A String", # The ID of the partner that owns the channel.
+  "positivelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel positively.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/displayvideo_v4.advertisers.channels.sites.html b/docs/dyn/displayvideo_v4.advertisers.channels.sites.html new file mode 100644 index 00000000000..45ae4b0272b --- /dev/null +++ b/docs/dyn/displayvideo_v4.advertisers.channels.sites.html @@ -0,0 +1,281 @@ + + + +

Display & Video 360 API . advertisers . channels . sites

+

Instance Methods

+

+ bulkEdit(advertiserId, channelId, body=None, x__xgafv=None)

+

Bulk edits sites under a single channel. The operation will delete the sites provided in BulkEditSitesRequest.deleted_sites and then create the sites provided in BulkEditSitesRequest.created_sites.

+

+ close()

+

Close httplib2 connections.

+

+ create(advertiserId, channelId, body=None, partnerId=None, x__xgafv=None)

+

Creates a site in a channel.

+

+ delete(advertiserId, channelId, urlOrAppId, partnerId=None, x__xgafv=None)

+

Deletes a site from a channel.

+

+ list(advertiserId, channelId, filter=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None)

+

Lists sites in a channel.

+

+ list_next()

+

Retrieves the next page of results.

+

+ replace(advertiserId, channelId, body=None, x__xgafv=None)

+

Replaces all of the sites under a single channel. The operation will replace the sites under a channel with the sites provided in ReplaceSitesRequest.new_sites. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.

+

Method Details

+
+ bulkEdit(advertiserId, channelId, body=None, x__xgafv=None) +
Bulk edits sites under a single channel. The operation will delete the sites provided in BulkEditSitesRequest.deleted_sites and then create the sites provided in BulkEditSitesRequest.created_sites.
+
+Args:
+  advertiserId: string, The ID of the advertiser that owns the parent channel. (required)
+  channelId: string, Required. The ID of the parent channel to which the sites belong. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for SiteService.BulkEditSites.
+  "advertiserId": "A String", # The ID of the advertiser that owns the parent channel.
+  "createdSites": [ # The sites to create in batch, specified as a list of Sites.
+    { # A single site. Sites are apps or websites belonging to a channel.
+      "name": "A String", # Output only. The resource name of the site.
+      "urlOrAppId": "A String", # Required. The app ID or URL of the site. Must be UTF-8 encoded with a maximum length of 240 bytes.
+    },
+  ],
+  "deletedSites": [ # The sites to delete in batch, specified as a list of site url_or_app_ids.
+    "A String",
+  ],
+  "partnerId": "A String", # The ID of the partner that owns the parent channel.
+}
+
+  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 SiteService.BulkEditSites.
+  "sites": [ # The list of sites that have been successfully created. This list will be absent if empty.
+    { # A single site. Sites are apps or websites belonging to a channel.
+      "name": "A String", # Output only. The resource name of the site.
+      "urlOrAppId": "A String", # Required. The app ID or URL of the site. Must be UTF-8 encoded with a maximum length of 240 bytes.
+    },
+  ],
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ create(advertiserId, channelId, body=None, partnerId=None, x__xgafv=None) +
Creates a site in a channel.
+
+Args:
+  advertiserId: string, The ID of the advertiser that owns the parent channel. (required)
+  channelId: string, Required. The ID of the parent channel in which the site will be created. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A single site. Sites are apps or websites belonging to a channel.
+  "name": "A String", # Output only. The resource name of the site.
+  "urlOrAppId": "A String", # Required. The app ID or URL of the site. Must be UTF-8 encoded with a maximum length of 240 bytes.
+}
+
+  partnerId: string, The ID of the partner that owns the parent channel.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single site. Sites are apps or websites belonging to a channel.
+  "name": "A String", # Output only. The resource name of the site.
+  "urlOrAppId": "A String", # Required. The app ID or URL of the site. Must be UTF-8 encoded with a maximum length of 240 bytes.
+}
+
+ +
+ delete(advertiserId, channelId, urlOrAppId, partnerId=None, x__xgafv=None) +
Deletes a site from a channel.
+
+Args:
+  advertiserId: string, The ID of the advertiser that owns the parent channel. (required)
+  channelId: string, Required. The ID of the parent channel to which the site belongs. (required)
+  urlOrAppId: string, Required. The URL or app ID of the site to delete. (required)
+  partnerId: string, The ID of the partner that owns the parent channel.
+  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); }
+}
+
+ +
+ list(advertiserId, channelId, filter=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None) +
Lists sites in a channel.
+
+Args:
+  advertiserId: string, The ID of the advertiser that owns the parent channel. (required)
+  channelId: string, Required. The ID of the parent channel to which the requested sites belong. (required)
+  filter: string, Allows filtering by site fields. Supported syntax: * Filter expressions for site retrieval can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `urlOrAppId` Examples: * All sites for which the URL or app ID contains "google": `urlOrAppId : "google"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
+  orderBy: string, Field by which to sort the list. Acceptable values are: * `urlOrAppId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `urlOrAppId desc`.
+  pageSize: integer, Requested page size. Must be between `1` and `10000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
+  pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListSites` method. If not specified, the first page of results will be returned.
+  partnerId: string, The ID of the partner that owns the parent channel.
+  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 SiteService.ListSites.
+  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListSites` method to retrieve the next page of results.
+  "sites": [ # The list of sites. This list will be absent if empty.
+    { # A single site. Sites are apps or websites belonging to a channel.
+      "name": "A String", # Output only. The resource name of the site.
+      "urlOrAppId": "A String", # Required. The app ID or URL of the site. Must be UTF-8 encoded with a maximum length of 240 bytes.
+    },
+  ],
+}
+
+ +
+ 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.
+        
+
+ +
+ replace(advertiserId, channelId, body=None, x__xgafv=None) +
Replaces all of the sites under a single channel. The operation will replace the sites under a channel with the sites provided in ReplaceSitesRequest.new_sites. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.
+
+Args:
+  advertiserId: string, The ID of the advertiser that owns the parent channel. (required)
+  channelId: string, Required. The ID of the parent channel whose sites will be replaced. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for SiteService.ReplaceSites.
+  "advertiserId": "A String", # The ID of the advertiser that owns the parent channel.
+  "newSites": [ # The sites that will replace the existing sites assigned to the channel, specified as a list of Sites.
+    { # A single site. Sites are apps or websites belonging to a channel.
+      "name": "A String", # Output only. The resource name of the site.
+      "urlOrAppId": "A String", # Required. The app ID or URL of the site. Must be UTF-8 encoded with a maximum length of 240 bytes.
+    },
+  ],
+  "partnerId": "A String", # The ID of the partner that owns the parent channel.
+}
+
+  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 SiteService.ReplaceSites.
+  "sites": [ # The list of sites in the channel after replacing.
+    { # A single site. Sites are apps or websites belonging to a channel.
+      "name": "A String", # Output only. The resource name of the site.
+      "urlOrAppId": "A String", # Required. The app ID or URL of the site. Must be UTF-8 encoded with a maximum length of 240 bytes.
+    },
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/displayvideo_v4.advertisers.creatives.html b/docs/dyn/displayvideo_v4.advertisers.creatives.html new file mode 100644 index 00000000000..1b215919d0c --- /dev/null +++ b/docs/dyn/displayvideo_v4.advertisers.creatives.html @@ -0,0 +1,1091 @@ + + + +

Display & Video 360 API . advertisers . creatives

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(advertiserId, body=None, x__xgafv=None)

+

Creates a new creative. Returns the newly created creative if successful. A ["Standard" user role](//support.google.com/displayvideo/answer/2723011) or greater for the parent advertiser or partner is required to make this request.

+

+ delete(advertiserId, creativeId, x__xgafv=None)

+

Deletes a creative. Returns error code `NOT_FOUND` if the creative does not exist. The creative should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, before it can be deleted. A ["Standard" user role](//support.google.com/displayvideo/answer/2723011) or greater for the parent advertiser or partner is required to make this request.

+

+ get(advertiserId, creativeId, x__xgafv=None)

+

Gets a creative.

+

+ list(advertiserId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists creatives in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, creatives with `ENTITY_STATUS_ARCHIVED` will not be included in the results.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(advertiserId, creativeId, body=None, updateMask=None, x__xgafv=None)

+

Updates an existing creative. Returns the updated creative if successful. A ["Standard" user role](//support.google.com/displayvideo/answer/2723011) or greater for the parent advertiser or partner is required to make this request.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(advertiserId, body=None, x__xgafv=None) +
Creates a new creative. Returns the newly created creative if successful. A ["Standard" user role](//support.google.com/displayvideo/answer/2723011) or greater for the parent advertiser or partner is required to make this request.
+
+Args:
+  advertiserId: string, Output only. The unique ID of the advertiser the creative belongs to. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A single Creative.
+  "additionalDimensions": [ # Optional. Additional dimensions. Applicable when creative_type is one of: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_LIGHTBOX` * `CREATIVE_TYPE_PUBLISHER_HOSTED` If this field is specified, width_pixels and height_pixels are both required and must be greater than or equal to 0.
+    { # Dimensions.
+      "heightPixels": 42, # The height in pixels.
+      "widthPixels": 42, # The width in pixels.
+    },
+  ],
+  "advertiserId": "A String", # Output only. The unique ID of the advertiser the creative belongs to.
+  "appendedTag": "A String", # Optional. Third-party HTML tracking tag to be appended to the creative tag.
+  "assets": [ # Required. Assets associated to this creative.
+    { # Asset association for the creative.
+      "asset": { # A single asset. # Optional. The associated asset.
+        "content": "A String", # The asset content. For uploaded assets, the content is the serving path.
+        "mediaId": "A String", # Media ID of the uploaded asset. This is a unique identifier for the asset. This ID can be passed to other API calls, e.g. CreateCreative to associate the asset with a creative. The Media ID space updated on **April 5, 2023**. Update media IDs cached before **April 5, 2023** by retrieving the new media ID from associated creative resources or re-uploading the asset.
+      },
+      "role": "A String", # Optional. The role of this asset for the creative.
+    },
+  ],
+  "cmPlacementId": "A String", # Output only. The unique ID of the Campaign Manager 360 placement associated with the creative. This field is only applicable for creatives that are synced from Campaign Manager.
+  "cmTrackingAd": { # A Campaign Manager 360 tracking ad. # Optional. The Campaign Manager 360 tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager 360 and third-party ad serving: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` Output only for other cases.
+    "cmAdId": "A String", # Optional. The ad ID of the campaign manager 360 tracking Ad.
+    "cmCreativeId": "A String", # Optional. The creative ID of the campaign manager 360 tracking Ad.
+    "cmPlacementId": "A String", # Optional. The placement ID of the campaign manager 360 tracking Ad.
+  },
+  "companionCreativeIds": [ # Optional. The IDs of companion creatives for a video creative. You can assign existing display creatives (with image or HTML5 assets) to serve surrounding the publisher's video player. Companions display around the video player while the video is playing and remain after the video has completed. Creatives contain additional dimensions can not be companion creatives. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO`
+    "A String",
+  ],
+  "counterEvents": [ # Optional. Counter events for a rich media creative. Counters track the number of times that a user interacts with any part of a rich media creative in a specified way (mouse-overs, mouse-outs, clicks, taps, data loading, keyboard entries, etc.). Any event that can be captured in the creative can be recorded as a counter. Leave it empty or unset for creatives containing image assets only.
+    { # Counter event of the creative.
+      "name": "A String", # Required. The name of the counter event.
+      "reportingName": "A String", # Required. The name used to identify this counter event in reports.
+    },
+  ],
+  "createTime": "A String", # Output only. The timestamp when the creative was created. Assigned by the system.
+  "creativeAttributes": [ # Output only. A list of attributes of the creative that is generated by the system.
+    "A String",
+  ],
+  "creativeId": "A String", # Output only. The unique ID of the creative. Assigned by the system.
+  "creativeType": "A String", # Required. Immutable. The type of the creative.
+  "dimensions": { # Dimensions. # Required. Primary dimensions of the creative. Applicable to all creative types. The value of width_pixels and height_pixels defaults to `0` when creative_type is one of: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_NATIVE_VIDEO`
+    "heightPixels": 42, # The height in pixels.
+    "widthPixels": 42, # The width in pixels.
+  },
+  "displayName": "A String", # Required. The display name of the creative. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "dynamic": True or False, # Output only. Indicates whether the creative is dynamic.
+  "entityStatus": "A String", # Required. Controls whether or not the creative can serve. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED` * `ENTITY_STATUS_PAUSED`
+  "exitEvents": [ # Required. Exit events for this creative. An exit (also known as a click tag) is any area in your creative that someone can click or tap to open an advertiser's landing page. Every creative must include at least one exit. You can add an exit to your creative in any of the following ways: * Use Google Web Designer's tap area. * Define a JavaScript variable called "clickTag". * Use the Enabler (Enabler.exit()) to track exits in rich media formats.
+    { # Exit event of the creative.
+      "name": "A String", # Optional. The name of the click tag of the exit event. The name must be unique within one creative. Leave it empty or unset for creatives containing image assets only.
+      "reportingName": "A String", # Optional. The name used to identify this event in reports. Leave it empty or unset for creatives containing image assets only.
+      "type": "A String", # Required. The type of the exit event.
+      "url": "A String", # Required. The click through URL of the exit event. This is required when type is: * `EXIT_EVENT_TYPE_DEFAULT` * `EXIT_EVENT_TYPE_BACKUP`
+    },
+  ],
+  "expandOnHover": True or False, # Optional. Indicates the creative will automatically expand on hover. Optional and only valid for third-party expandable creatives. Third-party expandable creatives are creatives with following hosting source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_EXPANDABLE`
+  "expandingDirection": "A String", # Optional. Specifies the expanding direction of the creative. Required and only valid for third-party expandable creatives. Third-party expandable creatives are creatives with following hosting source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_EXPANDABLE`
+  "hostingSource": "A String", # Required. Indicates where the creative is hosted.
+  "html5Video": True or False, # Output only. Indicates the third-party VAST tag creative requires HTML5 Video support. Output only and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_VIDEO`
+  "iasCampaignMonitoring": True or False, # Optional. Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. To enable this for the creative, make sure the Advertiser.creative_config.ias_client_id has been set to your IAS client ID.
+  "integrationCode": "A String", # Optional. ID information used to link this creative to an external system. Must be UTF-8 encoded with a length of no more than 10,000 characters.
+  "jsTrackerUrl": "A String", # Optional. JavaScript measurement URL from supported third-party verification providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not supported. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`
+  "lineItemIds": [ # Output only. The IDs of the line items this creative is associated with. To associate a creative to a line item, use LineItem.creative_ids instead.
+    "A String",
+  ],
+  "mediaDuration": "A String", # Output only. Media duration of the creative. Applicable when creative_type is one of: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_PUBLISHER_HOSTED`
+  "mp3Audio": True or False, # Output only. Indicates the third-party audio creative supports MP3. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO`
+  "name": "A String", # Output only. The resource name of the creative.
+  "notes": "A String", # Optional. User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters.
+  "obaIcon": { # OBA Icon for a Creative # Optional. Specifies the OBA icon for a video creative. This field is only supported in the following creative_type: * `CREATIVE_TYPE_VIDEO`
+    "clickTrackingUrl": "A String", # Required. The click tracking URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com`
+    "dimensions": { # Dimensions. # Optional. The dimensions of the OBA icon.
+      "heightPixels": 42, # The height in pixels.
+      "widthPixels": 42, # The width in pixels.
+    },
+    "landingPageUrl": "A String", # Required. The landing page URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com`
+    "position": "A String", # Optional. The position of the OBA icon on the creative.
+    "program": "A String", # Optional. The program of the OBA icon. For example: “AdChoices”.
+    "resourceMimeType": "A String", # Optional. The MIME type of the OBA icon resource.
+    "resourceUrl": "A String", # Optional. The URL of the OBA icon resource.
+    "viewTrackingUrl": "A String", # Required. The view tracking URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com`
+  },
+  "oggAudio": True or False, # Output only. Indicates the third-party audio creative supports OGG. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO`
+  "progressOffset": { # The length an audio or a video has been played. # Optional. Amount of time to play the video before counting a view. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`
+    "percentage": "A String", # Optional. The offset in percentage of the audio or video duration.
+    "seconds": "A String", # Optional. The offset in seconds from the start of the audio or video.
+  },
+  "requireHtml5": True or False, # Optional. Indicates that the creative relies on HTML5 to render properly. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE`
+  "requireMraid": True or False, # Optional. Indicates that the creative requires MRAID (Mobile Rich Media Ad Interface Definitions system). Set this if the creative relies on mobile gestures for interactivity, such as swiping or tapping. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE`
+  "requirePingForAttribution": True or False, # Optional. Indicates that the creative will wait for a return ping for attribution. Only valid when using a Campaign Manager 360 tracking ad with a third-party ad server parameter and the ${DC_DBM_TOKEN} macro. Optional and only valid for third-party tag creatives or third-party VAST tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO`
+  "reviewStatus": { # Review statuses for the creative. # Output only. The current status of the creative review process.
+    "approvalStatus": "A String", # Represents the basic approval needed for a creative to begin serving. Summary of creative_and_landing_page_review_status and content_and_policy_review_status.
+    "contentAndPolicyReviewStatus": "A String", # Content and policy review status for the creative.
+    "creativeAndLandingPageReviewStatus": "A String", # Creative and landing page review status for the creative.
+    "exchangeReviewStatuses": [ # Exchange review statuses for the creative.
+      { # Exchange review status for the creative.
+        "exchange": "A String", # The exchange reviewing the creative.
+        "status": "A String", # Status of the exchange review.
+      },
+    ],
+  },
+  "skipOffset": { # The length an audio or a video has been played. # Optional. Amount of time to play the video before the skip button appears. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`
+    "percentage": "A String", # Optional. The offset in percentage of the audio or video duration.
+    "seconds": "A String", # Optional. The offset in seconds from the start of the audio or video.
+  },
+  "skippable": True or False, # Optional. Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`
+  "thirdPartyTag": "A String", # Optional. The original third-party tag used for the creative. Required and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE`
+  "thirdPartyUrls": [ # Optional. Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO`
+    { # Tracking URLs from third parties to track interactions with an audio or a video creative.
+      "type": "A String", # Optional. The type of interaction needs to be tracked by the tracking URL
+      "url": "A String", # Optional. Tracking URL used to track the interaction. Provide a URL with optional path or query string, beginning with `https:`. For example, `https://www.example.com/path`
+    },
+  ],
+  "timerEvents": [ # Optional. Timer custom events for a rich media creative. Timers track the time during which a user views and interacts with a specified part of a rich media creative. A creative can have multiple timer events, each timed independently. Leave it empty or unset for creatives containing image assets only.
+    { # Timer event of the creative.
+      "name": "A String", # Required. The name of the timer event.
+      "reportingName": "A String", # Required. The name used to identify this timer event in reports.
+    },
+  ],
+  "trackerUrls": [ # Optional. Tracking URLs for analytics providers or third-party ad technology vendors. The URLs must start with `https:` (except on inventory that doesn't require SSL compliance). If using macros in your URL, use only macros supported by Display & Video 360. Standard URLs only, no IMG or SCRIPT tags. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`
+    "A String",
+  ],
+  "transcodes": [ # Output only. Audio/Video transcodes. Display & Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher's system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer’s connection and screen size. This field is only supported in the following creative_type: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_AUDIO`
+    { # Represents information about the transcoded audio or video file.
+      "audioBitRateKbps": "A String", # Optional. The bit rate for the audio stream of the transcoded video, or the bit rate for the transcoded audio, in kilobits per second.
+      "audioSampleRateHz": "A String", # Optional. The sample rate for the audio stream of the transcoded video, or the sample rate for the transcoded audio, in hertz.
+      "bitRateKbps": "A String", # Optional. The transcoding bit rate of the transcoded video, in kilobits per second.
+      "dimensions": { # Dimensions. # Optional. The dimensions of the transcoded video.
+        "heightPixels": 42, # The height in pixels.
+        "widthPixels": 42, # The width in pixels.
+      },
+      "fileSizeBytes": "A String", # Optional. The size of the transcoded file, in bytes.
+      "frameRate": 3.14, # Optional. The frame rate of the transcoded video, in frames per second.
+      "mimeType": "A String", # Optional. The MIME type of the transcoded file.
+      "name": "A String", # Optional. The name of the transcoded file.
+      "transcoded": True or False, # Optional. Indicates if the transcoding was successful.
+    },
+  ],
+  "universalAdId": { # A creative identifier provided by a registry that is unique across all platforms. This is part of the VAST 4.0 standard. # Optional. An optional creative identifier provided by a registry that is unique across all platforms. Universal Ad ID is part of the VAST 4.0 standard. It can be modified after the creative is created. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`
+    "id": "A String", # Optional. The unique creative identifier.
+    "registry": "A String", # Optional. The registry provides unique creative identifiers.
+  },
+  "updateTime": "A String", # Output only. The timestamp when the creative was last updated, either by the user or system (e.g. creative review). Assigned by the system.
+  "vastTagUrl": "A String", # Optional. The URL of the VAST tag for a third-party VAST tag creative. Required and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO`
+  "vpaid": True or False, # Output only. Indicates the third-party VAST tag creative requires VPAID (Digital Video Player-Ad Interface). Output only and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_VIDEO`
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single Creative.
+  "additionalDimensions": [ # Optional. Additional dimensions. Applicable when creative_type is one of: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_LIGHTBOX` * `CREATIVE_TYPE_PUBLISHER_HOSTED` If this field is specified, width_pixels and height_pixels are both required and must be greater than or equal to 0.
+    { # Dimensions.
+      "heightPixels": 42, # The height in pixels.
+      "widthPixels": 42, # The width in pixels.
+    },
+  ],
+  "advertiserId": "A String", # Output only. The unique ID of the advertiser the creative belongs to.
+  "appendedTag": "A String", # Optional. Third-party HTML tracking tag to be appended to the creative tag.
+  "assets": [ # Required. Assets associated to this creative.
+    { # Asset association for the creative.
+      "asset": { # A single asset. # Optional. The associated asset.
+        "content": "A String", # The asset content. For uploaded assets, the content is the serving path.
+        "mediaId": "A String", # Media ID of the uploaded asset. This is a unique identifier for the asset. This ID can be passed to other API calls, e.g. CreateCreative to associate the asset with a creative. The Media ID space updated on **April 5, 2023**. Update media IDs cached before **April 5, 2023** by retrieving the new media ID from associated creative resources or re-uploading the asset.
+      },
+      "role": "A String", # Optional. The role of this asset for the creative.
+    },
+  ],
+  "cmPlacementId": "A String", # Output only. The unique ID of the Campaign Manager 360 placement associated with the creative. This field is only applicable for creatives that are synced from Campaign Manager.
+  "cmTrackingAd": { # A Campaign Manager 360 tracking ad. # Optional. The Campaign Manager 360 tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager 360 and third-party ad serving: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` Output only for other cases.
+    "cmAdId": "A String", # Optional. The ad ID of the campaign manager 360 tracking Ad.
+    "cmCreativeId": "A String", # Optional. The creative ID of the campaign manager 360 tracking Ad.
+    "cmPlacementId": "A String", # Optional. The placement ID of the campaign manager 360 tracking Ad.
+  },
+  "companionCreativeIds": [ # Optional. The IDs of companion creatives for a video creative. You can assign existing display creatives (with image or HTML5 assets) to serve surrounding the publisher's video player. Companions display around the video player while the video is playing and remain after the video has completed. Creatives contain additional dimensions can not be companion creatives. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO`
+    "A String",
+  ],
+  "counterEvents": [ # Optional. Counter events for a rich media creative. Counters track the number of times that a user interacts with any part of a rich media creative in a specified way (mouse-overs, mouse-outs, clicks, taps, data loading, keyboard entries, etc.). Any event that can be captured in the creative can be recorded as a counter. Leave it empty or unset for creatives containing image assets only.
+    { # Counter event of the creative.
+      "name": "A String", # Required. The name of the counter event.
+      "reportingName": "A String", # Required. The name used to identify this counter event in reports.
+    },
+  ],
+  "createTime": "A String", # Output only. The timestamp when the creative was created. Assigned by the system.
+  "creativeAttributes": [ # Output only. A list of attributes of the creative that is generated by the system.
+    "A String",
+  ],
+  "creativeId": "A String", # Output only. The unique ID of the creative. Assigned by the system.
+  "creativeType": "A String", # Required. Immutable. The type of the creative.
+  "dimensions": { # Dimensions. # Required. Primary dimensions of the creative. Applicable to all creative types. The value of width_pixels and height_pixels defaults to `0` when creative_type is one of: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_NATIVE_VIDEO`
+    "heightPixels": 42, # The height in pixels.
+    "widthPixels": 42, # The width in pixels.
+  },
+  "displayName": "A String", # Required. The display name of the creative. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "dynamic": True or False, # Output only. Indicates whether the creative is dynamic.
+  "entityStatus": "A String", # Required. Controls whether or not the creative can serve. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED` * `ENTITY_STATUS_PAUSED`
+  "exitEvents": [ # Required. Exit events for this creative. An exit (also known as a click tag) is any area in your creative that someone can click or tap to open an advertiser's landing page. Every creative must include at least one exit. You can add an exit to your creative in any of the following ways: * Use Google Web Designer's tap area. * Define a JavaScript variable called "clickTag". * Use the Enabler (Enabler.exit()) to track exits in rich media formats.
+    { # Exit event of the creative.
+      "name": "A String", # Optional. The name of the click tag of the exit event. The name must be unique within one creative. Leave it empty or unset for creatives containing image assets only.
+      "reportingName": "A String", # Optional. The name used to identify this event in reports. Leave it empty or unset for creatives containing image assets only.
+      "type": "A String", # Required. The type of the exit event.
+      "url": "A String", # Required. The click through URL of the exit event. This is required when type is: * `EXIT_EVENT_TYPE_DEFAULT` * `EXIT_EVENT_TYPE_BACKUP`
+    },
+  ],
+  "expandOnHover": True or False, # Optional. Indicates the creative will automatically expand on hover. Optional and only valid for third-party expandable creatives. Third-party expandable creatives are creatives with following hosting source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_EXPANDABLE`
+  "expandingDirection": "A String", # Optional. Specifies the expanding direction of the creative. Required and only valid for third-party expandable creatives. Third-party expandable creatives are creatives with following hosting source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_EXPANDABLE`
+  "hostingSource": "A String", # Required. Indicates where the creative is hosted.
+  "html5Video": True or False, # Output only. Indicates the third-party VAST tag creative requires HTML5 Video support. Output only and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_VIDEO`
+  "iasCampaignMonitoring": True or False, # Optional. Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. To enable this for the creative, make sure the Advertiser.creative_config.ias_client_id has been set to your IAS client ID.
+  "integrationCode": "A String", # Optional. ID information used to link this creative to an external system. Must be UTF-8 encoded with a length of no more than 10,000 characters.
+  "jsTrackerUrl": "A String", # Optional. JavaScript measurement URL from supported third-party verification providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not supported. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`
+  "lineItemIds": [ # Output only. The IDs of the line items this creative is associated with. To associate a creative to a line item, use LineItem.creative_ids instead.
+    "A String",
+  ],
+  "mediaDuration": "A String", # Output only. Media duration of the creative. Applicable when creative_type is one of: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_PUBLISHER_HOSTED`
+  "mp3Audio": True or False, # Output only. Indicates the third-party audio creative supports MP3. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO`
+  "name": "A String", # Output only. The resource name of the creative.
+  "notes": "A String", # Optional. User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters.
+  "obaIcon": { # OBA Icon for a Creative # Optional. Specifies the OBA icon for a video creative. This field is only supported in the following creative_type: * `CREATIVE_TYPE_VIDEO`
+    "clickTrackingUrl": "A String", # Required. The click tracking URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com`
+    "dimensions": { # Dimensions. # Optional. The dimensions of the OBA icon.
+      "heightPixels": 42, # The height in pixels.
+      "widthPixels": 42, # The width in pixels.
+    },
+    "landingPageUrl": "A String", # Required. The landing page URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com`
+    "position": "A String", # Optional. The position of the OBA icon on the creative.
+    "program": "A String", # Optional. The program of the OBA icon. For example: “AdChoices”.
+    "resourceMimeType": "A String", # Optional. The MIME type of the OBA icon resource.
+    "resourceUrl": "A String", # Optional. The URL of the OBA icon resource.
+    "viewTrackingUrl": "A String", # Required. The view tracking URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com`
+  },
+  "oggAudio": True or False, # Output only. Indicates the third-party audio creative supports OGG. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO`
+  "progressOffset": { # The length an audio or a video has been played. # Optional. Amount of time to play the video before counting a view. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`
+    "percentage": "A String", # Optional. The offset in percentage of the audio or video duration.
+    "seconds": "A String", # Optional. The offset in seconds from the start of the audio or video.
+  },
+  "requireHtml5": True or False, # Optional. Indicates that the creative relies on HTML5 to render properly. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE`
+  "requireMraid": True or False, # Optional. Indicates that the creative requires MRAID (Mobile Rich Media Ad Interface Definitions system). Set this if the creative relies on mobile gestures for interactivity, such as swiping or tapping. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE`
+  "requirePingForAttribution": True or False, # Optional. Indicates that the creative will wait for a return ping for attribution. Only valid when using a Campaign Manager 360 tracking ad with a third-party ad server parameter and the ${DC_DBM_TOKEN} macro. Optional and only valid for third-party tag creatives or third-party VAST tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO`
+  "reviewStatus": { # Review statuses for the creative. # Output only. The current status of the creative review process.
+    "approvalStatus": "A String", # Represents the basic approval needed for a creative to begin serving. Summary of creative_and_landing_page_review_status and content_and_policy_review_status.
+    "contentAndPolicyReviewStatus": "A String", # Content and policy review status for the creative.
+    "creativeAndLandingPageReviewStatus": "A String", # Creative and landing page review status for the creative.
+    "exchangeReviewStatuses": [ # Exchange review statuses for the creative.
+      { # Exchange review status for the creative.
+        "exchange": "A String", # The exchange reviewing the creative.
+        "status": "A String", # Status of the exchange review.
+      },
+    ],
+  },
+  "skipOffset": { # The length an audio or a video has been played. # Optional. Amount of time to play the video before the skip button appears. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`
+    "percentage": "A String", # Optional. The offset in percentage of the audio or video duration.
+    "seconds": "A String", # Optional. The offset in seconds from the start of the audio or video.
+  },
+  "skippable": True or False, # Optional. Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`
+  "thirdPartyTag": "A String", # Optional. The original third-party tag used for the creative. Required and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE`
+  "thirdPartyUrls": [ # Optional. Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO`
+    { # Tracking URLs from third parties to track interactions with an audio or a video creative.
+      "type": "A String", # Optional. The type of interaction needs to be tracked by the tracking URL
+      "url": "A String", # Optional. Tracking URL used to track the interaction. Provide a URL with optional path or query string, beginning with `https:`. For example, `https://www.example.com/path`
+    },
+  ],
+  "timerEvents": [ # Optional. Timer custom events for a rich media creative. Timers track the time during which a user views and interacts with a specified part of a rich media creative. A creative can have multiple timer events, each timed independently. Leave it empty or unset for creatives containing image assets only.
+    { # Timer event of the creative.
+      "name": "A String", # Required. The name of the timer event.
+      "reportingName": "A String", # Required. The name used to identify this timer event in reports.
+    },
+  ],
+  "trackerUrls": [ # Optional. Tracking URLs for analytics providers or third-party ad technology vendors. The URLs must start with `https:` (except on inventory that doesn't require SSL compliance). If using macros in your URL, use only macros supported by Display & Video 360. Standard URLs only, no IMG or SCRIPT tags. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`
+    "A String",
+  ],
+  "transcodes": [ # Output only. Audio/Video transcodes. Display & Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher's system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer’s connection and screen size. This field is only supported in the following creative_type: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_AUDIO`
+    { # Represents information about the transcoded audio or video file.
+      "audioBitRateKbps": "A String", # Optional. The bit rate for the audio stream of the transcoded video, or the bit rate for the transcoded audio, in kilobits per second.
+      "audioSampleRateHz": "A String", # Optional. The sample rate for the audio stream of the transcoded video, or the sample rate for the transcoded audio, in hertz.
+      "bitRateKbps": "A String", # Optional. The transcoding bit rate of the transcoded video, in kilobits per second.
+      "dimensions": { # Dimensions. # Optional. The dimensions of the transcoded video.
+        "heightPixels": 42, # The height in pixels.
+        "widthPixels": 42, # The width in pixels.
+      },
+      "fileSizeBytes": "A String", # Optional. The size of the transcoded file, in bytes.
+      "frameRate": 3.14, # Optional. The frame rate of the transcoded video, in frames per second.
+      "mimeType": "A String", # Optional. The MIME type of the transcoded file.
+      "name": "A String", # Optional. The name of the transcoded file.
+      "transcoded": True or False, # Optional. Indicates if the transcoding was successful.
+    },
+  ],
+  "universalAdId": { # A creative identifier provided by a registry that is unique across all platforms. This is part of the VAST 4.0 standard. # Optional. An optional creative identifier provided by a registry that is unique across all platforms. Universal Ad ID is part of the VAST 4.0 standard. It can be modified after the creative is created. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`
+    "id": "A String", # Optional. The unique creative identifier.
+    "registry": "A String", # Optional. The registry provides unique creative identifiers.
+  },
+  "updateTime": "A String", # Output only. The timestamp when the creative was last updated, either by the user or system (e.g. creative review). Assigned by the system.
+  "vastTagUrl": "A String", # Optional. The URL of the VAST tag for a third-party VAST tag creative. Required and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO`
+  "vpaid": True or False, # Output only. Indicates the third-party VAST tag creative requires VPAID (Digital Video Player-Ad Interface). Output only and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_VIDEO`
+}
+
+ +
+ delete(advertiserId, creativeId, x__xgafv=None) +
Deletes a creative. Returns error code `NOT_FOUND` if the creative does not exist. The creative should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, before it can be deleted. A ["Standard" user role](//support.google.com/displayvideo/answer/2723011) or greater for the parent advertiser or partner is required to make this request.
+
+Args:
+  advertiserId: string, The ID of the advertiser this creative belongs to. (required)
+  creativeId: string, The ID of the creative 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(advertiserId, creativeId, x__xgafv=None) +
Gets a creative.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser this creative belongs to. (required)
+  creativeId: string, Required. The ID of the creative to fetch. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single Creative.
+  "additionalDimensions": [ # Optional. Additional dimensions. Applicable when creative_type is one of: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_LIGHTBOX` * `CREATIVE_TYPE_PUBLISHER_HOSTED` If this field is specified, width_pixels and height_pixels are both required and must be greater than or equal to 0.
+    { # Dimensions.
+      "heightPixels": 42, # The height in pixels.
+      "widthPixels": 42, # The width in pixels.
+    },
+  ],
+  "advertiserId": "A String", # Output only. The unique ID of the advertiser the creative belongs to.
+  "appendedTag": "A String", # Optional. Third-party HTML tracking tag to be appended to the creative tag.
+  "assets": [ # Required. Assets associated to this creative.
+    { # Asset association for the creative.
+      "asset": { # A single asset. # Optional. The associated asset.
+        "content": "A String", # The asset content. For uploaded assets, the content is the serving path.
+        "mediaId": "A String", # Media ID of the uploaded asset. This is a unique identifier for the asset. This ID can be passed to other API calls, e.g. CreateCreative to associate the asset with a creative. The Media ID space updated on **April 5, 2023**. Update media IDs cached before **April 5, 2023** by retrieving the new media ID from associated creative resources or re-uploading the asset.
+      },
+      "role": "A String", # Optional. The role of this asset for the creative.
+    },
+  ],
+  "cmPlacementId": "A String", # Output only. The unique ID of the Campaign Manager 360 placement associated with the creative. This field is only applicable for creatives that are synced from Campaign Manager.
+  "cmTrackingAd": { # A Campaign Manager 360 tracking ad. # Optional. The Campaign Manager 360 tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager 360 and third-party ad serving: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` Output only for other cases.
+    "cmAdId": "A String", # Optional. The ad ID of the campaign manager 360 tracking Ad.
+    "cmCreativeId": "A String", # Optional. The creative ID of the campaign manager 360 tracking Ad.
+    "cmPlacementId": "A String", # Optional. The placement ID of the campaign manager 360 tracking Ad.
+  },
+  "companionCreativeIds": [ # Optional. The IDs of companion creatives for a video creative. You can assign existing display creatives (with image or HTML5 assets) to serve surrounding the publisher's video player. Companions display around the video player while the video is playing and remain after the video has completed. Creatives contain additional dimensions can not be companion creatives. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO`
+    "A String",
+  ],
+  "counterEvents": [ # Optional. Counter events for a rich media creative. Counters track the number of times that a user interacts with any part of a rich media creative in a specified way (mouse-overs, mouse-outs, clicks, taps, data loading, keyboard entries, etc.). Any event that can be captured in the creative can be recorded as a counter. Leave it empty or unset for creatives containing image assets only.
+    { # Counter event of the creative.
+      "name": "A String", # Required. The name of the counter event.
+      "reportingName": "A String", # Required. The name used to identify this counter event in reports.
+    },
+  ],
+  "createTime": "A String", # Output only. The timestamp when the creative was created. Assigned by the system.
+  "creativeAttributes": [ # Output only. A list of attributes of the creative that is generated by the system.
+    "A String",
+  ],
+  "creativeId": "A String", # Output only. The unique ID of the creative. Assigned by the system.
+  "creativeType": "A String", # Required. Immutable. The type of the creative.
+  "dimensions": { # Dimensions. # Required. Primary dimensions of the creative. Applicable to all creative types. The value of width_pixels and height_pixels defaults to `0` when creative_type is one of: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_NATIVE_VIDEO`
+    "heightPixels": 42, # The height in pixels.
+    "widthPixels": 42, # The width in pixels.
+  },
+  "displayName": "A String", # Required. The display name of the creative. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "dynamic": True or False, # Output only. Indicates whether the creative is dynamic.
+  "entityStatus": "A String", # Required. Controls whether or not the creative can serve. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED` * `ENTITY_STATUS_PAUSED`
+  "exitEvents": [ # Required. Exit events for this creative. An exit (also known as a click tag) is any area in your creative that someone can click or tap to open an advertiser's landing page. Every creative must include at least one exit. You can add an exit to your creative in any of the following ways: * Use Google Web Designer's tap area. * Define a JavaScript variable called "clickTag". * Use the Enabler (Enabler.exit()) to track exits in rich media formats.
+    { # Exit event of the creative.
+      "name": "A String", # Optional. The name of the click tag of the exit event. The name must be unique within one creative. Leave it empty or unset for creatives containing image assets only.
+      "reportingName": "A String", # Optional. The name used to identify this event in reports. Leave it empty or unset for creatives containing image assets only.
+      "type": "A String", # Required. The type of the exit event.
+      "url": "A String", # Required. The click through URL of the exit event. This is required when type is: * `EXIT_EVENT_TYPE_DEFAULT` * `EXIT_EVENT_TYPE_BACKUP`
+    },
+  ],
+  "expandOnHover": True or False, # Optional. Indicates the creative will automatically expand on hover. Optional and only valid for third-party expandable creatives. Third-party expandable creatives are creatives with following hosting source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_EXPANDABLE`
+  "expandingDirection": "A String", # Optional. Specifies the expanding direction of the creative. Required and only valid for third-party expandable creatives. Third-party expandable creatives are creatives with following hosting source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_EXPANDABLE`
+  "hostingSource": "A String", # Required. Indicates where the creative is hosted.
+  "html5Video": True or False, # Output only. Indicates the third-party VAST tag creative requires HTML5 Video support. Output only and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_VIDEO`
+  "iasCampaignMonitoring": True or False, # Optional. Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. To enable this for the creative, make sure the Advertiser.creative_config.ias_client_id has been set to your IAS client ID.
+  "integrationCode": "A String", # Optional. ID information used to link this creative to an external system. Must be UTF-8 encoded with a length of no more than 10,000 characters.
+  "jsTrackerUrl": "A String", # Optional. JavaScript measurement URL from supported third-party verification providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not supported. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`
+  "lineItemIds": [ # Output only. The IDs of the line items this creative is associated with. To associate a creative to a line item, use LineItem.creative_ids instead.
+    "A String",
+  ],
+  "mediaDuration": "A String", # Output only. Media duration of the creative. Applicable when creative_type is one of: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_PUBLISHER_HOSTED`
+  "mp3Audio": True or False, # Output only. Indicates the third-party audio creative supports MP3. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO`
+  "name": "A String", # Output only. The resource name of the creative.
+  "notes": "A String", # Optional. User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters.
+  "obaIcon": { # OBA Icon for a Creative # Optional. Specifies the OBA icon for a video creative. This field is only supported in the following creative_type: * `CREATIVE_TYPE_VIDEO`
+    "clickTrackingUrl": "A String", # Required. The click tracking URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com`
+    "dimensions": { # Dimensions. # Optional. The dimensions of the OBA icon.
+      "heightPixels": 42, # The height in pixels.
+      "widthPixels": 42, # The width in pixels.
+    },
+    "landingPageUrl": "A String", # Required. The landing page URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com`
+    "position": "A String", # Optional. The position of the OBA icon on the creative.
+    "program": "A String", # Optional. The program of the OBA icon. For example: “AdChoices”.
+    "resourceMimeType": "A String", # Optional. The MIME type of the OBA icon resource.
+    "resourceUrl": "A String", # Optional. The URL of the OBA icon resource.
+    "viewTrackingUrl": "A String", # Required. The view tracking URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com`
+  },
+  "oggAudio": True or False, # Output only. Indicates the third-party audio creative supports OGG. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO`
+  "progressOffset": { # The length an audio or a video has been played. # Optional. Amount of time to play the video before counting a view. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`
+    "percentage": "A String", # Optional. The offset in percentage of the audio or video duration.
+    "seconds": "A String", # Optional. The offset in seconds from the start of the audio or video.
+  },
+  "requireHtml5": True or False, # Optional. Indicates that the creative relies on HTML5 to render properly. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE`
+  "requireMraid": True or False, # Optional. Indicates that the creative requires MRAID (Mobile Rich Media Ad Interface Definitions system). Set this if the creative relies on mobile gestures for interactivity, such as swiping or tapping. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE`
+  "requirePingForAttribution": True or False, # Optional. Indicates that the creative will wait for a return ping for attribution. Only valid when using a Campaign Manager 360 tracking ad with a third-party ad server parameter and the ${DC_DBM_TOKEN} macro. Optional and only valid for third-party tag creatives or third-party VAST tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO`
+  "reviewStatus": { # Review statuses for the creative. # Output only. The current status of the creative review process.
+    "approvalStatus": "A String", # Represents the basic approval needed for a creative to begin serving. Summary of creative_and_landing_page_review_status and content_and_policy_review_status.
+    "contentAndPolicyReviewStatus": "A String", # Content and policy review status for the creative.
+    "creativeAndLandingPageReviewStatus": "A String", # Creative and landing page review status for the creative.
+    "exchangeReviewStatuses": [ # Exchange review statuses for the creative.
+      { # Exchange review status for the creative.
+        "exchange": "A String", # The exchange reviewing the creative.
+        "status": "A String", # Status of the exchange review.
+      },
+    ],
+  },
+  "skipOffset": { # The length an audio or a video has been played. # Optional. Amount of time to play the video before the skip button appears. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`
+    "percentage": "A String", # Optional. The offset in percentage of the audio or video duration.
+    "seconds": "A String", # Optional. The offset in seconds from the start of the audio or video.
+  },
+  "skippable": True or False, # Optional. Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`
+  "thirdPartyTag": "A String", # Optional. The original third-party tag used for the creative. Required and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE`
+  "thirdPartyUrls": [ # Optional. Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO`
+    { # Tracking URLs from third parties to track interactions with an audio or a video creative.
+      "type": "A String", # Optional. The type of interaction needs to be tracked by the tracking URL
+      "url": "A String", # Optional. Tracking URL used to track the interaction. Provide a URL with optional path or query string, beginning with `https:`. For example, `https://www.example.com/path`
+    },
+  ],
+  "timerEvents": [ # Optional. Timer custom events for a rich media creative. Timers track the time during which a user views and interacts with a specified part of a rich media creative. A creative can have multiple timer events, each timed independently. Leave it empty or unset for creatives containing image assets only.
+    { # Timer event of the creative.
+      "name": "A String", # Required. The name of the timer event.
+      "reportingName": "A String", # Required. The name used to identify this timer event in reports.
+    },
+  ],
+  "trackerUrls": [ # Optional. Tracking URLs for analytics providers or third-party ad technology vendors. The URLs must start with `https:` (except on inventory that doesn't require SSL compliance). If using macros in your URL, use only macros supported by Display & Video 360. Standard URLs only, no IMG or SCRIPT tags. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`
+    "A String",
+  ],
+  "transcodes": [ # Output only. Audio/Video transcodes. Display & Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher's system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer’s connection and screen size. This field is only supported in the following creative_type: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_AUDIO`
+    { # Represents information about the transcoded audio or video file.
+      "audioBitRateKbps": "A String", # Optional. The bit rate for the audio stream of the transcoded video, or the bit rate for the transcoded audio, in kilobits per second.
+      "audioSampleRateHz": "A String", # Optional. The sample rate for the audio stream of the transcoded video, or the sample rate for the transcoded audio, in hertz.
+      "bitRateKbps": "A String", # Optional. The transcoding bit rate of the transcoded video, in kilobits per second.
+      "dimensions": { # Dimensions. # Optional. The dimensions of the transcoded video.
+        "heightPixels": 42, # The height in pixels.
+        "widthPixels": 42, # The width in pixels.
+      },
+      "fileSizeBytes": "A String", # Optional. The size of the transcoded file, in bytes.
+      "frameRate": 3.14, # Optional. The frame rate of the transcoded video, in frames per second.
+      "mimeType": "A String", # Optional. The MIME type of the transcoded file.
+      "name": "A String", # Optional. The name of the transcoded file.
+      "transcoded": True or False, # Optional. Indicates if the transcoding was successful.
+    },
+  ],
+  "universalAdId": { # A creative identifier provided by a registry that is unique across all platforms. This is part of the VAST 4.0 standard. # Optional. An optional creative identifier provided by a registry that is unique across all platforms. Universal Ad ID is part of the VAST 4.0 standard. It can be modified after the creative is created. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`
+    "id": "A String", # Optional. The unique creative identifier.
+    "registry": "A String", # Optional. The registry provides unique creative identifiers.
+  },
+  "updateTime": "A String", # Output only. The timestamp when the creative was last updated, either by the user or system (e.g. creative review). Assigned by the system.
+  "vastTagUrl": "A String", # Optional. The URL of the VAST tag for a third-party VAST tag creative. Required and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO`
+  "vpaid": True or False, # Output only. Indicates the third-party VAST tag creative requires VPAID (Digital Video Player-Ad Interface). Output only and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_VIDEO`
+}
+
+ +
+ list(advertiserId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists creatives in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, creatives with `ENTITY_STATUS_ARCHIVED` will not be included in the results.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser to list creatives for. (required)
+  filter: string, Allows filtering by creative fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `lineItemIds` field must use the `HAS (:)` operator. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. * For `entityStatus`, `minDuration`, `maxDuration`, `updateTime`, and `dynamic` fields, there may be at most one restriction. Supported Fields: * `approvalStatus` * `creativeId` * `creativeType` * `dimensions` (input in the form of `{width}x{height}`) * `dynamic` * `entityStatus` * `exchangeReviewStatus` (input in the form of `{exchange}-{reviewStatus}`) * `lineItemIds` * `maxDuration` (input in the form of `{duration}s`. Only seconds are supported) * `minDuration` (input in the form of `{duration}s`. Only seconds are supported) * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Notes: * For `updateTime`, a creative resource's field value reflects the last time that a creative has been updated, which includes updates made by the system (e.g. creative review updates). Examples: * All native creatives: `creativeType="CREATIVE_TYPE_NATIVE"` * All active creatives with 300x400 or 50x100 dimensions: `entityStatus="ENTITY_STATUS_ACTIVE" AND (dimensions="300x400" OR dimensions="50x100")` * All dynamic creatives that are approved by AdX or AppNexus, with a minimum duration of 5 seconds and 200ms: `dynamic="true" AND minDuration="5.2s" AND (exchangeReviewStatus="EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED" OR exchangeReviewStatus="EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED")` * All video creatives that are associated with line item ID 1 or 2: `creativeType="CREATIVE_TYPE_VIDEO" AND (lineItemIds:1 OR lineItemIds:2)` * Find creatives by multiple creative IDs: `creativeId=1 OR creativeId=2` * All creatives with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
+  orderBy: string, Field by which to sort the list. Acceptable values are: * `creativeId` (default) * `createTime` * `mediaDuration` * `dimensions` (sorts by width first, then by height) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `createTime desc`.
+  pageSize: integer, Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
+  pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCreatives` method. If not specified, the first page of results 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:
+
+    {
+  "creatives": [ # The list of creatives. This list will be absent if empty.
+    { # A single Creative.
+      "additionalDimensions": [ # Optional. Additional dimensions. Applicable when creative_type is one of: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_LIGHTBOX` * `CREATIVE_TYPE_PUBLISHER_HOSTED` If this field is specified, width_pixels and height_pixels are both required and must be greater than or equal to 0.
+        { # Dimensions.
+          "heightPixels": 42, # The height in pixels.
+          "widthPixels": 42, # The width in pixels.
+        },
+      ],
+      "advertiserId": "A String", # Output only. The unique ID of the advertiser the creative belongs to.
+      "appendedTag": "A String", # Optional. Third-party HTML tracking tag to be appended to the creative tag.
+      "assets": [ # Required. Assets associated to this creative.
+        { # Asset association for the creative.
+          "asset": { # A single asset. # Optional. The associated asset.
+            "content": "A String", # The asset content. For uploaded assets, the content is the serving path.
+            "mediaId": "A String", # Media ID of the uploaded asset. This is a unique identifier for the asset. This ID can be passed to other API calls, e.g. CreateCreative to associate the asset with a creative. The Media ID space updated on **April 5, 2023**. Update media IDs cached before **April 5, 2023** by retrieving the new media ID from associated creative resources or re-uploading the asset.
+          },
+          "role": "A String", # Optional. The role of this asset for the creative.
+        },
+      ],
+      "cmPlacementId": "A String", # Output only. The unique ID of the Campaign Manager 360 placement associated with the creative. This field is only applicable for creatives that are synced from Campaign Manager.
+      "cmTrackingAd": { # A Campaign Manager 360 tracking ad. # Optional. The Campaign Manager 360 tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager 360 and third-party ad serving: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` Output only for other cases.
+        "cmAdId": "A String", # Optional. The ad ID of the campaign manager 360 tracking Ad.
+        "cmCreativeId": "A String", # Optional. The creative ID of the campaign manager 360 tracking Ad.
+        "cmPlacementId": "A String", # Optional. The placement ID of the campaign manager 360 tracking Ad.
+      },
+      "companionCreativeIds": [ # Optional. The IDs of companion creatives for a video creative. You can assign existing display creatives (with image or HTML5 assets) to serve surrounding the publisher's video player. Companions display around the video player while the video is playing and remain after the video has completed. Creatives contain additional dimensions can not be companion creatives. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO`
+        "A String",
+      ],
+      "counterEvents": [ # Optional. Counter events for a rich media creative. Counters track the number of times that a user interacts with any part of a rich media creative in a specified way (mouse-overs, mouse-outs, clicks, taps, data loading, keyboard entries, etc.). Any event that can be captured in the creative can be recorded as a counter. Leave it empty or unset for creatives containing image assets only.
+        { # Counter event of the creative.
+          "name": "A String", # Required. The name of the counter event.
+          "reportingName": "A String", # Required. The name used to identify this counter event in reports.
+        },
+      ],
+      "createTime": "A String", # Output only. The timestamp when the creative was created. Assigned by the system.
+      "creativeAttributes": [ # Output only. A list of attributes of the creative that is generated by the system.
+        "A String",
+      ],
+      "creativeId": "A String", # Output only. The unique ID of the creative. Assigned by the system.
+      "creativeType": "A String", # Required. Immutable. The type of the creative.
+      "dimensions": { # Dimensions. # Required. Primary dimensions of the creative. Applicable to all creative types. The value of width_pixels and height_pixels defaults to `0` when creative_type is one of: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_NATIVE_VIDEO`
+        "heightPixels": 42, # The height in pixels.
+        "widthPixels": 42, # The width in pixels.
+      },
+      "displayName": "A String", # Required. The display name of the creative. Must be UTF-8 encoded with a maximum size of 240 bytes.
+      "dynamic": True or False, # Output only. Indicates whether the creative is dynamic.
+      "entityStatus": "A String", # Required. Controls whether or not the creative can serve. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED` * `ENTITY_STATUS_PAUSED`
+      "exitEvents": [ # Required. Exit events for this creative. An exit (also known as a click tag) is any area in your creative that someone can click or tap to open an advertiser's landing page. Every creative must include at least one exit. You can add an exit to your creative in any of the following ways: * Use Google Web Designer's tap area. * Define a JavaScript variable called "clickTag". * Use the Enabler (Enabler.exit()) to track exits in rich media formats.
+        { # Exit event of the creative.
+          "name": "A String", # Optional. The name of the click tag of the exit event. The name must be unique within one creative. Leave it empty or unset for creatives containing image assets only.
+          "reportingName": "A String", # Optional. The name used to identify this event in reports. Leave it empty or unset for creatives containing image assets only.
+          "type": "A String", # Required. The type of the exit event.
+          "url": "A String", # Required. The click through URL of the exit event. This is required when type is: * `EXIT_EVENT_TYPE_DEFAULT` * `EXIT_EVENT_TYPE_BACKUP`
+        },
+      ],
+      "expandOnHover": True or False, # Optional. Indicates the creative will automatically expand on hover. Optional and only valid for third-party expandable creatives. Third-party expandable creatives are creatives with following hosting source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_EXPANDABLE`
+      "expandingDirection": "A String", # Optional. Specifies the expanding direction of the creative. Required and only valid for third-party expandable creatives. Third-party expandable creatives are creatives with following hosting source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_EXPANDABLE`
+      "hostingSource": "A String", # Required. Indicates where the creative is hosted.
+      "html5Video": True or False, # Output only. Indicates the third-party VAST tag creative requires HTML5 Video support. Output only and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_VIDEO`
+      "iasCampaignMonitoring": True or False, # Optional. Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. To enable this for the creative, make sure the Advertiser.creative_config.ias_client_id has been set to your IAS client ID.
+      "integrationCode": "A String", # Optional. ID information used to link this creative to an external system. Must be UTF-8 encoded with a length of no more than 10,000 characters.
+      "jsTrackerUrl": "A String", # Optional. JavaScript measurement URL from supported third-party verification providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not supported. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`
+      "lineItemIds": [ # Output only. The IDs of the line items this creative is associated with. To associate a creative to a line item, use LineItem.creative_ids instead.
+        "A String",
+      ],
+      "mediaDuration": "A String", # Output only. Media duration of the creative. Applicable when creative_type is one of: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_PUBLISHER_HOSTED`
+      "mp3Audio": True or False, # Output only. Indicates the third-party audio creative supports MP3. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO`
+      "name": "A String", # Output only. The resource name of the creative.
+      "notes": "A String", # Optional. User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters.
+      "obaIcon": { # OBA Icon for a Creative # Optional. Specifies the OBA icon for a video creative. This field is only supported in the following creative_type: * `CREATIVE_TYPE_VIDEO`
+        "clickTrackingUrl": "A String", # Required. The click tracking URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com`
+        "dimensions": { # Dimensions. # Optional. The dimensions of the OBA icon.
+          "heightPixels": 42, # The height in pixels.
+          "widthPixels": 42, # The width in pixels.
+        },
+        "landingPageUrl": "A String", # Required. The landing page URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com`
+        "position": "A String", # Optional. The position of the OBA icon on the creative.
+        "program": "A String", # Optional. The program of the OBA icon. For example: “AdChoices”.
+        "resourceMimeType": "A String", # Optional. The MIME type of the OBA icon resource.
+        "resourceUrl": "A String", # Optional. The URL of the OBA icon resource.
+        "viewTrackingUrl": "A String", # Required. The view tracking URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com`
+      },
+      "oggAudio": True or False, # Output only. Indicates the third-party audio creative supports OGG. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO`
+      "progressOffset": { # The length an audio or a video has been played. # Optional. Amount of time to play the video before counting a view. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`
+        "percentage": "A String", # Optional. The offset in percentage of the audio or video duration.
+        "seconds": "A String", # Optional. The offset in seconds from the start of the audio or video.
+      },
+      "requireHtml5": True or False, # Optional. Indicates that the creative relies on HTML5 to render properly. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE`
+      "requireMraid": True or False, # Optional. Indicates that the creative requires MRAID (Mobile Rich Media Ad Interface Definitions system). Set this if the creative relies on mobile gestures for interactivity, such as swiping or tapping. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE`
+      "requirePingForAttribution": True or False, # Optional. Indicates that the creative will wait for a return ping for attribution. Only valid when using a Campaign Manager 360 tracking ad with a third-party ad server parameter and the ${DC_DBM_TOKEN} macro. Optional and only valid for third-party tag creatives or third-party VAST tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO`
+      "reviewStatus": { # Review statuses for the creative. # Output only. The current status of the creative review process.
+        "approvalStatus": "A String", # Represents the basic approval needed for a creative to begin serving. Summary of creative_and_landing_page_review_status and content_and_policy_review_status.
+        "contentAndPolicyReviewStatus": "A String", # Content and policy review status for the creative.
+        "creativeAndLandingPageReviewStatus": "A String", # Creative and landing page review status for the creative.
+        "exchangeReviewStatuses": [ # Exchange review statuses for the creative.
+          { # Exchange review status for the creative.
+            "exchange": "A String", # The exchange reviewing the creative.
+            "status": "A String", # Status of the exchange review.
+          },
+        ],
+      },
+      "skipOffset": { # The length an audio or a video has been played. # Optional. Amount of time to play the video before the skip button appears. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`
+        "percentage": "A String", # Optional. The offset in percentage of the audio or video duration.
+        "seconds": "A String", # Optional. The offset in seconds from the start of the audio or video.
+      },
+      "skippable": True or False, # Optional. Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`
+      "thirdPartyTag": "A String", # Optional. The original third-party tag used for the creative. Required and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE`
+      "thirdPartyUrls": [ # Optional. Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO`
+        { # Tracking URLs from third parties to track interactions with an audio or a video creative.
+          "type": "A String", # Optional. The type of interaction needs to be tracked by the tracking URL
+          "url": "A String", # Optional. Tracking URL used to track the interaction. Provide a URL with optional path or query string, beginning with `https:`. For example, `https://www.example.com/path`
+        },
+      ],
+      "timerEvents": [ # Optional. Timer custom events for a rich media creative. Timers track the time during which a user views and interacts with a specified part of a rich media creative. A creative can have multiple timer events, each timed independently. Leave it empty or unset for creatives containing image assets only.
+        { # Timer event of the creative.
+          "name": "A String", # Required. The name of the timer event.
+          "reportingName": "A String", # Required. The name used to identify this timer event in reports.
+        },
+      ],
+      "trackerUrls": [ # Optional. Tracking URLs for analytics providers or third-party ad technology vendors. The URLs must start with `https:` (except on inventory that doesn't require SSL compliance). If using macros in your URL, use only macros supported by Display & Video 360. Standard URLs only, no IMG or SCRIPT tags. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`
+        "A String",
+      ],
+      "transcodes": [ # Output only. Audio/Video transcodes. Display & Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher's system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer’s connection and screen size. This field is only supported in the following creative_type: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_AUDIO`
+        { # Represents information about the transcoded audio or video file.
+          "audioBitRateKbps": "A String", # Optional. The bit rate for the audio stream of the transcoded video, or the bit rate for the transcoded audio, in kilobits per second.
+          "audioSampleRateHz": "A String", # Optional. The sample rate for the audio stream of the transcoded video, or the sample rate for the transcoded audio, in hertz.
+          "bitRateKbps": "A String", # Optional. The transcoding bit rate of the transcoded video, in kilobits per second.
+          "dimensions": { # Dimensions. # Optional. The dimensions of the transcoded video.
+            "heightPixels": 42, # The height in pixels.
+            "widthPixels": 42, # The width in pixels.
+          },
+          "fileSizeBytes": "A String", # Optional. The size of the transcoded file, in bytes.
+          "frameRate": 3.14, # Optional. The frame rate of the transcoded video, in frames per second.
+          "mimeType": "A String", # Optional. The MIME type of the transcoded file.
+          "name": "A String", # Optional. The name of the transcoded file.
+          "transcoded": True or False, # Optional. Indicates if the transcoding was successful.
+        },
+      ],
+      "universalAdId": { # A creative identifier provided by a registry that is unique across all platforms. This is part of the VAST 4.0 standard. # Optional. An optional creative identifier provided by a registry that is unique across all platforms. Universal Ad ID is part of the VAST 4.0 standard. It can be modified after the creative is created. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`
+        "id": "A String", # Optional. The unique creative identifier.
+        "registry": "A String", # Optional. The registry provides unique creative identifiers.
+      },
+      "updateTime": "A String", # Output only. The timestamp when the creative was last updated, either by the user or system (e.g. creative review). Assigned by the system.
+      "vastTagUrl": "A String", # Optional. The URL of the VAST tag for a third-party VAST tag creative. Required and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO`
+      "vpaid": True or False, # Output only. Indicates the third-party VAST tag creative requires VPAID (Digital Video Player-Ad Interface). Output only and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_VIDEO`
+    },
+  ],
+  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListCreativesRequest` method to retrieve the next page of results. If this field is null, it means this is the last page.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(advertiserId, creativeId, body=None, updateMask=None, x__xgafv=None) +
Updates an existing creative. Returns the updated creative if successful. A ["Standard" user role](//support.google.com/displayvideo/answer/2723011) or greater for the parent advertiser or partner is required to make this request.
+
+Args:
+  advertiserId: string, Output only. The unique ID of the advertiser the creative belongs to. (required)
+  creativeId: string, Output only. The unique ID of the creative. Assigned by the system. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A single Creative.
+  "additionalDimensions": [ # Optional. Additional dimensions. Applicable when creative_type is one of: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_LIGHTBOX` * `CREATIVE_TYPE_PUBLISHER_HOSTED` If this field is specified, width_pixels and height_pixels are both required and must be greater than or equal to 0.
+    { # Dimensions.
+      "heightPixels": 42, # The height in pixels.
+      "widthPixels": 42, # The width in pixels.
+    },
+  ],
+  "advertiserId": "A String", # Output only. The unique ID of the advertiser the creative belongs to.
+  "appendedTag": "A String", # Optional. Third-party HTML tracking tag to be appended to the creative tag.
+  "assets": [ # Required. Assets associated to this creative.
+    { # Asset association for the creative.
+      "asset": { # A single asset. # Optional. The associated asset.
+        "content": "A String", # The asset content. For uploaded assets, the content is the serving path.
+        "mediaId": "A String", # Media ID of the uploaded asset. This is a unique identifier for the asset. This ID can be passed to other API calls, e.g. CreateCreative to associate the asset with a creative. The Media ID space updated on **April 5, 2023**. Update media IDs cached before **April 5, 2023** by retrieving the new media ID from associated creative resources or re-uploading the asset.
+      },
+      "role": "A String", # Optional. The role of this asset for the creative.
+    },
+  ],
+  "cmPlacementId": "A String", # Output only. The unique ID of the Campaign Manager 360 placement associated with the creative. This field is only applicable for creatives that are synced from Campaign Manager.
+  "cmTrackingAd": { # A Campaign Manager 360 tracking ad. # Optional. The Campaign Manager 360 tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager 360 and third-party ad serving: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` Output only for other cases.
+    "cmAdId": "A String", # Optional. The ad ID of the campaign manager 360 tracking Ad.
+    "cmCreativeId": "A String", # Optional. The creative ID of the campaign manager 360 tracking Ad.
+    "cmPlacementId": "A String", # Optional. The placement ID of the campaign manager 360 tracking Ad.
+  },
+  "companionCreativeIds": [ # Optional. The IDs of companion creatives for a video creative. You can assign existing display creatives (with image or HTML5 assets) to serve surrounding the publisher's video player. Companions display around the video player while the video is playing and remain after the video has completed. Creatives contain additional dimensions can not be companion creatives. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO`
+    "A String",
+  ],
+  "counterEvents": [ # Optional. Counter events for a rich media creative. Counters track the number of times that a user interacts with any part of a rich media creative in a specified way (mouse-overs, mouse-outs, clicks, taps, data loading, keyboard entries, etc.). Any event that can be captured in the creative can be recorded as a counter. Leave it empty or unset for creatives containing image assets only.
+    { # Counter event of the creative.
+      "name": "A String", # Required. The name of the counter event.
+      "reportingName": "A String", # Required. The name used to identify this counter event in reports.
+    },
+  ],
+  "createTime": "A String", # Output only. The timestamp when the creative was created. Assigned by the system.
+  "creativeAttributes": [ # Output only. A list of attributes of the creative that is generated by the system.
+    "A String",
+  ],
+  "creativeId": "A String", # Output only. The unique ID of the creative. Assigned by the system.
+  "creativeType": "A String", # Required. Immutable. The type of the creative.
+  "dimensions": { # Dimensions. # Required. Primary dimensions of the creative. Applicable to all creative types. The value of width_pixels and height_pixels defaults to `0` when creative_type is one of: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_NATIVE_VIDEO`
+    "heightPixels": 42, # The height in pixels.
+    "widthPixels": 42, # The width in pixels.
+  },
+  "displayName": "A String", # Required. The display name of the creative. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "dynamic": True or False, # Output only. Indicates whether the creative is dynamic.
+  "entityStatus": "A String", # Required. Controls whether or not the creative can serve. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED` * `ENTITY_STATUS_PAUSED`
+  "exitEvents": [ # Required. Exit events for this creative. An exit (also known as a click tag) is any area in your creative that someone can click or tap to open an advertiser's landing page. Every creative must include at least one exit. You can add an exit to your creative in any of the following ways: * Use Google Web Designer's tap area. * Define a JavaScript variable called "clickTag". * Use the Enabler (Enabler.exit()) to track exits in rich media formats.
+    { # Exit event of the creative.
+      "name": "A String", # Optional. The name of the click tag of the exit event. The name must be unique within one creative. Leave it empty or unset for creatives containing image assets only.
+      "reportingName": "A String", # Optional. The name used to identify this event in reports. Leave it empty or unset for creatives containing image assets only.
+      "type": "A String", # Required. The type of the exit event.
+      "url": "A String", # Required. The click through URL of the exit event. This is required when type is: * `EXIT_EVENT_TYPE_DEFAULT` * `EXIT_EVENT_TYPE_BACKUP`
+    },
+  ],
+  "expandOnHover": True or False, # Optional. Indicates the creative will automatically expand on hover. Optional and only valid for third-party expandable creatives. Third-party expandable creatives are creatives with following hosting source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_EXPANDABLE`
+  "expandingDirection": "A String", # Optional. Specifies the expanding direction of the creative. Required and only valid for third-party expandable creatives. Third-party expandable creatives are creatives with following hosting source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_EXPANDABLE`
+  "hostingSource": "A String", # Required. Indicates where the creative is hosted.
+  "html5Video": True or False, # Output only. Indicates the third-party VAST tag creative requires HTML5 Video support. Output only and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_VIDEO`
+  "iasCampaignMonitoring": True or False, # Optional. Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. To enable this for the creative, make sure the Advertiser.creative_config.ias_client_id has been set to your IAS client ID.
+  "integrationCode": "A String", # Optional. ID information used to link this creative to an external system. Must be UTF-8 encoded with a length of no more than 10,000 characters.
+  "jsTrackerUrl": "A String", # Optional. JavaScript measurement URL from supported third-party verification providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not supported. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`
+  "lineItemIds": [ # Output only. The IDs of the line items this creative is associated with. To associate a creative to a line item, use LineItem.creative_ids instead.
+    "A String",
+  ],
+  "mediaDuration": "A String", # Output only. Media duration of the creative. Applicable when creative_type is one of: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_PUBLISHER_HOSTED`
+  "mp3Audio": True or False, # Output only. Indicates the third-party audio creative supports MP3. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO`
+  "name": "A String", # Output only. The resource name of the creative.
+  "notes": "A String", # Optional. User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters.
+  "obaIcon": { # OBA Icon for a Creative # Optional. Specifies the OBA icon for a video creative. This field is only supported in the following creative_type: * `CREATIVE_TYPE_VIDEO`
+    "clickTrackingUrl": "A String", # Required. The click tracking URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com`
+    "dimensions": { # Dimensions. # Optional. The dimensions of the OBA icon.
+      "heightPixels": 42, # The height in pixels.
+      "widthPixels": 42, # The width in pixels.
+    },
+    "landingPageUrl": "A String", # Required. The landing page URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com`
+    "position": "A String", # Optional. The position of the OBA icon on the creative.
+    "program": "A String", # Optional. The program of the OBA icon. For example: “AdChoices”.
+    "resourceMimeType": "A String", # Optional. The MIME type of the OBA icon resource.
+    "resourceUrl": "A String", # Optional. The URL of the OBA icon resource.
+    "viewTrackingUrl": "A String", # Required. The view tracking URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com`
+  },
+  "oggAudio": True or False, # Output only. Indicates the third-party audio creative supports OGG. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO`
+  "progressOffset": { # The length an audio or a video has been played. # Optional. Amount of time to play the video before counting a view. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`
+    "percentage": "A String", # Optional. The offset in percentage of the audio or video duration.
+    "seconds": "A String", # Optional. The offset in seconds from the start of the audio or video.
+  },
+  "requireHtml5": True or False, # Optional. Indicates that the creative relies on HTML5 to render properly. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE`
+  "requireMraid": True or False, # Optional. Indicates that the creative requires MRAID (Mobile Rich Media Ad Interface Definitions system). Set this if the creative relies on mobile gestures for interactivity, such as swiping or tapping. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE`
+  "requirePingForAttribution": True or False, # Optional. Indicates that the creative will wait for a return ping for attribution. Only valid when using a Campaign Manager 360 tracking ad with a third-party ad server parameter and the ${DC_DBM_TOKEN} macro. Optional and only valid for third-party tag creatives or third-party VAST tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO`
+  "reviewStatus": { # Review statuses for the creative. # Output only. The current status of the creative review process.
+    "approvalStatus": "A String", # Represents the basic approval needed for a creative to begin serving. Summary of creative_and_landing_page_review_status and content_and_policy_review_status.
+    "contentAndPolicyReviewStatus": "A String", # Content and policy review status for the creative.
+    "creativeAndLandingPageReviewStatus": "A String", # Creative and landing page review status for the creative.
+    "exchangeReviewStatuses": [ # Exchange review statuses for the creative.
+      { # Exchange review status for the creative.
+        "exchange": "A String", # The exchange reviewing the creative.
+        "status": "A String", # Status of the exchange review.
+      },
+    ],
+  },
+  "skipOffset": { # The length an audio or a video has been played. # Optional. Amount of time to play the video before the skip button appears. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`
+    "percentage": "A String", # Optional. The offset in percentage of the audio or video duration.
+    "seconds": "A String", # Optional. The offset in seconds from the start of the audio or video.
+  },
+  "skippable": True or False, # Optional. Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`
+  "thirdPartyTag": "A String", # Optional. The original third-party tag used for the creative. Required and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE`
+  "thirdPartyUrls": [ # Optional. Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO`
+    { # Tracking URLs from third parties to track interactions with an audio or a video creative.
+      "type": "A String", # Optional. The type of interaction needs to be tracked by the tracking URL
+      "url": "A String", # Optional. Tracking URL used to track the interaction. Provide a URL with optional path or query string, beginning with `https:`. For example, `https://www.example.com/path`
+    },
+  ],
+  "timerEvents": [ # Optional. Timer custom events for a rich media creative. Timers track the time during which a user views and interacts with a specified part of a rich media creative. A creative can have multiple timer events, each timed independently. Leave it empty or unset for creatives containing image assets only.
+    { # Timer event of the creative.
+      "name": "A String", # Required. The name of the timer event.
+      "reportingName": "A String", # Required. The name used to identify this timer event in reports.
+    },
+  ],
+  "trackerUrls": [ # Optional. Tracking URLs for analytics providers or third-party ad technology vendors. The URLs must start with `https:` (except on inventory that doesn't require SSL compliance). If using macros in your URL, use only macros supported by Display & Video 360. Standard URLs only, no IMG or SCRIPT tags. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`
+    "A String",
+  ],
+  "transcodes": [ # Output only. Audio/Video transcodes. Display & Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher's system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer’s connection and screen size. This field is only supported in the following creative_type: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_AUDIO`
+    { # Represents information about the transcoded audio or video file.
+      "audioBitRateKbps": "A String", # Optional. The bit rate for the audio stream of the transcoded video, or the bit rate for the transcoded audio, in kilobits per second.
+      "audioSampleRateHz": "A String", # Optional. The sample rate for the audio stream of the transcoded video, or the sample rate for the transcoded audio, in hertz.
+      "bitRateKbps": "A String", # Optional. The transcoding bit rate of the transcoded video, in kilobits per second.
+      "dimensions": { # Dimensions. # Optional. The dimensions of the transcoded video.
+        "heightPixels": 42, # The height in pixels.
+        "widthPixels": 42, # The width in pixels.
+      },
+      "fileSizeBytes": "A String", # Optional. The size of the transcoded file, in bytes.
+      "frameRate": 3.14, # Optional. The frame rate of the transcoded video, in frames per second.
+      "mimeType": "A String", # Optional. The MIME type of the transcoded file.
+      "name": "A String", # Optional. The name of the transcoded file.
+      "transcoded": True or False, # Optional. Indicates if the transcoding was successful.
+    },
+  ],
+  "universalAdId": { # A creative identifier provided by a registry that is unique across all platforms. This is part of the VAST 4.0 standard. # Optional. An optional creative identifier provided by a registry that is unique across all platforms. Universal Ad ID is part of the VAST 4.0 standard. It can be modified after the creative is created. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`
+    "id": "A String", # Optional. The unique creative identifier.
+    "registry": "A String", # Optional. The registry provides unique creative identifiers.
+  },
+  "updateTime": "A String", # Output only. The timestamp when the creative was last updated, either by the user or system (e.g. creative review). Assigned by the system.
+  "vastTagUrl": "A String", # Optional. The URL of the VAST tag for a third-party VAST tag creative. Required and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO`
+  "vpaid": True or False, # Output only. Indicates the third-party VAST tag creative requires VPAID (Digital Video Player-Ad Interface). Output only and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_VIDEO`
+}
+
+  updateMask: string, Required. The mask to control which fields to update.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single Creative.
+  "additionalDimensions": [ # Optional. Additional dimensions. Applicable when creative_type is one of: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_LIGHTBOX` * `CREATIVE_TYPE_PUBLISHER_HOSTED` If this field is specified, width_pixels and height_pixels are both required and must be greater than or equal to 0.
+    { # Dimensions.
+      "heightPixels": 42, # The height in pixels.
+      "widthPixels": 42, # The width in pixels.
+    },
+  ],
+  "advertiserId": "A String", # Output only. The unique ID of the advertiser the creative belongs to.
+  "appendedTag": "A String", # Optional. Third-party HTML tracking tag to be appended to the creative tag.
+  "assets": [ # Required. Assets associated to this creative.
+    { # Asset association for the creative.
+      "asset": { # A single asset. # Optional. The associated asset.
+        "content": "A String", # The asset content. For uploaded assets, the content is the serving path.
+        "mediaId": "A String", # Media ID of the uploaded asset. This is a unique identifier for the asset. This ID can be passed to other API calls, e.g. CreateCreative to associate the asset with a creative. The Media ID space updated on **April 5, 2023**. Update media IDs cached before **April 5, 2023** by retrieving the new media ID from associated creative resources or re-uploading the asset.
+      },
+      "role": "A String", # Optional. The role of this asset for the creative.
+    },
+  ],
+  "cmPlacementId": "A String", # Output only. The unique ID of the Campaign Manager 360 placement associated with the creative. This field is only applicable for creatives that are synced from Campaign Manager.
+  "cmTrackingAd": { # A Campaign Manager 360 tracking ad. # Optional. The Campaign Manager 360 tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager 360 and third-party ad serving: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` Output only for other cases.
+    "cmAdId": "A String", # Optional. The ad ID of the campaign manager 360 tracking Ad.
+    "cmCreativeId": "A String", # Optional. The creative ID of the campaign manager 360 tracking Ad.
+    "cmPlacementId": "A String", # Optional. The placement ID of the campaign manager 360 tracking Ad.
+  },
+  "companionCreativeIds": [ # Optional. The IDs of companion creatives for a video creative. You can assign existing display creatives (with image or HTML5 assets) to serve surrounding the publisher's video player. Companions display around the video player while the video is playing and remain after the video has completed. Creatives contain additional dimensions can not be companion creatives. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO`
+    "A String",
+  ],
+  "counterEvents": [ # Optional. Counter events for a rich media creative. Counters track the number of times that a user interacts with any part of a rich media creative in a specified way (mouse-overs, mouse-outs, clicks, taps, data loading, keyboard entries, etc.). Any event that can be captured in the creative can be recorded as a counter. Leave it empty or unset for creatives containing image assets only.
+    { # Counter event of the creative.
+      "name": "A String", # Required. The name of the counter event.
+      "reportingName": "A String", # Required. The name used to identify this counter event in reports.
+    },
+  ],
+  "createTime": "A String", # Output only. The timestamp when the creative was created. Assigned by the system.
+  "creativeAttributes": [ # Output only. A list of attributes of the creative that is generated by the system.
+    "A String",
+  ],
+  "creativeId": "A String", # Output only. The unique ID of the creative. Assigned by the system.
+  "creativeType": "A String", # Required. Immutable. The type of the creative.
+  "dimensions": { # Dimensions. # Required. Primary dimensions of the creative. Applicable to all creative types. The value of width_pixels and height_pixels defaults to `0` when creative_type is one of: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_NATIVE_VIDEO`
+    "heightPixels": 42, # The height in pixels.
+    "widthPixels": 42, # The width in pixels.
+  },
+  "displayName": "A String", # Required. The display name of the creative. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "dynamic": True or False, # Output only. Indicates whether the creative is dynamic.
+  "entityStatus": "A String", # Required. Controls whether or not the creative can serve. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED` * `ENTITY_STATUS_PAUSED`
+  "exitEvents": [ # Required. Exit events for this creative. An exit (also known as a click tag) is any area in your creative that someone can click or tap to open an advertiser's landing page. Every creative must include at least one exit. You can add an exit to your creative in any of the following ways: * Use Google Web Designer's tap area. * Define a JavaScript variable called "clickTag". * Use the Enabler (Enabler.exit()) to track exits in rich media formats.
+    { # Exit event of the creative.
+      "name": "A String", # Optional. The name of the click tag of the exit event. The name must be unique within one creative. Leave it empty or unset for creatives containing image assets only.
+      "reportingName": "A String", # Optional. The name used to identify this event in reports. Leave it empty or unset for creatives containing image assets only.
+      "type": "A String", # Required. The type of the exit event.
+      "url": "A String", # Required. The click through URL of the exit event. This is required when type is: * `EXIT_EVENT_TYPE_DEFAULT` * `EXIT_EVENT_TYPE_BACKUP`
+    },
+  ],
+  "expandOnHover": True or False, # Optional. Indicates the creative will automatically expand on hover. Optional and only valid for third-party expandable creatives. Third-party expandable creatives are creatives with following hosting source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_EXPANDABLE`
+  "expandingDirection": "A String", # Optional. Specifies the expanding direction of the creative. Required and only valid for third-party expandable creatives. Third-party expandable creatives are creatives with following hosting source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_EXPANDABLE`
+  "hostingSource": "A String", # Required. Indicates where the creative is hosted.
+  "html5Video": True or False, # Output only. Indicates the third-party VAST tag creative requires HTML5 Video support. Output only and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_VIDEO`
+  "iasCampaignMonitoring": True or False, # Optional. Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. To enable this for the creative, make sure the Advertiser.creative_config.ias_client_id has been set to your IAS client ID.
+  "integrationCode": "A String", # Optional. ID information used to link this creative to an external system. Must be UTF-8 encoded with a length of no more than 10,000 characters.
+  "jsTrackerUrl": "A String", # Optional. JavaScript measurement URL from supported third-party verification providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not supported. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`
+  "lineItemIds": [ # Output only. The IDs of the line items this creative is associated with. To associate a creative to a line item, use LineItem.creative_ids instead.
+    "A String",
+  ],
+  "mediaDuration": "A String", # Output only. Media duration of the creative. Applicable when creative_type is one of: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_PUBLISHER_HOSTED`
+  "mp3Audio": True or False, # Output only. Indicates the third-party audio creative supports MP3. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO`
+  "name": "A String", # Output only. The resource name of the creative.
+  "notes": "A String", # Optional. User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters.
+  "obaIcon": { # OBA Icon for a Creative # Optional. Specifies the OBA icon for a video creative. This field is only supported in the following creative_type: * `CREATIVE_TYPE_VIDEO`
+    "clickTrackingUrl": "A String", # Required. The click tracking URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com`
+    "dimensions": { # Dimensions. # Optional. The dimensions of the OBA icon.
+      "heightPixels": 42, # The height in pixels.
+      "widthPixels": 42, # The width in pixels.
+    },
+    "landingPageUrl": "A String", # Required. The landing page URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com`
+    "position": "A String", # Optional. The position of the OBA icon on the creative.
+    "program": "A String", # Optional. The program of the OBA icon. For example: “AdChoices”.
+    "resourceMimeType": "A String", # Optional. The MIME type of the OBA icon resource.
+    "resourceUrl": "A String", # Optional. The URL of the OBA icon resource.
+    "viewTrackingUrl": "A String", # Required. The view tracking URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com`
+  },
+  "oggAudio": True or False, # Output only. Indicates the third-party audio creative supports OGG. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO`
+  "progressOffset": { # The length an audio or a video has been played. # Optional. Amount of time to play the video before counting a view. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`
+    "percentage": "A String", # Optional. The offset in percentage of the audio or video duration.
+    "seconds": "A String", # Optional. The offset in seconds from the start of the audio or video.
+  },
+  "requireHtml5": True or False, # Optional. Indicates that the creative relies on HTML5 to render properly. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE`
+  "requireMraid": True or False, # Optional. Indicates that the creative requires MRAID (Mobile Rich Media Ad Interface Definitions system). Set this if the creative relies on mobile gestures for interactivity, such as swiping or tapping. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE`
+  "requirePingForAttribution": True or False, # Optional. Indicates that the creative will wait for a return ping for attribution. Only valid when using a Campaign Manager 360 tracking ad with a third-party ad server parameter and the ${DC_DBM_TOKEN} macro. Optional and only valid for third-party tag creatives or third-party VAST tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO`
+  "reviewStatus": { # Review statuses for the creative. # Output only. The current status of the creative review process.
+    "approvalStatus": "A String", # Represents the basic approval needed for a creative to begin serving. Summary of creative_and_landing_page_review_status and content_and_policy_review_status.
+    "contentAndPolicyReviewStatus": "A String", # Content and policy review status for the creative.
+    "creativeAndLandingPageReviewStatus": "A String", # Creative and landing page review status for the creative.
+    "exchangeReviewStatuses": [ # Exchange review statuses for the creative.
+      { # Exchange review status for the creative.
+        "exchange": "A String", # The exchange reviewing the creative.
+        "status": "A String", # Status of the exchange review.
+      },
+    ],
+  },
+  "skipOffset": { # The length an audio or a video has been played. # Optional. Amount of time to play the video before the skip button appears. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`
+    "percentage": "A String", # Optional. The offset in percentage of the audio or video duration.
+    "seconds": "A String", # Optional. The offset in seconds from the start of the audio or video.
+  },
+  "skippable": True or False, # Optional. Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`
+  "thirdPartyTag": "A String", # Optional. The original third-party tag used for the creative. Required and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE`
+  "thirdPartyUrls": [ # Optional. Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO`
+    { # Tracking URLs from third parties to track interactions with an audio or a video creative.
+      "type": "A String", # Optional. The type of interaction needs to be tracked by the tracking URL
+      "url": "A String", # Optional. Tracking URL used to track the interaction. Provide a URL with optional path or query string, beginning with `https:`. For example, `https://www.example.com/path`
+    },
+  ],
+  "timerEvents": [ # Optional. Timer custom events for a rich media creative. Timers track the time during which a user views and interacts with a specified part of a rich media creative. A creative can have multiple timer events, each timed independently. Leave it empty or unset for creatives containing image assets only.
+    { # Timer event of the creative.
+      "name": "A String", # Required. The name of the timer event.
+      "reportingName": "A String", # Required. The name used to identify this timer event in reports.
+    },
+  ],
+  "trackerUrls": [ # Optional. Tracking URLs for analytics providers or third-party ad technology vendors. The URLs must start with `https:` (except on inventory that doesn't require SSL compliance). If using macros in your URL, use only macros supported by Display & Video 360. Standard URLs only, no IMG or SCRIPT tags. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`
+    "A String",
+  ],
+  "transcodes": [ # Output only. Audio/Video transcodes. Display & Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher's system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer’s connection and screen size. This field is only supported in the following creative_type: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_AUDIO`
+    { # Represents information about the transcoded audio or video file.
+      "audioBitRateKbps": "A String", # Optional. The bit rate for the audio stream of the transcoded video, or the bit rate for the transcoded audio, in kilobits per second.
+      "audioSampleRateHz": "A String", # Optional. The sample rate for the audio stream of the transcoded video, or the sample rate for the transcoded audio, in hertz.
+      "bitRateKbps": "A String", # Optional. The transcoding bit rate of the transcoded video, in kilobits per second.
+      "dimensions": { # Dimensions. # Optional. The dimensions of the transcoded video.
+        "heightPixels": 42, # The height in pixels.
+        "widthPixels": 42, # The width in pixels.
+      },
+      "fileSizeBytes": "A String", # Optional. The size of the transcoded file, in bytes.
+      "frameRate": 3.14, # Optional. The frame rate of the transcoded video, in frames per second.
+      "mimeType": "A String", # Optional. The MIME type of the transcoded file.
+      "name": "A String", # Optional. The name of the transcoded file.
+      "transcoded": True or False, # Optional. Indicates if the transcoding was successful.
+    },
+  ],
+  "universalAdId": { # A creative identifier provided by a registry that is unique across all platforms. This is part of the VAST 4.0 standard. # Optional. An optional creative identifier provided by a registry that is unique across all platforms. Universal Ad ID is part of the VAST 4.0 standard. It can be modified after the creative is created. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`
+    "id": "A String", # Optional. The unique creative identifier.
+    "registry": "A String", # Optional. The registry provides unique creative identifiers.
+  },
+  "updateTime": "A String", # Output only. The timestamp when the creative was last updated, either by the user or system (e.g. creative review). Assigned by the system.
+  "vastTagUrl": "A String", # Optional. The URL of the VAST tag for a third-party VAST tag creative. Required and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO`
+  "vpaid": True or False, # Output only. Indicates the third-party VAST tag creative requires VPAID (Digital Video Player-Ad Interface). Output only and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_VIDEO`
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/displayvideo_v4.advertisers.html b/docs/dyn/displayvideo_v4.advertisers.html new file mode 100644 index 00000000000..06e4e164e86 --- /dev/null +++ b/docs/dyn/displayvideo_v4.advertisers.html @@ -0,0 +1,1698 @@ + + + +

Display & Video 360 API . advertisers

+

Instance Methods

+

+ adGroupAds() +

+

Returns the adGroupAds Resource.

+ +

+ adGroups() +

+

Returns the adGroups Resource.

+ +

+ assets() +

+

Returns the assets Resource.

+ +

+ campaigns() +

+

Returns the campaigns Resource.

+ +

+ channels() +

+

Returns the channels Resource.

+ +

+ creatives() +

+

Returns the creatives Resource.

+ +

+ insertionOrders() +

+

Returns the insertionOrders Resource.

+ +

+ invoices() +

+

Returns the invoices Resource.

+ +

+ lineItems() +

+

Returns the lineItems Resource.

+ +

+ locationLists() +

+

Returns the locationLists Resource.

+ +

+ negativeKeywordLists() +

+

Returns the negativeKeywordLists Resource.

+ +

+ targetingTypes() +

+

Returns the targetingTypes Resource.

+ +

+ audit(advertiserId, readMask=None, x__xgafv=None)

+

Audits an advertiser. Returns the counts of used entities per resource type under the advertiser provided. Used entities count towards their respective resource limit. See https://support.google.com/displayvideo/answer/6071450.

+

+ close()

+

Close httplib2 connections.

+

+ create(body=None, x__xgafv=None)

+

Creates a new advertiser. Returns the newly created advertiser if successful. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.

+

+ delete(advertiserId, x__xgafv=None)

+

Deletes an advertiser. Deleting an advertiser will delete all of its child resources, for example, campaigns, insertion orders and line items. A deleted advertiser cannot be recovered.

+

+ editAssignedTargetingOptions(advertiserId, body=None, x__xgafv=None)

+

Edits targeting options under a single advertiser. The operation will delete the assigned targeting options provided in BulkEditAdvertiserAssignedTargetingOptionsRequest.delete_requests and then create the assigned targeting options provided in BulkEditAdvertiserAssignedTargetingOptionsRequest.create_requests .

+

+ get(advertiserId, x__xgafv=None)

+

Gets an advertiser.

+

+ list(filter=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None)

+

Lists advertisers that are accessible to the current user. The order is defined by the order_by parameter. A single partner_id is required. Cross-partner listing is not supported.

+

+ listAssignedTargetingOptions(advertiserId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists assigned targeting options of an advertiser across targeting types.

+

+ listAssignedTargetingOptions_next()

+

Retrieves the next page of results.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(advertiserId, body=None, updateMask=None, x__xgafv=None)

+

Updates an existing advertiser. Returns the updated advertiser if successful.

+

Method Details

+
+ audit(advertiserId, readMask=None, x__xgafv=None) +
Audits an advertiser. Returns the counts of used entities per resource type under the advertiser provided. Used entities count towards their respective resource limit. See https://support.google.com/displayvideo/answer/6071450.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser to audit. (required)
+  readMask: string, Optional. The specific fields to return. If no mask is specified, all fields in the response proto will be filled. Valid values are: * usedLineItemsCount * usedInsertionOrdersCount * usedCampaignsCount * channelsCount * negativelyTargetedChannelsCount * negativeKeywordListsCount * adGroupCriteriaCount * campaignCriteriaCount
+  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 AdvertiserService.AuditAdvertiser.
+  "adGroupCriteriaCount": "A String", # The number of individual targeting options from the following targeting types that are assigned to a line item under this advertiser. These individual targeting options count towards the limit of 4500000 ad group targeting options per advertiser. Qualifying Targeting types: * Channels, URLs, apps, and collections * Demographic * Google Audiences, including Affinity, Custom Affinity, and In-market audiences * Inventory source * Keyword * Mobile app category * User lists * Video targeting * Viewability
+  "campaignCriteriaCount": "A String", # The number of individual targeting options from the following targeting types that are assigned to a line item under this advertiser. These individual targeting options count towards the limit of 900000 campaign targeting options per advertiser. Qualifying Targeting types: * Position * Browser * Connection speed * Day and time * Device and operating system * Digital content label * Sensitive categories * Environment * Geography, including business chains and proximity * ISP * Language * Third-party verification
+  "channelsCount": "A String", # The number of channels created under this advertiser. These channels count towards the limit of 1000 channels per advertiser.
+  "negativeKeywordListsCount": "A String", # The number of negative keyword lists created under this advertiser. These negative keyword lists count towards the limit of 20 negative keyword lists per advertiser.
+  "negativelyTargetedChannelsCount": "A String", # The number of negatively targeted channels created under this advertiser. These negatively targeted channels count towards the limit of 5 negatively targeted channels per advertiser.
+  "usedCampaignsCount": "A String", # The number of ACTIVE and PAUSED campaigns under this advertiser. These campaigns count towards the limit of 9999 campaigns per advertiser.
+  "usedInsertionOrdersCount": "A String", # The number of ACTIVE, PAUSED and DRAFT insertion orders under this advertiser. These insertion orders count towards the limit of 9999 insertion orders per advertiser.
+  "usedLineItemsCount": "A String", # The number of ACTIVE, PAUSED, and DRAFT line items under this advertiser. These line items count towards the limit of 9999 line items per advertiser.
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ create(body=None, x__xgafv=None) +
Creates a new advertiser. Returns the newly created advertiser if successful. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.
+
+Args:
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A single advertiser in Display & Video 360 (DV360).
+  "adServerConfig": { # Ad server related settings of an advertiser. # Required. Immutable. Ad server related settings of the advertiser.
+    "cmHybridConfig": { # Settings for advertisers that use both Campaign Manager 360 (CM360) and third-party ad servers. # The configuration for advertisers that use both Campaign Manager 360 (CM360) and third-party ad servers.
+      "cmAccountId": "A String", # Required. Immutable. Account ID of the CM360 Floodlight configuration linked with the DV360 advertiser.
+      "cmAdvertiserIds": [ # Output only. The set of CM360 Advertiser IDs sharing the CM360 Floodlight configuration.
+        "A String",
+      ],
+      "cmFloodlightConfigId": "A String", # Required. Immutable. ID of the CM360 Floodlight configuration linked with the DV360 advertiser.
+      "cmFloodlightLinkingAuthorized": True or False, # Required. Immutable. By setting this field to `true`, you, on behalf of your company, authorize the sharing of information from the given Floodlight configuration to this Display & Video 360 advertiser.
+      "cmSyncableSiteIds": [ # A list of CM360 sites whose placements will be synced to DV360 as creatives. If absent or empty in CreateAdvertiser method, the system will automatically create a CM360 site. Removing sites from this list may cause DV360 creatives synced from CM360 to be deleted. At least one site must be specified.
+        "A String",
+      ],
+      "dv360ToCmCostReportingEnabled": True or False, # Whether or not to report DV360 cost to CM360.
+      "dv360ToCmDataSharingEnabled": True or False, # Whether or not to include DV360 data in CM360 data transfer reports.
+    },
+    "thirdPartyOnlyConfig": { # Settings for advertisers that use third-party ad servers only. # The configuration for advertisers that use third-party ad servers only.
+      "pixelOrderIdReportingEnabled": True or False, # Whether or not order ID reporting for pixels is enabled. This value cannot be changed once set to `true`.
+    },
+  },
+  "advertiserId": "A String", # Output only. The unique ID of the advertiser. Assigned by the system.
+  "billingConfig": { # Billing related settings of an advertiser. # Required. Billing related settings of the advertiser.
+    "billingProfileId": "A String", # Required. The ID of a billing profile assigned to the advertiser.
+  },
+  "creativeConfig": { # Creatives related settings of an advertiser. # Required. Creative related settings of the advertiser.
+    "dynamicCreativeEnabled": True or False, # Whether or not the advertiser is enabled for dynamic creatives.
+    "iasClientId": "A String", # An ID for configuring campaign monitoring provided by Integral Ad Service (IAS). The DV360 system will append an IAS "Campaign Monitor" tag containing this ID to the creative tag.
+    "obaComplianceDisabled": True or False, # Whether or not to disable Google's About this Ad feature that adds badging (to identify the content as an ad) and transparency information (on interaction with About this Ad) to your ads for Online Behavioral Advertising (OBA) and regulatory requirements. About this Ad gives users greater control over the ads they see and helps you explain why they're seeing your ad. [Learn more](//support.google.com/displayvideo/answer/14315795). If you choose to set this field to `true`, note that ads served through Display & Video 360 must comply to the following: * Be Online Behavioral Advertising (OBA) compliant, as per your contract with Google Marketing Platform. * In the European Economic Area (EEA), include transparency information and a mechanism for users to report illegal content in ads. If using an alternative ad badging, transparency, and reporting solution, you must ensure it includes the required transparency information and illegal content flagging mechanism and that you notify Google of any illegal content reports using the appropriate [form](//support.google.com/legal/troubleshooter/1114905?sjid=6787484030557261960-EU#ts=2981967%2C2982031%2C12980091).
+    "videoCreativeDataSharingAuthorized": True or False, # By setting this field to `true`, you, on behalf of your company, authorize Google to use video creatives associated with this Display & Video 360 advertiser to provide reporting and features related to the advertiser's television campaigns. Applicable only when the advertiser has a CM360 hybrid ad server configuration.
+  },
+  "dataAccessConfig": { # Settings that control how advertiser related data may be accessed. # Settings that control how advertiser data may be accessed.
+    "sdfConfig": { # Structured Data Files (SDF) settings of an advertiser. # Structured Data Files (SDF) settings for the advertiser. If not specified, the SDF settings of the parent partner are used.
+      "overridePartnerSdfConfig": True or False, # Whether or not this advertiser overrides the SDF configuration of its parent partner. By default, an advertiser inherits the SDF configuration from the parent partner. To override the partner configuration, set this field to `true` and provide the new configuration in sdfConfig.
+      "sdfConfig": { # Structured Data File (SDF) related settings. # The SDF configuration for the advertiser. * Required when overridePartnerSdfConfig is `true`. * Output only when overridePartnerSdfConfig is `false`.
+        "adminEmail": "A String", # An administrator email address to which the SDF processing status reports will be sent.
+        "version": "A String", # Required. The version of SDF being used.
+      },
+    },
+  },
+  "displayName": "A String", # Required. The display name of the advertiser. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_PAUSED` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days from when it was first scheduled for deletion.
+  "generalConfig": { # General settings of an advertiser. # Required. General settings of the advertiser.
+    "currencyCode": "A String", # Required. Immutable. Advertiser's currency in ISO 4217 format. Accepted codes and the currencies they represent are: Currency Code : Currency Name * `ARS` : Argentine Peso * `AUD` : Australian Dollar * `BRL` : Brazilian Real * `CAD` : Canadian Dollar * `CHF` : Swiss Franc * `CLP` : Chilean Peso * `CNY` : Chinese Yuan * `COP` : Colombian Peso * `CZK` : Czech Koruna * `DKK` : Danish Krone * `EGP` : Egyption Pound * `EUR` : Euro * `GBP` : British Pound * `HKD` : Hong Kong Dollar * `HUF` : Hungarian Forint * `IDR` : Indonesian Rupiah * `ILS` : Israeli Shekel * `INR` : Indian Rupee * `JPY` : Japanese Yen * `KRW` : South Korean Won * `MXN` : Mexican Pesos * `MYR` : Malaysian Ringgit * `NGN` : Nigerian Naira * `NOK` : Norwegian Krone * `NZD` : New Zealand Dollar * `PEN` : Peruvian Nuevo Sol * `PLN` : Polish Zloty * `RON` : New Romanian Leu * `RUB` : Russian Ruble * `SEK` : Swedish Krona * `TRY` : Turkish Lira * `TWD` : New Taiwan Dollar * `USD` : US Dollar * `ZAR` : South African Rand
+    "domainUrl": "A String", # Required. The domain URL of the advertiser's primary website. The system will send this information to publishers that require website URL to associate a campaign with an advertiser. Provide a URL with no path or query string, beginning with `http:` or `https:`. For example, http://www.example.com
+    "timeZone": "A String", # Output only. The standard TZ database name of the advertiser's time zone. For example, `America/New_York`. See more at: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones For CM360 hybrid advertisers, the time zone is the same as that of the associated CM360 account; for third-party only advertisers, the time zone is the same as that of the parent partner.
+  },
+  "integrationDetails": { # Integration details of an entry. # Integration details of the advertiser. Only integrationCode is currently applicable to advertiser. Other fields of IntegrationDetails are not supported and will be ignored if provided.
+    "details": "A String", # Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters.
+    "integrationCode": "A String", # An external identifier to be associated with the entry. The integration code will show up together with the entry in many places in the system, for example, reporting. Must be UTF-8 encoded with a length of no more than 500 characters.
+  },
+  "name": "A String", # Output only. The resource name of the advertiser.
+  "partnerId": "A String", # Required. Immutable. The unique ID of the partner that the advertiser belongs to.
+  "prismaEnabled": True or False, # Whether integration with Mediaocean (Prisma) is enabled. By enabling this, you agree to the following: On behalf of my company, I authorize Mediaocean (Prisma) to send budget segment plans to Google, and I authorize Google to send corresponding reporting and invoices from DV360 to Mediaocean for the purposes of budget planning, billing, and reconciliation for this advertiser.
+  "servingConfig": { # Targeting settings related to ad serving of an advertiser. # Targeting settings related to ad serving of the advertiser.
+    "exemptTvFromViewabilityTargeting": True or False, # Whether or not connected TV devices are exempt from viewability targeting for all video line items under the advertiser.
+  },
+  "updateTime": "A String", # Output only. The timestamp when the advertiser was last updated. Assigned by the system.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single advertiser in Display & Video 360 (DV360).
+  "adServerConfig": { # Ad server related settings of an advertiser. # Required. Immutable. Ad server related settings of the advertiser.
+    "cmHybridConfig": { # Settings for advertisers that use both Campaign Manager 360 (CM360) and third-party ad servers. # The configuration for advertisers that use both Campaign Manager 360 (CM360) and third-party ad servers.
+      "cmAccountId": "A String", # Required. Immutable. Account ID of the CM360 Floodlight configuration linked with the DV360 advertiser.
+      "cmAdvertiserIds": [ # Output only. The set of CM360 Advertiser IDs sharing the CM360 Floodlight configuration.
+        "A String",
+      ],
+      "cmFloodlightConfigId": "A String", # Required. Immutable. ID of the CM360 Floodlight configuration linked with the DV360 advertiser.
+      "cmFloodlightLinkingAuthorized": True or False, # Required. Immutable. By setting this field to `true`, you, on behalf of your company, authorize the sharing of information from the given Floodlight configuration to this Display & Video 360 advertiser.
+      "cmSyncableSiteIds": [ # A list of CM360 sites whose placements will be synced to DV360 as creatives. If absent or empty in CreateAdvertiser method, the system will automatically create a CM360 site. Removing sites from this list may cause DV360 creatives synced from CM360 to be deleted. At least one site must be specified.
+        "A String",
+      ],
+      "dv360ToCmCostReportingEnabled": True or False, # Whether or not to report DV360 cost to CM360.
+      "dv360ToCmDataSharingEnabled": True or False, # Whether or not to include DV360 data in CM360 data transfer reports.
+    },
+    "thirdPartyOnlyConfig": { # Settings for advertisers that use third-party ad servers only. # The configuration for advertisers that use third-party ad servers only.
+      "pixelOrderIdReportingEnabled": True or False, # Whether or not order ID reporting for pixels is enabled. This value cannot be changed once set to `true`.
+    },
+  },
+  "advertiserId": "A String", # Output only. The unique ID of the advertiser. Assigned by the system.
+  "billingConfig": { # Billing related settings of an advertiser. # Required. Billing related settings of the advertiser.
+    "billingProfileId": "A String", # Required. The ID of a billing profile assigned to the advertiser.
+  },
+  "creativeConfig": { # Creatives related settings of an advertiser. # Required. Creative related settings of the advertiser.
+    "dynamicCreativeEnabled": True or False, # Whether or not the advertiser is enabled for dynamic creatives.
+    "iasClientId": "A String", # An ID for configuring campaign monitoring provided by Integral Ad Service (IAS). The DV360 system will append an IAS "Campaign Monitor" tag containing this ID to the creative tag.
+    "obaComplianceDisabled": True or False, # Whether or not to disable Google's About this Ad feature that adds badging (to identify the content as an ad) and transparency information (on interaction with About this Ad) to your ads for Online Behavioral Advertising (OBA) and regulatory requirements. About this Ad gives users greater control over the ads they see and helps you explain why they're seeing your ad. [Learn more](//support.google.com/displayvideo/answer/14315795). If you choose to set this field to `true`, note that ads served through Display & Video 360 must comply to the following: * Be Online Behavioral Advertising (OBA) compliant, as per your contract with Google Marketing Platform. * In the European Economic Area (EEA), include transparency information and a mechanism for users to report illegal content in ads. If using an alternative ad badging, transparency, and reporting solution, you must ensure it includes the required transparency information and illegal content flagging mechanism and that you notify Google of any illegal content reports using the appropriate [form](//support.google.com/legal/troubleshooter/1114905?sjid=6787484030557261960-EU#ts=2981967%2C2982031%2C12980091).
+    "videoCreativeDataSharingAuthorized": True or False, # By setting this field to `true`, you, on behalf of your company, authorize Google to use video creatives associated with this Display & Video 360 advertiser to provide reporting and features related to the advertiser's television campaigns. Applicable only when the advertiser has a CM360 hybrid ad server configuration.
+  },
+  "dataAccessConfig": { # Settings that control how advertiser related data may be accessed. # Settings that control how advertiser data may be accessed.
+    "sdfConfig": { # Structured Data Files (SDF) settings of an advertiser. # Structured Data Files (SDF) settings for the advertiser. If not specified, the SDF settings of the parent partner are used.
+      "overridePartnerSdfConfig": True or False, # Whether or not this advertiser overrides the SDF configuration of its parent partner. By default, an advertiser inherits the SDF configuration from the parent partner. To override the partner configuration, set this field to `true` and provide the new configuration in sdfConfig.
+      "sdfConfig": { # Structured Data File (SDF) related settings. # The SDF configuration for the advertiser. * Required when overridePartnerSdfConfig is `true`. * Output only when overridePartnerSdfConfig is `false`.
+        "adminEmail": "A String", # An administrator email address to which the SDF processing status reports will be sent.
+        "version": "A String", # Required. The version of SDF being used.
+      },
+    },
+  },
+  "displayName": "A String", # Required. The display name of the advertiser. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_PAUSED` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days from when it was first scheduled for deletion.
+  "generalConfig": { # General settings of an advertiser. # Required. General settings of the advertiser.
+    "currencyCode": "A String", # Required. Immutable. Advertiser's currency in ISO 4217 format. Accepted codes and the currencies they represent are: Currency Code : Currency Name * `ARS` : Argentine Peso * `AUD` : Australian Dollar * `BRL` : Brazilian Real * `CAD` : Canadian Dollar * `CHF` : Swiss Franc * `CLP` : Chilean Peso * `CNY` : Chinese Yuan * `COP` : Colombian Peso * `CZK` : Czech Koruna * `DKK` : Danish Krone * `EGP` : Egyption Pound * `EUR` : Euro * `GBP` : British Pound * `HKD` : Hong Kong Dollar * `HUF` : Hungarian Forint * `IDR` : Indonesian Rupiah * `ILS` : Israeli Shekel * `INR` : Indian Rupee * `JPY` : Japanese Yen * `KRW` : South Korean Won * `MXN` : Mexican Pesos * `MYR` : Malaysian Ringgit * `NGN` : Nigerian Naira * `NOK` : Norwegian Krone * `NZD` : New Zealand Dollar * `PEN` : Peruvian Nuevo Sol * `PLN` : Polish Zloty * `RON` : New Romanian Leu * `RUB` : Russian Ruble * `SEK` : Swedish Krona * `TRY` : Turkish Lira * `TWD` : New Taiwan Dollar * `USD` : US Dollar * `ZAR` : South African Rand
+    "domainUrl": "A String", # Required. The domain URL of the advertiser's primary website. The system will send this information to publishers that require website URL to associate a campaign with an advertiser. Provide a URL with no path or query string, beginning with `http:` or `https:`. For example, http://www.example.com
+    "timeZone": "A String", # Output only. The standard TZ database name of the advertiser's time zone. For example, `America/New_York`. See more at: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones For CM360 hybrid advertisers, the time zone is the same as that of the associated CM360 account; for third-party only advertisers, the time zone is the same as that of the parent partner.
+  },
+  "integrationDetails": { # Integration details of an entry. # Integration details of the advertiser. Only integrationCode is currently applicable to advertiser. Other fields of IntegrationDetails are not supported and will be ignored if provided.
+    "details": "A String", # Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters.
+    "integrationCode": "A String", # An external identifier to be associated with the entry. The integration code will show up together with the entry in many places in the system, for example, reporting. Must be UTF-8 encoded with a length of no more than 500 characters.
+  },
+  "name": "A String", # Output only. The resource name of the advertiser.
+  "partnerId": "A String", # Required. Immutable. The unique ID of the partner that the advertiser belongs to.
+  "prismaEnabled": True or False, # Whether integration with Mediaocean (Prisma) is enabled. By enabling this, you agree to the following: On behalf of my company, I authorize Mediaocean (Prisma) to send budget segment plans to Google, and I authorize Google to send corresponding reporting and invoices from DV360 to Mediaocean for the purposes of budget planning, billing, and reconciliation for this advertiser.
+  "servingConfig": { # Targeting settings related to ad serving of an advertiser. # Targeting settings related to ad serving of the advertiser.
+    "exemptTvFromViewabilityTargeting": True or False, # Whether or not connected TV devices are exempt from viewability targeting for all video line items under the advertiser.
+  },
+  "updateTime": "A String", # Output only. The timestamp when the advertiser was last updated. Assigned by the system.
+}
+
+ +
+ delete(advertiserId, x__xgafv=None) +
Deletes an advertiser. Deleting an advertiser will delete all of its child resources, for example, campaigns, insertion orders and line items. A deleted advertiser cannot be recovered.
+
+Args:
+  advertiserId: string, The ID of the advertiser we need 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); }
+}
+
+ +
+ editAssignedTargetingOptions(advertiserId, body=None, x__xgafv=None) +
Edits targeting options under a single advertiser. The operation will delete the assigned targeting options provided in BulkEditAdvertiserAssignedTargetingOptionsRequest.delete_requests and then create the assigned targeting options provided in BulkEditAdvertiserAssignedTargetingOptionsRequest.create_requests .
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for BulkEditAdvertiserAssignedTargetingOptions.
+  "createRequests": [ # The assigned targeting options to create in batch, specified as a list of `CreateAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD`
+    { # A request listing which assigned targeting options of a given targeting type should be created and added.
+      "assignedTargetingOptions": [ # Required. The assigned targeting options to create and add.
+        { # A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings.
+          "ageRangeDetails": { # Represents a targetable age range. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AGE_RANGE`. # Age range details. This field will be populated when the targeting_type is `TARGETING_TYPE_AGE_RANGE`.
+            "ageRange": "A String", # Required. The age range of an audience. We only support targeting a continuous age range of an audience. Thus, the age range represented in this field can be 1) targeted solely, or, 2) part of a larger continuous age range. The reach of a continuous age range targeting can be expanded by also targeting an audience of an unknown age.
+          },
+          "appCategoryDetails": { # Details for assigned app category targeting option. This will be populated in the app_category_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. # App category details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
+            "displayName": "A String", # Output only. The display name of the app category.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+            "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
+          },
+          "appDetails": { # Details for assigned app targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP`. # App details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP`.
+            "appId": "A String", # Required. The ID of the app. Android's Play store app uses bundle ID, for example `com.google.android.gm`. Apple's App store app ID uses 9 digit string, for example `422689480`.
+            "appPlatform": "A String", # Indicates the platform of the targeted app. If this field is not specified, the app platform will be assumed to be mobile (i.e., Android or iOS), and we will derive the appropriate mobile platform from the app ID.
+            "displayName": "A String", # Output only. The display name of the app.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+          },
+          "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts.
+          "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`
+          "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource.
+            "excludedFirstPartyAndPartnerAudienceGroup": { # Details of first party and partner audience group. All first party and partner audience targeting settings are logically ‘OR’ of each other. # Optional. The first party and partner audience ids and recencies of the excluded first party and partner audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other.
+              "settings": [ # Required. All first party and partner audience targeting settings in first party and partner audience group. Repeated settings with the same id are not allowed.
+                { # Details of first party and partner audience targeting setting.
+                  "firstPartyAndPartnerAudienceId": "A String", # Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.
+                  "recency": "A String", # Required. The recency of the first party and partner audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
+                },
+              ],
+            },
+            "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other.
+              "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
+                { # Details of Google audience targeting setting.
+                  "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
+                },
+              ],
+            },
+            "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only.
+              "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise.
+                { # Details of combined audience targeting setting.
+                  "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id.
+                },
+              ],
+            },
+            "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only.
+              "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored.
+                { # Details of custom list targeting setting.
+                  "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id.
+                },
+              ],
+            },
+            "includedFirstPartyAndPartnerAudienceGroups": [ # Optional. The first party and partner audience ids and recencies of included first party and partner audience groups. Each first party and partner audience group contains first party and partner audience ids only. The relation between each first party and partner audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored.
+              { # Details of first party and partner audience group. All first party and partner audience targeting settings are logically ‘OR’ of each other.
+                "settings": [ # Required. All first party and partner audience targeting settings in first party and partner audience group. Repeated settings with the same id are not allowed.
+                  { # Details of first party and partner audience targeting setting.
+                    "firstPartyAndPartnerAudienceId": "A String", # Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.
+                    "recency": "A String", # Required. The recency of the first party and partner audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
+                  },
+                ],
+              },
+            ],
+            "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only.
+              "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
+                { # Details of Google audience targeting setting.
+                  "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
+                },
+              ],
+            },
+          },
+          "audioContentTypeDetails": { # Details for audio content type assigned targeting option. This will be populated in the audio_content_type_details field when targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`. Explicitly targeting all options is not supported. Remove all audio content type targeting options to achieve this effect. # Audio content type details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`.
+            "audioContentType": "A String", # Required. The audio content type.
+          },
+          "authorizedSellerStatusDetails": { # Represents an assigned authorized seller status. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. If a resource does not have an `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` assigned targeting option, it is using the "Authorized Direct Sellers and Resellers" option. # Authorized seller status details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. You can only target one authorized seller status option per resource. If a resource doesn't have an authorized seller status option, all authorized sellers indicated as DIRECT or RESELLER in the ads.txt file are targeted by default.
+            "authorizedSellerStatus": "A String", # Output only. The authorized seller status to target.
+            "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.
+          },
+          "browserDetails": { # Details for assigned browser targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BROWSER`. # Browser details. This field will be populated when the targeting_type is `TARGETING_TYPE_BROWSER`.
+            "displayName": "A String", # Output only. The display name of the browser.
+            "negative": True or False, # Indicates if this option is being negatively targeted. All assigned browser targeting options on the same resource must have the same value for this field.
+            "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BROWSER`.
+          },
+          "businessChainDetails": { # Details for assigned Business chain targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`. # Business chain details. This field will be populated when the targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`.
+            "displayName": "A String", # Output only. The display name of a business chain, e.g. "KFC", "Chase Bank".
+            "proximityRadiusAmount": 3.14, # Required. The radius of the area around the business chain that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`. The minimum increment for both cases is 0.1. Inputs will be rounded to the nearest acceptable value if it is too granular, e.g. 15.57 will become 15.6.
+            "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
+            "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BUSINESS_CHAIN`. Accepted business chain targeting option IDs can be retrieved using SearchTargetingOptions.
+          },
+          "carrierAndIspDetails": { # Details for assigned carrier and ISP targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`. # Carrier and ISP details. This field will be populated when the targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`.
+            "displayName": "A String", # Output only. The display name of the carrier or ISP.
+            "negative": True or False, # Indicates if this option is being negatively targeted. All assigned carrier and ISP targeting options on the same resource must have the same value for this field.
+            "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`.
+          },
+          "categoryDetails": { # Assigned category targeting option details. This will be populated in the category_details field when targeting_type is `TARGETING_TYPE_CATEGORY`. # Category details. This field will be populated when the targeting_type is `TARGETING_TYPE_CATEGORY`. Targeting a category will also target its subcategories. If a category is excluded from targeting and a subcategory is included, the exclusion will take precedence.
+            "displayName": "A String", # Output only. The display name of the category.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+            "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CATEGORY`.
+          },
+          "channelDetails": { # Details for assigned channel targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CHANNEL`. # Channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_CHANNEL`.
+            "channelId": "A String", # Required. ID of the channel. Should refer to the channel ID field on a [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id) resource.
+            "negative": True or False, # Indicates if this option is being negatively targeted. For advertiser level assigned targeting option, this field must be true.
+          },
+          "contentDurationDetails": { # Details for content duration assigned targeting option. This will be populated in the content_duration_details field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`. Explicitly targeting all options is not supported. Remove all content duration targeting options to achieve this effect. # Content duration details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
+            "contentDuration": "A String", # Output only. The content duration.
+            "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
+          },
+          "contentGenreDetails": { # Details for content genre assigned targeting option. This will be populated in the content_genre_details field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`. Explicitly targeting all options is not supported. Remove all content genre targeting options to achieve this effect. # Content genre details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
+            "displayName": "A String", # Output only. The display name of the content genre.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+            "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
+          },
+          "contentInstreamPositionDetails": { # Assigned content instream position targeting option details. This will be populated in the content_instream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. # Content instream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.
+            "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`. * `AD_TYPE_AUDIO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_AUDIO_DEFAULT`.
+            "contentInstreamPosition": "A String", # Required. The content instream position for video or audio ads.
+          },
+          "contentOutstreamPositionDetails": { # Assigned content outstream position targeting option details. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. # Content outstream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.
+            "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+            "contentOutstreamPosition": "A String", # Required. The content outstream position.
+          },
+          "contentStreamTypeDetails": { # Details for content stream type assigned targeting option. This will be populated in the content_stream_type_details field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`. Explicitly targeting all options is not supported. Remove all content stream type targeting options to achieve this effect. # Content duration details. This field will be populated when the TargetingType is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
+            "contentStreamType": "A String", # Output only. The content stream type.
+            "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
+          },
+          "dayAndTimeDetails": { # Representation of a segment of time defined on a specific day of the week and with a start and end time. The time represented by `start_hour` must be before the time represented by `end_hour`. # Day and time details. This field will be populated when the targeting_type is `TARGETING_TYPE_DAY_AND_TIME`.
+            "dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting.
+            "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day).
+            "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day).
+            "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting.
+          },
+          "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
+            "displayName": "A String", # Output only. The display name of the device make and model.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+            "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
+          },
+          "deviceTypeDetails": { # Targeting details for device type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`. # Device Type details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_TYPE`.
+            "deviceType": "A String", # Required. The display name of the device type.
+            "youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items.
+          },
+          "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded.
+            "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED.
+          },
+          "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`.
+            "environment": "A String", # Required. The serving environment.
+          },
+          "exchangeDetails": { # Details for assigned exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`. # Exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_EXCHANGE`.
+            "exchange": "A String", # Required. The enum value for the exchange.
+          },
+          "genderDetails": { # Details for assigned gender targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GENDER`. # Gender details. This field will be populated when the targeting_type is `TARGETING_TYPE_GENDER`.
+            "gender": "A String", # Required. The gender of the audience.
+          },
+          "geoRegionDetails": { # Details for assigned geographic region targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GEO_REGION`. # Geographic region details. This field will be populated when the targeting_type is `TARGETING_TYPE_GEO_REGION`.
+            "displayName": "A String", # Output only. The display name of the geographic region (e.g., "Ontario, Canada").
+            "geoRegionType": "A String", # Output only. The type of geographic region targeting.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+            "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GEO_REGION`.
+          },
+          "householdIncomeDetails": { # Details for assigned household income targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`. # Household income details. This field will be populated when the targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`.
+            "householdIncome": "A String", # Required. The household income of the audience.
+          },
+          "inheritance": "A String", # Output only. The inheritance status of the assigned targeting option.
+          "inventorySourceDetails": { # Targeting details for inventory source. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`. # Inventory source details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`.
+            "inventorySourceId": "A String", # Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource.
+          },
+          "inventorySourceGroupDetails": { # Targeting details for inventory source group. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`. # Inventory source group details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`.
+            "inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource.
+          },
+          "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned.
+            "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+          },
+          "languageDetails": { # Details for assigned language targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_LANGUAGE`. # Language details. This field will be populated when the targeting_type is `TARGETING_TYPE_LANGUAGE`.
+            "displayName": "A String", # Output only. The display name of the language (e.g., "French").
+            "negative": True or False, # Indicates if this option is being negatively targeted. All assigned language targeting options on the same resource must have the same value for this field.
+            "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_LANGUAGE`.
+          },
+          "name": "A String", # Output only. The resource name for this assigned targeting option.
+          "nativeContentPositionDetails": { # Details for native content position assigned targeting option. This will be populated in the native_content_position_details field when targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`. Explicitly targeting all options is not supported. Remove all native content position targeting options to achieve this effect. # Native content position details. This field will be populated when the targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`.
+            "contentPosition": "A String", # Required. The content position.
+          },
+          "negativeKeywordListDetails": { # Targeting details for negative keyword list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. A maximum of 4 negative keyword lists can be assigned to a resource.
+            "negativeKeywordListId": "A String", # Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource.
+          },
+          "omidDetails": { # Represents a targetable Open Measurement enabled inventory type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_OMID`. # Open Measurement enabled inventory details. This field will be populated when the targeting_type is `TARGETING_TYPE_OMID`.
+            "omid": "A String", # Required. The type of Open Measurement enabled inventory.
+          },
+          "onScreenPositionDetails": { # On screen position targeting option details. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. # On screen position details. This field will be populated when the targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
+            "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+            "onScreenPosition": "A String", # Output only. The on screen position.
+            "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
+          },
+          "operatingSystemDetails": { # Assigned operating system targeting option details. This will be populated in the operating_system_details field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. # Operating system details. This field will be populated when the targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
+            "displayName": "A String", # Output only. The display name of the operating system.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+            "targetingOptionId": "A String", # Required. The targeting option ID populated in targeting_option_id field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
+          },
+          "parentalStatusDetails": { # Details for assigned parental status targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`. # Parental status details. This field will be populated when the targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`.
+            "parentalStatus": "A String", # Required. The parental status of the audience.
+          },
+          "poiDetails": { # Details for assigned POI targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_POI`. # POI details. This field will be populated when the targeting_type is `TARGETING_TYPE_POI`.
+            "displayName": "A String", # Output only. The display name of a POI, e.g. "Times Square", "Space Needle", followed by its full address if available.
+            "latitude": 3.14, # Output only. Latitude of the POI rounding to 6th decimal place.
+            "longitude": 3.14, # Output only. Longitude of the POI rounding to 6th decimal place.
+            "proximityRadiusAmount": 3.14, # Required. The radius of the area around the POI that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`.
+            "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
+            "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_POI`. Accepted POI targeting option IDs can be retrieved using `targetingTypes.targetingOptions.search`. If targeting a specific latitude/longitude coordinate removed from an address or POI name, you can generate the necessary targeting option ID by rounding the desired coordinate values to the 6th decimal place, removing the decimals, and concatenating the string values separated by a semicolon. For example, you can target the latitude/longitude pair of 40.7414691, -74.003387 using the targeting option ID "40741469;-74003387". **Upon** **creation, this field value will be updated to append a semicolon and** **alphanumerical hash value if only latitude/longitude coordinates are** **provided.**
+          },
+          "proximityLocationListDetails": { # Targeting details for proximity location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`. # Proximity location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`.
+            "proximityLocationListId": "A String", # Required. ID of the proximity location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_PROXIMITY`.
+            "proximityRadius": 3.14, # Required. Radius expressed in the distance units set in proximity_radius_unit. This represents the size of the area around a chosen location that will be targeted. Radius should be between 1 and 500 miles or 800 kilometers.
+            "proximityRadiusUnit": "A String", # Required. Radius distance units.
+          },
+          "regionalLocationListDetails": { # Targeting details for regional location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`. # Regional location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+            "regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`.
+          },
+          "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them.
+            "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED.
+          },
+          "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`.
+            "sessionPosition": "A String", # The position where the ad will show in a session.
+          },
+          "subExchangeDetails": { # Details for assigned sub-exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`. # Sub-exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`.
+            "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`.
+          },
+          "targetingType": "A String", # Output only. Identifies the type of this assigned targeting option.
+          "thirdPartyVerifierDetails": { # Assigned third party verifier targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`. # Third party verification details. This field will be populated when the targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`.
+            "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox.
+              "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads.
+              "excludedAdlooxCategories": [ # Adloox categories to exclude.
+                "A String",
+              ],
+              "excludedFraudIvtMfaCategories": [ # Optional. Adloox's fraud IVT MFA categories to exclude.
+                "A String",
+              ],
+              "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads.
+            },
+            "doubleVerify": { # Details of DoubleVerify settings. # Third party brand verifier -- DoubleVerify.
+              "appStarRating": { # Details of DoubleVerify star ratings settings. # Avoid bidding on apps with the star ratings.
+                "avoidInsufficientStarRating": True or False, # Avoid bidding on apps with insufficient star ratings.
+                "avoidedStarRating": "A String", # Avoid bidding on apps with the star ratings.
+              },
+              "avoidedAgeRatings": [ # Avoid bidding on apps with the age rating.
+                "A String",
+              ],
+              "brandSafetyCategories": { # Settings for brand safety controls. # DV Brand Safety Controls.
+                "avoidUnknownBrandSafetyCategory": True or False, # Unknown or unrateable.
+                "avoidedHighSeverityCategories": [ # Brand safety high severity avoidance categories.
+                  "A String",
+                ],
+                "avoidedMediumSeverityCategories": [ # Brand safety medium severity avoidance categories.
+                  "A String",
+                ],
+              },
+              "customSegmentId": "A String", # The custom segment ID provided by DoubleVerify. The ID must start with "51" and consist of eight digits. Custom segment ID cannot be specified along with any of the following fields: * brand_safety_categories * avoided_age_ratings * app_star_rating * fraud_invalid_traffic
+              "displayViewability": { # Details of DoubleVerify display viewability settings. # Display viewability settings (applicable to display line items only).
+                "iab": "A String", # Target web and app inventory to maximize IAB viewable rate.
+                "viewableDuring": "A String", # Target web and app inventory to maximize 100% viewable duration.
+              },
+              "fraudInvalidTraffic": { # DoubleVerify Fraud & Invalid Traffic settings. # Avoid Sites and Apps with historical Fraud & IVT Rates.
+                "avoidInsufficientOption": True or False, # Insufficient Historical Fraud & IVT Stats.
+                "avoidedFraudOption": "A String", # Avoid Sites and Apps with historical Fraud & IVT.
+              },
+              "videoViewability": { # Details of DoubleVerify video viewability settings. # Video viewability settings (applicable to video line items only).
+                "playerImpressionRate": "A String", # Target inventory to maximize impressions with 400x300 or greater player size.
+                "videoIab": "A String", # Target web inventory to maximize IAB viewable rate.
+                "videoViewableRate": "A String", # Target web inventory to maximize fully viewable rate.
+              },
+            },
+            "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science.
+              "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive.
+                "A String",
+              ],
+              "displayViewability": "A String", # Display Viewability section (applicable to display line items only).
+              "excludeUnrateable": True or False, # Brand Safety - **Unrateable**.
+              "excludedAdFraudRisk": "A String", # Ad Fraud settings.
+              "excludedAdultRisk": "A String", # Brand Safety - **Adult content**.
+              "excludedAlcoholRisk": "A String", # Brand Safety - **Alcohol**.
+              "excludedDrugsRisk": "A String", # Brand Safety - **Drugs**.
+              "excludedGamblingRisk": "A String", # Brand Safety - **Gambling**.
+              "excludedHateSpeechRisk": "A String", # Brand Safety - **Hate speech**.
+              "excludedIllegalDownloadsRisk": "A String", # Brand Safety - **Illegal downloads**.
+              "excludedOffensiveLanguageRisk": "A String", # Brand Safety - **Offensive language**.
+              "excludedViolenceRisk": "A String", # Brand Safety - **Violence**.
+              "qualitySyncCustomSegmentId": [ # Optional. The quality sync custom segment ID provided by Integral Ad Science. The ID must be between `3000000` and `4999999`, inclusive.
+                "A String",
+              ],
+              "traqScoreOption": "A String", # True advertising quality (applicable to Display line items only).
+              "videoViewability": "A String", # Video Viewability Section (applicable to video line items only).
+            },
+          },
+          "urlDetails": { # Details for assigned URL targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_URL`. # URL details. This field will be populated when the targeting_type is `TARGETING_TYPE_URL`.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+            "url": "A String", # Required. The URL, for example `example.com`. DV360 supports two levels of subdirectory targeting, for example `www.example.com/one-subdirectory-level/second-level`, and five levels of subdomain targeting, for example `five.four.three.two.one.example.com`.
+          },
+          "userRewardedContentDetails": { # User rewarded content targeting option details. This will be populated in the user_rewarded_content_details field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. # User rewarded content details. This field will be populated when the targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
+            "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
+            "userRewardedContent": "A String", # Output only. User rewarded content status for video ads.
+          },
+          "videoPlayerSizeDetails": { # Video player size targeting option details. This will be populated in the video_player_size_details field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. Explicitly targeting all options is not supported. Remove all video player size targeting options to achieve this effect. # Video player size details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.
+            "videoPlayerSize": "A String", # Required. The video player size.
+          },
+          "viewabilityDetails": { # Assigned viewability targeting option details. This will be populated in the viewability_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`. # Viewability details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIEWABILITY`. You can only target one viewability option per resource.
+            "viewability": "A String", # Required. The predicted viewability percentage.
+          },
+          "youtubeChannelDetails": { # Details for YouTube channel assigned targeting option. This will be populated in the youtube_channel_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`. # YouTube channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`.
+            "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+          },
+          "youtubeVideoDetails": { # Details for YouTube video assigned targeting option. This will be populated in the youtube_video_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`. # YouTube video details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+            "videoId": "A String", # YouTube video id as it appears on the YouTube watch page.
+          },
+        },
+      ],
+      "targetingType": "A String", # Required. Identifies the type of this assigned targeting option.
+    },
+  ],
+  "deleteRequests": [ # The assigned targeting options to delete in batch, specified as a list of `DeleteAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD`
+    { # A request listing which assigned targeting options of a given targeting type should be deleted.
+      "assignedTargetingOptionIds": [ # Required. The assigned targeting option IDs to delete.
+        "A String",
+      ],
+      "targetingType": "A String", # Required. Identifies the type of this assigned targeting option.
+    },
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "createdAssignedTargetingOptions": [ # The list of assigned targeting options that have been successfully created. This list will be absent if empty.
+    { # A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings.
+      "ageRangeDetails": { # Represents a targetable age range. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AGE_RANGE`. # Age range details. This field will be populated when the targeting_type is `TARGETING_TYPE_AGE_RANGE`.
+        "ageRange": "A String", # Required. The age range of an audience. We only support targeting a continuous age range of an audience. Thus, the age range represented in this field can be 1) targeted solely, or, 2) part of a larger continuous age range. The reach of a continuous age range targeting can be expanded by also targeting an audience of an unknown age.
+      },
+      "appCategoryDetails": { # Details for assigned app category targeting option. This will be populated in the app_category_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. # App category details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
+        "displayName": "A String", # Output only. The display name of the app category.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
+      },
+      "appDetails": { # Details for assigned app targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP`. # App details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP`.
+        "appId": "A String", # Required. The ID of the app. Android's Play store app uses bundle ID, for example `com.google.android.gm`. Apple's App store app ID uses 9 digit string, for example `422689480`.
+        "appPlatform": "A String", # Indicates the platform of the targeted app. If this field is not specified, the app platform will be assumed to be mobile (i.e., Android or iOS), and we will derive the appropriate mobile platform from the app ID.
+        "displayName": "A String", # Output only. The display name of the app.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+      },
+      "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts.
+      "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`
+      "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource.
+        "excludedFirstPartyAndPartnerAudienceGroup": { # Details of first party and partner audience group. All first party and partner audience targeting settings are logically ‘OR’ of each other. # Optional. The first party and partner audience ids and recencies of the excluded first party and partner audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other.
+          "settings": [ # Required. All first party and partner audience targeting settings in first party and partner audience group. Repeated settings with the same id are not allowed.
+            { # Details of first party and partner audience targeting setting.
+              "firstPartyAndPartnerAudienceId": "A String", # Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.
+              "recency": "A String", # Required. The recency of the first party and partner audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
+            },
+          ],
+        },
+        "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other.
+          "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
+            { # Details of Google audience targeting setting.
+              "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
+            },
+          ],
+        },
+        "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only.
+          "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise.
+            { # Details of combined audience targeting setting.
+              "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id.
+            },
+          ],
+        },
+        "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only.
+          "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored.
+            { # Details of custom list targeting setting.
+              "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id.
+            },
+          ],
+        },
+        "includedFirstPartyAndPartnerAudienceGroups": [ # Optional. The first party and partner audience ids and recencies of included first party and partner audience groups. Each first party and partner audience group contains first party and partner audience ids only. The relation between each first party and partner audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored.
+          { # Details of first party and partner audience group. All first party and partner audience targeting settings are logically ‘OR’ of each other.
+            "settings": [ # Required. All first party and partner audience targeting settings in first party and partner audience group. Repeated settings with the same id are not allowed.
+              { # Details of first party and partner audience targeting setting.
+                "firstPartyAndPartnerAudienceId": "A String", # Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.
+                "recency": "A String", # Required. The recency of the first party and partner audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
+              },
+            ],
+          },
+        ],
+        "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only.
+          "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
+            { # Details of Google audience targeting setting.
+              "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
+            },
+          ],
+        },
+      },
+      "audioContentTypeDetails": { # Details for audio content type assigned targeting option. This will be populated in the audio_content_type_details field when targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`. Explicitly targeting all options is not supported. Remove all audio content type targeting options to achieve this effect. # Audio content type details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`.
+        "audioContentType": "A String", # Required. The audio content type.
+      },
+      "authorizedSellerStatusDetails": { # Represents an assigned authorized seller status. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. If a resource does not have an `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` assigned targeting option, it is using the "Authorized Direct Sellers and Resellers" option. # Authorized seller status details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. You can only target one authorized seller status option per resource. If a resource doesn't have an authorized seller status option, all authorized sellers indicated as DIRECT or RESELLER in the ads.txt file are targeted by default.
+        "authorizedSellerStatus": "A String", # Output only. The authorized seller status to target.
+        "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.
+      },
+      "browserDetails": { # Details for assigned browser targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BROWSER`. # Browser details. This field will be populated when the targeting_type is `TARGETING_TYPE_BROWSER`.
+        "displayName": "A String", # Output only. The display name of the browser.
+        "negative": True or False, # Indicates if this option is being negatively targeted. All assigned browser targeting options on the same resource must have the same value for this field.
+        "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BROWSER`.
+      },
+      "businessChainDetails": { # Details for assigned Business chain targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`. # Business chain details. This field will be populated when the targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`.
+        "displayName": "A String", # Output only. The display name of a business chain, e.g. "KFC", "Chase Bank".
+        "proximityRadiusAmount": 3.14, # Required. The radius of the area around the business chain that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`. The minimum increment for both cases is 0.1. Inputs will be rounded to the nearest acceptable value if it is too granular, e.g. 15.57 will become 15.6.
+        "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
+        "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BUSINESS_CHAIN`. Accepted business chain targeting option IDs can be retrieved using SearchTargetingOptions.
+      },
+      "carrierAndIspDetails": { # Details for assigned carrier and ISP targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`. # Carrier and ISP details. This field will be populated when the targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`.
+        "displayName": "A String", # Output only. The display name of the carrier or ISP.
+        "negative": True or False, # Indicates if this option is being negatively targeted. All assigned carrier and ISP targeting options on the same resource must have the same value for this field.
+        "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`.
+      },
+      "categoryDetails": { # Assigned category targeting option details. This will be populated in the category_details field when targeting_type is `TARGETING_TYPE_CATEGORY`. # Category details. This field will be populated when the targeting_type is `TARGETING_TYPE_CATEGORY`. Targeting a category will also target its subcategories. If a category is excluded from targeting and a subcategory is included, the exclusion will take precedence.
+        "displayName": "A String", # Output only. The display name of the category.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CATEGORY`.
+      },
+      "channelDetails": { # Details for assigned channel targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CHANNEL`. # Channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_CHANNEL`.
+        "channelId": "A String", # Required. ID of the channel. Should refer to the channel ID field on a [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id) resource.
+        "negative": True or False, # Indicates if this option is being negatively targeted. For advertiser level assigned targeting option, this field must be true.
+      },
+      "contentDurationDetails": { # Details for content duration assigned targeting option. This will be populated in the content_duration_details field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`. Explicitly targeting all options is not supported. Remove all content duration targeting options to achieve this effect. # Content duration details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
+        "contentDuration": "A String", # Output only. The content duration.
+        "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
+      },
+      "contentGenreDetails": { # Details for content genre assigned targeting option. This will be populated in the content_genre_details field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`. Explicitly targeting all options is not supported. Remove all content genre targeting options to achieve this effect. # Content genre details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
+        "displayName": "A String", # Output only. The display name of the content genre.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
+      },
+      "contentInstreamPositionDetails": { # Assigned content instream position targeting option details. This will be populated in the content_instream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. # Content instream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.
+        "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`. * `AD_TYPE_AUDIO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_AUDIO_DEFAULT`.
+        "contentInstreamPosition": "A String", # Required. The content instream position for video or audio ads.
+      },
+      "contentOutstreamPositionDetails": { # Assigned content outstream position targeting option details. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. # Content outstream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.
+        "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+        "contentOutstreamPosition": "A String", # Required. The content outstream position.
+      },
+      "contentStreamTypeDetails": { # Details for content stream type assigned targeting option. This will be populated in the content_stream_type_details field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`. Explicitly targeting all options is not supported. Remove all content stream type targeting options to achieve this effect. # Content duration details. This field will be populated when the TargetingType is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
+        "contentStreamType": "A String", # Output only. The content stream type.
+        "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
+      },
+      "dayAndTimeDetails": { # Representation of a segment of time defined on a specific day of the week and with a start and end time. The time represented by `start_hour` must be before the time represented by `end_hour`. # Day and time details. This field will be populated when the targeting_type is `TARGETING_TYPE_DAY_AND_TIME`.
+        "dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting.
+        "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day).
+        "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day).
+        "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting.
+      },
+      "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
+        "displayName": "A String", # Output only. The display name of the device make and model.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
+      },
+      "deviceTypeDetails": { # Targeting details for device type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`. # Device Type details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_TYPE`.
+        "deviceType": "A String", # Required. The display name of the device type.
+        "youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items.
+      },
+      "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded.
+        "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED.
+      },
+      "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`.
+        "environment": "A String", # Required. The serving environment.
+      },
+      "exchangeDetails": { # Details for assigned exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`. # Exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_EXCHANGE`.
+        "exchange": "A String", # Required. The enum value for the exchange.
+      },
+      "genderDetails": { # Details for assigned gender targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GENDER`. # Gender details. This field will be populated when the targeting_type is `TARGETING_TYPE_GENDER`.
+        "gender": "A String", # Required. The gender of the audience.
+      },
+      "geoRegionDetails": { # Details for assigned geographic region targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GEO_REGION`. # Geographic region details. This field will be populated when the targeting_type is `TARGETING_TYPE_GEO_REGION`.
+        "displayName": "A String", # Output only. The display name of the geographic region (e.g., "Ontario, Canada").
+        "geoRegionType": "A String", # Output only. The type of geographic region targeting.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GEO_REGION`.
+      },
+      "householdIncomeDetails": { # Details for assigned household income targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`. # Household income details. This field will be populated when the targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`.
+        "householdIncome": "A String", # Required. The household income of the audience.
+      },
+      "inheritance": "A String", # Output only. The inheritance status of the assigned targeting option.
+      "inventorySourceDetails": { # Targeting details for inventory source. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`. # Inventory source details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`.
+        "inventorySourceId": "A String", # Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource.
+      },
+      "inventorySourceGroupDetails": { # Targeting details for inventory source group. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`. # Inventory source group details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`.
+        "inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource.
+      },
+      "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned.
+        "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+      },
+      "languageDetails": { # Details for assigned language targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_LANGUAGE`. # Language details. This field will be populated when the targeting_type is `TARGETING_TYPE_LANGUAGE`.
+        "displayName": "A String", # Output only. The display name of the language (e.g., "French").
+        "negative": True or False, # Indicates if this option is being negatively targeted. All assigned language targeting options on the same resource must have the same value for this field.
+        "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_LANGUAGE`.
+      },
+      "name": "A String", # Output only. The resource name for this assigned targeting option.
+      "nativeContentPositionDetails": { # Details for native content position assigned targeting option. This will be populated in the native_content_position_details field when targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`. Explicitly targeting all options is not supported. Remove all native content position targeting options to achieve this effect. # Native content position details. This field will be populated when the targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`.
+        "contentPosition": "A String", # Required. The content position.
+      },
+      "negativeKeywordListDetails": { # Targeting details for negative keyword list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. A maximum of 4 negative keyword lists can be assigned to a resource.
+        "negativeKeywordListId": "A String", # Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource.
+      },
+      "omidDetails": { # Represents a targetable Open Measurement enabled inventory type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_OMID`. # Open Measurement enabled inventory details. This field will be populated when the targeting_type is `TARGETING_TYPE_OMID`.
+        "omid": "A String", # Required. The type of Open Measurement enabled inventory.
+      },
+      "onScreenPositionDetails": { # On screen position targeting option details. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. # On screen position details. This field will be populated when the targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
+        "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+        "onScreenPosition": "A String", # Output only. The on screen position.
+        "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
+      },
+      "operatingSystemDetails": { # Assigned operating system targeting option details. This will be populated in the operating_system_details field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. # Operating system details. This field will be populated when the targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
+        "displayName": "A String", # Output only. The display name of the operating system.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "targetingOptionId": "A String", # Required. The targeting option ID populated in targeting_option_id field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
+      },
+      "parentalStatusDetails": { # Details for assigned parental status targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`. # Parental status details. This field will be populated when the targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`.
+        "parentalStatus": "A String", # Required. The parental status of the audience.
+      },
+      "poiDetails": { # Details for assigned POI targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_POI`. # POI details. This field will be populated when the targeting_type is `TARGETING_TYPE_POI`.
+        "displayName": "A String", # Output only. The display name of a POI, e.g. "Times Square", "Space Needle", followed by its full address if available.
+        "latitude": 3.14, # Output only. Latitude of the POI rounding to 6th decimal place.
+        "longitude": 3.14, # Output only. Longitude of the POI rounding to 6th decimal place.
+        "proximityRadiusAmount": 3.14, # Required. The radius of the area around the POI that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`.
+        "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
+        "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_POI`. Accepted POI targeting option IDs can be retrieved using `targetingTypes.targetingOptions.search`. If targeting a specific latitude/longitude coordinate removed from an address or POI name, you can generate the necessary targeting option ID by rounding the desired coordinate values to the 6th decimal place, removing the decimals, and concatenating the string values separated by a semicolon. For example, you can target the latitude/longitude pair of 40.7414691, -74.003387 using the targeting option ID "40741469;-74003387". **Upon** **creation, this field value will be updated to append a semicolon and** **alphanumerical hash value if only latitude/longitude coordinates are** **provided.**
+      },
+      "proximityLocationListDetails": { # Targeting details for proximity location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`. # Proximity location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`.
+        "proximityLocationListId": "A String", # Required. ID of the proximity location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_PROXIMITY`.
+        "proximityRadius": 3.14, # Required. Radius expressed in the distance units set in proximity_radius_unit. This represents the size of the area around a chosen location that will be targeted. Radius should be between 1 and 500 miles or 800 kilometers.
+        "proximityRadiusUnit": "A String", # Required. Radius distance units.
+      },
+      "regionalLocationListDetails": { # Targeting details for regional location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`. # Regional location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`.
+      },
+      "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them.
+        "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED.
+      },
+      "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`.
+        "sessionPosition": "A String", # The position where the ad will show in a session.
+      },
+      "subExchangeDetails": { # Details for assigned sub-exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`. # Sub-exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`.
+        "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`.
+      },
+      "targetingType": "A String", # Output only. Identifies the type of this assigned targeting option.
+      "thirdPartyVerifierDetails": { # Assigned third party verifier targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`. # Third party verification details. This field will be populated when the targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`.
+        "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox.
+          "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads.
+          "excludedAdlooxCategories": [ # Adloox categories to exclude.
+            "A String",
+          ],
+          "excludedFraudIvtMfaCategories": [ # Optional. Adloox's fraud IVT MFA categories to exclude.
+            "A String",
+          ],
+          "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads.
+        },
+        "doubleVerify": { # Details of DoubleVerify settings. # Third party brand verifier -- DoubleVerify.
+          "appStarRating": { # Details of DoubleVerify star ratings settings. # Avoid bidding on apps with the star ratings.
+            "avoidInsufficientStarRating": True or False, # Avoid bidding on apps with insufficient star ratings.
+            "avoidedStarRating": "A String", # Avoid bidding on apps with the star ratings.
+          },
+          "avoidedAgeRatings": [ # Avoid bidding on apps with the age rating.
+            "A String",
+          ],
+          "brandSafetyCategories": { # Settings for brand safety controls. # DV Brand Safety Controls.
+            "avoidUnknownBrandSafetyCategory": True or False, # Unknown or unrateable.
+            "avoidedHighSeverityCategories": [ # Brand safety high severity avoidance categories.
+              "A String",
+            ],
+            "avoidedMediumSeverityCategories": [ # Brand safety medium severity avoidance categories.
+              "A String",
+            ],
+          },
+          "customSegmentId": "A String", # The custom segment ID provided by DoubleVerify. The ID must start with "51" and consist of eight digits. Custom segment ID cannot be specified along with any of the following fields: * brand_safety_categories * avoided_age_ratings * app_star_rating * fraud_invalid_traffic
+          "displayViewability": { # Details of DoubleVerify display viewability settings. # Display viewability settings (applicable to display line items only).
+            "iab": "A String", # Target web and app inventory to maximize IAB viewable rate.
+            "viewableDuring": "A String", # Target web and app inventory to maximize 100% viewable duration.
+          },
+          "fraudInvalidTraffic": { # DoubleVerify Fraud & Invalid Traffic settings. # Avoid Sites and Apps with historical Fraud & IVT Rates.
+            "avoidInsufficientOption": True or False, # Insufficient Historical Fraud & IVT Stats.
+            "avoidedFraudOption": "A String", # Avoid Sites and Apps with historical Fraud & IVT.
+          },
+          "videoViewability": { # Details of DoubleVerify video viewability settings. # Video viewability settings (applicable to video line items only).
+            "playerImpressionRate": "A String", # Target inventory to maximize impressions with 400x300 or greater player size.
+            "videoIab": "A String", # Target web inventory to maximize IAB viewable rate.
+            "videoViewableRate": "A String", # Target web inventory to maximize fully viewable rate.
+          },
+        },
+        "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science.
+          "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive.
+            "A String",
+          ],
+          "displayViewability": "A String", # Display Viewability section (applicable to display line items only).
+          "excludeUnrateable": True or False, # Brand Safety - **Unrateable**.
+          "excludedAdFraudRisk": "A String", # Ad Fraud settings.
+          "excludedAdultRisk": "A String", # Brand Safety - **Adult content**.
+          "excludedAlcoholRisk": "A String", # Brand Safety - **Alcohol**.
+          "excludedDrugsRisk": "A String", # Brand Safety - **Drugs**.
+          "excludedGamblingRisk": "A String", # Brand Safety - **Gambling**.
+          "excludedHateSpeechRisk": "A String", # Brand Safety - **Hate speech**.
+          "excludedIllegalDownloadsRisk": "A String", # Brand Safety - **Illegal downloads**.
+          "excludedOffensiveLanguageRisk": "A String", # Brand Safety - **Offensive language**.
+          "excludedViolenceRisk": "A String", # Brand Safety - **Violence**.
+          "qualitySyncCustomSegmentId": [ # Optional. The quality sync custom segment ID provided by Integral Ad Science. The ID must be between `3000000` and `4999999`, inclusive.
+            "A String",
+          ],
+          "traqScoreOption": "A String", # True advertising quality (applicable to Display line items only).
+          "videoViewability": "A String", # Video Viewability Section (applicable to video line items only).
+        },
+      },
+      "urlDetails": { # Details for assigned URL targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_URL`. # URL details. This field will be populated when the targeting_type is `TARGETING_TYPE_URL`.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "url": "A String", # Required. The URL, for example `example.com`. DV360 supports two levels of subdirectory targeting, for example `www.example.com/one-subdirectory-level/second-level`, and five levels of subdomain targeting, for example `five.four.three.two.one.example.com`.
+      },
+      "userRewardedContentDetails": { # User rewarded content targeting option details. This will be populated in the user_rewarded_content_details field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. # User rewarded content details. This field will be populated when the targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
+        "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
+        "userRewardedContent": "A String", # Output only. User rewarded content status for video ads.
+      },
+      "videoPlayerSizeDetails": { # Video player size targeting option details. This will be populated in the video_player_size_details field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. Explicitly targeting all options is not supported. Remove all video player size targeting options to achieve this effect. # Video player size details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.
+        "videoPlayerSize": "A String", # Required. The video player size.
+      },
+      "viewabilityDetails": { # Assigned viewability targeting option details. This will be populated in the viewability_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`. # Viewability details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIEWABILITY`. You can only target one viewability option per resource.
+        "viewability": "A String", # Required. The predicted viewability percentage.
+      },
+      "youtubeChannelDetails": { # Details for YouTube channel assigned targeting option. This will be populated in the youtube_channel_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`. # YouTube channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`.
+        "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+      },
+      "youtubeVideoDetails": { # Details for YouTube video assigned targeting option. This will be populated in the youtube_video_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`. # YouTube video details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "videoId": "A String", # YouTube video id as it appears on the YouTube watch page.
+      },
+    },
+  ],
+}
+
+ +
+ get(advertiserId, x__xgafv=None) +
Gets an advertiser.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser to fetch. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single advertiser in Display & Video 360 (DV360).
+  "adServerConfig": { # Ad server related settings of an advertiser. # Required. Immutable. Ad server related settings of the advertiser.
+    "cmHybridConfig": { # Settings for advertisers that use both Campaign Manager 360 (CM360) and third-party ad servers. # The configuration for advertisers that use both Campaign Manager 360 (CM360) and third-party ad servers.
+      "cmAccountId": "A String", # Required. Immutable. Account ID of the CM360 Floodlight configuration linked with the DV360 advertiser.
+      "cmAdvertiserIds": [ # Output only. The set of CM360 Advertiser IDs sharing the CM360 Floodlight configuration.
+        "A String",
+      ],
+      "cmFloodlightConfigId": "A String", # Required. Immutable. ID of the CM360 Floodlight configuration linked with the DV360 advertiser.
+      "cmFloodlightLinkingAuthorized": True or False, # Required. Immutable. By setting this field to `true`, you, on behalf of your company, authorize the sharing of information from the given Floodlight configuration to this Display & Video 360 advertiser.
+      "cmSyncableSiteIds": [ # A list of CM360 sites whose placements will be synced to DV360 as creatives. If absent or empty in CreateAdvertiser method, the system will automatically create a CM360 site. Removing sites from this list may cause DV360 creatives synced from CM360 to be deleted. At least one site must be specified.
+        "A String",
+      ],
+      "dv360ToCmCostReportingEnabled": True or False, # Whether or not to report DV360 cost to CM360.
+      "dv360ToCmDataSharingEnabled": True or False, # Whether or not to include DV360 data in CM360 data transfer reports.
+    },
+    "thirdPartyOnlyConfig": { # Settings for advertisers that use third-party ad servers only. # The configuration for advertisers that use third-party ad servers only.
+      "pixelOrderIdReportingEnabled": True or False, # Whether or not order ID reporting for pixels is enabled. This value cannot be changed once set to `true`.
+    },
+  },
+  "advertiserId": "A String", # Output only. The unique ID of the advertiser. Assigned by the system.
+  "billingConfig": { # Billing related settings of an advertiser. # Required. Billing related settings of the advertiser.
+    "billingProfileId": "A String", # Required. The ID of a billing profile assigned to the advertiser.
+  },
+  "creativeConfig": { # Creatives related settings of an advertiser. # Required. Creative related settings of the advertiser.
+    "dynamicCreativeEnabled": True or False, # Whether or not the advertiser is enabled for dynamic creatives.
+    "iasClientId": "A String", # An ID for configuring campaign monitoring provided by Integral Ad Service (IAS). The DV360 system will append an IAS "Campaign Monitor" tag containing this ID to the creative tag.
+    "obaComplianceDisabled": True or False, # Whether or not to disable Google's About this Ad feature that adds badging (to identify the content as an ad) and transparency information (on interaction with About this Ad) to your ads for Online Behavioral Advertising (OBA) and regulatory requirements. About this Ad gives users greater control over the ads they see and helps you explain why they're seeing your ad. [Learn more](//support.google.com/displayvideo/answer/14315795). If you choose to set this field to `true`, note that ads served through Display & Video 360 must comply to the following: * Be Online Behavioral Advertising (OBA) compliant, as per your contract with Google Marketing Platform. * In the European Economic Area (EEA), include transparency information and a mechanism for users to report illegal content in ads. If using an alternative ad badging, transparency, and reporting solution, you must ensure it includes the required transparency information and illegal content flagging mechanism and that you notify Google of any illegal content reports using the appropriate [form](//support.google.com/legal/troubleshooter/1114905?sjid=6787484030557261960-EU#ts=2981967%2C2982031%2C12980091).
+    "videoCreativeDataSharingAuthorized": True or False, # By setting this field to `true`, you, on behalf of your company, authorize Google to use video creatives associated with this Display & Video 360 advertiser to provide reporting and features related to the advertiser's television campaigns. Applicable only when the advertiser has a CM360 hybrid ad server configuration.
+  },
+  "dataAccessConfig": { # Settings that control how advertiser related data may be accessed. # Settings that control how advertiser data may be accessed.
+    "sdfConfig": { # Structured Data Files (SDF) settings of an advertiser. # Structured Data Files (SDF) settings for the advertiser. If not specified, the SDF settings of the parent partner are used.
+      "overridePartnerSdfConfig": True or False, # Whether or not this advertiser overrides the SDF configuration of its parent partner. By default, an advertiser inherits the SDF configuration from the parent partner. To override the partner configuration, set this field to `true` and provide the new configuration in sdfConfig.
+      "sdfConfig": { # Structured Data File (SDF) related settings. # The SDF configuration for the advertiser. * Required when overridePartnerSdfConfig is `true`. * Output only when overridePartnerSdfConfig is `false`.
+        "adminEmail": "A String", # An administrator email address to which the SDF processing status reports will be sent.
+        "version": "A String", # Required. The version of SDF being used.
+      },
+    },
+  },
+  "displayName": "A String", # Required. The display name of the advertiser. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_PAUSED` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days from when it was first scheduled for deletion.
+  "generalConfig": { # General settings of an advertiser. # Required. General settings of the advertiser.
+    "currencyCode": "A String", # Required. Immutable. Advertiser's currency in ISO 4217 format. Accepted codes and the currencies they represent are: Currency Code : Currency Name * `ARS` : Argentine Peso * `AUD` : Australian Dollar * `BRL` : Brazilian Real * `CAD` : Canadian Dollar * `CHF` : Swiss Franc * `CLP` : Chilean Peso * `CNY` : Chinese Yuan * `COP` : Colombian Peso * `CZK` : Czech Koruna * `DKK` : Danish Krone * `EGP` : Egyption Pound * `EUR` : Euro * `GBP` : British Pound * `HKD` : Hong Kong Dollar * `HUF` : Hungarian Forint * `IDR` : Indonesian Rupiah * `ILS` : Israeli Shekel * `INR` : Indian Rupee * `JPY` : Japanese Yen * `KRW` : South Korean Won * `MXN` : Mexican Pesos * `MYR` : Malaysian Ringgit * `NGN` : Nigerian Naira * `NOK` : Norwegian Krone * `NZD` : New Zealand Dollar * `PEN` : Peruvian Nuevo Sol * `PLN` : Polish Zloty * `RON` : New Romanian Leu * `RUB` : Russian Ruble * `SEK` : Swedish Krona * `TRY` : Turkish Lira * `TWD` : New Taiwan Dollar * `USD` : US Dollar * `ZAR` : South African Rand
+    "domainUrl": "A String", # Required. The domain URL of the advertiser's primary website. The system will send this information to publishers that require website URL to associate a campaign with an advertiser. Provide a URL with no path or query string, beginning with `http:` or `https:`. For example, http://www.example.com
+    "timeZone": "A String", # Output only. The standard TZ database name of the advertiser's time zone. For example, `America/New_York`. See more at: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones For CM360 hybrid advertisers, the time zone is the same as that of the associated CM360 account; for third-party only advertisers, the time zone is the same as that of the parent partner.
+  },
+  "integrationDetails": { # Integration details of an entry. # Integration details of the advertiser. Only integrationCode is currently applicable to advertiser. Other fields of IntegrationDetails are not supported and will be ignored if provided.
+    "details": "A String", # Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters.
+    "integrationCode": "A String", # An external identifier to be associated with the entry. The integration code will show up together with the entry in many places in the system, for example, reporting. Must be UTF-8 encoded with a length of no more than 500 characters.
+  },
+  "name": "A String", # Output only. The resource name of the advertiser.
+  "partnerId": "A String", # Required. Immutable. The unique ID of the partner that the advertiser belongs to.
+  "prismaEnabled": True or False, # Whether integration with Mediaocean (Prisma) is enabled. By enabling this, you agree to the following: On behalf of my company, I authorize Mediaocean (Prisma) to send budget segment plans to Google, and I authorize Google to send corresponding reporting and invoices from DV360 to Mediaocean for the purposes of budget planning, billing, and reconciliation for this advertiser.
+  "servingConfig": { # Targeting settings related to ad serving of an advertiser. # Targeting settings related to ad serving of the advertiser.
+    "exemptTvFromViewabilityTargeting": True or False, # Whether or not connected TV devices are exempt from viewability targeting for all video line items under the advertiser.
+  },
+  "updateTime": "A String", # Output only. The timestamp when the advertiser was last updated. Assigned by the system.
+}
+
+ +
+ list(filter=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None) +
Lists advertisers that are accessible to the current user. The order is defined by the order_by parameter. A single partner_id is required. Cross-partner listing is not supported.
+
+Args:
+  filter: string, Allows filtering by advertiser fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. * A restriction has the form of `{field} {operator} {value}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `advertiserId` * `displayName` * `entityStatus` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All active advertisers under a partner: `entityStatus="ENTITY_STATUS_ACTIVE"` * All advertisers with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<="2020-11-04T18:54:47Z"` * All advertisers with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
+  orderBy: string, Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` * `updateTime` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`.
+  pageSize: integer, Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
+  pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdvertisers` method. If not specified, the first page of results will be returned.
+  partnerId: string, Required. The ID of the partner that the fetched advertisers should all belong to. The system only supports listing advertisers for one partner at a time.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "advertisers": [ # The list of advertisers. This list will be absent if empty.
+    { # A single advertiser in Display & Video 360 (DV360).
+      "adServerConfig": { # Ad server related settings of an advertiser. # Required. Immutable. Ad server related settings of the advertiser.
+        "cmHybridConfig": { # Settings for advertisers that use both Campaign Manager 360 (CM360) and third-party ad servers. # The configuration for advertisers that use both Campaign Manager 360 (CM360) and third-party ad servers.
+          "cmAccountId": "A String", # Required. Immutable. Account ID of the CM360 Floodlight configuration linked with the DV360 advertiser.
+          "cmAdvertiserIds": [ # Output only. The set of CM360 Advertiser IDs sharing the CM360 Floodlight configuration.
+            "A String",
+          ],
+          "cmFloodlightConfigId": "A String", # Required. Immutable. ID of the CM360 Floodlight configuration linked with the DV360 advertiser.
+          "cmFloodlightLinkingAuthorized": True or False, # Required. Immutable. By setting this field to `true`, you, on behalf of your company, authorize the sharing of information from the given Floodlight configuration to this Display & Video 360 advertiser.
+          "cmSyncableSiteIds": [ # A list of CM360 sites whose placements will be synced to DV360 as creatives. If absent or empty in CreateAdvertiser method, the system will automatically create a CM360 site. Removing sites from this list may cause DV360 creatives synced from CM360 to be deleted. At least one site must be specified.
+            "A String",
+          ],
+          "dv360ToCmCostReportingEnabled": True or False, # Whether or not to report DV360 cost to CM360.
+          "dv360ToCmDataSharingEnabled": True or False, # Whether or not to include DV360 data in CM360 data transfer reports.
+        },
+        "thirdPartyOnlyConfig": { # Settings for advertisers that use third-party ad servers only. # The configuration for advertisers that use third-party ad servers only.
+          "pixelOrderIdReportingEnabled": True or False, # Whether or not order ID reporting for pixels is enabled. This value cannot be changed once set to `true`.
+        },
+      },
+      "advertiserId": "A String", # Output only. The unique ID of the advertiser. Assigned by the system.
+      "billingConfig": { # Billing related settings of an advertiser. # Required. Billing related settings of the advertiser.
+        "billingProfileId": "A String", # Required. The ID of a billing profile assigned to the advertiser.
+      },
+      "creativeConfig": { # Creatives related settings of an advertiser. # Required. Creative related settings of the advertiser.
+        "dynamicCreativeEnabled": True or False, # Whether or not the advertiser is enabled for dynamic creatives.
+        "iasClientId": "A String", # An ID for configuring campaign monitoring provided by Integral Ad Service (IAS). The DV360 system will append an IAS "Campaign Monitor" tag containing this ID to the creative tag.
+        "obaComplianceDisabled": True or False, # Whether or not to disable Google's About this Ad feature that adds badging (to identify the content as an ad) and transparency information (on interaction with About this Ad) to your ads for Online Behavioral Advertising (OBA) and regulatory requirements. About this Ad gives users greater control over the ads they see and helps you explain why they're seeing your ad. [Learn more](//support.google.com/displayvideo/answer/14315795). If you choose to set this field to `true`, note that ads served through Display & Video 360 must comply to the following: * Be Online Behavioral Advertising (OBA) compliant, as per your contract with Google Marketing Platform. * In the European Economic Area (EEA), include transparency information and a mechanism for users to report illegal content in ads. If using an alternative ad badging, transparency, and reporting solution, you must ensure it includes the required transparency information and illegal content flagging mechanism and that you notify Google of any illegal content reports using the appropriate [form](//support.google.com/legal/troubleshooter/1114905?sjid=6787484030557261960-EU#ts=2981967%2C2982031%2C12980091).
+        "videoCreativeDataSharingAuthorized": True or False, # By setting this field to `true`, you, on behalf of your company, authorize Google to use video creatives associated with this Display & Video 360 advertiser to provide reporting and features related to the advertiser's television campaigns. Applicable only when the advertiser has a CM360 hybrid ad server configuration.
+      },
+      "dataAccessConfig": { # Settings that control how advertiser related data may be accessed. # Settings that control how advertiser data may be accessed.
+        "sdfConfig": { # Structured Data Files (SDF) settings of an advertiser. # Structured Data Files (SDF) settings for the advertiser. If not specified, the SDF settings of the parent partner are used.
+          "overridePartnerSdfConfig": True or False, # Whether or not this advertiser overrides the SDF configuration of its parent partner. By default, an advertiser inherits the SDF configuration from the parent partner. To override the partner configuration, set this field to `true` and provide the new configuration in sdfConfig.
+          "sdfConfig": { # Structured Data File (SDF) related settings. # The SDF configuration for the advertiser. * Required when overridePartnerSdfConfig is `true`. * Output only when overridePartnerSdfConfig is `false`.
+            "adminEmail": "A String", # An administrator email address to which the SDF processing status reports will be sent.
+            "version": "A String", # Required. The version of SDF being used.
+          },
+        },
+      },
+      "displayName": "A String", # Required. The display name of the advertiser. Must be UTF-8 encoded with a maximum size of 240 bytes.
+      "entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_PAUSED` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days from when it was first scheduled for deletion.
+      "generalConfig": { # General settings of an advertiser. # Required. General settings of the advertiser.
+        "currencyCode": "A String", # Required. Immutable. Advertiser's currency in ISO 4217 format. Accepted codes and the currencies they represent are: Currency Code : Currency Name * `ARS` : Argentine Peso * `AUD` : Australian Dollar * `BRL` : Brazilian Real * `CAD` : Canadian Dollar * `CHF` : Swiss Franc * `CLP` : Chilean Peso * `CNY` : Chinese Yuan * `COP` : Colombian Peso * `CZK` : Czech Koruna * `DKK` : Danish Krone * `EGP` : Egyption Pound * `EUR` : Euro * `GBP` : British Pound * `HKD` : Hong Kong Dollar * `HUF` : Hungarian Forint * `IDR` : Indonesian Rupiah * `ILS` : Israeli Shekel * `INR` : Indian Rupee * `JPY` : Japanese Yen * `KRW` : South Korean Won * `MXN` : Mexican Pesos * `MYR` : Malaysian Ringgit * `NGN` : Nigerian Naira * `NOK` : Norwegian Krone * `NZD` : New Zealand Dollar * `PEN` : Peruvian Nuevo Sol * `PLN` : Polish Zloty * `RON` : New Romanian Leu * `RUB` : Russian Ruble * `SEK` : Swedish Krona * `TRY` : Turkish Lira * `TWD` : New Taiwan Dollar * `USD` : US Dollar * `ZAR` : South African Rand
+        "domainUrl": "A String", # Required. The domain URL of the advertiser's primary website. The system will send this information to publishers that require website URL to associate a campaign with an advertiser. Provide a URL with no path or query string, beginning with `http:` or `https:`. For example, http://www.example.com
+        "timeZone": "A String", # Output only. The standard TZ database name of the advertiser's time zone. For example, `America/New_York`. See more at: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones For CM360 hybrid advertisers, the time zone is the same as that of the associated CM360 account; for third-party only advertisers, the time zone is the same as that of the parent partner.
+      },
+      "integrationDetails": { # Integration details of an entry. # Integration details of the advertiser. Only integrationCode is currently applicable to advertiser. Other fields of IntegrationDetails are not supported and will be ignored if provided.
+        "details": "A String", # Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters.
+        "integrationCode": "A String", # An external identifier to be associated with the entry. The integration code will show up together with the entry in many places in the system, for example, reporting. Must be UTF-8 encoded with a length of no more than 500 characters.
+      },
+      "name": "A String", # Output only. The resource name of the advertiser.
+      "partnerId": "A String", # Required. Immutable. The unique ID of the partner that the advertiser belongs to.
+      "prismaEnabled": True or False, # Whether integration with Mediaocean (Prisma) is enabled. By enabling this, you agree to the following: On behalf of my company, I authorize Mediaocean (Prisma) to send budget segment plans to Google, and I authorize Google to send corresponding reporting and invoices from DV360 to Mediaocean for the purposes of budget planning, billing, and reconciliation for this advertiser.
+      "servingConfig": { # Targeting settings related to ad serving of an advertiser. # Targeting settings related to ad serving of the advertiser.
+        "exemptTvFromViewabilityTargeting": True or False, # Whether or not connected TV devices are exempt from viewability targeting for all video line items under the advertiser.
+      },
+      "updateTime": "A String", # Output only. The timestamp when the advertiser was last updated. Assigned by the system.
+    },
+  ],
+  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListAdvertisers` method to retrieve the next page of results.
+}
+
+ +
+ listAssignedTargetingOptions(advertiserId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists assigned targeting options of an advertiser across targeting types.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser the line item belongs to. (required)
+  filter: string, Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=) operator`. Supported fields: * `targetingType` Examples: * targetingType with value TARGETING_TYPE_CHANNEL `targetingType="TARGETING_TYPE_CHANNEL"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
+  orderBy: string, Field by which to sort the list. Acceptable values are: * `targetingType` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `targetingType desc`.
+  pageSize: integer, Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is '5000'. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
+  pageToken: string, A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to `BulkListAdvertiserAssignedTargetingOptions` method. If not specified, the first page of results 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:
+
+    {
+  "assignedTargetingOptions": [ # The list of assigned targeting options. This list will be absent if empty.
+    { # A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings.
+      "ageRangeDetails": { # Represents a targetable age range. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AGE_RANGE`. # Age range details. This field will be populated when the targeting_type is `TARGETING_TYPE_AGE_RANGE`.
+        "ageRange": "A String", # Required. The age range of an audience. We only support targeting a continuous age range of an audience. Thus, the age range represented in this field can be 1) targeted solely, or, 2) part of a larger continuous age range. The reach of a continuous age range targeting can be expanded by also targeting an audience of an unknown age.
+      },
+      "appCategoryDetails": { # Details for assigned app category targeting option. This will be populated in the app_category_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. # App category details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
+        "displayName": "A String", # Output only. The display name of the app category.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
+      },
+      "appDetails": { # Details for assigned app targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP`. # App details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP`.
+        "appId": "A String", # Required. The ID of the app. Android's Play store app uses bundle ID, for example `com.google.android.gm`. Apple's App store app ID uses 9 digit string, for example `422689480`.
+        "appPlatform": "A String", # Indicates the platform of the targeted app. If this field is not specified, the app platform will be assumed to be mobile (i.e., Android or iOS), and we will derive the appropriate mobile platform from the app ID.
+        "displayName": "A String", # Output only. The display name of the app.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+      },
+      "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts.
+      "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`
+      "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource.
+        "excludedFirstPartyAndPartnerAudienceGroup": { # Details of first party and partner audience group. All first party and partner audience targeting settings are logically ‘OR’ of each other. # Optional. The first party and partner audience ids and recencies of the excluded first party and partner audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other.
+          "settings": [ # Required. All first party and partner audience targeting settings in first party and partner audience group. Repeated settings with the same id are not allowed.
+            { # Details of first party and partner audience targeting setting.
+              "firstPartyAndPartnerAudienceId": "A String", # Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.
+              "recency": "A String", # Required. The recency of the first party and partner audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
+            },
+          ],
+        },
+        "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other.
+          "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
+            { # Details of Google audience targeting setting.
+              "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
+            },
+          ],
+        },
+        "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only.
+          "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise.
+            { # Details of combined audience targeting setting.
+              "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id.
+            },
+          ],
+        },
+        "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only.
+          "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored.
+            { # Details of custom list targeting setting.
+              "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id.
+            },
+          ],
+        },
+        "includedFirstPartyAndPartnerAudienceGroups": [ # Optional. The first party and partner audience ids and recencies of included first party and partner audience groups. Each first party and partner audience group contains first party and partner audience ids only. The relation between each first party and partner audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored.
+          { # Details of first party and partner audience group. All first party and partner audience targeting settings are logically ‘OR’ of each other.
+            "settings": [ # Required. All first party and partner audience targeting settings in first party and partner audience group. Repeated settings with the same id are not allowed.
+              { # Details of first party and partner audience targeting setting.
+                "firstPartyAndPartnerAudienceId": "A String", # Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.
+                "recency": "A String", # Required. The recency of the first party and partner audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
+              },
+            ],
+          },
+        ],
+        "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only.
+          "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
+            { # Details of Google audience targeting setting.
+              "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
+            },
+          ],
+        },
+      },
+      "audioContentTypeDetails": { # Details for audio content type assigned targeting option. This will be populated in the audio_content_type_details field when targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`. Explicitly targeting all options is not supported. Remove all audio content type targeting options to achieve this effect. # Audio content type details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`.
+        "audioContentType": "A String", # Required. The audio content type.
+      },
+      "authorizedSellerStatusDetails": { # Represents an assigned authorized seller status. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. If a resource does not have an `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` assigned targeting option, it is using the "Authorized Direct Sellers and Resellers" option. # Authorized seller status details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. You can only target one authorized seller status option per resource. If a resource doesn't have an authorized seller status option, all authorized sellers indicated as DIRECT or RESELLER in the ads.txt file are targeted by default.
+        "authorizedSellerStatus": "A String", # Output only. The authorized seller status to target.
+        "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.
+      },
+      "browserDetails": { # Details for assigned browser targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BROWSER`. # Browser details. This field will be populated when the targeting_type is `TARGETING_TYPE_BROWSER`.
+        "displayName": "A String", # Output only. The display name of the browser.
+        "negative": True or False, # Indicates if this option is being negatively targeted. All assigned browser targeting options on the same resource must have the same value for this field.
+        "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BROWSER`.
+      },
+      "businessChainDetails": { # Details for assigned Business chain targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`. # Business chain details. This field will be populated when the targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`.
+        "displayName": "A String", # Output only. The display name of a business chain, e.g. "KFC", "Chase Bank".
+        "proximityRadiusAmount": 3.14, # Required. The radius of the area around the business chain that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`. The minimum increment for both cases is 0.1. Inputs will be rounded to the nearest acceptable value if it is too granular, e.g. 15.57 will become 15.6.
+        "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
+        "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BUSINESS_CHAIN`. Accepted business chain targeting option IDs can be retrieved using SearchTargetingOptions.
+      },
+      "carrierAndIspDetails": { # Details for assigned carrier and ISP targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`. # Carrier and ISP details. This field will be populated when the targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`.
+        "displayName": "A String", # Output only. The display name of the carrier or ISP.
+        "negative": True or False, # Indicates if this option is being negatively targeted. All assigned carrier and ISP targeting options on the same resource must have the same value for this field.
+        "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`.
+      },
+      "categoryDetails": { # Assigned category targeting option details. This will be populated in the category_details field when targeting_type is `TARGETING_TYPE_CATEGORY`. # Category details. This field will be populated when the targeting_type is `TARGETING_TYPE_CATEGORY`. Targeting a category will also target its subcategories. If a category is excluded from targeting and a subcategory is included, the exclusion will take precedence.
+        "displayName": "A String", # Output only. The display name of the category.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CATEGORY`.
+      },
+      "channelDetails": { # Details for assigned channel targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CHANNEL`. # Channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_CHANNEL`.
+        "channelId": "A String", # Required. ID of the channel. Should refer to the channel ID field on a [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id) resource.
+        "negative": True or False, # Indicates if this option is being negatively targeted. For advertiser level assigned targeting option, this field must be true.
+      },
+      "contentDurationDetails": { # Details for content duration assigned targeting option. This will be populated in the content_duration_details field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`. Explicitly targeting all options is not supported. Remove all content duration targeting options to achieve this effect. # Content duration details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
+        "contentDuration": "A String", # Output only. The content duration.
+        "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
+      },
+      "contentGenreDetails": { # Details for content genre assigned targeting option. This will be populated in the content_genre_details field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`. Explicitly targeting all options is not supported. Remove all content genre targeting options to achieve this effect. # Content genre details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
+        "displayName": "A String", # Output only. The display name of the content genre.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
+      },
+      "contentInstreamPositionDetails": { # Assigned content instream position targeting option details. This will be populated in the content_instream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. # Content instream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.
+        "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`. * `AD_TYPE_AUDIO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_AUDIO_DEFAULT`.
+        "contentInstreamPosition": "A String", # Required. The content instream position for video or audio ads.
+      },
+      "contentOutstreamPositionDetails": { # Assigned content outstream position targeting option details. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. # Content outstream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.
+        "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+        "contentOutstreamPosition": "A String", # Required. The content outstream position.
+      },
+      "contentStreamTypeDetails": { # Details for content stream type assigned targeting option. This will be populated in the content_stream_type_details field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`. Explicitly targeting all options is not supported. Remove all content stream type targeting options to achieve this effect. # Content duration details. This field will be populated when the TargetingType is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
+        "contentStreamType": "A String", # Output only. The content stream type.
+        "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
+      },
+      "dayAndTimeDetails": { # Representation of a segment of time defined on a specific day of the week and with a start and end time. The time represented by `start_hour` must be before the time represented by `end_hour`. # Day and time details. This field will be populated when the targeting_type is `TARGETING_TYPE_DAY_AND_TIME`.
+        "dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting.
+        "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day).
+        "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day).
+        "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting.
+      },
+      "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
+        "displayName": "A String", # Output only. The display name of the device make and model.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
+      },
+      "deviceTypeDetails": { # Targeting details for device type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`. # Device Type details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_TYPE`.
+        "deviceType": "A String", # Required. The display name of the device type.
+        "youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items.
+      },
+      "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded.
+        "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED.
+      },
+      "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`.
+        "environment": "A String", # Required. The serving environment.
+      },
+      "exchangeDetails": { # Details for assigned exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`. # Exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_EXCHANGE`.
+        "exchange": "A String", # Required. The enum value for the exchange.
+      },
+      "genderDetails": { # Details for assigned gender targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GENDER`. # Gender details. This field will be populated when the targeting_type is `TARGETING_TYPE_GENDER`.
+        "gender": "A String", # Required. The gender of the audience.
+      },
+      "geoRegionDetails": { # Details for assigned geographic region targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GEO_REGION`. # Geographic region details. This field will be populated when the targeting_type is `TARGETING_TYPE_GEO_REGION`.
+        "displayName": "A String", # Output only. The display name of the geographic region (e.g., "Ontario, Canada").
+        "geoRegionType": "A String", # Output only. The type of geographic region targeting.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GEO_REGION`.
+      },
+      "householdIncomeDetails": { # Details for assigned household income targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`. # Household income details. This field will be populated when the targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`.
+        "householdIncome": "A String", # Required. The household income of the audience.
+      },
+      "inheritance": "A String", # Output only. The inheritance status of the assigned targeting option.
+      "inventorySourceDetails": { # Targeting details for inventory source. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`. # Inventory source details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`.
+        "inventorySourceId": "A String", # Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource.
+      },
+      "inventorySourceGroupDetails": { # Targeting details for inventory source group. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`. # Inventory source group details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`.
+        "inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource.
+      },
+      "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned.
+        "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+      },
+      "languageDetails": { # Details for assigned language targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_LANGUAGE`. # Language details. This field will be populated when the targeting_type is `TARGETING_TYPE_LANGUAGE`.
+        "displayName": "A String", # Output only. The display name of the language (e.g., "French").
+        "negative": True or False, # Indicates if this option is being negatively targeted. All assigned language targeting options on the same resource must have the same value for this field.
+        "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_LANGUAGE`.
+      },
+      "name": "A String", # Output only. The resource name for this assigned targeting option.
+      "nativeContentPositionDetails": { # Details for native content position assigned targeting option. This will be populated in the native_content_position_details field when targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`. Explicitly targeting all options is not supported. Remove all native content position targeting options to achieve this effect. # Native content position details. This field will be populated when the targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`.
+        "contentPosition": "A String", # Required. The content position.
+      },
+      "negativeKeywordListDetails": { # Targeting details for negative keyword list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. A maximum of 4 negative keyword lists can be assigned to a resource.
+        "negativeKeywordListId": "A String", # Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource.
+      },
+      "omidDetails": { # Represents a targetable Open Measurement enabled inventory type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_OMID`. # Open Measurement enabled inventory details. This field will be populated when the targeting_type is `TARGETING_TYPE_OMID`.
+        "omid": "A String", # Required. The type of Open Measurement enabled inventory.
+      },
+      "onScreenPositionDetails": { # On screen position targeting option details. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. # On screen position details. This field will be populated when the targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
+        "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+        "onScreenPosition": "A String", # Output only. The on screen position.
+        "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
+      },
+      "operatingSystemDetails": { # Assigned operating system targeting option details. This will be populated in the operating_system_details field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. # Operating system details. This field will be populated when the targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
+        "displayName": "A String", # Output only. The display name of the operating system.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "targetingOptionId": "A String", # Required. The targeting option ID populated in targeting_option_id field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
+      },
+      "parentalStatusDetails": { # Details for assigned parental status targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`. # Parental status details. This field will be populated when the targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`.
+        "parentalStatus": "A String", # Required. The parental status of the audience.
+      },
+      "poiDetails": { # Details for assigned POI targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_POI`. # POI details. This field will be populated when the targeting_type is `TARGETING_TYPE_POI`.
+        "displayName": "A String", # Output only. The display name of a POI, e.g. "Times Square", "Space Needle", followed by its full address if available.
+        "latitude": 3.14, # Output only. Latitude of the POI rounding to 6th decimal place.
+        "longitude": 3.14, # Output only. Longitude of the POI rounding to 6th decimal place.
+        "proximityRadiusAmount": 3.14, # Required. The radius of the area around the POI that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`.
+        "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
+        "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_POI`. Accepted POI targeting option IDs can be retrieved using `targetingTypes.targetingOptions.search`. If targeting a specific latitude/longitude coordinate removed from an address or POI name, you can generate the necessary targeting option ID by rounding the desired coordinate values to the 6th decimal place, removing the decimals, and concatenating the string values separated by a semicolon. For example, you can target the latitude/longitude pair of 40.7414691, -74.003387 using the targeting option ID "40741469;-74003387". **Upon** **creation, this field value will be updated to append a semicolon and** **alphanumerical hash value if only latitude/longitude coordinates are** **provided.**
+      },
+      "proximityLocationListDetails": { # Targeting details for proximity location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`. # Proximity location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`.
+        "proximityLocationListId": "A String", # Required. ID of the proximity location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_PROXIMITY`.
+        "proximityRadius": 3.14, # Required. Radius expressed in the distance units set in proximity_radius_unit. This represents the size of the area around a chosen location that will be targeted. Radius should be between 1 and 500 miles or 800 kilometers.
+        "proximityRadiusUnit": "A String", # Required. Radius distance units.
+      },
+      "regionalLocationListDetails": { # Targeting details for regional location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`. # Regional location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`.
+      },
+      "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them.
+        "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED.
+      },
+      "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`.
+        "sessionPosition": "A String", # The position where the ad will show in a session.
+      },
+      "subExchangeDetails": { # Details for assigned sub-exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`. # Sub-exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`.
+        "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`.
+      },
+      "targetingType": "A String", # Output only. Identifies the type of this assigned targeting option.
+      "thirdPartyVerifierDetails": { # Assigned third party verifier targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`. # Third party verification details. This field will be populated when the targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`.
+        "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox.
+          "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads.
+          "excludedAdlooxCategories": [ # Adloox categories to exclude.
+            "A String",
+          ],
+          "excludedFraudIvtMfaCategories": [ # Optional. Adloox's fraud IVT MFA categories to exclude.
+            "A String",
+          ],
+          "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads.
+        },
+        "doubleVerify": { # Details of DoubleVerify settings. # Third party brand verifier -- DoubleVerify.
+          "appStarRating": { # Details of DoubleVerify star ratings settings. # Avoid bidding on apps with the star ratings.
+            "avoidInsufficientStarRating": True or False, # Avoid bidding on apps with insufficient star ratings.
+            "avoidedStarRating": "A String", # Avoid bidding on apps with the star ratings.
+          },
+          "avoidedAgeRatings": [ # Avoid bidding on apps with the age rating.
+            "A String",
+          ],
+          "brandSafetyCategories": { # Settings for brand safety controls. # DV Brand Safety Controls.
+            "avoidUnknownBrandSafetyCategory": True or False, # Unknown or unrateable.
+            "avoidedHighSeverityCategories": [ # Brand safety high severity avoidance categories.
+              "A String",
+            ],
+            "avoidedMediumSeverityCategories": [ # Brand safety medium severity avoidance categories.
+              "A String",
+            ],
+          },
+          "customSegmentId": "A String", # The custom segment ID provided by DoubleVerify. The ID must start with "51" and consist of eight digits. Custom segment ID cannot be specified along with any of the following fields: * brand_safety_categories * avoided_age_ratings * app_star_rating * fraud_invalid_traffic
+          "displayViewability": { # Details of DoubleVerify display viewability settings. # Display viewability settings (applicable to display line items only).
+            "iab": "A String", # Target web and app inventory to maximize IAB viewable rate.
+            "viewableDuring": "A String", # Target web and app inventory to maximize 100% viewable duration.
+          },
+          "fraudInvalidTraffic": { # DoubleVerify Fraud & Invalid Traffic settings. # Avoid Sites and Apps with historical Fraud & IVT Rates.
+            "avoidInsufficientOption": True or False, # Insufficient Historical Fraud & IVT Stats.
+            "avoidedFraudOption": "A String", # Avoid Sites and Apps with historical Fraud & IVT.
+          },
+          "videoViewability": { # Details of DoubleVerify video viewability settings. # Video viewability settings (applicable to video line items only).
+            "playerImpressionRate": "A String", # Target inventory to maximize impressions with 400x300 or greater player size.
+            "videoIab": "A String", # Target web inventory to maximize IAB viewable rate.
+            "videoViewableRate": "A String", # Target web inventory to maximize fully viewable rate.
+          },
+        },
+        "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science.
+          "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive.
+            "A String",
+          ],
+          "displayViewability": "A String", # Display Viewability section (applicable to display line items only).
+          "excludeUnrateable": True or False, # Brand Safety - **Unrateable**.
+          "excludedAdFraudRisk": "A String", # Ad Fraud settings.
+          "excludedAdultRisk": "A String", # Brand Safety - **Adult content**.
+          "excludedAlcoholRisk": "A String", # Brand Safety - **Alcohol**.
+          "excludedDrugsRisk": "A String", # Brand Safety - **Drugs**.
+          "excludedGamblingRisk": "A String", # Brand Safety - **Gambling**.
+          "excludedHateSpeechRisk": "A String", # Brand Safety - **Hate speech**.
+          "excludedIllegalDownloadsRisk": "A String", # Brand Safety - **Illegal downloads**.
+          "excludedOffensiveLanguageRisk": "A String", # Brand Safety - **Offensive language**.
+          "excludedViolenceRisk": "A String", # Brand Safety - **Violence**.
+          "qualitySyncCustomSegmentId": [ # Optional. The quality sync custom segment ID provided by Integral Ad Science. The ID must be between `3000000` and `4999999`, inclusive.
+            "A String",
+          ],
+          "traqScoreOption": "A String", # True advertising quality (applicable to Display line items only).
+          "videoViewability": "A String", # Video Viewability Section (applicable to video line items only).
+        },
+      },
+      "urlDetails": { # Details for assigned URL targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_URL`. # URL details. This field will be populated when the targeting_type is `TARGETING_TYPE_URL`.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "url": "A String", # Required. The URL, for example `example.com`. DV360 supports two levels of subdirectory targeting, for example `www.example.com/one-subdirectory-level/second-level`, and five levels of subdomain targeting, for example `five.four.three.two.one.example.com`.
+      },
+      "userRewardedContentDetails": { # User rewarded content targeting option details. This will be populated in the user_rewarded_content_details field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. # User rewarded content details. This field will be populated when the targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
+        "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
+        "userRewardedContent": "A String", # Output only. User rewarded content status for video ads.
+      },
+      "videoPlayerSizeDetails": { # Video player size targeting option details. This will be populated in the video_player_size_details field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. Explicitly targeting all options is not supported. Remove all video player size targeting options to achieve this effect. # Video player size details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.
+        "videoPlayerSize": "A String", # Required. The video player size.
+      },
+      "viewabilityDetails": { # Assigned viewability targeting option details. This will be populated in the viewability_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`. # Viewability details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIEWABILITY`. You can only target one viewability option per resource.
+        "viewability": "A String", # Required. The predicted viewability percentage.
+      },
+      "youtubeChannelDetails": { # Details for YouTube channel assigned targeting option. This will be populated in the youtube_channel_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`. # YouTube channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`.
+        "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+      },
+      "youtubeVideoDetails": { # Details for YouTube video assigned targeting option. This will be populated in the youtube_video_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`. # YouTube video details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "videoId": "A String", # YouTube video id as it appears on the YouTube watch page.
+      },
+    },
+  ],
+  "nextPageToken": "A String", # A token identifying the next page of results. This value should be specified as the pageToken in a subsequent BulkListAdvertiserAssignedTargetingOptionsRequest to fetch the next page of results. This token will be absent if there are no more assigned_targeting_options to return.
+}
+
+ +
+ listAssignedTargetingOptions_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.
+        
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(advertiserId, body=None, updateMask=None, x__xgafv=None) +
Updates an existing advertiser. Returns the updated advertiser if successful.
+
+Args:
+  advertiserId: string, Output only. The unique ID of the advertiser. Assigned by the system. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A single advertiser in Display & Video 360 (DV360).
+  "adServerConfig": { # Ad server related settings of an advertiser. # Required. Immutable. Ad server related settings of the advertiser.
+    "cmHybridConfig": { # Settings for advertisers that use both Campaign Manager 360 (CM360) and third-party ad servers. # The configuration for advertisers that use both Campaign Manager 360 (CM360) and third-party ad servers.
+      "cmAccountId": "A String", # Required. Immutable. Account ID of the CM360 Floodlight configuration linked with the DV360 advertiser.
+      "cmAdvertiserIds": [ # Output only. The set of CM360 Advertiser IDs sharing the CM360 Floodlight configuration.
+        "A String",
+      ],
+      "cmFloodlightConfigId": "A String", # Required. Immutable. ID of the CM360 Floodlight configuration linked with the DV360 advertiser.
+      "cmFloodlightLinkingAuthorized": True or False, # Required. Immutable. By setting this field to `true`, you, on behalf of your company, authorize the sharing of information from the given Floodlight configuration to this Display & Video 360 advertiser.
+      "cmSyncableSiteIds": [ # A list of CM360 sites whose placements will be synced to DV360 as creatives. If absent or empty in CreateAdvertiser method, the system will automatically create a CM360 site. Removing sites from this list may cause DV360 creatives synced from CM360 to be deleted. At least one site must be specified.
+        "A String",
+      ],
+      "dv360ToCmCostReportingEnabled": True or False, # Whether or not to report DV360 cost to CM360.
+      "dv360ToCmDataSharingEnabled": True or False, # Whether or not to include DV360 data in CM360 data transfer reports.
+    },
+    "thirdPartyOnlyConfig": { # Settings for advertisers that use third-party ad servers only. # The configuration for advertisers that use third-party ad servers only.
+      "pixelOrderIdReportingEnabled": True or False, # Whether or not order ID reporting for pixels is enabled. This value cannot be changed once set to `true`.
+    },
+  },
+  "advertiserId": "A String", # Output only. The unique ID of the advertiser. Assigned by the system.
+  "billingConfig": { # Billing related settings of an advertiser. # Required. Billing related settings of the advertiser.
+    "billingProfileId": "A String", # Required. The ID of a billing profile assigned to the advertiser.
+  },
+  "creativeConfig": { # Creatives related settings of an advertiser. # Required. Creative related settings of the advertiser.
+    "dynamicCreativeEnabled": True or False, # Whether or not the advertiser is enabled for dynamic creatives.
+    "iasClientId": "A String", # An ID for configuring campaign monitoring provided by Integral Ad Service (IAS). The DV360 system will append an IAS "Campaign Monitor" tag containing this ID to the creative tag.
+    "obaComplianceDisabled": True or False, # Whether or not to disable Google's About this Ad feature that adds badging (to identify the content as an ad) and transparency information (on interaction with About this Ad) to your ads for Online Behavioral Advertising (OBA) and regulatory requirements. About this Ad gives users greater control over the ads they see and helps you explain why they're seeing your ad. [Learn more](//support.google.com/displayvideo/answer/14315795). If you choose to set this field to `true`, note that ads served through Display & Video 360 must comply to the following: * Be Online Behavioral Advertising (OBA) compliant, as per your contract with Google Marketing Platform. * In the European Economic Area (EEA), include transparency information and a mechanism for users to report illegal content in ads. If using an alternative ad badging, transparency, and reporting solution, you must ensure it includes the required transparency information and illegal content flagging mechanism and that you notify Google of any illegal content reports using the appropriate [form](//support.google.com/legal/troubleshooter/1114905?sjid=6787484030557261960-EU#ts=2981967%2C2982031%2C12980091).
+    "videoCreativeDataSharingAuthorized": True or False, # By setting this field to `true`, you, on behalf of your company, authorize Google to use video creatives associated with this Display & Video 360 advertiser to provide reporting and features related to the advertiser's television campaigns. Applicable only when the advertiser has a CM360 hybrid ad server configuration.
+  },
+  "dataAccessConfig": { # Settings that control how advertiser related data may be accessed. # Settings that control how advertiser data may be accessed.
+    "sdfConfig": { # Structured Data Files (SDF) settings of an advertiser. # Structured Data Files (SDF) settings for the advertiser. If not specified, the SDF settings of the parent partner are used.
+      "overridePartnerSdfConfig": True or False, # Whether or not this advertiser overrides the SDF configuration of its parent partner. By default, an advertiser inherits the SDF configuration from the parent partner. To override the partner configuration, set this field to `true` and provide the new configuration in sdfConfig.
+      "sdfConfig": { # Structured Data File (SDF) related settings. # The SDF configuration for the advertiser. * Required when overridePartnerSdfConfig is `true`. * Output only when overridePartnerSdfConfig is `false`.
+        "adminEmail": "A String", # An administrator email address to which the SDF processing status reports will be sent.
+        "version": "A String", # Required. The version of SDF being used.
+      },
+    },
+  },
+  "displayName": "A String", # Required. The display name of the advertiser. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_PAUSED` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days from when it was first scheduled for deletion.
+  "generalConfig": { # General settings of an advertiser. # Required. General settings of the advertiser.
+    "currencyCode": "A String", # Required. Immutable. Advertiser's currency in ISO 4217 format. Accepted codes and the currencies they represent are: Currency Code : Currency Name * `ARS` : Argentine Peso * `AUD` : Australian Dollar * `BRL` : Brazilian Real * `CAD` : Canadian Dollar * `CHF` : Swiss Franc * `CLP` : Chilean Peso * `CNY` : Chinese Yuan * `COP` : Colombian Peso * `CZK` : Czech Koruna * `DKK` : Danish Krone * `EGP` : Egyption Pound * `EUR` : Euro * `GBP` : British Pound * `HKD` : Hong Kong Dollar * `HUF` : Hungarian Forint * `IDR` : Indonesian Rupiah * `ILS` : Israeli Shekel * `INR` : Indian Rupee * `JPY` : Japanese Yen * `KRW` : South Korean Won * `MXN` : Mexican Pesos * `MYR` : Malaysian Ringgit * `NGN` : Nigerian Naira * `NOK` : Norwegian Krone * `NZD` : New Zealand Dollar * `PEN` : Peruvian Nuevo Sol * `PLN` : Polish Zloty * `RON` : New Romanian Leu * `RUB` : Russian Ruble * `SEK` : Swedish Krona * `TRY` : Turkish Lira * `TWD` : New Taiwan Dollar * `USD` : US Dollar * `ZAR` : South African Rand
+    "domainUrl": "A String", # Required. The domain URL of the advertiser's primary website. The system will send this information to publishers that require website URL to associate a campaign with an advertiser. Provide a URL with no path or query string, beginning with `http:` or `https:`. For example, http://www.example.com
+    "timeZone": "A String", # Output only. The standard TZ database name of the advertiser's time zone. For example, `America/New_York`. See more at: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones For CM360 hybrid advertisers, the time zone is the same as that of the associated CM360 account; for third-party only advertisers, the time zone is the same as that of the parent partner.
+  },
+  "integrationDetails": { # Integration details of an entry. # Integration details of the advertiser. Only integrationCode is currently applicable to advertiser. Other fields of IntegrationDetails are not supported and will be ignored if provided.
+    "details": "A String", # Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters.
+    "integrationCode": "A String", # An external identifier to be associated with the entry. The integration code will show up together with the entry in many places in the system, for example, reporting. Must be UTF-8 encoded with a length of no more than 500 characters.
+  },
+  "name": "A String", # Output only. The resource name of the advertiser.
+  "partnerId": "A String", # Required. Immutable. The unique ID of the partner that the advertiser belongs to.
+  "prismaEnabled": True or False, # Whether integration with Mediaocean (Prisma) is enabled. By enabling this, you agree to the following: On behalf of my company, I authorize Mediaocean (Prisma) to send budget segment plans to Google, and I authorize Google to send corresponding reporting and invoices from DV360 to Mediaocean for the purposes of budget planning, billing, and reconciliation for this advertiser.
+  "servingConfig": { # Targeting settings related to ad serving of an advertiser. # Targeting settings related to ad serving of the advertiser.
+    "exemptTvFromViewabilityTargeting": True or False, # Whether or not connected TV devices are exempt from viewability targeting for all video line items under the advertiser.
+  },
+  "updateTime": "A String", # Output only. The timestamp when the advertiser was last updated. Assigned by the system.
+}
+
+  updateMask: string, Required. The mask to control which fields to update.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single advertiser in Display & Video 360 (DV360).
+  "adServerConfig": { # Ad server related settings of an advertiser. # Required. Immutable. Ad server related settings of the advertiser.
+    "cmHybridConfig": { # Settings for advertisers that use both Campaign Manager 360 (CM360) and third-party ad servers. # The configuration for advertisers that use both Campaign Manager 360 (CM360) and third-party ad servers.
+      "cmAccountId": "A String", # Required. Immutable. Account ID of the CM360 Floodlight configuration linked with the DV360 advertiser.
+      "cmAdvertiserIds": [ # Output only. The set of CM360 Advertiser IDs sharing the CM360 Floodlight configuration.
+        "A String",
+      ],
+      "cmFloodlightConfigId": "A String", # Required. Immutable. ID of the CM360 Floodlight configuration linked with the DV360 advertiser.
+      "cmFloodlightLinkingAuthorized": True or False, # Required. Immutable. By setting this field to `true`, you, on behalf of your company, authorize the sharing of information from the given Floodlight configuration to this Display & Video 360 advertiser.
+      "cmSyncableSiteIds": [ # A list of CM360 sites whose placements will be synced to DV360 as creatives. If absent or empty in CreateAdvertiser method, the system will automatically create a CM360 site. Removing sites from this list may cause DV360 creatives synced from CM360 to be deleted. At least one site must be specified.
+        "A String",
+      ],
+      "dv360ToCmCostReportingEnabled": True or False, # Whether or not to report DV360 cost to CM360.
+      "dv360ToCmDataSharingEnabled": True or False, # Whether or not to include DV360 data in CM360 data transfer reports.
+    },
+    "thirdPartyOnlyConfig": { # Settings for advertisers that use third-party ad servers only. # The configuration for advertisers that use third-party ad servers only.
+      "pixelOrderIdReportingEnabled": True or False, # Whether or not order ID reporting for pixels is enabled. This value cannot be changed once set to `true`.
+    },
+  },
+  "advertiserId": "A String", # Output only. The unique ID of the advertiser. Assigned by the system.
+  "billingConfig": { # Billing related settings of an advertiser. # Required. Billing related settings of the advertiser.
+    "billingProfileId": "A String", # Required. The ID of a billing profile assigned to the advertiser.
+  },
+  "creativeConfig": { # Creatives related settings of an advertiser. # Required. Creative related settings of the advertiser.
+    "dynamicCreativeEnabled": True or False, # Whether or not the advertiser is enabled for dynamic creatives.
+    "iasClientId": "A String", # An ID for configuring campaign monitoring provided by Integral Ad Service (IAS). The DV360 system will append an IAS "Campaign Monitor" tag containing this ID to the creative tag.
+    "obaComplianceDisabled": True or False, # Whether or not to disable Google's About this Ad feature that adds badging (to identify the content as an ad) and transparency information (on interaction with About this Ad) to your ads for Online Behavioral Advertising (OBA) and regulatory requirements. About this Ad gives users greater control over the ads they see and helps you explain why they're seeing your ad. [Learn more](//support.google.com/displayvideo/answer/14315795). If you choose to set this field to `true`, note that ads served through Display & Video 360 must comply to the following: * Be Online Behavioral Advertising (OBA) compliant, as per your contract with Google Marketing Platform. * In the European Economic Area (EEA), include transparency information and a mechanism for users to report illegal content in ads. If using an alternative ad badging, transparency, and reporting solution, you must ensure it includes the required transparency information and illegal content flagging mechanism and that you notify Google of any illegal content reports using the appropriate [form](//support.google.com/legal/troubleshooter/1114905?sjid=6787484030557261960-EU#ts=2981967%2C2982031%2C12980091).
+    "videoCreativeDataSharingAuthorized": True or False, # By setting this field to `true`, you, on behalf of your company, authorize Google to use video creatives associated with this Display & Video 360 advertiser to provide reporting and features related to the advertiser's television campaigns. Applicable only when the advertiser has a CM360 hybrid ad server configuration.
+  },
+  "dataAccessConfig": { # Settings that control how advertiser related data may be accessed. # Settings that control how advertiser data may be accessed.
+    "sdfConfig": { # Structured Data Files (SDF) settings of an advertiser. # Structured Data Files (SDF) settings for the advertiser. If not specified, the SDF settings of the parent partner are used.
+      "overridePartnerSdfConfig": True or False, # Whether or not this advertiser overrides the SDF configuration of its parent partner. By default, an advertiser inherits the SDF configuration from the parent partner. To override the partner configuration, set this field to `true` and provide the new configuration in sdfConfig.
+      "sdfConfig": { # Structured Data File (SDF) related settings. # The SDF configuration for the advertiser. * Required when overridePartnerSdfConfig is `true`. * Output only when overridePartnerSdfConfig is `false`.
+        "adminEmail": "A String", # An administrator email address to which the SDF processing status reports will be sent.
+        "version": "A String", # Required. The version of SDF being used.
+      },
+    },
+  },
+  "displayName": "A String", # Required. The display name of the advertiser. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_PAUSED` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days from when it was first scheduled for deletion.
+  "generalConfig": { # General settings of an advertiser. # Required. General settings of the advertiser.
+    "currencyCode": "A String", # Required. Immutable. Advertiser's currency in ISO 4217 format. Accepted codes and the currencies they represent are: Currency Code : Currency Name * `ARS` : Argentine Peso * `AUD` : Australian Dollar * `BRL` : Brazilian Real * `CAD` : Canadian Dollar * `CHF` : Swiss Franc * `CLP` : Chilean Peso * `CNY` : Chinese Yuan * `COP` : Colombian Peso * `CZK` : Czech Koruna * `DKK` : Danish Krone * `EGP` : Egyption Pound * `EUR` : Euro * `GBP` : British Pound * `HKD` : Hong Kong Dollar * `HUF` : Hungarian Forint * `IDR` : Indonesian Rupiah * `ILS` : Israeli Shekel * `INR` : Indian Rupee * `JPY` : Japanese Yen * `KRW` : South Korean Won * `MXN` : Mexican Pesos * `MYR` : Malaysian Ringgit * `NGN` : Nigerian Naira * `NOK` : Norwegian Krone * `NZD` : New Zealand Dollar * `PEN` : Peruvian Nuevo Sol * `PLN` : Polish Zloty * `RON` : New Romanian Leu * `RUB` : Russian Ruble * `SEK` : Swedish Krona * `TRY` : Turkish Lira * `TWD` : New Taiwan Dollar * `USD` : US Dollar * `ZAR` : South African Rand
+    "domainUrl": "A String", # Required. The domain URL of the advertiser's primary website. The system will send this information to publishers that require website URL to associate a campaign with an advertiser. Provide a URL with no path or query string, beginning with `http:` or `https:`. For example, http://www.example.com
+    "timeZone": "A String", # Output only. The standard TZ database name of the advertiser's time zone. For example, `America/New_York`. See more at: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones For CM360 hybrid advertisers, the time zone is the same as that of the associated CM360 account; for third-party only advertisers, the time zone is the same as that of the parent partner.
+  },
+  "integrationDetails": { # Integration details of an entry. # Integration details of the advertiser. Only integrationCode is currently applicable to advertiser. Other fields of IntegrationDetails are not supported and will be ignored if provided.
+    "details": "A String", # Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters.
+    "integrationCode": "A String", # An external identifier to be associated with the entry. The integration code will show up together with the entry in many places in the system, for example, reporting. Must be UTF-8 encoded with a length of no more than 500 characters.
+  },
+  "name": "A String", # Output only. The resource name of the advertiser.
+  "partnerId": "A String", # Required. Immutable. The unique ID of the partner that the advertiser belongs to.
+  "prismaEnabled": True or False, # Whether integration with Mediaocean (Prisma) is enabled. By enabling this, you agree to the following: On behalf of my company, I authorize Mediaocean (Prisma) to send budget segment plans to Google, and I authorize Google to send corresponding reporting and invoices from DV360 to Mediaocean for the purposes of budget planning, billing, and reconciliation for this advertiser.
+  "servingConfig": { # Targeting settings related to ad serving of an advertiser. # Targeting settings related to ad serving of the advertiser.
+    "exemptTvFromViewabilityTargeting": True or False, # Whether or not connected TV devices are exempt from viewability targeting for all video line items under the advertiser.
+  },
+  "updateTime": "A String", # Output only. The timestamp when the advertiser was last updated. Assigned by the system.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/displayvideo_v4.advertisers.insertionOrders.html b/docs/dyn/displayvideo_v4.advertisers.insertionOrders.html new file mode 100644 index 00000000000..730b3e8fafb --- /dev/null +++ b/docs/dyn/displayvideo_v4.advertisers.insertionOrders.html @@ -0,0 +1,767 @@ + + + +

Display & Video 360 API . advertisers . insertionOrders

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(advertiserId, body=None, x__xgafv=None)

+

Creates a new insertion order. Returns the newly created insertion order if successful.

+

+ delete(advertiserId, insertionOrderId, x__xgafv=None)

+

Deletes an insertion order. Returns error code `NOT_FOUND` if the insertion order does not exist. The insertion order should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it.

+

+ get(advertiserId, insertionOrderId, x__xgafv=None)

+

Gets an insertion order. Returns error code `NOT_FOUND` if the insertion order does not exist.

+

+ list(advertiserId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists insertion orders in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, insertion orders with `ENTITY_STATUS_ARCHIVED` will not be included in the results.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(advertiserId, insertionOrderId, body=None, updateMask=None, x__xgafv=None)

+

Updates an existing insertion order. Returns the updated insertion order if successful.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(advertiserId, body=None, x__xgafv=None) +
Creates a new insertion order. Returns the newly created insertion order if successful.
+
+Args:
+  advertiserId: string, Output only. The unique ID of the advertiser the insertion order belongs to. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A single insertion order.
+  "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to.
+  "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set.
+    "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
+      "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
+    },
+    "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, when performance_goal_type is one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , the line_item_type of the insertion order line items must be either: * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , and when performance_goal_type is either: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` the line_item_type of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+      "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).
+      "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.
+      "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.
+      "raiseBidForDeals": True or False, # Whether the strategy takes deal floor prices into account.
+    },
+    "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity.
+      "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).
+      "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency.
+      "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value.
+      "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`.
+    },
+    "youtubeAndPartnersBid": { # Settings that control the bid strategy for YouTube and Partners resources. # A bid strategy used by YouTube and Partners resources. It can only be used for a YouTube and Partners line item or ad group entity.
+      "adGroupEffectiveTargetCpaSource": "A String", # Output only. Source of the effective target CPA value for ad group.
+      "adGroupEffectiveTargetCpaValue": "A String", # Output only. The effective target CPA for ad group, in micros of advertiser's currency.
+      "type": "A String", # The type of the bidding strategy.
+      "value": "A String", # The value used by the bidding strategy. When the bidding strategy is assigned at the line item level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` When the bidding strategy is assigned at the ad group level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPV` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` If not using an applicable strategy, the value of this field will be 0.
+    },
+  },
+  "budget": { # Settings that control how insertion order budget is allocated. # Required. The budget allocation settings of the insertion order.
+    "automationType": "A String", # Optional. The type of automation used to manage bid and budget for the insertion order. If this field is unspecified in creation, the value defaults to `INSERTION_ORDER_AUTOMATION_TYPE_NONE`.
+    "budgetSegments": [ # Required. The list of budget segments. Use a budget segment to specify a specific budget for a given period of time an insertion order is running.
+      { # Settings that control the budget of a single budget segment.
+        "budgetAmountMicros": "A String", # Required. The budget amount the insertion order will spend for the given date_range. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency.
+        "campaignBudgetId": "A String", # Optional. The budget_id of the campaign budget that this insertion order budget segment is a part of.
+        "dateRange": { # A date range. # Required. The start and end date settings of the budget segment. They are resolved relative to the parent advertiser's time zone. * When creating a new budget segment, both `start_date` and `end_date` must be in the future. * An existing budget segment with a `start_date` in the past has a mutable `end_date` but an immutable `start_date`. * `end_date` must be the `start_date` or later, both before the year 2037.
+          "endDate": { # 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 # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
+            "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.
+          },
+          "startDate": { # 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 # The lower bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
+            "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.
+          },
+        },
+        "description": "A String", # Optional. The budget segment description. It can be used to enter Purchase Order information for each budget segment and have that information printed on the invoices. Must be UTF-8 encoded.
+      },
+    ],
+    "budgetUnit": "A String", # Required. Immutable. The budget unit specifies whether the budget is currency based or impression based.
+  },
+  "campaignId": "A String", # Required. Immutable. The unique ID of the campaign that the insertion order belongs to.
+  "displayName": "A String", # Required. The display name of the insertion order. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "entityStatus": "A String", # Required. Controls whether or not the insertion order can spend its budget and bid on inventory. * For CreateInsertionOrder method, only `ENTITY_STATUS_DRAFT` is allowed. To activate an insertion order, use UpdateInsertionOrder method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * An insertion order cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * An insertion order cannot be set to `ENTITY_STATUS_ACTIVE` if its parent campaign is not active.
+  "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency capping setting of the insertion order. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap)
+    "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set.
+    "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set.
+    "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).
+    "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).
+    "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable.
+  },
+  "insertionOrderId": "A String", # Output only. The unique ID of the insertion order. Assigned by the system.
+  "insertionOrderType": "A String", # Optional. The type of insertion order. If this field is unspecified in creation, the value defaults to `RTB`.
+  "integrationDetails": { # Integration details of an entry. # Optional. Additional integration details of the insertion order.
+    "details": "A String", # Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters.
+    "integrationCode": "A String", # An external identifier to be associated with the entry. The integration code will show up together with the entry in many places in the system, for example, reporting. Must be UTF-8 encoded with a length of no more than 500 characters.
+  },
+  "kpi": { # Settings that control the key performance indicator, or KPI, of an insertion order. # Required. The key performance indicator (KPI) of the insertion order. This is represented as referred to as the "Goal" in the Display & Video 360 interface.
+    "kpiAlgorithmId": "A String", # Optional. Custom Bidding Algorithm ID associated with KPI_CUSTOM_IMPRESSION_VALUE_OVER_COST. This field is ignored if the proper KPI is not selected.
+    "kpiAmountMicros": "A String", # The goal amount, in micros of the advertiser's currency. Applicable when kpi_type is one of: * `KPI_TYPE_CPM` * `KPI_TYPE_CPC` * `KPI_TYPE_CPA` * `KPI_TYPE_CPIAVC` * `KPI_TYPE_VCPM` For example: 1500000 represents 1.5 standard units of the currency.
+    "kpiPercentageMicros": "A String", # The decimal representation of the goal percentage in micros. Applicable when kpi_type is one of: * `KPI_TYPE_CTR` * `KPI_TYPE_VIEWABILITY` * `KPI_TYPE_CLICK_CVR` * `KPI_TYPE_IMPRESSION_CVR` * `KPI_TYPE_VTR` * `KPI_TYPE_AUDIO_COMPLETION_RATE` * `KPI_TYPE_VIDEO_COMPLETION_RATE` For example: 70000 represents 7% (decimal 0.07).
+    "kpiString": "A String", # A KPI string, which can be empty. Must be UTF-8 encoded with a length of no more than 100 characters. Applicable when kpi_type is `KPI_TYPE_OTHER`.
+    "kpiType": "A String", # Required. The type of KPI.
+  },
+  "name": "A String", # Output only. The resource name of the insertion order.
+  "optimizationObjective": "A String", # Optional. Required. The optimization objective of the insertion order.
+  "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the insertion order. pacing_type `PACING_TYPE_ASAP` is not compatible with pacing_period `PACING_PERIOD_FLIGHT`.
+    "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0.
+    "dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of advertiser's currency. Applicable when the budget is currency based. Must be greater than 0. For example, for 1.5 standard unit of the currency, set this field to 1500000. The value assigned will be rounded to whole billable units for the relevant currency by the following rules: any positive value less than a single billable unit will be rounded up to one billable unit and any value larger than a single billable unit will be rounded down to the nearest billable value. For example, if the currency's billable unit is 0.01, and this field is set to 10257770, it will round down to 10250000, a value of 10.25. If set to 505, it will round up to 10000, a value of 0.01.
+    "pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent. When automatic budget allocation is enabled at the insertion order via automationType, this field is output only and defaults to `PACING_PERIOD_FLIGHT`.
+    "pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be spent across the pacing_period. `PACING_TYPE_ASAP` is not compatible with pacing_period `PACING_PERIOD_FLIGHT` for insertion orders.
+  },
+  "partnerCosts": [ # Optional. The partner costs associated with the insertion order. If absent or empty in CreateInsertionOrder method, the newly created insertion order will inherit partner costs from the partner settings.
+    { # Settings that control a partner cost. A partner cost is any type of expense involved in running a campaign, other than the costs of purchasing impressions (which is called the media cost) and using third-party audience segment data (data fee). Some examples of partner costs include the fees for using DV360, a third-party ad server, or a third-party ad serving verification service.
+      "costType": "A String", # Required. The type of the partner cost.
+      "feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency. Applicable when the fee_type is `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0. For example, for 1.5 standard unit of the advertiser's currency, set this field to 1500000.
+      "feePercentageMillis": "A String", # The media fee percentage in millis (1/1000 of a percent). Applicable when the fee_type is `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0. For example: 100 represents 0.1%.
+      "feeType": "A String", # Required. The fee type for this partner cost.
+      "invoiceType": "A String", # The invoice type for this partner cost. * Required when cost_type is one of: - `PARTNER_COST_TYPE_ADLOOX` - `PARTNER_COST_TYPE_DOUBLE_VERIFY` - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`. * Output only for other types.
+    },
+  ],
+  "reservationType": "A String", # Output only. The reservation type of the insertion order.
+  "updateTime": "A String", # Output only. The timestamp when the insertion order was last updated. Assigned by the system.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single insertion order.
+  "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to.
+  "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set.
+    "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
+      "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
+    },
+    "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, when performance_goal_type is one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , the line_item_type of the insertion order line items must be either: * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , and when performance_goal_type is either: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` the line_item_type of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+      "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).
+      "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.
+      "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.
+      "raiseBidForDeals": True or False, # Whether the strategy takes deal floor prices into account.
+    },
+    "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity.
+      "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).
+      "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency.
+      "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value.
+      "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`.
+    },
+    "youtubeAndPartnersBid": { # Settings that control the bid strategy for YouTube and Partners resources. # A bid strategy used by YouTube and Partners resources. It can only be used for a YouTube and Partners line item or ad group entity.
+      "adGroupEffectiveTargetCpaSource": "A String", # Output only. Source of the effective target CPA value for ad group.
+      "adGroupEffectiveTargetCpaValue": "A String", # Output only. The effective target CPA for ad group, in micros of advertiser's currency.
+      "type": "A String", # The type of the bidding strategy.
+      "value": "A String", # The value used by the bidding strategy. When the bidding strategy is assigned at the line item level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` When the bidding strategy is assigned at the ad group level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPV` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` If not using an applicable strategy, the value of this field will be 0.
+    },
+  },
+  "budget": { # Settings that control how insertion order budget is allocated. # Required. The budget allocation settings of the insertion order.
+    "automationType": "A String", # Optional. The type of automation used to manage bid and budget for the insertion order. If this field is unspecified in creation, the value defaults to `INSERTION_ORDER_AUTOMATION_TYPE_NONE`.
+    "budgetSegments": [ # Required. The list of budget segments. Use a budget segment to specify a specific budget for a given period of time an insertion order is running.
+      { # Settings that control the budget of a single budget segment.
+        "budgetAmountMicros": "A String", # Required. The budget amount the insertion order will spend for the given date_range. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency.
+        "campaignBudgetId": "A String", # Optional. The budget_id of the campaign budget that this insertion order budget segment is a part of.
+        "dateRange": { # A date range. # Required. The start and end date settings of the budget segment. They are resolved relative to the parent advertiser's time zone. * When creating a new budget segment, both `start_date` and `end_date` must be in the future. * An existing budget segment with a `start_date` in the past has a mutable `end_date` but an immutable `start_date`. * `end_date` must be the `start_date` or later, both before the year 2037.
+          "endDate": { # 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 # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
+            "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.
+          },
+          "startDate": { # 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 # The lower bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
+            "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.
+          },
+        },
+        "description": "A String", # Optional. The budget segment description. It can be used to enter Purchase Order information for each budget segment and have that information printed on the invoices. Must be UTF-8 encoded.
+      },
+    ],
+    "budgetUnit": "A String", # Required. Immutable. The budget unit specifies whether the budget is currency based or impression based.
+  },
+  "campaignId": "A String", # Required. Immutable. The unique ID of the campaign that the insertion order belongs to.
+  "displayName": "A String", # Required. The display name of the insertion order. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "entityStatus": "A String", # Required. Controls whether or not the insertion order can spend its budget and bid on inventory. * For CreateInsertionOrder method, only `ENTITY_STATUS_DRAFT` is allowed. To activate an insertion order, use UpdateInsertionOrder method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * An insertion order cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * An insertion order cannot be set to `ENTITY_STATUS_ACTIVE` if its parent campaign is not active.
+  "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency capping setting of the insertion order. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap)
+    "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set.
+    "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set.
+    "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).
+    "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).
+    "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable.
+  },
+  "insertionOrderId": "A String", # Output only. The unique ID of the insertion order. Assigned by the system.
+  "insertionOrderType": "A String", # Optional. The type of insertion order. If this field is unspecified in creation, the value defaults to `RTB`.
+  "integrationDetails": { # Integration details of an entry. # Optional. Additional integration details of the insertion order.
+    "details": "A String", # Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters.
+    "integrationCode": "A String", # An external identifier to be associated with the entry. The integration code will show up together with the entry in many places in the system, for example, reporting. Must be UTF-8 encoded with a length of no more than 500 characters.
+  },
+  "kpi": { # Settings that control the key performance indicator, or KPI, of an insertion order. # Required. The key performance indicator (KPI) of the insertion order. This is represented as referred to as the "Goal" in the Display & Video 360 interface.
+    "kpiAlgorithmId": "A String", # Optional. Custom Bidding Algorithm ID associated with KPI_CUSTOM_IMPRESSION_VALUE_OVER_COST. This field is ignored if the proper KPI is not selected.
+    "kpiAmountMicros": "A String", # The goal amount, in micros of the advertiser's currency. Applicable when kpi_type is one of: * `KPI_TYPE_CPM` * `KPI_TYPE_CPC` * `KPI_TYPE_CPA` * `KPI_TYPE_CPIAVC` * `KPI_TYPE_VCPM` For example: 1500000 represents 1.5 standard units of the currency.
+    "kpiPercentageMicros": "A String", # The decimal representation of the goal percentage in micros. Applicable when kpi_type is one of: * `KPI_TYPE_CTR` * `KPI_TYPE_VIEWABILITY` * `KPI_TYPE_CLICK_CVR` * `KPI_TYPE_IMPRESSION_CVR` * `KPI_TYPE_VTR` * `KPI_TYPE_AUDIO_COMPLETION_RATE` * `KPI_TYPE_VIDEO_COMPLETION_RATE` For example: 70000 represents 7% (decimal 0.07).
+    "kpiString": "A String", # A KPI string, which can be empty. Must be UTF-8 encoded with a length of no more than 100 characters. Applicable when kpi_type is `KPI_TYPE_OTHER`.
+    "kpiType": "A String", # Required. The type of KPI.
+  },
+  "name": "A String", # Output only. The resource name of the insertion order.
+  "optimizationObjective": "A String", # Optional. Required. The optimization objective of the insertion order.
+  "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the insertion order. pacing_type `PACING_TYPE_ASAP` is not compatible with pacing_period `PACING_PERIOD_FLIGHT`.
+    "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0.
+    "dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of advertiser's currency. Applicable when the budget is currency based. Must be greater than 0. For example, for 1.5 standard unit of the currency, set this field to 1500000. The value assigned will be rounded to whole billable units for the relevant currency by the following rules: any positive value less than a single billable unit will be rounded up to one billable unit and any value larger than a single billable unit will be rounded down to the nearest billable value. For example, if the currency's billable unit is 0.01, and this field is set to 10257770, it will round down to 10250000, a value of 10.25. If set to 505, it will round up to 10000, a value of 0.01.
+    "pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent. When automatic budget allocation is enabled at the insertion order via automationType, this field is output only and defaults to `PACING_PERIOD_FLIGHT`.
+    "pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be spent across the pacing_period. `PACING_TYPE_ASAP` is not compatible with pacing_period `PACING_PERIOD_FLIGHT` for insertion orders.
+  },
+  "partnerCosts": [ # Optional. The partner costs associated with the insertion order. If absent or empty in CreateInsertionOrder method, the newly created insertion order will inherit partner costs from the partner settings.
+    { # Settings that control a partner cost. A partner cost is any type of expense involved in running a campaign, other than the costs of purchasing impressions (which is called the media cost) and using third-party audience segment data (data fee). Some examples of partner costs include the fees for using DV360, a third-party ad server, or a third-party ad serving verification service.
+      "costType": "A String", # Required. The type of the partner cost.
+      "feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency. Applicable when the fee_type is `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0. For example, for 1.5 standard unit of the advertiser's currency, set this field to 1500000.
+      "feePercentageMillis": "A String", # The media fee percentage in millis (1/1000 of a percent). Applicable when the fee_type is `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0. For example: 100 represents 0.1%.
+      "feeType": "A String", # Required. The fee type for this partner cost.
+      "invoiceType": "A String", # The invoice type for this partner cost. * Required when cost_type is one of: - `PARTNER_COST_TYPE_ADLOOX` - `PARTNER_COST_TYPE_DOUBLE_VERIFY` - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`. * Output only for other types.
+    },
+  ],
+  "reservationType": "A String", # Output only. The reservation type of the insertion order.
+  "updateTime": "A String", # Output only. The timestamp when the insertion order was last updated. Assigned by the system.
+}
+
+ +
+ delete(advertiserId, insertionOrderId, x__xgafv=None) +
Deletes an insertion order. Returns error code `NOT_FOUND` if the insertion order does not exist. The insertion order should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it.
+
+Args:
+  advertiserId: string, The ID of the advertiser this insertion order belongs to. (required)
+  insertionOrderId: string, The ID of the insertion order 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(advertiserId, insertionOrderId, x__xgafv=None) +
Gets an insertion order. Returns error code `NOT_FOUND` if the insertion order does not exist.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser this insertion order belongs to. (required)
+  insertionOrderId: string, Required. The ID of the insertion order to fetch. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single insertion order.
+  "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to.
+  "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set.
+    "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
+      "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
+    },
+    "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, when performance_goal_type is one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , the line_item_type of the insertion order line items must be either: * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , and when performance_goal_type is either: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` the line_item_type of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+      "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).
+      "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.
+      "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.
+      "raiseBidForDeals": True or False, # Whether the strategy takes deal floor prices into account.
+    },
+    "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity.
+      "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).
+      "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency.
+      "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value.
+      "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`.
+    },
+    "youtubeAndPartnersBid": { # Settings that control the bid strategy for YouTube and Partners resources. # A bid strategy used by YouTube and Partners resources. It can only be used for a YouTube and Partners line item or ad group entity.
+      "adGroupEffectiveTargetCpaSource": "A String", # Output only. Source of the effective target CPA value for ad group.
+      "adGroupEffectiveTargetCpaValue": "A String", # Output only. The effective target CPA for ad group, in micros of advertiser's currency.
+      "type": "A String", # The type of the bidding strategy.
+      "value": "A String", # The value used by the bidding strategy. When the bidding strategy is assigned at the line item level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` When the bidding strategy is assigned at the ad group level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPV` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` If not using an applicable strategy, the value of this field will be 0.
+    },
+  },
+  "budget": { # Settings that control how insertion order budget is allocated. # Required. The budget allocation settings of the insertion order.
+    "automationType": "A String", # Optional. The type of automation used to manage bid and budget for the insertion order. If this field is unspecified in creation, the value defaults to `INSERTION_ORDER_AUTOMATION_TYPE_NONE`.
+    "budgetSegments": [ # Required. The list of budget segments. Use a budget segment to specify a specific budget for a given period of time an insertion order is running.
+      { # Settings that control the budget of a single budget segment.
+        "budgetAmountMicros": "A String", # Required. The budget amount the insertion order will spend for the given date_range. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency.
+        "campaignBudgetId": "A String", # Optional. The budget_id of the campaign budget that this insertion order budget segment is a part of.
+        "dateRange": { # A date range. # Required. The start and end date settings of the budget segment. They are resolved relative to the parent advertiser's time zone. * When creating a new budget segment, both `start_date` and `end_date` must be in the future. * An existing budget segment with a `start_date` in the past has a mutable `end_date` but an immutable `start_date`. * `end_date` must be the `start_date` or later, both before the year 2037.
+          "endDate": { # 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 # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
+            "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.
+          },
+          "startDate": { # 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 # The lower bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
+            "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.
+          },
+        },
+        "description": "A String", # Optional. The budget segment description. It can be used to enter Purchase Order information for each budget segment and have that information printed on the invoices. Must be UTF-8 encoded.
+      },
+    ],
+    "budgetUnit": "A String", # Required. Immutable. The budget unit specifies whether the budget is currency based or impression based.
+  },
+  "campaignId": "A String", # Required. Immutable. The unique ID of the campaign that the insertion order belongs to.
+  "displayName": "A String", # Required. The display name of the insertion order. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "entityStatus": "A String", # Required. Controls whether or not the insertion order can spend its budget and bid on inventory. * For CreateInsertionOrder method, only `ENTITY_STATUS_DRAFT` is allowed. To activate an insertion order, use UpdateInsertionOrder method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * An insertion order cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * An insertion order cannot be set to `ENTITY_STATUS_ACTIVE` if its parent campaign is not active.
+  "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency capping setting of the insertion order. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap)
+    "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set.
+    "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set.
+    "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).
+    "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).
+    "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable.
+  },
+  "insertionOrderId": "A String", # Output only. The unique ID of the insertion order. Assigned by the system.
+  "insertionOrderType": "A String", # Optional. The type of insertion order. If this field is unspecified in creation, the value defaults to `RTB`.
+  "integrationDetails": { # Integration details of an entry. # Optional. Additional integration details of the insertion order.
+    "details": "A String", # Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters.
+    "integrationCode": "A String", # An external identifier to be associated with the entry. The integration code will show up together with the entry in many places in the system, for example, reporting. Must be UTF-8 encoded with a length of no more than 500 characters.
+  },
+  "kpi": { # Settings that control the key performance indicator, or KPI, of an insertion order. # Required. The key performance indicator (KPI) of the insertion order. This is represented as referred to as the "Goal" in the Display & Video 360 interface.
+    "kpiAlgorithmId": "A String", # Optional. Custom Bidding Algorithm ID associated with KPI_CUSTOM_IMPRESSION_VALUE_OVER_COST. This field is ignored if the proper KPI is not selected.
+    "kpiAmountMicros": "A String", # The goal amount, in micros of the advertiser's currency. Applicable when kpi_type is one of: * `KPI_TYPE_CPM` * `KPI_TYPE_CPC` * `KPI_TYPE_CPA` * `KPI_TYPE_CPIAVC` * `KPI_TYPE_VCPM` For example: 1500000 represents 1.5 standard units of the currency.
+    "kpiPercentageMicros": "A String", # The decimal representation of the goal percentage in micros. Applicable when kpi_type is one of: * `KPI_TYPE_CTR` * `KPI_TYPE_VIEWABILITY` * `KPI_TYPE_CLICK_CVR` * `KPI_TYPE_IMPRESSION_CVR` * `KPI_TYPE_VTR` * `KPI_TYPE_AUDIO_COMPLETION_RATE` * `KPI_TYPE_VIDEO_COMPLETION_RATE` For example: 70000 represents 7% (decimal 0.07).
+    "kpiString": "A String", # A KPI string, which can be empty. Must be UTF-8 encoded with a length of no more than 100 characters. Applicable when kpi_type is `KPI_TYPE_OTHER`.
+    "kpiType": "A String", # Required. The type of KPI.
+  },
+  "name": "A String", # Output only. The resource name of the insertion order.
+  "optimizationObjective": "A String", # Optional. Required. The optimization objective of the insertion order.
+  "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the insertion order. pacing_type `PACING_TYPE_ASAP` is not compatible with pacing_period `PACING_PERIOD_FLIGHT`.
+    "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0.
+    "dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of advertiser's currency. Applicable when the budget is currency based. Must be greater than 0. For example, for 1.5 standard unit of the currency, set this field to 1500000. The value assigned will be rounded to whole billable units for the relevant currency by the following rules: any positive value less than a single billable unit will be rounded up to one billable unit and any value larger than a single billable unit will be rounded down to the nearest billable value. For example, if the currency's billable unit is 0.01, and this field is set to 10257770, it will round down to 10250000, a value of 10.25. If set to 505, it will round up to 10000, a value of 0.01.
+    "pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent. When automatic budget allocation is enabled at the insertion order via automationType, this field is output only and defaults to `PACING_PERIOD_FLIGHT`.
+    "pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be spent across the pacing_period. `PACING_TYPE_ASAP` is not compatible with pacing_period `PACING_PERIOD_FLIGHT` for insertion orders.
+  },
+  "partnerCosts": [ # Optional. The partner costs associated with the insertion order. If absent or empty in CreateInsertionOrder method, the newly created insertion order will inherit partner costs from the partner settings.
+    { # Settings that control a partner cost. A partner cost is any type of expense involved in running a campaign, other than the costs of purchasing impressions (which is called the media cost) and using third-party audience segment data (data fee). Some examples of partner costs include the fees for using DV360, a third-party ad server, or a third-party ad serving verification service.
+      "costType": "A String", # Required. The type of the partner cost.
+      "feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency. Applicable when the fee_type is `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0. For example, for 1.5 standard unit of the advertiser's currency, set this field to 1500000.
+      "feePercentageMillis": "A String", # The media fee percentage in millis (1/1000 of a percent). Applicable when the fee_type is `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0. For example: 100 represents 0.1%.
+      "feeType": "A String", # Required. The fee type for this partner cost.
+      "invoiceType": "A String", # The invoice type for this partner cost. * Required when cost_type is one of: - `PARTNER_COST_TYPE_ADLOOX` - `PARTNER_COST_TYPE_DOUBLE_VERIFY` - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`. * Output only for other types.
+    },
+  ],
+  "reservationType": "A String", # Output only. The reservation type of the insertion order.
+  "updateTime": "A String", # Output only. The timestamp when the insertion order was last updated. Assigned by the system.
+}
+
+ +
+ list(advertiserId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists insertion orders in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, insertion orders with `ENTITY_STATUS_ARCHIVED` will not be included in the results.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser to list insertion orders for. (required)
+  filter: string, Allows filtering by insertion order fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All insertion orders under a campaign: `campaignId="1234"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` insertion orders under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")` * All insertion orders with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<="2020-11-04T18:54:47Z"` * All insertion orders with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
+  orderBy: string, Field by which to sort the list. Acceptable values are: * "displayName" (default) * "entityStatus" * "updateTime" The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.
+  pageSize: integer, Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
+  pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInsertionOrders` method. If not specified, the first page of results 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:
+
+    {
+  "insertionOrders": [ # The list of insertion orders. This list will be absent if empty.
+    { # A single insertion order.
+      "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to.
+      "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set.
+        "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
+          "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
+        },
+        "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, when performance_goal_type is one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , the line_item_type of the insertion order line items must be either: * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , and when performance_goal_type is either: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` the line_item_type of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+          "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).
+          "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.
+          "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.
+          "raiseBidForDeals": True or False, # Whether the strategy takes deal floor prices into account.
+        },
+        "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity.
+          "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).
+          "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency.
+          "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value.
+          "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`.
+        },
+        "youtubeAndPartnersBid": { # Settings that control the bid strategy for YouTube and Partners resources. # A bid strategy used by YouTube and Partners resources. It can only be used for a YouTube and Partners line item or ad group entity.
+          "adGroupEffectiveTargetCpaSource": "A String", # Output only. Source of the effective target CPA value for ad group.
+          "adGroupEffectiveTargetCpaValue": "A String", # Output only. The effective target CPA for ad group, in micros of advertiser's currency.
+          "type": "A String", # The type of the bidding strategy.
+          "value": "A String", # The value used by the bidding strategy. When the bidding strategy is assigned at the line item level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` When the bidding strategy is assigned at the ad group level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPV` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` If not using an applicable strategy, the value of this field will be 0.
+        },
+      },
+      "budget": { # Settings that control how insertion order budget is allocated. # Required. The budget allocation settings of the insertion order.
+        "automationType": "A String", # Optional. The type of automation used to manage bid and budget for the insertion order. If this field is unspecified in creation, the value defaults to `INSERTION_ORDER_AUTOMATION_TYPE_NONE`.
+        "budgetSegments": [ # Required. The list of budget segments. Use a budget segment to specify a specific budget for a given period of time an insertion order is running.
+          { # Settings that control the budget of a single budget segment.
+            "budgetAmountMicros": "A String", # Required. The budget amount the insertion order will spend for the given date_range. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency.
+            "campaignBudgetId": "A String", # Optional. The budget_id of the campaign budget that this insertion order budget segment is a part of.
+            "dateRange": { # A date range. # Required. The start and end date settings of the budget segment. They are resolved relative to the parent advertiser's time zone. * When creating a new budget segment, both `start_date` and `end_date` must be in the future. * An existing budget segment with a `start_date` in the past has a mutable `end_date` but an immutable `start_date`. * `end_date` must be the `start_date` or later, both before the year 2037.
+              "endDate": { # 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 # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
+                "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.
+              },
+              "startDate": { # 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 # The lower bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
+                "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.
+              },
+            },
+            "description": "A String", # Optional. The budget segment description. It can be used to enter Purchase Order information for each budget segment and have that information printed on the invoices. Must be UTF-8 encoded.
+          },
+        ],
+        "budgetUnit": "A String", # Required. Immutable. The budget unit specifies whether the budget is currency based or impression based.
+      },
+      "campaignId": "A String", # Required. Immutable. The unique ID of the campaign that the insertion order belongs to.
+      "displayName": "A String", # Required. The display name of the insertion order. Must be UTF-8 encoded with a maximum size of 240 bytes.
+      "entityStatus": "A String", # Required. Controls whether or not the insertion order can spend its budget and bid on inventory. * For CreateInsertionOrder method, only `ENTITY_STATUS_DRAFT` is allowed. To activate an insertion order, use UpdateInsertionOrder method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * An insertion order cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * An insertion order cannot be set to `ENTITY_STATUS_ACTIVE` if its parent campaign is not active.
+      "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency capping setting of the insertion order. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap)
+        "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set.
+        "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set.
+        "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).
+        "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).
+        "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable.
+      },
+      "insertionOrderId": "A String", # Output only. The unique ID of the insertion order. Assigned by the system.
+      "insertionOrderType": "A String", # Optional. The type of insertion order. If this field is unspecified in creation, the value defaults to `RTB`.
+      "integrationDetails": { # Integration details of an entry. # Optional. Additional integration details of the insertion order.
+        "details": "A String", # Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters.
+        "integrationCode": "A String", # An external identifier to be associated with the entry. The integration code will show up together with the entry in many places in the system, for example, reporting. Must be UTF-8 encoded with a length of no more than 500 characters.
+      },
+      "kpi": { # Settings that control the key performance indicator, or KPI, of an insertion order. # Required. The key performance indicator (KPI) of the insertion order. This is represented as referred to as the "Goal" in the Display & Video 360 interface.
+        "kpiAlgorithmId": "A String", # Optional. Custom Bidding Algorithm ID associated with KPI_CUSTOM_IMPRESSION_VALUE_OVER_COST. This field is ignored if the proper KPI is not selected.
+        "kpiAmountMicros": "A String", # The goal amount, in micros of the advertiser's currency. Applicable when kpi_type is one of: * `KPI_TYPE_CPM` * `KPI_TYPE_CPC` * `KPI_TYPE_CPA` * `KPI_TYPE_CPIAVC` * `KPI_TYPE_VCPM` For example: 1500000 represents 1.5 standard units of the currency.
+        "kpiPercentageMicros": "A String", # The decimal representation of the goal percentage in micros. Applicable when kpi_type is one of: * `KPI_TYPE_CTR` * `KPI_TYPE_VIEWABILITY` * `KPI_TYPE_CLICK_CVR` * `KPI_TYPE_IMPRESSION_CVR` * `KPI_TYPE_VTR` * `KPI_TYPE_AUDIO_COMPLETION_RATE` * `KPI_TYPE_VIDEO_COMPLETION_RATE` For example: 70000 represents 7% (decimal 0.07).
+        "kpiString": "A String", # A KPI string, which can be empty. Must be UTF-8 encoded with a length of no more than 100 characters. Applicable when kpi_type is `KPI_TYPE_OTHER`.
+        "kpiType": "A String", # Required. The type of KPI.
+      },
+      "name": "A String", # Output only. The resource name of the insertion order.
+      "optimizationObjective": "A String", # Optional. Required. The optimization objective of the insertion order.
+      "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the insertion order. pacing_type `PACING_TYPE_ASAP` is not compatible with pacing_period `PACING_PERIOD_FLIGHT`.
+        "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0.
+        "dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of advertiser's currency. Applicable when the budget is currency based. Must be greater than 0. For example, for 1.5 standard unit of the currency, set this field to 1500000. The value assigned will be rounded to whole billable units for the relevant currency by the following rules: any positive value less than a single billable unit will be rounded up to one billable unit and any value larger than a single billable unit will be rounded down to the nearest billable value. For example, if the currency's billable unit is 0.01, and this field is set to 10257770, it will round down to 10250000, a value of 10.25. If set to 505, it will round up to 10000, a value of 0.01.
+        "pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent. When automatic budget allocation is enabled at the insertion order via automationType, this field is output only and defaults to `PACING_PERIOD_FLIGHT`.
+        "pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be spent across the pacing_period. `PACING_TYPE_ASAP` is not compatible with pacing_period `PACING_PERIOD_FLIGHT` for insertion orders.
+      },
+      "partnerCosts": [ # Optional. The partner costs associated with the insertion order. If absent or empty in CreateInsertionOrder method, the newly created insertion order will inherit partner costs from the partner settings.
+        { # Settings that control a partner cost. A partner cost is any type of expense involved in running a campaign, other than the costs of purchasing impressions (which is called the media cost) and using third-party audience segment data (data fee). Some examples of partner costs include the fees for using DV360, a third-party ad server, or a third-party ad serving verification service.
+          "costType": "A String", # Required. The type of the partner cost.
+          "feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency. Applicable when the fee_type is `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0. For example, for 1.5 standard unit of the advertiser's currency, set this field to 1500000.
+          "feePercentageMillis": "A String", # The media fee percentage in millis (1/1000 of a percent). Applicable when the fee_type is `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0. For example: 100 represents 0.1%.
+          "feeType": "A String", # Required. The fee type for this partner cost.
+          "invoiceType": "A String", # The invoice type for this partner cost. * Required when cost_type is one of: - `PARTNER_COST_TYPE_ADLOOX` - `PARTNER_COST_TYPE_DOUBLE_VERIFY` - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`. * Output only for other types.
+        },
+      ],
+      "reservationType": "A String", # Output only. The reservation type of the insertion order.
+      "updateTime": "A String", # Output only. The timestamp when the insertion order was last updated. Assigned by the system.
+    },
+  ],
+  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListInsertionOrders` method to retrieve the next page of results.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(advertiserId, insertionOrderId, body=None, updateMask=None, x__xgafv=None) +
Updates an existing insertion order. Returns the updated insertion order if successful.
+
+Args:
+  advertiserId: string, Output only. The unique ID of the advertiser the insertion order belongs to. (required)
+  insertionOrderId: string, Output only. The unique ID of the insertion order. Assigned by the system. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A single insertion order.
+  "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to.
+  "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set.
+    "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
+      "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
+    },
+    "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, when performance_goal_type is one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , the line_item_type of the insertion order line items must be either: * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , and when performance_goal_type is either: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` the line_item_type of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+      "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).
+      "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.
+      "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.
+      "raiseBidForDeals": True or False, # Whether the strategy takes deal floor prices into account.
+    },
+    "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity.
+      "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).
+      "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency.
+      "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value.
+      "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`.
+    },
+    "youtubeAndPartnersBid": { # Settings that control the bid strategy for YouTube and Partners resources. # A bid strategy used by YouTube and Partners resources. It can only be used for a YouTube and Partners line item or ad group entity.
+      "adGroupEffectiveTargetCpaSource": "A String", # Output only. Source of the effective target CPA value for ad group.
+      "adGroupEffectiveTargetCpaValue": "A String", # Output only. The effective target CPA for ad group, in micros of advertiser's currency.
+      "type": "A String", # The type of the bidding strategy.
+      "value": "A String", # The value used by the bidding strategy. When the bidding strategy is assigned at the line item level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` When the bidding strategy is assigned at the ad group level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPV` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` If not using an applicable strategy, the value of this field will be 0.
+    },
+  },
+  "budget": { # Settings that control how insertion order budget is allocated. # Required. The budget allocation settings of the insertion order.
+    "automationType": "A String", # Optional. The type of automation used to manage bid and budget for the insertion order. If this field is unspecified in creation, the value defaults to `INSERTION_ORDER_AUTOMATION_TYPE_NONE`.
+    "budgetSegments": [ # Required. The list of budget segments. Use a budget segment to specify a specific budget for a given period of time an insertion order is running.
+      { # Settings that control the budget of a single budget segment.
+        "budgetAmountMicros": "A String", # Required. The budget amount the insertion order will spend for the given date_range. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency.
+        "campaignBudgetId": "A String", # Optional. The budget_id of the campaign budget that this insertion order budget segment is a part of.
+        "dateRange": { # A date range. # Required. The start and end date settings of the budget segment. They are resolved relative to the parent advertiser's time zone. * When creating a new budget segment, both `start_date` and `end_date` must be in the future. * An existing budget segment with a `start_date` in the past has a mutable `end_date` but an immutable `start_date`. * `end_date` must be the `start_date` or later, both before the year 2037.
+          "endDate": { # 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 # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
+            "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.
+          },
+          "startDate": { # 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 # The lower bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
+            "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.
+          },
+        },
+        "description": "A String", # Optional. The budget segment description. It can be used to enter Purchase Order information for each budget segment and have that information printed on the invoices. Must be UTF-8 encoded.
+      },
+    ],
+    "budgetUnit": "A String", # Required. Immutable. The budget unit specifies whether the budget is currency based or impression based.
+  },
+  "campaignId": "A String", # Required. Immutable. The unique ID of the campaign that the insertion order belongs to.
+  "displayName": "A String", # Required. The display name of the insertion order. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "entityStatus": "A String", # Required. Controls whether or not the insertion order can spend its budget and bid on inventory. * For CreateInsertionOrder method, only `ENTITY_STATUS_DRAFT` is allowed. To activate an insertion order, use UpdateInsertionOrder method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * An insertion order cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * An insertion order cannot be set to `ENTITY_STATUS_ACTIVE` if its parent campaign is not active.
+  "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency capping setting of the insertion order. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap)
+    "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set.
+    "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set.
+    "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).
+    "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).
+    "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable.
+  },
+  "insertionOrderId": "A String", # Output only. The unique ID of the insertion order. Assigned by the system.
+  "insertionOrderType": "A String", # Optional. The type of insertion order. If this field is unspecified in creation, the value defaults to `RTB`.
+  "integrationDetails": { # Integration details of an entry. # Optional. Additional integration details of the insertion order.
+    "details": "A String", # Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters.
+    "integrationCode": "A String", # An external identifier to be associated with the entry. The integration code will show up together with the entry in many places in the system, for example, reporting. Must be UTF-8 encoded with a length of no more than 500 characters.
+  },
+  "kpi": { # Settings that control the key performance indicator, or KPI, of an insertion order. # Required. The key performance indicator (KPI) of the insertion order. This is represented as referred to as the "Goal" in the Display & Video 360 interface.
+    "kpiAlgorithmId": "A String", # Optional. Custom Bidding Algorithm ID associated with KPI_CUSTOM_IMPRESSION_VALUE_OVER_COST. This field is ignored if the proper KPI is not selected.
+    "kpiAmountMicros": "A String", # The goal amount, in micros of the advertiser's currency. Applicable when kpi_type is one of: * `KPI_TYPE_CPM` * `KPI_TYPE_CPC` * `KPI_TYPE_CPA` * `KPI_TYPE_CPIAVC` * `KPI_TYPE_VCPM` For example: 1500000 represents 1.5 standard units of the currency.
+    "kpiPercentageMicros": "A String", # The decimal representation of the goal percentage in micros. Applicable when kpi_type is one of: * `KPI_TYPE_CTR` * `KPI_TYPE_VIEWABILITY` * `KPI_TYPE_CLICK_CVR` * `KPI_TYPE_IMPRESSION_CVR` * `KPI_TYPE_VTR` * `KPI_TYPE_AUDIO_COMPLETION_RATE` * `KPI_TYPE_VIDEO_COMPLETION_RATE` For example: 70000 represents 7% (decimal 0.07).
+    "kpiString": "A String", # A KPI string, which can be empty. Must be UTF-8 encoded with a length of no more than 100 characters. Applicable when kpi_type is `KPI_TYPE_OTHER`.
+    "kpiType": "A String", # Required. The type of KPI.
+  },
+  "name": "A String", # Output only. The resource name of the insertion order.
+  "optimizationObjective": "A String", # Optional. Required. The optimization objective of the insertion order.
+  "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the insertion order. pacing_type `PACING_TYPE_ASAP` is not compatible with pacing_period `PACING_PERIOD_FLIGHT`.
+    "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0.
+    "dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of advertiser's currency. Applicable when the budget is currency based. Must be greater than 0. For example, for 1.5 standard unit of the currency, set this field to 1500000. The value assigned will be rounded to whole billable units for the relevant currency by the following rules: any positive value less than a single billable unit will be rounded up to one billable unit and any value larger than a single billable unit will be rounded down to the nearest billable value. For example, if the currency's billable unit is 0.01, and this field is set to 10257770, it will round down to 10250000, a value of 10.25. If set to 505, it will round up to 10000, a value of 0.01.
+    "pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent. When automatic budget allocation is enabled at the insertion order via automationType, this field is output only and defaults to `PACING_PERIOD_FLIGHT`.
+    "pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be spent across the pacing_period. `PACING_TYPE_ASAP` is not compatible with pacing_period `PACING_PERIOD_FLIGHT` for insertion orders.
+  },
+  "partnerCosts": [ # Optional. The partner costs associated with the insertion order. If absent or empty in CreateInsertionOrder method, the newly created insertion order will inherit partner costs from the partner settings.
+    { # Settings that control a partner cost. A partner cost is any type of expense involved in running a campaign, other than the costs of purchasing impressions (which is called the media cost) and using third-party audience segment data (data fee). Some examples of partner costs include the fees for using DV360, a third-party ad server, or a third-party ad serving verification service.
+      "costType": "A String", # Required. The type of the partner cost.
+      "feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency. Applicable when the fee_type is `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0. For example, for 1.5 standard unit of the advertiser's currency, set this field to 1500000.
+      "feePercentageMillis": "A String", # The media fee percentage in millis (1/1000 of a percent). Applicable when the fee_type is `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0. For example: 100 represents 0.1%.
+      "feeType": "A String", # Required. The fee type for this partner cost.
+      "invoiceType": "A String", # The invoice type for this partner cost. * Required when cost_type is one of: - `PARTNER_COST_TYPE_ADLOOX` - `PARTNER_COST_TYPE_DOUBLE_VERIFY` - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`. * Output only for other types.
+    },
+  ],
+  "reservationType": "A String", # Output only. The reservation type of the insertion order.
+  "updateTime": "A String", # Output only. The timestamp when the insertion order was last updated. Assigned by the system.
+}
+
+  updateMask: string, Required. The mask to control which fields to update.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single insertion order.
+  "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to.
+  "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set.
+    "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
+      "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
+    },
+    "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, when performance_goal_type is one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , the line_item_type of the insertion order line items must be either: * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , and when performance_goal_type is either: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` the line_item_type of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+      "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).
+      "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.
+      "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.
+      "raiseBidForDeals": True or False, # Whether the strategy takes deal floor prices into account.
+    },
+    "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity.
+      "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).
+      "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency.
+      "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value.
+      "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`.
+    },
+    "youtubeAndPartnersBid": { # Settings that control the bid strategy for YouTube and Partners resources. # A bid strategy used by YouTube and Partners resources. It can only be used for a YouTube and Partners line item or ad group entity.
+      "adGroupEffectiveTargetCpaSource": "A String", # Output only. Source of the effective target CPA value for ad group.
+      "adGroupEffectiveTargetCpaValue": "A String", # Output only. The effective target CPA for ad group, in micros of advertiser's currency.
+      "type": "A String", # The type of the bidding strategy.
+      "value": "A String", # The value used by the bidding strategy. When the bidding strategy is assigned at the line item level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` When the bidding strategy is assigned at the ad group level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPV` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` If not using an applicable strategy, the value of this field will be 0.
+    },
+  },
+  "budget": { # Settings that control how insertion order budget is allocated. # Required. The budget allocation settings of the insertion order.
+    "automationType": "A String", # Optional. The type of automation used to manage bid and budget for the insertion order. If this field is unspecified in creation, the value defaults to `INSERTION_ORDER_AUTOMATION_TYPE_NONE`.
+    "budgetSegments": [ # Required. The list of budget segments. Use a budget segment to specify a specific budget for a given period of time an insertion order is running.
+      { # Settings that control the budget of a single budget segment.
+        "budgetAmountMicros": "A String", # Required. The budget amount the insertion order will spend for the given date_range. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency.
+        "campaignBudgetId": "A String", # Optional. The budget_id of the campaign budget that this insertion order budget segment is a part of.
+        "dateRange": { # A date range. # Required. The start and end date settings of the budget segment. They are resolved relative to the parent advertiser's time zone. * When creating a new budget segment, both `start_date` and `end_date` must be in the future. * An existing budget segment with a `start_date` in the past has a mutable `end_date` but an immutable `start_date`. * `end_date` must be the `start_date` or later, both before the year 2037.
+          "endDate": { # 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 # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
+            "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.
+          },
+          "startDate": { # 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 # The lower bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
+            "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.
+          },
+        },
+        "description": "A String", # Optional. The budget segment description. It can be used to enter Purchase Order information for each budget segment and have that information printed on the invoices. Must be UTF-8 encoded.
+      },
+    ],
+    "budgetUnit": "A String", # Required. Immutable. The budget unit specifies whether the budget is currency based or impression based.
+  },
+  "campaignId": "A String", # Required. Immutable. The unique ID of the campaign that the insertion order belongs to.
+  "displayName": "A String", # Required. The display name of the insertion order. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "entityStatus": "A String", # Required. Controls whether or not the insertion order can spend its budget and bid on inventory. * For CreateInsertionOrder method, only `ENTITY_STATUS_DRAFT` is allowed. To activate an insertion order, use UpdateInsertionOrder method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * An insertion order cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * An insertion order cannot be set to `ENTITY_STATUS_ACTIVE` if its parent campaign is not active.
+  "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency capping setting of the insertion order. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap)
+    "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set.
+    "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set.
+    "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).
+    "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).
+    "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable.
+  },
+  "insertionOrderId": "A String", # Output only. The unique ID of the insertion order. Assigned by the system.
+  "insertionOrderType": "A String", # Optional. The type of insertion order. If this field is unspecified in creation, the value defaults to `RTB`.
+  "integrationDetails": { # Integration details of an entry. # Optional. Additional integration details of the insertion order.
+    "details": "A String", # Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters.
+    "integrationCode": "A String", # An external identifier to be associated with the entry. The integration code will show up together with the entry in many places in the system, for example, reporting. Must be UTF-8 encoded with a length of no more than 500 characters.
+  },
+  "kpi": { # Settings that control the key performance indicator, or KPI, of an insertion order. # Required. The key performance indicator (KPI) of the insertion order. This is represented as referred to as the "Goal" in the Display & Video 360 interface.
+    "kpiAlgorithmId": "A String", # Optional. Custom Bidding Algorithm ID associated with KPI_CUSTOM_IMPRESSION_VALUE_OVER_COST. This field is ignored if the proper KPI is not selected.
+    "kpiAmountMicros": "A String", # The goal amount, in micros of the advertiser's currency. Applicable when kpi_type is one of: * `KPI_TYPE_CPM` * `KPI_TYPE_CPC` * `KPI_TYPE_CPA` * `KPI_TYPE_CPIAVC` * `KPI_TYPE_VCPM` For example: 1500000 represents 1.5 standard units of the currency.
+    "kpiPercentageMicros": "A String", # The decimal representation of the goal percentage in micros. Applicable when kpi_type is one of: * `KPI_TYPE_CTR` * `KPI_TYPE_VIEWABILITY` * `KPI_TYPE_CLICK_CVR` * `KPI_TYPE_IMPRESSION_CVR` * `KPI_TYPE_VTR` * `KPI_TYPE_AUDIO_COMPLETION_RATE` * `KPI_TYPE_VIDEO_COMPLETION_RATE` For example: 70000 represents 7% (decimal 0.07).
+    "kpiString": "A String", # A KPI string, which can be empty. Must be UTF-8 encoded with a length of no more than 100 characters. Applicable when kpi_type is `KPI_TYPE_OTHER`.
+    "kpiType": "A String", # Required. The type of KPI.
+  },
+  "name": "A String", # Output only. The resource name of the insertion order.
+  "optimizationObjective": "A String", # Optional. Required. The optimization objective of the insertion order.
+  "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the insertion order. pacing_type `PACING_TYPE_ASAP` is not compatible with pacing_period `PACING_PERIOD_FLIGHT`.
+    "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0.
+    "dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of advertiser's currency. Applicable when the budget is currency based. Must be greater than 0. For example, for 1.5 standard unit of the currency, set this field to 1500000. The value assigned will be rounded to whole billable units for the relevant currency by the following rules: any positive value less than a single billable unit will be rounded up to one billable unit and any value larger than a single billable unit will be rounded down to the nearest billable value. For example, if the currency's billable unit is 0.01, and this field is set to 10257770, it will round down to 10250000, a value of 10.25. If set to 505, it will round up to 10000, a value of 0.01.
+    "pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent. When automatic budget allocation is enabled at the insertion order via automationType, this field is output only and defaults to `PACING_PERIOD_FLIGHT`.
+    "pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be spent across the pacing_period. `PACING_TYPE_ASAP` is not compatible with pacing_period `PACING_PERIOD_FLIGHT` for insertion orders.
+  },
+  "partnerCosts": [ # Optional. The partner costs associated with the insertion order. If absent or empty in CreateInsertionOrder method, the newly created insertion order will inherit partner costs from the partner settings.
+    { # Settings that control a partner cost. A partner cost is any type of expense involved in running a campaign, other than the costs of purchasing impressions (which is called the media cost) and using third-party audience segment data (data fee). Some examples of partner costs include the fees for using DV360, a third-party ad server, or a third-party ad serving verification service.
+      "costType": "A String", # Required. The type of the partner cost.
+      "feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency. Applicable when the fee_type is `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0. For example, for 1.5 standard unit of the advertiser's currency, set this field to 1500000.
+      "feePercentageMillis": "A String", # The media fee percentage in millis (1/1000 of a percent). Applicable when the fee_type is `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0. For example: 100 represents 0.1%.
+      "feeType": "A String", # Required. The fee type for this partner cost.
+      "invoiceType": "A String", # The invoice type for this partner cost. * Required when cost_type is one of: - `PARTNER_COST_TYPE_ADLOOX` - `PARTNER_COST_TYPE_DOUBLE_VERIFY` - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`. * Output only for other types.
+    },
+  ],
+  "reservationType": "A String", # Output only. The reservation type of the insertion order.
+  "updateTime": "A String", # Output only. The timestamp when the insertion order was last updated. Assigned by the system.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/displayvideo_v4.advertisers.invoices.html b/docs/dyn/displayvideo_v4.advertisers.invoices.html new file mode 100644 index 00000000000..c29f75639ec --- /dev/null +++ b/docs/dyn/displayvideo_v4.advertisers.invoices.html @@ -0,0 +1,213 @@ + + + +

Display & Video 360 API . advertisers . invoices

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ list(advertiserId, issueMonth=None, loiSapinInvoiceType=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists invoices posted for an advertiser in a given month. Invoices generated by billing profiles with a "Partner" invoice level are not retrievable through this method.

+

+ list_next()

+

Retrieves the next page of results.

+

+ lookupInvoiceCurrency(advertiserId, invoiceMonth=None, x__xgafv=None)

+

Retrieves the invoice currency used by an advertiser in a given month.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ list(advertiserId, issueMonth=None, loiSapinInvoiceType=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists invoices posted for an advertiser in a given month. Invoices generated by billing profiles with a "Partner" invoice level are not retrievable through this method.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser to list invoices for. (required)
+  issueMonth: string, The month to list the invoices for. If not set, the request will retrieve invoices for the previous month. Must be in the format YYYYMM.
+  loiSapinInvoiceType: string, Select type of invoice to retrieve for Loi Sapin advertisers. Only applicable to Loi Sapin advertisers. Will be ignored otherwise.
+    Allowed values
+      LOI_SAPIN_INVOICE_TYPE_UNSPECIFIED - Value is not specified.
+      LOI_SAPIN_INVOICE_TYPE_MEDIA - Invoices with Media cost.
+      LOI_SAPIN_INVOICE_TYPE_PLATFORM - Invoices with Platform fee.
+  pageSize: integer, Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
+  pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInvoices` method. If not specified, the first page of results 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:
+
+    {
+  "invoices": [ # The list of invoices. This list will be absent if empty.
+    { # A single invoice.
+      "budgetInvoiceGroupingId": "A String", # The budget grouping ID for this invoice. This field will only be set if the invoice level of the corresponding billing profile was set to "Budget invoice grouping ID".
+      "budgetSummaries": [ # The list of summarized information for each budget associated with this invoice. This field will only be set if the invoice detail level of the corresponding billing profile was set to "Budget level PO".
+        { # Summarized information of an individual campaign budget.
+          "externalBudgetId": "A String", # Corresponds to the external_budget_id of a campaign budget. If the value is not set in the campaign budget, this field will be empty.
+          "preTaxAmountMicros": "A String", # The sum of charges made under this budget before taxes, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar.
+          "prismaCpeCode": { # Google Payments Center supports searching and filtering on the component fields of this code. # Relevant client, product, and estimate codes from the Mediaocean Prisma tool. Only applicable for campaign budgets with an external_budget_source of EXTERNAL_BUDGET_SOURCE_MEDIA_OCEAN.
+            "prismaClientCode": "A String", # The Prisma client code.
+            "prismaEstimateCode": "A String", # The Prisma estimate code.
+            "prismaProductCode": "A String", # The Prisma product code.
+          },
+          "taxAmountMicros": "A String", # The amount of tax applied to charges under this budget, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar.
+          "totalAmountMicros": "A String", # The total sum of charges made under this budget, including tax, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar.
+        },
+      ],
+      "correctedInvoiceId": "A String", # The ID of the original invoice being adjusted by this invoice, if applicable. May appear on the invoice PDF as `Reference invoice number`. If replaced_invoice_ids is set, this field will be empty.
+      "currencyCode": "A String", # The currency used in the invoice in ISO 4217 format.
+      "displayName": "A String", # The display name of the invoice.
+      "dueDate": { # 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 # The date when the invoice is due.
+        "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.
+      },
+      "invoiceId": "A String", # The unique ID of the invoice.
+      "invoiceType": "A String", # The type of invoice document.
+      "issueDate": { # 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 # The date when the invoice was issued.
+        "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.
+      },
+      "name": "A String", # The resource name of the invoice.
+      "nonBudgetMicros": "A String", # The total amount of costs or adjustments not tied to a particular budget, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar.
+      "paymentsAccountId": "A String", # The ID of the payments account the invoice belongs to. Appears on the invoice PDF as `Billing Account Number`.
+      "paymentsProfileId": "A String", # The ID of the payments profile the invoice belongs to. Appears on the invoice PDF as `Billing ID`.
+      "pdfUrl": "A String", # The URL to download a PDF copy of the invoice. This URL is user specific and requires a valid OAuth 2.0 access token to access. The access token must be provided in an `Authorization: Bearer` HTTP header and be authorized for one of the following scopes: * `https://www.googleapis.com/auth/display-video-mediaplanning` * `https://www.googleapis.com/auth/display-video` The URL will be valid for 7 days after retrieval of this invoice object or until this invoice is retrieved again.
+      "purchaseOrderNumber": "A String", # Purchase order number associated with the invoice.
+      "replacedInvoiceIds": [ # The ID(s) of any originally issued invoice that is being cancelled by this invoice, if applicable. Multiple invoices may be listed if those invoices are being consolidated into a single invoice. May appear on invoice PDF as `Replaced invoice numbers`. If corrected_invoice_id is set, this field will be empty.
+        "A String",
+      ],
+      "serviceDateRange": { # A date range. # The service start and end dates which are covered by this invoice.
+        "endDate": { # 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 # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
+          "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.
+        },
+        "startDate": { # 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 # The lower bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
+          "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.
+        },
+      },
+      "subtotalAmountMicros": "A String", # The pre-tax subtotal amount, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar.
+      "totalAmountMicros": "A String", # The invoice total amount, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar.
+      "totalTaxAmountMicros": "A String", # The sum of all taxes in invoice, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar.
+    },
+  ],
+  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListInvoices` method to retrieve the next page of results. This token will be absent if there are no more invoices to return.
+}
+
+ +
+ 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.
+        
+
+ +
+ lookupInvoiceCurrency(advertiserId, invoiceMonth=None, x__xgafv=None) +
Retrieves the invoice currency used by an advertiser in a given month.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser to lookup currency for. (required)
+  invoiceMonth: string, Month for which the currency is needed. If not set, the request will return existing currency settings for the advertiser. Must be in the format YYYYMM.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "currencyCode": "A String", # Currency used by the advertiser in ISO 4217 format.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/displayvideo_v4.advertisers.lineItems.html b/docs/dyn/displayvideo_v4.advertisers.lineItems.html new file mode 100644 index 00000000000..96ae3a88266 --- /dev/null +++ b/docs/dyn/displayvideo_v4.advertisers.lineItems.html @@ -0,0 +1,2500 @@ + + + +

Display & Video 360 API . advertisers . lineItems

+

Instance Methods

+

+ targetingTypes() +

+

Returns the targetingTypes Resource.

+ +

+ bulkEditAssignedTargetingOptions(advertiserId, body=None, x__xgafv=None)

+

Bulk edits targeting options under multiple line items. The operation will delete the assigned targeting options provided in BulkEditAssignedTargetingOptionsRequest.delete_requests and then create the assigned targeting options provided in BulkEditAssignedTargetingOptionsRequest.create_requests. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * lineItems.bulkUpdate * lineItems.patch * assignedTargetingOptions.create * assignedTargetingOptions.delete YouTube & Partners line items cannot be created or updated using the API.

+

+ bulkListAssignedTargetingOptions(advertiserId, filter=None, lineItemIds=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists assigned targeting options for multiple line items across targeting types.

+

+ bulkListAssignedTargetingOptions_next()

+

Retrieves the next page of results.

+

+ bulkUpdate(advertiserId, body=None, x__xgafv=None)

+

Updates multiple line items. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * BulkEditAssignedTargetingOptions * UpdateLineItem * assignedTargetingOptions.create * assignedTargetingOptions.delete YouTube & Partners line items cannot be created or updated using the API.

+

+ close()

+

Close httplib2 connections.

+

+ create(advertiserId, body=None, x__xgafv=None)

+

Creates a new line item. Returns the newly created line item if successful. YouTube & Partners line items cannot be created or updated using the API.

+

+ delete(advertiserId, lineItemId, x__xgafv=None)

+

Deletes a line item. Returns error code `NOT_FOUND` if the line item does not exist. The line item should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it. YouTube & Partners line items cannot be created or updated using the API.

+

+ duplicate(advertiserId, lineItemId, body=None, x__xgafv=None)

+

Duplicates a line item. Returns the ID of the created line item if successful. YouTube & Partners line items cannot be created or updated using the API. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.

+

+ generateDefault(advertiserId, body=None, x__xgafv=None)

+

Creates a new line item with settings (including targeting) inherited from the insertion order and an `ENTITY_STATUS_DRAFT` entity_status. Returns the newly created line item if successful. There are default values based on the three fields: * The insertion order's insertion_order_type * The insertion order's automation_type * The given line_item_type YouTube & Partners line items cannot be created or updated using the API.

+

+ get(advertiserId, lineItemId, x__xgafv=None)

+

Gets a line item.

+

+ list(advertiserId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists line items in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, line items with `ENTITY_STATUS_ARCHIVED` will not be included in the results.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(advertiserId, lineItemId, body=None, updateMask=None, x__xgafv=None)

+

Updates an existing line item. Returns the updated line item if successful. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * BulkEditAssignedTargetingOptions * BulkUpdateLineItems * assignedTargetingOptions.create * assignedTargetingOptions.delete YouTube & Partners line items cannot be created or updated using the API. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.

+

Method Details

+
+ bulkEditAssignedTargetingOptions(advertiserId, body=None, x__xgafv=None) +
Bulk edits targeting options under multiple line items. The operation will delete the assigned targeting options provided in BulkEditAssignedTargetingOptionsRequest.delete_requests and then create the assigned targeting options provided in BulkEditAssignedTargetingOptionsRequest.create_requests. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * lineItems.bulkUpdate * lineItems.patch * assignedTargetingOptions.create * assignedTargetingOptions.delete YouTube & Partners line items cannot be created or updated using the API.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser the line items belong to. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for BulkEditLineItemsAssignedTargetingOptions.
+  "createRequests": [ # The assigned targeting options to create in batch, specified as a list of CreateAssignedTargetingOptionsRequest. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY`
+    { # A request listing which assigned targeting options of a given targeting type should be created and added.
+      "assignedTargetingOptions": [ # Required. The assigned targeting options to create and add.
+        { # A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings.
+          "ageRangeDetails": { # Represents a targetable age range. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AGE_RANGE`. # Age range details. This field will be populated when the targeting_type is `TARGETING_TYPE_AGE_RANGE`.
+            "ageRange": "A String", # Required. The age range of an audience. We only support targeting a continuous age range of an audience. Thus, the age range represented in this field can be 1) targeted solely, or, 2) part of a larger continuous age range. The reach of a continuous age range targeting can be expanded by also targeting an audience of an unknown age.
+          },
+          "appCategoryDetails": { # Details for assigned app category targeting option. This will be populated in the app_category_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. # App category details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
+            "displayName": "A String", # Output only. The display name of the app category.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+            "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
+          },
+          "appDetails": { # Details for assigned app targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP`. # App details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP`.
+            "appId": "A String", # Required. The ID of the app. Android's Play store app uses bundle ID, for example `com.google.android.gm`. Apple's App store app ID uses 9 digit string, for example `422689480`.
+            "appPlatform": "A String", # Indicates the platform of the targeted app. If this field is not specified, the app platform will be assumed to be mobile (i.e., Android or iOS), and we will derive the appropriate mobile platform from the app ID.
+            "displayName": "A String", # Output only. The display name of the app.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+          },
+          "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts.
+          "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`
+          "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource.
+            "excludedFirstPartyAndPartnerAudienceGroup": { # Details of first party and partner audience group. All first party and partner audience targeting settings are logically ‘OR’ of each other. # Optional. The first party and partner audience ids and recencies of the excluded first party and partner audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other.
+              "settings": [ # Required. All first party and partner audience targeting settings in first party and partner audience group. Repeated settings with the same id are not allowed.
+                { # Details of first party and partner audience targeting setting.
+                  "firstPartyAndPartnerAudienceId": "A String", # Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.
+                  "recency": "A String", # Required. The recency of the first party and partner audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
+                },
+              ],
+            },
+            "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other.
+              "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
+                { # Details of Google audience targeting setting.
+                  "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
+                },
+              ],
+            },
+            "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only.
+              "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise.
+                { # Details of combined audience targeting setting.
+                  "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id.
+                },
+              ],
+            },
+            "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only.
+              "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored.
+                { # Details of custom list targeting setting.
+                  "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id.
+                },
+              ],
+            },
+            "includedFirstPartyAndPartnerAudienceGroups": [ # Optional. The first party and partner audience ids and recencies of included first party and partner audience groups. Each first party and partner audience group contains first party and partner audience ids only. The relation between each first party and partner audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored.
+              { # Details of first party and partner audience group. All first party and partner audience targeting settings are logically ‘OR’ of each other.
+                "settings": [ # Required. All first party and partner audience targeting settings in first party and partner audience group. Repeated settings with the same id are not allowed.
+                  { # Details of first party and partner audience targeting setting.
+                    "firstPartyAndPartnerAudienceId": "A String", # Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.
+                    "recency": "A String", # Required. The recency of the first party and partner audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
+                  },
+                ],
+              },
+            ],
+            "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only.
+              "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
+                { # Details of Google audience targeting setting.
+                  "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
+                },
+              ],
+            },
+          },
+          "audioContentTypeDetails": { # Details for audio content type assigned targeting option. This will be populated in the audio_content_type_details field when targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`. Explicitly targeting all options is not supported. Remove all audio content type targeting options to achieve this effect. # Audio content type details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`.
+            "audioContentType": "A String", # Required. The audio content type.
+          },
+          "authorizedSellerStatusDetails": { # Represents an assigned authorized seller status. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. If a resource does not have an `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` assigned targeting option, it is using the "Authorized Direct Sellers and Resellers" option. # Authorized seller status details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. You can only target one authorized seller status option per resource. If a resource doesn't have an authorized seller status option, all authorized sellers indicated as DIRECT or RESELLER in the ads.txt file are targeted by default.
+            "authorizedSellerStatus": "A String", # Output only. The authorized seller status to target.
+            "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.
+          },
+          "browserDetails": { # Details for assigned browser targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BROWSER`. # Browser details. This field will be populated when the targeting_type is `TARGETING_TYPE_BROWSER`.
+            "displayName": "A String", # Output only. The display name of the browser.
+            "negative": True or False, # Indicates if this option is being negatively targeted. All assigned browser targeting options on the same resource must have the same value for this field.
+            "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BROWSER`.
+          },
+          "businessChainDetails": { # Details for assigned Business chain targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`. # Business chain details. This field will be populated when the targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`.
+            "displayName": "A String", # Output only. The display name of a business chain, e.g. "KFC", "Chase Bank".
+            "proximityRadiusAmount": 3.14, # Required. The radius of the area around the business chain that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`. The minimum increment for both cases is 0.1. Inputs will be rounded to the nearest acceptable value if it is too granular, e.g. 15.57 will become 15.6.
+            "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
+            "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BUSINESS_CHAIN`. Accepted business chain targeting option IDs can be retrieved using SearchTargetingOptions.
+          },
+          "carrierAndIspDetails": { # Details for assigned carrier and ISP targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`. # Carrier and ISP details. This field will be populated when the targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`.
+            "displayName": "A String", # Output only. The display name of the carrier or ISP.
+            "negative": True or False, # Indicates if this option is being negatively targeted. All assigned carrier and ISP targeting options on the same resource must have the same value for this field.
+            "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`.
+          },
+          "categoryDetails": { # Assigned category targeting option details. This will be populated in the category_details field when targeting_type is `TARGETING_TYPE_CATEGORY`. # Category details. This field will be populated when the targeting_type is `TARGETING_TYPE_CATEGORY`. Targeting a category will also target its subcategories. If a category is excluded from targeting and a subcategory is included, the exclusion will take precedence.
+            "displayName": "A String", # Output only. The display name of the category.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+            "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CATEGORY`.
+          },
+          "channelDetails": { # Details for assigned channel targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CHANNEL`. # Channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_CHANNEL`.
+            "channelId": "A String", # Required. ID of the channel. Should refer to the channel ID field on a [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id) resource.
+            "negative": True or False, # Indicates if this option is being negatively targeted. For advertiser level assigned targeting option, this field must be true.
+          },
+          "contentDurationDetails": { # Details for content duration assigned targeting option. This will be populated in the content_duration_details field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`. Explicitly targeting all options is not supported. Remove all content duration targeting options to achieve this effect. # Content duration details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
+            "contentDuration": "A String", # Output only. The content duration.
+            "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
+          },
+          "contentGenreDetails": { # Details for content genre assigned targeting option. This will be populated in the content_genre_details field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`. Explicitly targeting all options is not supported. Remove all content genre targeting options to achieve this effect. # Content genre details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
+            "displayName": "A String", # Output only. The display name of the content genre.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+            "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
+          },
+          "contentInstreamPositionDetails": { # Assigned content instream position targeting option details. This will be populated in the content_instream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. # Content instream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.
+            "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`. * `AD_TYPE_AUDIO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_AUDIO_DEFAULT`.
+            "contentInstreamPosition": "A String", # Required. The content instream position for video or audio ads.
+          },
+          "contentOutstreamPositionDetails": { # Assigned content outstream position targeting option details. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. # Content outstream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.
+            "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+            "contentOutstreamPosition": "A String", # Required. The content outstream position.
+          },
+          "contentStreamTypeDetails": { # Details for content stream type assigned targeting option. This will be populated in the content_stream_type_details field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`. Explicitly targeting all options is not supported. Remove all content stream type targeting options to achieve this effect. # Content duration details. This field will be populated when the TargetingType is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
+            "contentStreamType": "A String", # Output only. The content stream type.
+            "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
+          },
+          "dayAndTimeDetails": { # Representation of a segment of time defined on a specific day of the week and with a start and end time. The time represented by `start_hour` must be before the time represented by `end_hour`. # Day and time details. This field will be populated when the targeting_type is `TARGETING_TYPE_DAY_AND_TIME`.
+            "dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting.
+            "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day).
+            "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day).
+            "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting.
+          },
+          "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
+            "displayName": "A String", # Output only. The display name of the device make and model.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+            "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
+          },
+          "deviceTypeDetails": { # Targeting details for device type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`. # Device Type details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_TYPE`.
+            "deviceType": "A String", # Required. The display name of the device type.
+            "youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items.
+          },
+          "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded.
+            "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED.
+          },
+          "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`.
+            "environment": "A String", # Required. The serving environment.
+          },
+          "exchangeDetails": { # Details for assigned exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`. # Exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_EXCHANGE`.
+            "exchange": "A String", # Required. The enum value for the exchange.
+          },
+          "genderDetails": { # Details for assigned gender targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GENDER`. # Gender details. This field will be populated when the targeting_type is `TARGETING_TYPE_GENDER`.
+            "gender": "A String", # Required. The gender of the audience.
+          },
+          "geoRegionDetails": { # Details for assigned geographic region targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GEO_REGION`. # Geographic region details. This field will be populated when the targeting_type is `TARGETING_TYPE_GEO_REGION`.
+            "displayName": "A String", # Output only. The display name of the geographic region (e.g., "Ontario, Canada").
+            "geoRegionType": "A String", # Output only. The type of geographic region targeting.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+            "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GEO_REGION`.
+          },
+          "householdIncomeDetails": { # Details for assigned household income targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`. # Household income details. This field will be populated when the targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`.
+            "householdIncome": "A String", # Required. The household income of the audience.
+          },
+          "inheritance": "A String", # Output only. The inheritance status of the assigned targeting option.
+          "inventorySourceDetails": { # Targeting details for inventory source. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`. # Inventory source details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`.
+            "inventorySourceId": "A String", # Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource.
+          },
+          "inventorySourceGroupDetails": { # Targeting details for inventory source group. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`. # Inventory source group details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`.
+            "inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource.
+          },
+          "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned.
+            "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+          },
+          "languageDetails": { # Details for assigned language targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_LANGUAGE`. # Language details. This field will be populated when the targeting_type is `TARGETING_TYPE_LANGUAGE`.
+            "displayName": "A String", # Output only. The display name of the language (e.g., "French").
+            "negative": True or False, # Indicates if this option is being negatively targeted. All assigned language targeting options on the same resource must have the same value for this field.
+            "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_LANGUAGE`.
+          },
+          "name": "A String", # Output only. The resource name for this assigned targeting option.
+          "nativeContentPositionDetails": { # Details for native content position assigned targeting option. This will be populated in the native_content_position_details field when targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`. Explicitly targeting all options is not supported. Remove all native content position targeting options to achieve this effect. # Native content position details. This field will be populated when the targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`.
+            "contentPosition": "A String", # Required. The content position.
+          },
+          "negativeKeywordListDetails": { # Targeting details for negative keyword list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. A maximum of 4 negative keyword lists can be assigned to a resource.
+            "negativeKeywordListId": "A String", # Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource.
+          },
+          "omidDetails": { # Represents a targetable Open Measurement enabled inventory type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_OMID`. # Open Measurement enabled inventory details. This field will be populated when the targeting_type is `TARGETING_TYPE_OMID`.
+            "omid": "A String", # Required. The type of Open Measurement enabled inventory.
+          },
+          "onScreenPositionDetails": { # On screen position targeting option details. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. # On screen position details. This field will be populated when the targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
+            "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+            "onScreenPosition": "A String", # Output only. The on screen position.
+            "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
+          },
+          "operatingSystemDetails": { # Assigned operating system targeting option details. This will be populated in the operating_system_details field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. # Operating system details. This field will be populated when the targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
+            "displayName": "A String", # Output only. The display name of the operating system.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+            "targetingOptionId": "A String", # Required. The targeting option ID populated in targeting_option_id field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
+          },
+          "parentalStatusDetails": { # Details for assigned parental status targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`. # Parental status details. This field will be populated when the targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`.
+            "parentalStatus": "A String", # Required. The parental status of the audience.
+          },
+          "poiDetails": { # Details for assigned POI targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_POI`. # POI details. This field will be populated when the targeting_type is `TARGETING_TYPE_POI`.
+            "displayName": "A String", # Output only. The display name of a POI, e.g. "Times Square", "Space Needle", followed by its full address if available.
+            "latitude": 3.14, # Output only. Latitude of the POI rounding to 6th decimal place.
+            "longitude": 3.14, # Output only. Longitude of the POI rounding to 6th decimal place.
+            "proximityRadiusAmount": 3.14, # Required. The radius of the area around the POI that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`.
+            "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
+            "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_POI`. Accepted POI targeting option IDs can be retrieved using `targetingTypes.targetingOptions.search`. If targeting a specific latitude/longitude coordinate removed from an address or POI name, you can generate the necessary targeting option ID by rounding the desired coordinate values to the 6th decimal place, removing the decimals, and concatenating the string values separated by a semicolon. For example, you can target the latitude/longitude pair of 40.7414691, -74.003387 using the targeting option ID "40741469;-74003387". **Upon** **creation, this field value will be updated to append a semicolon and** **alphanumerical hash value if only latitude/longitude coordinates are** **provided.**
+          },
+          "proximityLocationListDetails": { # Targeting details for proximity location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`. # Proximity location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`.
+            "proximityLocationListId": "A String", # Required. ID of the proximity location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_PROXIMITY`.
+            "proximityRadius": 3.14, # Required. Radius expressed in the distance units set in proximity_radius_unit. This represents the size of the area around a chosen location that will be targeted. Radius should be between 1 and 500 miles or 800 kilometers.
+            "proximityRadiusUnit": "A String", # Required. Radius distance units.
+          },
+          "regionalLocationListDetails": { # Targeting details for regional location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`. # Regional location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+            "regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`.
+          },
+          "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them.
+            "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED.
+          },
+          "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`.
+            "sessionPosition": "A String", # The position where the ad will show in a session.
+          },
+          "subExchangeDetails": { # Details for assigned sub-exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`. # Sub-exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`.
+            "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`.
+          },
+          "targetingType": "A String", # Output only. Identifies the type of this assigned targeting option.
+          "thirdPartyVerifierDetails": { # Assigned third party verifier targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`. # Third party verification details. This field will be populated when the targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`.
+            "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox.
+              "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads.
+              "excludedAdlooxCategories": [ # Adloox categories to exclude.
+                "A String",
+              ],
+              "excludedFraudIvtMfaCategories": [ # Optional. Adloox's fraud IVT MFA categories to exclude.
+                "A String",
+              ],
+              "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads.
+            },
+            "doubleVerify": { # Details of DoubleVerify settings. # Third party brand verifier -- DoubleVerify.
+              "appStarRating": { # Details of DoubleVerify star ratings settings. # Avoid bidding on apps with the star ratings.
+                "avoidInsufficientStarRating": True or False, # Avoid bidding on apps with insufficient star ratings.
+                "avoidedStarRating": "A String", # Avoid bidding on apps with the star ratings.
+              },
+              "avoidedAgeRatings": [ # Avoid bidding on apps with the age rating.
+                "A String",
+              ],
+              "brandSafetyCategories": { # Settings for brand safety controls. # DV Brand Safety Controls.
+                "avoidUnknownBrandSafetyCategory": True or False, # Unknown or unrateable.
+                "avoidedHighSeverityCategories": [ # Brand safety high severity avoidance categories.
+                  "A String",
+                ],
+                "avoidedMediumSeverityCategories": [ # Brand safety medium severity avoidance categories.
+                  "A String",
+                ],
+              },
+              "customSegmentId": "A String", # The custom segment ID provided by DoubleVerify. The ID must start with "51" and consist of eight digits. Custom segment ID cannot be specified along with any of the following fields: * brand_safety_categories * avoided_age_ratings * app_star_rating * fraud_invalid_traffic
+              "displayViewability": { # Details of DoubleVerify display viewability settings. # Display viewability settings (applicable to display line items only).
+                "iab": "A String", # Target web and app inventory to maximize IAB viewable rate.
+                "viewableDuring": "A String", # Target web and app inventory to maximize 100% viewable duration.
+              },
+              "fraudInvalidTraffic": { # DoubleVerify Fraud & Invalid Traffic settings. # Avoid Sites and Apps with historical Fraud & IVT Rates.
+                "avoidInsufficientOption": True or False, # Insufficient Historical Fraud & IVT Stats.
+                "avoidedFraudOption": "A String", # Avoid Sites and Apps with historical Fraud & IVT.
+              },
+              "videoViewability": { # Details of DoubleVerify video viewability settings. # Video viewability settings (applicable to video line items only).
+                "playerImpressionRate": "A String", # Target inventory to maximize impressions with 400x300 or greater player size.
+                "videoIab": "A String", # Target web inventory to maximize IAB viewable rate.
+                "videoViewableRate": "A String", # Target web inventory to maximize fully viewable rate.
+              },
+            },
+            "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science.
+              "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive.
+                "A String",
+              ],
+              "displayViewability": "A String", # Display Viewability section (applicable to display line items only).
+              "excludeUnrateable": True or False, # Brand Safety - **Unrateable**.
+              "excludedAdFraudRisk": "A String", # Ad Fraud settings.
+              "excludedAdultRisk": "A String", # Brand Safety - **Adult content**.
+              "excludedAlcoholRisk": "A String", # Brand Safety - **Alcohol**.
+              "excludedDrugsRisk": "A String", # Brand Safety - **Drugs**.
+              "excludedGamblingRisk": "A String", # Brand Safety - **Gambling**.
+              "excludedHateSpeechRisk": "A String", # Brand Safety - **Hate speech**.
+              "excludedIllegalDownloadsRisk": "A String", # Brand Safety - **Illegal downloads**.
+              "excludedOffensiveLanguageRisk": "A String", # Brand Safety - **Offensive language**.
+              "excludedViolenceRisk": "A String", # Brand Safety - **Violence**.
+              "qualitySyncCustomSegmentId": [ # Optional. The quality sync custom segment ID provided by Integral Ad Science. The ID must be between `3000000` and `4999999`, inclusive.
+                "A String",
+              ],
+              "traqScoreOption": "A String", # True advertising quality (applicable to Display line items only).
+              "videoViewability": "A String", # Video Viewability Section (applicable to video line items only).
+            },
+          },
+          "urlDetails": { # Details for assigned URL targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_URL`. # URL details. This field will be populated when the targeting_type is `TARGETING_TYPE_URL`.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+            "url": "A String", # Required. The URL, for example `example.com`. DV360 supports two levels of subdirectory targeting, for example `www.example.com/one-subdirectory-level/second-level`, and five levels of subdomain targeting, for example `five.four.three.two.one.example.com`.
+          },
+          "userRewardedContentDetails": { # User rewarded content targeting option details. This will be populated in the user_rewarded_content_details field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. # User rewarded content details. This field will be populated when the targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
+            "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
+            "userRewardedContent": "A String", # Output only. User rewarded content status for video ads.
+          },
+          "videoPlayerSizeDetails": { # Video player size targeting option details. This will be populated in the video_player_size_details field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. Explicitly targeting all options is not supported. Remove all video player size targeting options to achieve this effect. # Video player size details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.
+            "videoPlayerSize": "A String", # Required. The video player size.
+          },
+          "viewabilityDetails": { # Assigned viewability targeting option details. This will be populated in the viewability_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`. # Viewability details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIEWABILITY`. You can only target one viewability option per resource.
+            "viewability": "A String", # Required. The predicted viewability percentage.
+          },
+          "youtubeChannelDetails": { # Details for YouTube channel assigned targeting option. This will be populated in the youtube_channel_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`. # YouTube channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`.
+            "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+          },
+          "youtubeVideoDetails": { # Details for YouTube video assigned targeting option. This will be populated in the youtube_video_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`. # YouTube video details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+            "videoId": "A String", # YouTube video id as it appears on the YouTube watch page.
+          },
+        },
+      ],
+      "targetingType": "A String", # Required. Identifies the type of this assigned targeting option.
+    },
+  ],
+  "deleteRequests": [ # The assigned targeting options to delete in batch, specified as a list of DeleteAssignedTargetingOptionsRequest. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY`
+    { # A request listing which assigned targeting options of a given targeting type should be deleted.
+      "assignedTargetingOptionIds": [ # Required. The assigned targeting option IDs to delete.
+        "A String",
+      ],
+      "targetingType": "A String", # Required. Identifies the type of this assigned targeting option.
+    },
+  ],
+  "lineItemIds": [ # Required. The ID of the line items whose targeting is being updated.
+    "A String",
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "errors": [ # The error information for each line item that failed to update.
+    { # 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).
+      "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.
+    },
+  ],
+  "failedLineItemIds": [ # Output only. The IDs of the line items which failed.
+    "A String",
+  ],
+  "updatedLineItemIds": [ # Output only. The IDs of the line items which successfully updated.
+    "A String",
+  ],
+}
+
+ +
+ bulkListAssignedTargetingOptions(advertiserId, filter=None, lineItemIds=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists assigned targeting options for multiple line items across targeting types.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser the line items belongs to. (required)
+  filter: string, Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR` on the same field. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `targetingType` * `inheritance` Examples: * `AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` or `TARGETING_TYPE_CHANNEL`: `targetingType="TARGETING_TYPE_PROXIMITY_LOCATION_LIST" OR targetingType="TARGETING_TYPE_CHANNEL"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
+  lineItemIds: string, Required. The IDs of the line items to list assigned targeting options for. (repeated)
+  orderBy: string, Field by which to sort the list. Acceptable values are: * `lineItemId` (default) * `assignedTargetingOption.targetingType` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `targetingType desc`.
+  pageSize: integer, Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
+  pageToken: string, A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to the `BulkListAssignedTargetingOptions` method. If not specified, the first page of results 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:
+
+    {
+  "lineItemAssignedTargetingOptions": [ # The list of wrapper objects, each providing an assigned targeting option and the line item it is assigned to. This list will be absent if empty.
+    { # Wrapper object associating an assigned_targeting_option resource and the line item it is assigned to.
+      "assignedTargetingOption": { # A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings. # The assigned targeting option resource.
+        "ageRangeDetails": { # Represents a targetable age range. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AGE_RANGE`. # Age range details. This field will be populated when the targeting_type is `TARGETING_TYPE_AGE_RANGE`.
+          "ageRange": "A String", # Required. The age range of an audience. We only support targeting a continuous age range of an audience. Thus, the age range represented in this field can be 1) targeted solely, or, 2) part of a larger continuous age range. The reach of a continuous age range targeting can be expanded by also targeting an audience of an unknown age.
+        },
+        "appCategoryDetails": { # Details for assigned app category targeting option. This will be populated in the app_category_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. # App category details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
+          "displayName": "A String", # Output only. The display name of the app category.
+          "negative": True or False, # Indicates if this option is being negatively targeted.
+          "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
+        },
+        "appDetails": { # Details for assigned app targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP`. # App details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP`.
+          "appId": "A String", # Required. The ID of the app. Android's Play store app uses bundle ID, for example `com.google.android.gm`. Apple's App store app ID uses 9 digit string, for example `422689480`.
+          "appPlatform": "A String", # Indicates the platform of the targeted app. If this field is not specified, the app platform will be assumed to be mobile (i.e., Android or iOS), and we will derive the appropriate mobile platform from the app ID.
+          "displayName": "A String", # Output only. The display name of the app.
+          "negative": True or False, # Indicates if this option is being negatively targeted.
+        },
+        "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts.
+        "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`
+        "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource.
+          "excludedFirstPartyAndPartnerAudienceGroup": { # Details of first party and partner audience group. All first party and partner audience targeting settings are logically ‘OR’ of each other. # Optional. The first party and partner audience ids and recencies of the excluded first party and partner audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other.
+            "settings": [ # Required. All first party and partner audience targeting settings in first party and partner audience group. Repeated settings with the same id are not allowed.
+              { # Details of first party and partner audience targeting setting.
+                "firstPartyAndPartnerAudienceId": "A String", # Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.
+                "recency": "A String", # Required. The recency of the first party and partner audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
+              },
+            ],
+          },
+          "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other.
+            "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
+              { # Details of Google audience targeting setting.
+                "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
+              },
+            ],
+          },
+          "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only.
+            "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise.
+              { # Details of combined audience targeting setting.
+                "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id.
+              },
+            ],
+          },
+          "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only.
+            "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored.
+              { # Details of custom list targeting setting.
+                "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id.
+              },
+            ],
+          },
+          "includedFirstPartyAndPartnerAudienceGroups": [ # Optional. The first party and partner audience ids and recencies of included first party and partner audience groups. Each first party and partner audience group contains first party and partner audience ids only. The relation between each first party and partner audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored.
+            { # Details of first party and partner audience group. All first party and partner audience targeting settings are logically ‘OR’ of each other.
+              "settings": [ # Required. All first party and partner audience targeting settings in first party and partner audience group. Repeated settings with the same id are not allowed.
+                { # Details of first party and partner audience targeting setting.
+                  "firstPartyAndPartnerAudienceId": "A String", # Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.
+                  "recency": "A String", # Required. The recency of the first party and partner audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
+                },
+              ],
+            },
+          ],
+          "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only.
+            "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
+              { # Details of Google audience targeting setting.
+                "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
+              },
+            ],
+          },
+        },
+        "audioContentTypeDetails": { # Details for audio content type assigned targeting option. This will be populated in the audio_content_type_details field when targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`. Explicitly targeting all options is not supported. Remove all audio content type targeting options to achieve this effect. # Audio content type details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`.
+          "audioContentType": "A String", # Required. The audio content type.
+        },
+        "authorizedSellerStatusDetails": { # Represents an assigned authorized seller status. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. If a resource does not have an `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` assigned targeting option, it is using the "Authorized Direct Sellers and Resellers" option. # Authorized seller status details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. You can only target one authorized seller status option per resource. If a resource doesn't have an authorized seller status option, all authorized sellers indicated as DIRECT or RESELLER in the ads.txt file are targeted by default.
+          "authorizedSellerStatus": "A String", # Output only. The authorized seller status to target.
+          "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.
+        },
+        "browserDetails": { # Details for assigned browser targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BROWSER`. # Browser details. This field will be populated when the targeting_type is `TARGETING_TYPE_BROWSER`.
+          "displayName": "A String", # Output only. The display name of the browser.
+          "negative": True or False, # Indicates if this option is being negatively targeted. All assigned browser targeting options on the same resource must have the same value for this field.
+          "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BROWSER`.
+        },
+        "businessChainDetails": { # Details for assigned Business chain targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`. # Business chain details. This field will be populated when the targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`.
+          "displayName": "A String", # Output only. The display name of a business chain, e.g. "KFC", "Chase Bank".
+          "proximityRadiusAmount": 3.14, # Required. The radius of the area around the business chain that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`. The minimum increment for both cases is 0.1. Inputs will be rounded to the nearest acceptable value if it is too granular, e.g. 15.57 will become 15.6.
+          "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
+          "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BUSINESS_CHAIN`. Accepted business chain targeting option IDs can be retrieved using SearchTargetingOptions.
+        },
+        "carrierAndIspDetails": { # Details for assigned carrier and ISP targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`. # Carrier and ISP details. This field will be populated when the targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`.
+          "displayName": "A String", # Output only. The display name of the carrier or ISP.
+          "negative": True or False, # Indicates if this option is being negatively targeted. All assigned carrier and ISP targeting options on the same resource must have the same value for this field.
+          "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`.
+        },
+        "categoryDetails": { # Assigned category targeting option details. This will be populated in the category_details field when targeting_type is `TARGETING_TYPE_CATEGORY`. # Category details. This field will be populated when the targeting_type is `TARGETING_TYPE_CATEGORY`. Targeting a category will also target its subcategories. If a category is excluded from targeting and a subcategory is included, the exclusion will take precedence.
+          "displayName": "A String", # Output only. The display name of the category.
+          "negative": True or False, # Indicates if this option is being negatively targeted.
+          "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CATEGORY`.
+        },
+        "channelDetails": { # Details for assigned channel targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CHANNEL`. # Channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_CHANNEL`.
+          "channelId": "A String", # Required. ID of the channel. Should refer to the channel ID field on a [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id) resource.
+          "negative": True or False, # Indicates if this option is being negatively targeted. For advertiser level assigned targeting option, this field must be true.
+        },
+        "contentDurationDetails": { # Details for content duration assigned targeting option. This will be populated in the content_duration_details field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`. Explicitly targeting all options is not supported. Remove all content duration targeting options to achieve this effect. # Content duration details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
+          "contentDuration": "A String", # Output only. The content duration.
+          "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
+        },
+        "contentGenreDetails": { # Details for content genre assigned targeting option. This will be populated in the content_genre_details field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`. Explicitly targeting all options is not supported. Remove all content genre targeting options to achieve this effect. # Content genre details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
+          "displayName": "A String", # Output only. The display name of the content genre.
+          "negative": True or False, # Indicates if this option is being negatively targeted.
+          "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
+        },
+        "contentInstreamPositionDetails": { # Assigned content instream position targeting option details. This will be populated in the content_instream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. # Content instream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.
+          "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`. * `AD_TYPE_AUDIO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_AUDIO_DEFAULT`.
+          "contentInstreamPosition": "A String", # Required. The content instream position for video or audio ads.
+        },
+        "contentOutstreamPositionDetails": { # Assigned content outstream position targeting option details. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. # Content outstream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.
+          "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+          "contentOutstreamPosition": "A String", # Required. The content outstream position.
+        },
+        "contentStreamTypeDetails": { # Details for content stream type assigned targeting option. This will be populated in the content_stream_type_details field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`. Explicitly targeting all options is not supported. Remove all content stream type targeting options to achieve this effect. # Content duration details. This field will be populated when the TargetingType is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
+          "contentStreamType": "A String", # Output only. The content stream type.
+          "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
+        },
+        "dayAndTimeDetails": { # Representation of a segment of time defined on a specific day of the week and with a start and end time. The time represented by `start_hour` must be before the time represented by `end_hour`. # Day and time details. This field will be populated when the targeting_type is `TARGETING_TYPE_DAY_AND_TIME`.
+          "dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting.
+          "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day).
+          "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day).
+          "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting.
+        },
+        "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
+          "displayName": "A String", # Output only. The display name of the device make and model.
+          "negative": True or False, # Indicates if this option is being negatively targeted.
+          "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
+        },
+        "deviceTypeDetails": { # Targeting details for device type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`. # Device Type details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_TYPE`.
+          "deviceType": "A String", # Required. The display name of the device type.
+          "youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items.
+        },
+        "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded.
+          "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED.
+        },
+        "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`.
+          "environment": "A String", # Required. The serving environment.
+        },
+        "exchangeDetails": { # Details for assigned exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`. # Exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_EXCHANGE`.
+          "exchange": "A String", # Required. The enum value for the exchange.
+        },
+        "genderDetails": { # Details for assigned gender targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GENDER`. # Gender details. This field will be populated when the targeting_type is `TARGETING_TYPE_GENDER`.
+          "gender": "A String", # Required. The gender of the audience.
+        },
+        "geoRegionDetails": { # Details for assigned geographic region targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GEO_REGION`. # Geographic region details. This field will be populated when the targeting_type is `TARGETING_TYPE_GEO_REGION`.
+          "displayName": "A String", # Output only. The display name of the geographic region (e.g., "Ontario, Canada").
+          "geoRegionType": "A String", # Output only. The type of geographic region targeting.
+          "negative": True or False, # Indicates if this option is being negatively targeted.
+          "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GEO_REGION`.
+        },
+        "householdIncomeDetails": { # Details for assigned household income targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`. # Household income details. This field will be populated when the targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`.
+          "householdIncome": "A String", # Required. The household income of the audience.
+        },
+        "inheritance": "A String", # Output only. The inheritance status of the assigned targeting option.
+        "inventorySourceDetails": { # Targeting details for inventory source. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`. # Inventory source details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`.
+          "inventorySourceId": "A String", # Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource.
+        },
+        "inventorySourceGroupDetails": { # Targeting details for inventory source group. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`. # Inventory source group details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`.
+          "inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource.
+        },
+        "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned.
+          "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10.
+          "negative": True or False, # Indicates if this option is being negatively targeted.
+        },
+        "languageDetails": { # Details for assigned language targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_LANGUAGE`. # Language details. This field will be populated when the targeting_type is `TARGETING_TYPE_LANGUAGE`.
+          "displayName": "A String", # Output only. The display name of the language (e.g., "French").
+          "negative": True or False, # Indicates if this option is being negatively targeted. All assigned language targeting options on the same resource must have the same value for this field.
+          "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_LANGUAGE`.
+        },
+        "name": "A String", # Output only. The resource name for this assigned targeting option.
+        "nativeContentPositionDetails": { # Details for native content position assigned targeting option. This will be populated in the native_content_position_details field when targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`. Explicitly targeting all options is not supported. Remove all native content position targeting options to achieve this effect. # Native content position details. This field will be populated when the targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`.
+          "contentPosition": "A String", # Required. The content position.
+        },
+        "negativeKeywordListDetails": { # Targeting details for negative keyword list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. A maximum of 4 negative keyword lists can be assigned to a resource.
+          "negativeKeywordListId": "A String", # Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource.
+        },
+        "omidDetails": { # Represents a targetable Open Measurement enabled inventory type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_OMID`. # Open Measurement enabled inventory details. This field will be populated when the targeting_type is `TARGETING_TYPE_OMID`.
+          "omid": "A String", # Required. The type of Open Measurement enabled inventory.
+        },
+        "onScreenPositionDetails": { # On screen position targeting option details. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. # On screen position details. This field will be populated when the targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
+          "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+          "onScreenPosition": "A String", # Output only. The on screen position.
+          "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
+        },
+        "operatingSystemDetails": { # Assigned operating system targeting option details. This will be populated in the operating_system_details field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. # Operating system details. This field will be populated when the targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
+          "displayName": "A String", # Output only. The display name of the operating system.
+          "negative": True or False, # Indicates if this option is being negatively targeted.
+          "targetingOptionId": "A String", # Required. The targeting option ID populated in targeting_option_id field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
+        },
+        "parentalStatusDetails": { # Details for assigned parental status targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`. # Parental status details. This field will be populated when the targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`.
+          "parentalStatus": "A String", # Required. The parental status of the audience.
+        },
+        "poiDetails": { # Details for assigned POI targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_POI`. # POI details. This field will be populated when the targeting_type is `TARGETING_TYPE_POI`.
+          "displayName": "A String", # Output only. The display name of a POI, e.g. "Times Square", "Space Needle", followed by its full address if available.
+          "latitude": 3.14, # Output only. Latitude of the POI rounding to 6th decimal place.
+          "longitude": 3.14, # Output only. Longitude of the POI rounding to 6th decimal place.
+          "proximityRadiusAmount": 3.14, # Required. The radius of the area around the POI that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`.
+          "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
+          "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_POI`. Accepted POI targeting option IDs can be retrieved using `targetingTypes.targetingOptions.search`. If targeting a specific latitude/longitude coordinate removed from an address or POI name, you can generate the necessary targeting option ID by rounding the desired coordinate values to the 6th decimal place, removing the decimals, and concatenating the string values separated by a semicolon. For example, you can target the latitude/longitude pair of 40.7414691, -74.003387 using the targeting option ID "40741469;-74003387". **Upon** **creation, this field value will be updated to append a semicolon and** **alphanumerical hash value if only latitude/longitude coordinates are** **provided.**
+        },
+        "proximityLocationListDetails": { # Targeting details for proximity location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`. # Proximity location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`.
+          "proximityLocationListId": "A String", # Required. ID of the proximity location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_PROXIMITY`.
+          "proximityRadius": 3.14, # Required. Radius expressed in the distance units set in proximity_radius_unit. This represents the size of the area around a chosen location that will be targeted. Radius should be between 1 and 500 miles or 800 kilometers.
+          "proximityRadiusUnit": "A String", # Required. Radius distance units.
+        },
+        "regionalLocationListDetails": { # Targeting details for regional location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`. # Regional location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`.
+          "negative": True or False, # Indicates if this option is being negatively targeted.
+          "regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`.
+        },
+        "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them.
+          "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED.
+        },
+        "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`.
+          "sessionPosition": "A String", # The position where the ad will show in a session.
+        },
+        "subExchangeDetails": { # Details for assigned sub-exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`. # Sub-exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`.
+          "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`.
+        },
+        "targetingType": "A String", # Output only. Identifies the type of this assigned targeting option.
+        "thirdPartyVerifierDetails": { # Assigned third party verifier targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`. # Third party verification details. This field will be populated when the targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`.
+          "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox.
+            "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+            "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+            "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+            "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+            "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+            "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads.
+            "excludedAdlooxCategories": [ # Adloox categories to exclude.
+              "A String",
+            ],
+            "excludedFraudIvtMfaCategories": [ # Optional. Adloox's fraud IVT MFA categories to exclude.
+              "A String",
+            ],
+            "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+            "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+            "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+            "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+            "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+            "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+            "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+            "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads.
+          },
+          "doubleVerify": { # Details of DoubleVerify settings. # Third party brand verifier -- DoubleVerify.
+            "appStarRating": { # Details of DoubleVerify star ratings settings. # Avoid bidding on apps with the star ratings.
+              "avoidInsufficientStarRating": True or False, # Avoid bidding on apps with insufficient star ratings.
+              "avoidedStarRating": "A String", # Avoid bidding on apps with the star ratings.
+            },
+            "avoidedAgeRatings": [ # Avoid bidding on apps with the age rating.
+              "A String",
+            ],
+            "brandSafetyCategories": { # Settings for brand safety controls. # DV Brand Safety Controls.
+              "avoidUnknownBrandSafetyCategory": True or False, # Unknown or unrateable.
+              "avoidedHighSeverityCategories": [ # Brand safety high severity avoidance categories.
+                "A String",
+              ],
+              "avoidedMediumSeverityCategories": [ # Brand safety medium severity avoidance categories.
+                "A String",
+              ],
+            },
+            "customSegmentId": "A String", # The custom segment ID provided by DoubleVerify. The ID must start with "51" and consist of eight digits. Custom segment ID cannot be specified along with any of the following fields: * brand_safety_categories * avoided_age_ratings * app_star_rating * fraud_invalid_traffic
+            "displayViewability": { # Details of DoubleVerify display viewability settings. # Display viewability settings (applicable to display line items only).
+              "iab": "A String", # Target web and app inventory to maximize IAB viewable rate.
+              "viewableDuring": "A String", # Target web and app inventory to maximize 100% viewable duration.
+            },
+            "fraudInvalidTraffic": { # DoubleVerify Fraud & Invalid Traffic settings. # Avoid Sites and Apps with historical Fraud & IVT Rates.
+              "avoidInsufficientOption": True or False, # Insufficient Historical Fraud & IVT Stats.
+              "avoidedFraudOption": "A String", # Avoid Sites and Apps with historical Fraud & IVT.
+            },
+            "videoViewability": { # Details of DoubleVerify video viewability settings. # Video viewability settings (applicable to video line items only).
+              "playerImpressionRate": "A String", # Target inventory to maximize impressions with 400x300 or greater player size.
+              "videoIab": "A String", # Target web inventory to maximize IAB viewable rate.
+              "videoViewableRate": "A String", # Target web inventory to maximize fully viewable rate.
+            },
+          },
+          "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science.
+            "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive.
+              "A String",
+            ],
+            "displayViewability": "A String", # Display Viewability section (applicable to display line items only).
+            "excludeUnrateable": True or False, # Brand Safety - **Unrateable**.
+            "excludedAdFraudRisk": "A String", # Ad Fraud settings.
+            "excludedAdultRisk": "A String", # Brand Safety - **Adult content**.
+            "excludedAlcoholRisk": "A String", # Brand Safety - **Alcohol**.
+            "excludedDrugsRisk": "A String", # Brand Safety - **Drugs**.
+            "excludedGamblingRisk": "A String", # Brand Safety - **Gambling**.
+            "excludedHateSpeechRisk": "A String", # Brand Safety - **Hate speech**.
+            "excludedIllegalDownloadsRisk": "A String", # Brand Safety - **Illegal downloads**.
+            "excludedOffensiveLanguageRisk": "A String", # Brand Safety - **Offensive language**.
+            "excludedViolenceRisk": "A String", # Brand Safety - **Violence**.
+            "qualitySyncCustomSegmentId": [ # Optional. The quality sync custom segment ID provided by Integral Ad Science. The ID must be between `3000000` and `4999999`, inclusive.
+              "A String",
+            ],
+            "traqScoreOption": "A String", # True advertising quality (applicable to Display line items only).
+            "videoViewability": "A String", # Video Viewability Section (applicable to video line items only).
+          },
+        },
+        "urlDetails": { # Details for assigned URL targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_URL`. # URL details. This field will be populated when the targeting_type is `TARGETING_TYPE_URL`.
+          "negative": True or False, # Indicates if this option is being negatively targeted.
+          "url": "A String", # Required. The URL, for example `example.com`. DV360 supports two levels of subdirectory targeting, for example `www.example.com/one-subdirectory-level/second-level`, and five levels of subdomain targeting, for example `five.four.three.two.one.example.com`.
+        },
+        "userRewardedContentDetails": { # User rewarded content targeting option details. This will be populated in the user_rewarded_content_details field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. # User rewarded content details. This field will be populated when the targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
+          "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
+          "userRewardedContent": "A String", # Output only. User rewarded content status for video ads.
+        },
+        "videoPlayerSizeDetails": { # Video player size targeting option details. This will be populated in the video_player_size_details field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. Explicitly targeting all options is not supported. Remove all video player size targeting options to achieve this effect. # Video player size details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.
+          "videoPlayerSize": "A String", # Required. The video player size.
+        },
+        "viewabilityDetails": { # Assigned viewability targeting option details. This will be populated in the viewability_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`. # Viewability details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIEWABILITY`. You can only target one viewability option per resource.
+          "viewability": "A String", # Required. The predicted viewability percentage.
+        },
+        "youtubeChannelDetails": { # Details for YouTube channel assigned targeting option. This will be populated in the youtube_channel_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`. # YouTube channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`.
+          "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
+          "negative": True or False, # Indicates if this option is being negatively targeted.
+        },
+        "youtubeVideoDetails": { # Details for YouTube video assigned targeting option. This will be populated in the youtube_video_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`. # YouTube video details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`.
+          "negative": True or False, # Indicates if this option is being negatively targeted.
+          "videoId": "A String", # YouTube video id as it appears on the YouTube watch page.
+        },
+      },
+      "lineItemId": "A String", # The ID of the line item the assigned targeting option is assigned to.
+    },
+  ],
+  "nextPageToken": "A String", # A token identifying the next page of results. This value should be specified as the pageToken in a subsequent call to `BulkListAssignedTargetingOptions` to fetch the next page of results. This token will be absent if there are no more line_item_assigned_targeting_options to return.
+}
+
+ +
+ bulkListAssignedTargetingOptions_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.
+        
+
+ +
+ bulkUpdate(advertiserId, body=None, x__xgafv=None) +
Updates multiple line items. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * BulkEditAssignedTargetingOptions * UpdateLineItem * assignedTargetingOptions.create * assignedTargetingOptions.delete YouTube & Partners line items cannot be created or updated using the API.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser this line item belongs to. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for LineItemService.BulkUpdateLineItems.
+  "lineItemIds": [ # Required. IDs of line items to update.
+    "A String",
+  ],
+  "targetLineItem": { # A single line item. # Required. A line item object containing the fields to be updated and the new values to assign to all line items specified in line_item_ids."
+    "advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to.
+    "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Required. The bidding strategy of the line item.
+      "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
+        "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
+      },
+      "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, when performance_goal_type is one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , the line_item_type of the insertion order line items must be either: * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , and when performance_goal_type is either: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` the line_item_type of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+        "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).
+        "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.
+        "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.
+        "raiseBidForDeals": True or False, # Whether the strategy takes deal floor prices into account.
+      },
+      "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity.
+        "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).
+        "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency.
+        "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value.
+        "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`.
+      },
+      "youtubeAndPartnersBid": { # Settings that control the bid strategy for YouTube and Partners resources. # A bid strategy used by YouTube and Partners resources. It can only be used for a YouTube and Partners line item or ad group entity.
+        "adGroupEffectiveTargetCpaSource": "A String", # Output only. Source of the effective target CPA value for ad group.
+        "adGroupEffectiveTargetCpaValue": "A String", # Output only. The effective target CPA for ad group, in micros of advertiser's currency.
+        "type": "A String", # The type of the bidding strategy.
+        "value": "A String", # The value used by the bidding strategy. When the bidding strategy is assigned at the line item level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` When the bidding strategy is assigned at the ad group level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPV` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` If not using an applicable strategy, the value of this field will be 0.
+      },
+    },
+    "budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item.
+      "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order.
+      "budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order.
+      "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system.
+    },
+    "campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to.
+    "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item. *Warning*: Starting **April 1, 2025**, the floodlight_activity_configs field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).
+      "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. *Warning*: Starting **April 1, 2025**, this field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).
+        { # Settings that control the behavior of a single Floodlight activity config.
+          "floodlightActivityId": "A String", # Required. The ID of the Floodlight activity.
+          "postClickLookbackWindowDays": 42, # Required. The number of days after an ad has been clicked in which a conversion may be counted. Must be between 0 and 90 inclusive.
+          "postViewLookbackWindowDays": 42, # Required. The number of days after an ad has been viewed in which a conversion may be counted. Must be between 0 and 90 inclusive.
+        },
+      ],
+      "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000.
+    },
+    "creativeIds": [ # The IDs of the creatives associated with the line item.
+      "A String",
+    ],
+    "displayName": "A String", # Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes.
+    "entityStatus": "A String", # Required. Controls whether or not the line item can spend its budget and bid on inventory. * For CreateLineItem method, only `ENTITY_STATUS_DRAFT` is allowed. To activate a line item, use UpdateLineItem method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * A line item cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * If the line item's parent insertion order is not active, the line item can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.
+    "excludeNewExchanges": True or False, # Whether to exclude new exchanges from automatically being targeted by the line item. This field is false by default.
+    "flight": { # Settings that control the active duration of a line item. # Required. The start and end time of the line item's flight.
+      "dateRange": { # A date range. # The flight start and end dates of the line item. They are resolved relative to the parent advertiser's time zone. * Required when flight_date_type is `LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM`. Output only otherwise. * When creating a new flight, both `start_date` and `end_date` must be in the future. * An existing flight with a `start_date` in the past has a mutable `end_date` but an immutable `start_date`. * `end_date` must be the `start_date` or later, both before the year 2037.
+        "endDate": { # 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 # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
+          "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.
+        },
+        "startDate": { # 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 # The lower bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
+          "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.
+        },
+      },
+      "flightDateType": "A String", # Required. The type of the line item's flight dates.
+    },
+    "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap)
+      "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set.
+      "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set.
+      "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).
+      "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).
+      "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable.
+    },
+    "insertionOrderId": "A String", # Required. Immutable. The unique ID of the insertion order that the line item belongs to.
+    "integrationDetails": { # Integration details of an entry. # Integration details of the line item.
+      "details": "A String", # Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters.
+      "integrationCode": "A String", # An external identifier to be associated with the entry. The integration code will show up together with the entry in many places in the system, for example, reporting. Must be UTF-8 encoded with a length of no more than 500 characters.
+    },
+    "lineItemId": "A String", # Output only. The unique ID of the line item. Assigned by the system.
+    "lineItemType": "A String", # Required. Immutable. The type of the line item.
+    "mobileApp": { # A mobile app promoted by a mobile app install line item. # The mobile app promoted by the line item. This is applicable only when line_item_type is either `LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INSTALL` or `LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL`.
+      "appId": "A String", # Required. The ID of the app provided by the platform store. Android apps are identified by the bundle ID used by Android's Play store, such as `com.google.android.gm`. iOS apps are identified by a nine-digit app ID used by Apple's App store, such as `422689480`.
+      "displayName": "A String", # Output only. The app name.
+      "platform": "A String", # Output only. The app platform.
+      "publisher": "A String", # Output only. The app publisher.
+    },
+    "name": "A String", # Output only. The resource name of the line item.
+    "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the line item.
+      "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0.
+      "dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of advertiser's currency. Applicable when the budget is currency based. Must be greater than 0. For example, for 1.5 standard unit of the currency, set this field to 1500000. The value assigned will be rounded to whole billable units for the relevant currency by the following rules: any positive value less than a single billable unit will be rounded up to one billable unit and any value larger than a single billable unit will be rounded down to the nearest billable value. For example, if the currency's billable unit is 0.01, and this field is set to 10257770, it will round down to 10250000, a value of 10.25. If set to 505, it will round up to 10000, a value of 0.01.
+      "pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent. When automatic budget allocation is enabled at the insertion order via automationType, this field is output only and defaults to `PACING_PERIOD_FLIGHT`.
+      "pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be spent across the pacing_period. `PACING_TYPE_ASAP` is not compatible with pacing_period `PACING_PERIOD_FLIGHT` for insertion orders.
+    },
+    "partnerCosts": [ # The partner costs associated with the line item. If absent or empty in CreateLineItem method, the newly created line item will inherit partner costs from its parent insertion order.
+      { # Settings that control a partner cost. A partner cost is any type of expense involved in running a campaign, other than the costs of purchasing impressions (which is called the media cost) and using third-party audience segment data (data fee). Some examples of partner costs include the fees for using DV360, a third-party ad server, or a third-party ad serving verification service.
+        "costType": "A String", # Required. The type of the partner cost.
+        "feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency. Applicable when the fee_type is `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0. For example, for 1.5 standard unit of the advertiser's currency, set this field to 1500000.
+        "feePercentageMillis": "A String", # The media fee percentage in millis (1/1000 of a percent). Applicable when the fee_type is `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0. For example: 100 represents 0.1%.
+        "feeType": "A String", # Required. The fee type for this partner cost.
+        "invoiceType": "A String", # The invoice type for this partner cost. * Required when cost_type is one of: - `PARTNER_COST_TYPE_ADLOOX` - `PARTNER_COST_TYPE_DOUBLE_VERIFY` - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`. * Output only for other types.
+      },
+    ],
+    "partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item.
+      "markupAmount": "A String", # Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001).
+      "markupType": "A String", # Required. The markup type of the partner revenue model.
+    },
+    "reservationType": "A String", # Output only. The reservation type of the line item.
+    "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists.
+      "audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources.
+      "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources.
+      "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` *Warning*: Starting **March 6, 2025**, this field will stop being compatible when using the BiddingStrategy field fixed_bid. [Read more about this announced change](/display-video/api/deprecations#features.ot_fixed_bid)
+    },
+    "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system.
+    "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running.
+      "A String",
+    ],
+    "youtubeAndPartnersSettings": { # Settings for YouTube and Partners line items. # Output only. Settings specific to YouTube and Partners line items.
+      "contentCategory": "A String", # The kind of content on which the YouTube and Partners ads will be shown.
+      "effectiveContentCategory": "A String", # Output only. The content category which takes effect when serving the line item. When content category is set in both line item and advertiser, the stricter one will take effect when serving the line item.
+      "inventorySourceSettings": { # Settings that control what YouTube related inventories the YouTube and Partners line item will target. # Settings that control what YouTube and Partners inventories the line item will target.
+        "includeGoogleTv": True or False, # Optional. Whether to target inventory in video apps available with Google TV.
+        "includeYoutube": True or False, # Optional. Whether to target inventory on YouTube. This includes both search, channels and videos.
+        "includeYoutubeVideoPartners": True or False, # Whether to target inventory on a collection of partner sites and apps that follow the same brand safety standards as YouTube.
+      },
+      "leadFormId": "A String", # Optional. The ID of the form to generate leads.
+      "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed.
+      "relatedVideoIds": [ # Optional. The IDs of the videos appear below the primary video ad when the ad is playing in the YouTube app on mobile devices.
+        "A String",
+      ],
+      "targetFrequency": { # Setting that controls the average number of times the ads will show to the same person over a certain period of time. # Optional. The average number of times you want ads from this line item to show to the same person over a certain period of time.
+        "targetCount": "A String", # The target number of times, on average, the ads will be shown to the same person in the timespan dictated by time_unit and time_unit_count.
+        "timeUnit": "A String", # The unit of time in which the target frequency will be applied. The following time unit is applicable: * `TIME_UNIT_WEEKS`
+        "timeUnitCount": 42, # The number of time_unit the target frequency will last. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_WEEKS` - must be 1
+      },
+      "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third-party measurement configs of the line item.
+        "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR`
+          { # Settings that control how third-party measurement vendors are configured.
+            "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item.
+            "vendor": "A String", # The third-party measurement vendor.
+          },
+        ],
+        "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZERF` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE`
+          { # Settings that control how third-party measurement vendors are configured.
+            "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item.
+            "vendor": "A String", # The third-party measurement vendor.
+          },
+        ],
+        "reachVendorConfigs": [ # Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR`
+          { # Settings that control how third-party measurement vendors are configured.
+            "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item.
+            "vendor": "A String", # The third-party measurement vendor.
+          },
+        ],
+        "viewabilityVendorConfigs": [ # Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS`
+          { # Settings that control how third-party measurement vendors are configured.
+            "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item.
+            "vendor": "A String", # The third-party measurement vendor.
+          },
+        ],
+      },
+      "videoAdSequenceSettings": { # Settings related to VideoAdSequence. # Optional. The settings related to VideoAdSequence.
+        "minimumDuration": "A String", # The minimum time interval before the same user sees this sequence again.
+        "steps": [ # The steps of which the sequence consists.
+          { # The detail of a single step in a VideoAdSequence.
+            "adGroupId": "A String", # The ID of the corresponding ad group of the step.
+            "interactionType": "A String", # The interaction on the previous step that will lead the viewer to this step. The first step does not have interaction_type.
+            "previousStepId": "A String", # The ID of the previous step. The first step does not have previous step.
+            "stepId": "A String", # The ID of the step.
+          },
+        ],
+      },
+      "viewFrequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # The view frequency cap settings of the line item. The max_views field in this settings object must be used if assigning a limited cap. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap)
+        "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set.
+        "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set.
+        "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).
+        "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).
+        "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable.
+      },
+    },
+  },
+  "updateMask": "A String", # Required. A field mask identifying which fields to update. Only the following fields are currently supported: * entityStatus
+}
+
+  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 LineItemService.BulkUpdateLineItems.
+  "errors": [ # Errors returned by line items that failed to update.
+    { # 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).
+      "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.
+    },
+  ],
+  "failedLineItemIds": [ # The IDs of line items that failed to update.
+    "A String",
+  ],
+  "skippedLineItemIds": [ # The IDs of line items that are skipped for updates. For example, unnecessary mutates that will result in effectively no changes to line items will be skipped and corresponding line item IDs can be tracked here.
+    "A String",
+  ],
+  "updatedLineItemIds": [ # The IDs of successfully updated line items.
+    "A String",
+  ],
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ create(advertiserId, body=None, x__xgafv=None) +
Creates a new line item. Returns the newly created line item if successful. YouTube & Partners line items cannot be created or updated using the API.
+
+Args:
+  advertiserId: string, Output only. The unique ID of the advertiser the line item belongs to. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A single line item.
+  "advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to.
+  "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Required. The bidding strategy of the line item.
+    "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
+      "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
+    },
+    "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, when performance_goal_type is one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , the line_item_type of the insertion order line items must be either: * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , and when performance_goal_type is either: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` the line_item_type of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+      "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).
+      "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.
+      "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.
+      "raiseBidForDeals": True or False, # Whether the strategy takes deal floor prices into account.
+    },
+    "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity.
+      "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).
+      "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency.
+      "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value.
+      "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`.
+    },
+    "youtubeAndPartnersBid": { # Settings that control the bid strategy for YouTube and Partners resources. # A bid strategy used by YouTube and Partners resources. It can only be used for a YouTube and Partners line item or ad group entity.
+      "adGroupEffectiveTargetCpaSource": "A String", # Output only. Source of the effective target CPA value for ad group.
+      "adGroupEffectiveTargetCpaValue": "A String", # Output only. The effective target CPA for ad group, in micros of advertiser's currency.
+      "type": "A String", # The type of the bidding strategy.
+      "value": "A String", # The value used by the bidding strategy. When the bidding strategy is assigned at the line item level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` When the bidding strategy is assigned at the ad group level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPV` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` If not using an applicable strategy, the value of this field will be 0.
+    },
+  },
+  "budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item.
+    "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order.
+    "budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order.
+    "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system.
+  },
+  "campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to.
+  "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item. *Warning*: Starting **April 1, 2025**, the floodlight_activity_configs field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).
+    "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. *Warning*: Starting **April 1, 2025**, this field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).
+      { # Settings that control the behavior of a single Floodlight activity config.
+        "floodlightActivityId": "A String", # Required. The ID of the Floodlight activity.
+        "postClickLookbackWindowDays": 42, # Required. The number of days after an ad has been clicked in which a conversion may be counted. Must be between 0 and 90 inclusive.
+        "postViewLookbackWindowDays": 42, # Required. The number of days after an ad has been viewed in which a conversion may be counted. Must be between 0 and 90 inclusive.
+      },
+    ],
+    "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000.
+  },
+  "creativeIds": [ # The IDs of the creatives associated with the line item.
+    "A String",
+  ],
+  "displayName": "A String", # Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "entityStatus": "A String", # Required. Controls whether or not the line item can spend its budget and bid on inventory. * For CreateLineItem method, only `ENTITY_STATUS_DRAFT` is allowed. To activate a line item, use UpdateLineItem method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * A line item cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * If the line item's parent insertion order is not active, the line item can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.
+  "excludeNewExchanges": True or False, # Whether to exclude new exchanges from automatically being targeted by the line item. This field is false by default.
+  "flight": { # Settings that control the active duration of a line item. # Required. The start and end time of the line item's flight.
+    "dateRange": { # A date range. # The flight start and end dates of the line item. They are resolved relative to the parent advertiser's time zone. * Required when flight_date_type is `LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM`. Output only otherwise. * When creating a new flight, both `start_date` and `end_date` must be in the future. * An existing flight with a `start_date` in the past has a mutable `end_date` but an immutable `start_date`. * `end_date` must be the `start_date` or later, both before the year 2037.
+      "endDate": { # 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 # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
+        "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.
+      },
+      "startDate": { # 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 # The lower bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
+        "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.
+      },
+    },
+    "flightDateType": "A String", # Required. The type of the line item's flight dates.
+  },
+  "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap)
+    "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set.
+    "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set.
+    "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).
+    "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).
+    "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable.
+  },
+  "insertionOrderId": "A String", # Required. Immutable. The unique ID of the insertion order that the line item belongs to.
+  "integrationDetails": { # Integration details of an entry. # Integration details of the line item.
+    "details": "A String", # Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters.
+    "integrationCode": "A String", # An external identifier to be associated with the entry. The integration code will show up together with the entry in many places in the system, for example, reporting. Must be UTF-8 encoded with a length of no more than 500 characters.
+  },
+  "lineItemId": "A String", # Output only. The unique ID of the line item. Assigned by the system.
+  "lineItemType": "A String", # Required. Immutable. The type of the line item.
+  "mobileApp": { # A mobile app promoted by a mobile app install line item. # The mobile app promoted by the line item. This is applicable only when line_item_type is either `LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INSTALL` or `LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL`.
+    "appId": "A String", # Required. The ID of the app provided by the platform store. Android apps are identified by the bundle ID used by Android's Play store, such as `com.google.android.gm`. iOS apps are identified by a nine-digit app ID used by Apple's App store, such as `422689480`.
+    "displayName": "A String", # Output only. The app name.
+    "platform": "A String", # Output only. The app platform.
+    "publisher": "A String", # Output only. The app publisher.
+  },
+  "name": "A String", # Output only. The resource name of the line item.
+  "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the line item.
+    "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0.
+    "dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of advertiser's currency. Applicable when the budget is currency based. Must be greater than 0. For example, for 1.5 standard unit of the currency, set this field to 1500000. The value assigned will be rounded to whole billable units for the relevant currency by the following rules: any positive value less than a single billable unit will be rounded up to one billable unit and any value larger than a single billable unit will be rounded down to the nearest billable value. For example, if the currency's billable unit is 0.01, and this field is set to 10257770, it will round down to 10250000, a value of 10.25. If set to 505, it will round up to 10000, a value of 0.01.
+    "pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent. When automatic budget allocation is enabled at the insertion order via automationType, this field is output only and defaults to `PACING_PERIOD_FLIGHT`.
+    "pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be spent across the pacing_period. `PACING_TYPE_ASAP` is not compatible with pacing_period `PACING_PERIOD_FLIGHT` for insertion orders.
+  },
+  "partnerCosts": [ # The partner costs associated with the line item. If absent or empty in CreateLineItem method, the newly created line item will inherit partner costs from its parent insertion order.
+    { # Settings that control a partner cost. A partner cost is any type of expense involved in running a campaign, other than the costs of purchasing impressions (which is called the media cost) and using third-party audience segment data (data fee). Some examples of partner costs include the fees for using DV360, a third-party ad server, or a third-party ad serving verification service.
+      "costType": "A String", # Required. The type of the partner cost.
+      "feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency. Applicable when the fee_type is `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0. For example, for 1.5 standard unit of the advertiser's currency, set this field to 1500000.
+      "feePercentageMillis": "A String", # The media fee percentage in millis (1/1000 of a percent). Applicable when the fee_type is `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0. For example: 100 represents 0.1%.
+      "feeType": "A String", # Required. The fee type for this partner cost.
+      "invoiceType": "A String", # The invoice type for this partner cost. * Required when cost_type is one of: - `PARTNER_COST_TYPE_ADLOOX` - `PARTNER_COST_TYPE_DOUBLE_VERIFY` - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`. * Output only for other types.
+    },
+  ],
+  "partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item.
+    "markupAmount": "A String", # Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001).
+    "markupType": "A String", # Required. The markup type of the partner revenue model.
+  },
+  "reservationType": "A String", # Output only. The reservation type of the line item.
+  "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists.
+    "audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources.
+    "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources.
+    "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` *Warning*: Starting **March 6, 2025**, this field will stop being compatible when using the BiddingStrategy field fixed_bid. [Read more about this announced change](/display-video/api/deprecations#features.ot_fixed_bid)
+  },
+  "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system.
+  "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running.
+    "A String",
+  ],
+  "youtubeAndPartnersSettings": { # Settings for YouTube and Partners line items. # Output only. Settings specific to YouTube and Partners line items.
+    "contentCategory": "A String", # The kind of content on which the YouTube and Partners ads will be shown.
+    "effectiveContentCategory": "A String", # Output only. The content category which takes effect when serving the line item. When content category is set in both line item and advertiser, the stricter one will take effect when serving the line item.
+    "inventorySourceSettings": { # Settings that control what YouTube related inventories the YouTube and Partners line item will target. # Settings that control what YouTube and Partners inventories the line item will target.
+      "includeGoogleTv": True or False, # Optional. Whether to target inventory in video apps available with Google TV.
+      "includeYoutube": True or False, # Optional. Whether to target inventory on YouTube. This includes both search, channels and videos.
+      "includeYoutubeVideoPartners": True or False, # Whether to target inventory on a collection of partner sites and apps that follow the same brand safety standards as YouTube.
+    },
+    "leadFormId": "A String", # Optional. The ID of the form to generate leads.
+    "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed.
+    "relatedVideoIds": [ # Optional. The IDs of the videos appear below the primary video ad when the ad is playing in the YouTube app on mobile devices.
+      "A String",
+    ],
+    "targetFrequency": { # Setting that controls the average number of times the ads will show to the same person over a certain period of time. # Optional. The average number of times you want ads from this line item to show to the same person over a certain period of time.
+      "targetCount": "A String", # The target number of times, on average, the ads will be shown to the same person in the timespan dictated by time_unit and time_unit_count.
+      "timeUnit": "A String", # The unit of time in which the target frequency will be applied. The following time unit is applicable: * `TIME_UNIT_WEEKS`
+      "timeUnitCount": 42, # The number of time_unit the target frequency will last. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_WEEKS` - must be 1
+    },
+    "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third-party measurement configs of the line item.
+      "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR`
+        { # Settings that control how third-party measurement vendors are configured.
+          "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item.
+          "vendor": "A String", # The third-party measurement vendor.
+        },
+      ],
+      "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZERF` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE`
+        { # Settings that control how third-party measurement vendors are configured.
+          "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item.
+          "vendor": "A String", # The third-party measurement vendor.
+        },
+      ],
+      "reachVendorConfigs": [ # Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR`
+        { # Settings that control how third-party measurement vendors are configured.
+          "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item.
+          "vendor": "A String", # The third-party measurement vendor.
+        },
+      ],
+      "viewabilityVendorConfigs": [ # Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS`
+        { # Settings that control how third-party measurement vendors are configured.
+          "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item.
+          "vendor": "A String", # The third-party measurement vendor.
+        },
+      ],
+    },
+    "videoAdSequenceSettings": { # Settings related to VideoAdSequence. # Optional. The settings related to VideoAdSequence.
+      "minimumDuration": "A String", # The minimum time interval before the same user sees this sequence again.
+      "steps": [ # The steps of which the sequence consists.
+        { # The detail of a single step in a VideoAdSequence.
+          "adGroupId": "A String", # The ID of the corresponding ad group of the step.
+          "interactionType": "A String", # The interaction on the previous step that will lead the viewer to this step. The first step does not have interaction_type.
+          "previousStepId": "A String", # The ID of the previous step. The first step does not have previous step.
+          "stepId": "A String", # The ID of the step.
+        },
+      ],
+    },
+    "viewFrequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # The view frequency cap settings of the line item. The max_views field in this settings object must be used if assigning a limited cap. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap)
+      "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set.
+      "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set.
+      "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).
+      "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).
+      "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable.
+    },
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single line item.
+  "advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to.
+  "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Required. The bidding strategy of the line item.
+    "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
+      "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
+    },
+    "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, when performance_goal_type is one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , the line_item_type of the insertion order line items must be either: * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , and when performance_goal_type is either: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` the line_item_type of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+      "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).
+      "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.
+      "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.
+      "raiseBidForDeals": True or False, # Whether the strategy takes deal floor prices into account.
+    },
+    "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity.
+      "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).
+      "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency.
+      "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value.
+      "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`.
+    },
+    "youtubeAndPartnersBid": { # Settings that control the bid strategy for YouTube and Partners resources. # A bid strategy used by YouTube and Partners resources. It can only be used for a YouTube and Partners line item or ad group entity.
+      "adGroupEffectiveTargetCpaSource": "A String", # Output only. Source of the effective target CPA value for ad group.
+      "adGroupEffectiveTargetCpaValue": "A String", # Output only. The effective target CPA for ad group, in micros of advertiser's currency.
+      "type": "A String", # The type of the bidding strategy.
+      "value": "A String", # The value used by the bidding strategy. When the bidding strategy is assigned at the line item level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` When the bidding strategy is assigned at the ad group level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPV` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` If not using an applicable strategy, the value of this field will be 0.
+    },
+  },
+  "budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item.
+    "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order.
+    "budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order.
+    "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system.
+  },
+  "campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to.
+  "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item. *Warning*: Starting **April 1, 2025**, the floodlight_activity_configs field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).
+    "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. *Warning*: Starting **April 1, 2025**, this field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).
+      { # Settings that control the behavior of a single Floodlight activity config.
+        "floodlightActivityId": "A String", # Required. The ID of the Floodlight activity.
+        "postClickLookbackWindowDays": 42, # Required. The number of days after an ad has been clicked in which a conversion may be counted. Must be between 0 and 90 inclusive.
+        "postViewLookbackWindowDays": 42, # Required. The number of days after an ad has been viewed in which a conversion may be counted. Must be between 0 and 90 inclusive.
+      },
+    ],
+    "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000.
+  },
+  "creativeIds": [ # The IDs of the creatives associated with the line item.
+    "A String",
+  ],
+  "displayName": "A String", # Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "entityStatus": "A String", # Required. Controls whether or not the line item can spend its budget and bid on inventory. * For CreateLineItem method, only `ENTITY_STATUS_DRAFT` is allowed. To activate a line item, use UpdateLineItem method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * A line item cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * If the line item's parent insertion order is not active, the line item can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.
+  "excludeNewExchanges": True or False, # Whether to exclude new exchanges from automatically being targeted by the line item. This field is false by default.
+  "flight": { # Settings that control the active duration of a line item. # Required. The start and end time of the line item's flight.
+    "dateRange": { # A date range. # The flight start and end dates of the line item. They are resolved relative to the parent advertiser's time zone. * Required when flight_date_type is `LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM`. Output only otherwise. * When creating a new flight, both `start_date` and `end_date` must be in the future. * An existing flight with a `start_date` in the past has a mutable `end_date` but an immutable `start_date`. * `end_date` must be the `start_date` or later, both before the year 2037.
+      "endDate": { # 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 # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
+        "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.
+      },
+      "startDate": { # 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 # The lower bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
+        "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.
+      },
+    },
+    "flightDateType": "A String", # Required. The type of the line item's flight dates.
+  },
+  "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap)
+    "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set.
+    "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set.
+    "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).
+    "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).
+    "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable.
+  },
+  "insertionOrderId": "A String", # Required. Immutable. The unique ID of the insertion order that the line item belongs to.
+  "integrationDetails": { # Integration details of an entry. # Integration details of the line item.
+    "details": "A String", # Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters.
+    "integrationCode": "A String", # An external identifier to be associated with the entry. The integration code will show up together with the entry in many places in the system, for example, reporting. Must be UTF-8 encoded with a length of no more than 500 characters.
+  },
+  "lineItemId": "A String", # Output only. The unique ID of the line item. Assigned by the system.
+  "lineItemType": "A String", # Required. Immutable. The type of the line item.
+  "mobileApp": { # A mobile app promoted by a mobile app install line item. # The mobile app promoted by the line item. This is applicable only when line_item_type is either `LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INSTALL` or `LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL`.
+    "appId": "A String", # Required. The ID of the app provided by the platform store. Android apps are identified by the bundle ID used by Android's Play store, such as `com.google.android.gm`. iOS apps are identified by a nine-digit app ID used by Apple's App store, such as `422689480`.
+    "displayName": "A String", # Output only. The app name.
+    "platform": "A String", # Output only. The app platform.
+    "publisher": "A String", # Output only. The app publisher.
+  },
+  "name": "A String", # Output only. The resource name of the line item.
+  "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the line item.
+    "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0.
+    "dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of advertiser's currency. Applicable when the budget is currency based. Must be greater than 0. For example, for 1.5 standard unit of the currency, set this field to 1500000. The value assigned will be rounded to whole billable units for the relevant currency by the following rules: any positive value less than a single billable unit will be rounded up to one billable unit and any value larger than a single billable unit will be rounded down to the nearest billable value. For example, if the currency's billable unit is 0.01, and this field is set to 10257770, it will round down to 10250000, a value of 10.25. If set to 505, it will round up to 10000, a value of 0.01.
+    "pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent. When automatic budget allocation is enabled at the insertion order via automationType, this field is output only and defaults to `PACING_PERIOD_FLIGHT`.
+    "pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be spent across the pacing_period. `PACING_TYPE_ASAP` is not compatible with pacing_period `PACING_PERIOD_FLIGHT` for insertion orders.
+  },
+  "partnerCosts": [ # The partner costs associated with the line item. If absent or empty in CreateLineItem method, the newly created line item will inherit partner costs from its parent insertion order.
+    { # Settings that control a partner cost. A partner cost is any type of expense involved in running a campaign, other than the costs of purchasing impressions (which is called the media cost) and using third-party audience segment data (data fee). Some examples of partner costs include the fees for using DV360, a third-party ad server, or a third-party ad serving verification service.
+      "costType": "A String", # Required. The type of the partner cost.
+      "feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency. Applicable when the fee_type is `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0. For example, for 1.5 standard unit of the advertiser's currency, set this field to 1500000.
+      "feePercentageMillis": "A String", # The media fee percentage in millis (1/1000 of a percent). Applicable when the fee_type is `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0. For example: 100 represents 0.1%.
+      "feeType": "A String", # Required. The fee type for this partner cost.
+      "invoiceType": "A String", # The invoice type for this partner cost. * Required when cost_type is one of: - `PARTNER_COST_TYPE_ADLOOX` - `PARTNER_COST_TYPE_DOUBLE_VERIFY` - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`. * Output only for other types.
+    },
+  ],
+  "partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item.
+    "markupAmount": "A String", # Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001).
+    "markupType": "A String", # Required. The markup type of the partner revenue model.
+  },
+  "reservationType": "A String", # Output only. The reservation type of the line item.
+  "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists.
+    "audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources.
+    "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources.
+    "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` *Warning*: Starting **March 6, 2025**, this field will stop being compatible when using the BiddingStrategy field fixed_bid. [Read more about this announced change](/display-video/api/deprecations#features.ot_fixed_bid)
+  },
+  "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system.
+  "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running.
+    "A String",
+  ],
+  "youtubeAndPartnersSettings": { # Settings for YouTube and Partners line items. # Output only. Settings specific to YouTube and Partners line items.
+    "contentCategory": "A String", # The kind of content on which the YouTube and Partners ads will be shown.
+    "effectiveContentCategory": "A String", # Output only. The content category which takes effect when serving the line item. When content category is set in both line item and advertiser, the stricter one will take effect when serving the line item.
+    "inventorySourceSettings": { # Settings that control what YouTube related inventories the YouTube and Partners line item will target. # Settings that control what YouTube and Partners inventories the line item will target.
+      "includeGoogleTv": True or False, # Optional. Whether to target inventory in video apps available with Google TV.
+      "includeYoutube": True or False, # Optional. Whether to target inventory on YouTube. This includes both search, channels and videos.
+      "includeYoutubeVideoPartners": True or False, # Whether to target inventory on a collection of partner sites and apps that follow the same brand safety standards as YouTube.
+    },
+    "leadFormId": "A String", # Optional. The ID of the form to generate leads.
+    "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed.
+    "relatedVideoIds": [ # Optional. The IDs of the videos appear below the primary video ad when the ad is playing in the YouTube app on mobile devices.
+      "A String",
+    ],
+    "targetFrequency": { # Setting that controls the average number of times the ads will show to the same person over a certain period of time. # Optional. The average number of times you want ads from this line item to show to the same person over a certain period of time.
+      "targetCount": "A String", # The target number of times, on average, the ads will be shown to the same person in the timespan dictated by time_unit and time_unit_count.
+      "timeUnit": "A String", # The unit of time in which the target frequency will be applied. The following time unit is applicable: * `TIME_UNIT_WEEKS`
+      "timeUnitCount": 42, # The number of time_unit the target frequency will last. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_WEEKS` - must be 1
+    },
+    "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third-party measurement configs of the line item.
+      "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR`
+        { # Settings that control how third-party measurement vendors are configured.
+          "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item.
+          "vendor": "A String", # The third-party measurement vendor.
+        },
+      ],
+      "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZERF` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE`
+        { # Settings that control how third-party measurement vendors are configured.
+          "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item.
+          "vendor": "A String", # The third-party measurement vendor.
+        },
+      ],
+      "reachVendorConfigs": [ # Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR`
+        { # Settings that control how third-party measurement vendors are configured.
+          "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item.
+          "vendor": "A String", # The third-party measurement vendor.
+        },
+      ],
+      "viewabilityVendorConfigs": [ # Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS`
+        { # Settings that control how third-party measurement vendors are configured.
+          "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item.
+          "vendor": "A String", # The third-party measurement vendor.
+        },
+      ],
+    },
+    "videoAdSequenceSettings": { # Settings related to VideoAdSequence. # Optional. The settings related to VideoAdSequence.
+      "minimumDuration": "A String", # The minimum time interval before the same user sees this sequence again.
+      "steps": [ # The steps of which the sequence consists.
+        { # The detail of a single step in a VideoAdSequence.
+          "adGroupId": "A String", # The ID of the corresponding ad group of the step.
+          "interactionType": "A String", # The interaction on the previous step that will lead the viewer to this step. The first step does not have interaction_type.
+          "previousStepId": "A String", # The ID of the previous step. The first step does not have previous step.
+          "stepId": "A String", # The ID of the step.
+        },
+      ],
+    },
+    "viewFrequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # The view frequency cap settings of the line item. The max_views field in this settings object must be used if assigning a limited cap. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap)
+      "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set.
+      "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set.
+      "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).
+      "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).
+      "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable.
+    },
+  },
+}
+
+ +
+ delete(advertiserId, lineItemId, x__xgafv=None) +
Deletes a line item. Returns error code `NOT_FOUND` if the line item does not exist. The line item should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it. YouTube & Partners line items cannot be created or updated using the API.
+
+Args:
+  advertiserId: string, The ID of the advertiser this line item belongs to. (required)
+  lineItemId: string, The ID of the line item 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); }
+}
+
+ +
+ duplicate(advertiserId, lineItemId, body=None, x__xgafv=None) +
Duplicates a line item. Returns the ID of the created line item if successful. YouTube & Partners line items cannot be created or updated using the API. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser this line item belongs to. (required)
+  lineItemId: string, Required. The ID of the line item to duplicate. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for LineItemService.DuplicateLineItem.
+  "targetDisplayName": "A String", # The display name of the new line item. Must be UTF-8 encoded with a maximum size of 240 bytes.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "duplicateLineItemId": "A String", # The ID of the created line item.
+}
+
+ +
+ generateDefault(advertiserId, body=None, x__xgafv=None) +
Creates a new line item with settings (including targeting) inherited from the insertion order and an `ENTITY_STATUS_DRAFT` entity_status. Returns the newly created line item if successful. There are default values based on the three fields: * The insertion order's insertion_order_type * The insertion order's automation_type * The given line_item_type YouTube & Partners line items cannot be created or updated using the API.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser this line item belongs to. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for LineItemService.GenerateDefaultLineItem.
+  "displayName": "A String", # Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "insertionOrderId": "A String", # Required. The unique ID of the insertion order that the line item belongs to.
+  "lineItemType": "A String", # Required. The type of the line item.
+  "mobileApp": { # A mobile app promoted by a mobile app install line item. # The mobile app promoted by the line item. This is applicable only when line_item_type is either `LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INSTALL` or `LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL`.
+    "appId": "A String", # Required. The ID of the app provided by the platform store. Android apps are identified by the bundle ID used by Android's Play store, such as `com.google.android.gm`. iOS apps are identified by a nine-digit app ID used by Apple's App store, such as `422689480`.
+    "displayName": "A String", # Output only. The app name.
+    "platform": "A String", # Output only. The app platform.
+    "publisher": "A String", # Output only. The app publisher.
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single line item.
+  "advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to.
+  "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Required. The bidding strategy of the line item.
+    "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
+      "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
+    },
+    "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, when performance_goal_type is one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , the line_item_type of the insertion order line items must be either: * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , and when performance_goal_type is either: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` the line_item_type of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+      "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).
+      "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.
+      "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.
+      "raiseBidForDeals": True or False, # Whether the strategy takes deal floor prices into account.
+    },
+    "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity.
+      "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).
+      "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency.
+      "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value.
+      "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`.
+    },
+    "youtubeAndPartnersBid": { # Settings that control the bid strategy for YouTube and Partners resources. # A bid strategy used by YouTube and Partners resources. It can only be used for a YouTube and Partners line item or ad group entity.
+      "adGroupEffectiveTargetCpaSource": "A String", # Output only. Source of the effective target CPA value for ad group.
+      "adGroupEffectiveTargetCpaValue": "A String", # Output only. The effective target CPA for ad group, in micros of advertiser's currency.
+      "type": "A String", # The type of the bidding strategy.
+      "value": "A String", # The value used by the bidding strategy. When the bidding strategy is assigned at the line item level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` When the bidding strategy is assigned at the ad group level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPV` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` If not using an applicable strategy, the value of this field will be 0.
+    },
+  },
+  "budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item.
+    "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order.
+    "budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order.
+    "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system.
+  },
+  "campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to.
+  "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item. *Warning*: Starting **April 1, 2025**, the floodlight_activity_configs field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).
+    "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. *Warning*: Starting **April 1, 2025**, this field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).
+      { # Settings that control the behavior of a single Floodlight activity config.
+        "floodlightActivityId": "A String", # Required. The ID of the Floodlight activity.
+        "postClickLookbackWindowDays": 42, # Required. The number of days after an ad has been clicked in which a conversion may be counted. Must be between 0 and 90 inclusive.
+        "postViewLookbackWindowDays": 42, # Required. The number of days after an ad has been viewed in which a conversion may be counted. Must be between 0 and 90 inclusive.
+      },
+    ],
+    "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000.
+  },
+  "creativeIds": [ # The IDs of the creatives associated with the line item.
+    "A String",
+  ],
+  "displayName": "A String", # Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "entityStatus": "A String", # Required. Controls whether or not the line item can spend its budget and bid on inventory. * For CreateLineItem method, only `ENTITY_STATUS_DRAFT` is allowed. To activate a line item, use UpdateLineItem method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * A line item cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * If the line item's parent insertion order is not active, the line item can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.
+  "excludeNewExchanges": True or False, # Whether to exclude new exchanges from automatically being targeted by the line item. This field is false by default.
+  "flight": { # Settings that control the active duration of a line item. # Required. The start and end time of the line item's flight.
+    "dateRange": { # A date range. # The flight start and end dates of the line item. They are resolved relative to the parent advertiser's time zone. * Required when flight_date_type is `LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM`. Output only otherwise. * When creating a new flight, both `start_date` and `end_date` must be in the future. * An existing flight with a `start_date` in the past has a mutable `end_date` but an immutable `start_date`. * `end_date` must be the `start_date` or later, both before the year 2037.
+      "endDate": { # 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 # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
+        "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.
+      },
+      "startDate": { # 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 # The lower bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
+        "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.
+      },
+    },
+    "flightDateType": "A String", # Required. The type of the line item's flight dates.
+  },
+  "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap)
+    "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set.
+    "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set.
+    "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).
+    "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).
+    "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable.
+  },
+  "insertionOrderId": "A String", # Required. Immutable. The unique ID of the insertion order that the line item belongs to.
+  "integrationDetails": { # Integration details of an entry. # Integration details of the line item.
+    "details": "A String", # Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters.
+    "integrationCode": "A String", # An external identifier to be associated with the entry. The integration code will show up together with the entry in many places in the system, for example, reporting. Must be UTF-8 encoded with a length of no more than 500 characters.
+  },
+  "lineItemId": "A String", # Output only. The unique ID of the line item. Assigned by the system.
+  "lineItemType": "A String", # Required. Immutable. The type of the line item.
+  "mobileApp": { # A mobile app promoted by a mobile app install line item. # The mobile app promoted by the line item. This is applicable only when line_item_type is either `LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INSTALL` or `LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL`.
+    "appId": "A String", # Required. The ID of the app provided by the platform store. Android apps are identified by the bundle ID used by Android's Play store, such as `com.google.android.gm`. iOS apps are identified by a nine-digit app ID used by Apple's App store, such as `422689480`.
+    "displayName": "A String", # Output only. The app name.
+    "platform": "A String", # Output only. The app platform.
+    "publisher": "A String", # Output only. The app publisher.
+  },
+  "name": "A String", # Output only. The resource name of the line item.
+  "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the line item.
+    "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0.
+    "dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of advertiser's currency. Applicable when the budget is currency based. Must be greater than 0. For example, for 1.5 standard unit of the currency, set this field to 1500000. The value assigned will be rounded to whole billable units for the relevant currency by the following rules: any positive value less than a single billable unit will be rounded up to one billable unit and any value larger than a single billable unit will be rounded down to the nearest billable value. For example, if the currency's billable unit is 0.01, and this field is set to 10257770, it will round down to 10250000, a value of 10.25. If set to 505, it will round up to 10000, a value of 0.01.
+    "pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent. When automatic budget allocation is enabled at the insertion order via automationType, this field is output only and defaults to `PACING_PERIOD_FLIGHT`.
+    "pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be spent across the pacing_period. `PACING_TYPE_ASAP` is not compatible with pacing_period `PACING_PERIOD_FLIGHT` for insertion orders.
+  },
+  "partnerCosts": [ # The partner costs associated with the line item. If absent or empty in CreateLineItem method, the newly created line item will inherit partner costs from its parent insertion order.
+    { # Settings that control a partner cost. A partner cost is any type of expense involved in running a campaign, other than the costs of purchasing impressions (which is called the media cost) and using third-party audience segment data (data fee). Some examples of partner costs include the fees for using DV360, a third-party ad server, or a third-party ad serving verification service.
+      "costType": "A String", # Required. The type of the partner cost.
+      "feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency. Applicable when the fee_type is `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0. For example, for 1.5 standard unit of the advertiser's currency, set this field to 1500000.
+      "feePercentageMillis": "A String", # The media fee percentage in millis (1/1000 of a percent). Applicable when the fee_type is `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0. For example: 100 represents 0.1%.
+      "feeType": "A String", # Required. The fee type for this partner cost.
+      "invoiceType": "A String", # The invoice type for this partner cost. * Required when cost_type is one of: - `PARTNER_COST_TYPE_ADLOOX` - `PARTNER_COST_TYPE_DOUBLE_VERIFY` - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`. * Output only for other types.
+    },
+  ],
+  "partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item.
+    "markupAmount": "A String", # Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001).
+    "markupType": "A String", # Required. The markup type of the partner revenue model.
+  },
+  "reservationType": "A String", # Output only. The reservation type of the line item.
+  "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists.
+    "audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources.
+    "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources.
+    "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` *Warning*: Starting **March 6, 2025**, this field will stop being compatible when using the BiddingStrategy field fixed_bid. [Read more about this announced change](/display-video/api/deprecations#features.ot_fixed_bid)
+  },
+  "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system.
+  "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running.
+    "A String",
+  ],
+  "youtubeAndPartnersSettings": { # Settings for YouTube and Partners line items. # Output only. Settings specific to YouTube and Partners line items.
+    "contentCategory": "A String", # The kind of content on which the YouTube and Partners ads will be shown.
+    "effectiveContentCategory": "A String", # Output only. The content category which takes effect when serving the line item. When content category is set in both line item and advertiser, the stricter one will take effect when serving the line item.
+    "inventorySourceSettings": { # Settings that control what YouTube related inventories the YouTube and Partners line item will target. # Settings that control what YouTube and Partners inventories the line item will target.
+      "includeGoogleTv": True or False, # Optional. Whether to target inventory in video apps available with Google TV.
+      "includeYoutube": True or False, # Optional. Whether to target inventory on YouTube. This includes both search, channels and videos.
+      "includeYoutubeVideoPartners": True or False, # Whether to target inventory on a collection of partner sites and apps that follow the same brand safety standards as YouTube.
+    },
+    "leadFormId": "A String", # Optional. The ID of the form to generate leads.
+    "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed.
+    "relatedVideoIds": [ # Optional. The IDs of the videos appear below the primary video ad when the ad is playing in the YouTube app on mobile devices.
+      "A String",
+    ],
+    "targetFrequency": { # Setting that controls the average number of times the ads will show to the same person over a certain period of time. # Optional. The average number of times you want ads from this line item to show to the same person over a certain period of time.
+      "targetCount": "A String", # The target number of times, on average, the ads will be shown to the same person in the timespan dictated by time_unit and time_unit_count.
+      "timeUnit": "A String", # The unit of time in which the target frequency will be applied. The following time unit is applicable: * `TIME_UNIT_WEEKS`
+      "timeUnitCount": 42, # The number of time_unit the target frequency will last. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_WEEKS` - must be 1
+    },
+    "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third-party measurement configs of the line item.
+      "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR`
+        { # Settings that control how third-party measurement vendors are configured.
+          "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item.
+          "vendor": "A String", # The third-party measurement vendor.
+        },
+      ],
+      "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZERF` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE`
+        { # Settings that control how third-party measurement vendors are configured.
+          "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item.
+          "vendor": "A String", # The third-party measurement vendor.
+        },
+      ],
+      "reachVendorConfigs": [ # Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR`
+        { # Settings that control how third-party measurement vendors are configured.
+          "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item.
+          "vendor": "A String", # The third-party measurement vendor.
+        },
+      ],
+      "viewabilityVendorConfigs": [ # Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS`
+        { # Settings that control how third-party measurement vendors are configured.
+          "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item.
+          "vendor": "A String", # The third-party measurement vendor.
+        },
+      ],
+    },
+    "videoAdSequenceSettings": { # Settings related to VideoAdSequence. # Optional. The settings related to VideoAdSequence.
+      "minimumDuration": "A String", # The minimum time interval before the same user sees this sequence again.
+      "steps": [ # The steps of which the sequence consists.
+        { # The detail of a single step in a VideoAdSequence.
+          "adGroupId": "A String", # The ID of the corresponding ad group of the step.
+          "interactionType": "A String", # The interaction on the previous step that will lead the viewer to this step. The first step does not have interaction_type.
+          "previousStepId": "A String", # The ID of the previous step. The first step does not have previous step.
+          "stepId": "A String", # The ID of the step.
+        },
+      ],
+    },
+    "viewFrequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # The view frequency cap settings of the line item. The max_views field in this settings object must be used if assigning a limited cap. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap)
+      "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set.
+      "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set.
+      "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).
+      "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).
+      "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable.
+    },
+  },
+}
+
+ +
+ get(advertiserId, lineItemId, x__xgafv=None) +
Gets a line item.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser this line item belongs to. (required)
+  lineItemId: string, Required. The ID of the line item to fetch. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single line item.
+  "advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to.
+  "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Required. The bidding strategy of the line item.
+    "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
+      "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
+    },
+    "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, when performance_goal_type is one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , the line_item_type of the insertion order line items must be either: * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , and when performance_goal_type is either: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` the line_item_type of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+      "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).
+      "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.
+      "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.
+      "raiseBidForDeals": True or False, # Whether the strategy takes deal floor prices into account.
+    },
+    "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity.
+      "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).
+      "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency.
+      "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value.
+      "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`.
+    },
+    "youtubeAndPartnersBid": { # Settings that control the bid strategy for YouTube and Partners resources. # A bid strategy used by YouTube and Partners resources. It can only be used for a YouTube and Partners line item or ad group entity.
+      "adGroupEffectiveTargetCpaSource": "A String", # Output only. Source of the effective target CPA value for ad group.
+      "adGroupEffectiveTargetCpaValue": "A String", # Output only. The effective target CPA for ad group, in micros of advertiser's currency.
+      "type": "A String", # The type of the bidding strategy.
+      "value": "A String", # The value used by the bidding strategy. When the bidding strategy is assigned at the line item level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` When the bidding strategy is assigned at the ad group level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPV` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` If not using an applicable strategy, the value of this field will be 0.
+    },
+  },
+  "budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item.
+    "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order.
+    "budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order.
+    "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system.
+  },
+  "campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to.
+  "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item. *Warning*: Starting **April 1, 2025**, the floodlight_activity_configs field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).
+    "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. *Warning*: Starting **April 1, 2025**, this field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).
+      { # Settings that control the behavior of a single Floodlight activity config.
+        "floodlightActivityId": "A String", # Required. The ID of the Floodlight activity.
+        "postClickLookbackWindowDays": 42, # Required. The number of days after an ad has been clicked in which a conversion may be counted. Must be between 0 and 90 inclusive.
+        "postViewLookbackWindowDays": 42, # Required. The number of days after an ad has been viewed in which a conversion may be counted. Must be between 0 and 90 inclusive.
+      },
+    ],
+    "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000.
+  },
+  "creativeIds": [ # The IDs of the creatives associated with the line item.
+    "A String",
+  ],
+  "displayName": "A String", # Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "entityStatus": "A String", # Required. Controls whether or not the line item can spend its budget and bid on inventory. * For CreateLineItem method, only `ENTITY_STATUS_DRAFT` is allowed. To activate a line item, use UpdateLineItem method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * A line item cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * If the line item's parent insertion order is not active, the line item can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.
+  "excludeNewExchanges": True or False, # Whether to exclude new exchanges from automatically being targeted by the line item. This field is false by default.
+  "flight": { # Settings that control the active duration of a line item. # Required. The start and end time of the line item's flight.
+    "dateRange": { # A date range. # The flight start and end dates of the line item. They are resolved relative to the parent advertiser's time zone. * Required when flight_date_type is `LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM`. Output only otherwise. * When creating a new flight, both `start_date` and `end_date` must be in the future. * An existing flight with a `start_date` in the past has a mutable `end_date` but an immutable `start_date`. * `end_date` must be the `start_date` or later, both before the year 2037.
+      "endDate": { # 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 # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
+        "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.
+      },
+      "startDate": { # 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 # The lower bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
+        "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.
+      },
+    },
+    "flightDateType": "A String", # Required. The type of the line item's flight dates.
+  },
+  "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap)
+    "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set.
+    "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set.
+    "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).
+    "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).
+    "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable.
+  },
+  "insertionOrderId": "A String", # Required. Immutable. The unique ID of the insertion order that the line item belongs to.
+  "integrationDetails": { # Integration details of an entry. # Integration details of the line item.
+    "details": "A String", # Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters.
+    "integrationCode": "A String", # An external identifier to be associated with the entry. The integration code will show up together with the entry in many places in the system, for example, reporting. Must be UTF-8 encoded with a length of no more than 500 characters.
+  },
+  "lineItemId": "A String", # Output only. The unique ID of the line item. Assigned by the system.
+  "lineItemType": "A String", # Required. Immutable. The type of the line item.
+  "mobileApp": { # A mobile app promoted by a mobile app install line item. # The mobile app promoted by the line item. This is applicable only when line_item_type is either `LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INSTALL` or `LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL`.
+    "appId": "A String", # Required. The ID of the app provided by the platform store. Android apps are identified by the bundle ID used by Android's Play store, such as `com.google.android.gm`. iOS apps are identified by a nine-digit app ID used by Apple's App store, such as `422689480`.
+    "displayName": "A String", # Output only. The app name.
+    "platform": "A String", # Output only. The app platform.
+    "publisher": "A String", # Output only. The app publisher.
+  },
+  "name": "A String", # Output only. The resource name of the line item.
+  "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the line item.
+    "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0.
+    "dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of advertiser's currency. Applicable when the budget is currency based. Must be greater than 0. For example, for 1.5 standard unit of the currency, set this field to 1500000. The value assigned will be rounded to whole billable units for the relevant currency by the following rules: any positive value less than a single billable unit will be rounded up to one billable unit and any value larger than a single billable unit will be rounded down to the nearest billable value. For example, if the currency's billable unit is 0.01, and this field is set to 10257770, it will round down to 10250000, a value of 10.25. If set to 505, it will round up to 10000, a value of 0.01.
+    "pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent. When automatic budget allocation is enabled at the insertion order via automationType, this field is output only and defaults to `PACING_PERIOD_FLIGHT`.
+    "pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be spent across the pacing_period. `PACING_TYPE_ASAP` is not compatible with pacing_period `PACING_PERIOD_FLIGHT` for insertion orders.
+  },
+  "partnerCosts": [ # The partner costs associated with the line item. If absent or empty in CreateLineItem method, the newly created line item will inherit partner costs from its parent insertion order.
+    { # Settings that control a partner cost. A partner cost is any type of expense involved in running a campaign, other than the costs of purchasing impressions (which is called the media cost) and using third-party audience segment data (data fee). Some examples of partner costs include the fees for using DV360, a third-party ad server, or a third-party ad serving verification service.
+      "costType": "A String", # Required. The type of the partner cost.
+      "feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency. Applicable when the fee_type is `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0. For example, for 1.5 standard unit of the advertiser's currency, set this field to 1500000.
+      "feePercentageMillis": "A String", # The media fee percentage in millis (1/1000 of a percent). Applicable when the fee_type is `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0. For example: 100 represents 0.1%.
+      "feeType": "A String", # Required. The fee type for this partner cost.
+      "invoiceType": "A String", # The invoice type for this partner cost. * Required when cost_type is one of: - `PARTNER_COST_TYPE_ADLOOX` - `PARTNER_COST_TYPE_DOUBLE_VERIFY` - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`. * Output only for other types.
+    },
+  ],
+  "partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item.
+    "markupAmount": "A String", # Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001).
+    "markupType": "A String", # Required. The markup type of the partner revenue model.
+  },
+  "reservationType": "A String", # Output only. The reservation type of the line item.
+  "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists.
+    "audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources.
+    "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources.
+    "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` *Warning*: Starting **March 6, 2025**, this field will stop being compatible when using the BiddingStrategy field fixed_bid. [Read more about this announced change](/display-video/api/deprecations#features.ot_fixed_bid)
+  },
+  "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system.
+  "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running.
+    "A String",
+  ],
+  "youtubeAndPartnersSettings": { # Settings for YouTube and Partners line items. # Output only. Settings specific to YouTube and Partners line items.
+    "contentCategory": "A String", # The kind of content on which the YouTube and Partners ads will be shown.
+    "effectiveContentCategory": "A String", # Output only. The content category which takes effect when serving the line item. When content category is set in both line item and advertiser, the stricter one will take effect when serving the line item.
+    "inventorySourceSettings": { # Settings that control what YouTube related inventories the YouTube and Partners line item will target. # Settings that control what YouTube and Partners inventories the line item will target.
+      "includeGoogleTv": True or False, # Optional. Whether to target inventory in video apps available with Google TV.
+      "includeYoutube": True or False, # Optional. Whether to target inventory on YouTube. This includes both search, channels and videos.
+      "includeYoutubeVideoPartners": True or False, # Whether to target inventory on a collection of partner sites and apps that follow the same brand safety standards as YouTube.
+    },
+    "leadFormId": "A String", # Optional. The ID of the form to generate leads.
+    "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed.
+    "relatedVideoIds": [ # Optional. The IDs of the videos appear below the primary video ad when the ad is playing in the YouTube app on mobile devices.
+      "A String",
+    ],
+    "targetFrequency": { # Setting that controls the average number of times the ads will show to the same person over a certain period of time. # Optional. The average number of times you want ads from this line item to show to the same person over a certain period of time.
+      "targetCount": "A String", # The target number of times, on average, the ads will be shown to the same person in the timespan dictated by time_unit and time_unit_count.
+      "timeUnit": "A String", # The unit of time in which the target frequency will be applied. The following time unit is applicable: * `TIME_UNIT_WEEKS`
+      "timeUnitCount": 42, # The number of time_unit the target frequency will last. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_WEEKS` - must be 1
+    },
+    "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third-party measurement configs of the line item.
+      "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR`
+        { # Settings that control how third-party measurement vendors are configured.
+          "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item.
+          "vendor": "A String", # The third-party measurement vendor.
+        },
+      ],
+      "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZERF` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE`
+        { # Settings that control how third-party measurement vendors are configured.
+          "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item.
+          "vendor": "A String", # The third-party measurement vendor.
+        },
+      ],
+      "reachVendorConfigs": [ # Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR`
+        { # Settings that control how third-party measurement vendors are configured.
+          "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item.
+          "vendor": "A String", # The third-party measurement vendor.
+        },
+      ],
+      "viewabilityVendorConfigs": [ # Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS`
+        { # Settings that control how third-party measurement vendors are configured.
+          "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item.
+          "vendor": "A String", # The third-party measurement vendor.
+        },
+      ],
+    },
+    "videoAdSequenceSettings": { # Settings related to VideoAdSequence. # Optional. The settings related to VideoAdSequence.
+      "minimumDuration": "A String", # The minimum time interval before the same user sees this sequence again.
+      "steps": [ # The steps of which the sequence consists.
+        { # The detail of a single step in a VideoAdSequence.
+          "adGroupId": "A String", # The ID of the corresponding ad group of the step.
+          "interactionType": "A String", # The interaction on the previous step that will lead the viewer to this step. The first step does not have interaction_type.
+          "previousStepId": "A String", # The ID of the previous step. The first step does not have previous step.
+          "stepId": "A String", # The ID of the step.
+        },
+      ],
+    },
+    "viewFrequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # The view frequency cap settings of the line item. The max_views field in this settings object must be used if assigning a limited cap. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap)
+      "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set.
+      "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set.
+      "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).
+      "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).
+      "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable.
+    },
+  },
+}
+
+ +
+ list(advertiserId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists line items in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, line items with `ENTITY_STATUS_ARCHIVED` will not be included in the results.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser to list line items for. (required)
+  filter: string, Allows filtering by line item fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `insertionOrderId` * `lineItemId` * `lineItemType` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All line items under an insertion order: `insertionOrderId="1234"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` and `LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT"` * All line items with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<="2020-11-04T18:54:47Z"` * All line items with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
+  orderBy: string, Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` * `updateTime` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.
+  pageSize: integer, Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
+  pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListLineItems` method. If not specified, the first page of results 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:
+
+    {
+  "lineItems": [ # The list of line items. This list will be absent if empty.
+    { # A single line item.
+      "advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to.
+      "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Required. The bidding strategy of the line item.
+        "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
+          "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
+        },
+        "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, when performance_goal_type is one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , the line_item_type of the insertion order line items must be either: * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , and when performance_goal_type is either: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` the line_item_type of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+          "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).
+          "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.
+          "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.
+          "raiseBidForDeals": True or False, # Whether the strategy takes deal floor prices into account.
+        },
+        "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity.
+          "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).
+          "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency.
+          "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value.
+          "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`.
+        },
+        "youtubeAndPartnersBid": { # Settings that control the bid strategy for YouTube and Partners resources. # A bid strategy used by YouTube and Partners resources. It can only be used for a YouTube and Partners line item or ad group entity.
+          "adGroupEffectiveTargetCpaSource": "A String", # Output only. Source of the effective target CPA value for ad group.
+          "adGroupEffectiveTargetCpaValue": "A String", # Output only. The effective target CPA for ad group, in micros of advertiser's currency.
+          "type": "A String", # The type of the bidding strategy.
+          "value": "A String", # The value used by the bidding strategy. When the bidding strategy is assigned at the line item level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` When the bidding strategy is assigned at the ad group level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPV` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` If not using an applicable strategy, the value of this field will be 0.
+        },
+      },
+      "budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item.
+        "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order.
+        "budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order.
+        "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system.
+      },
+      "campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to.
+      "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item. *Warning*: Starting **April 1, 2025**, the floodlight_activity_configs field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).
+        "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. *Warning*: Starting **April 1, 2025**, this field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).
+          { # Settings that control the behavior of a single Floodlight activity config.
+            "floodlightActivityId": "A String", # Required. The ID of the Floodlight activity.
+            "postClickLookbackWindowDays": 42, # Required. The number of days after an ad has been clicked in which a conversion may be counted. Must be between 0 and 90 inclusive.
+            "postViewLookbackWindowDays": 42, # Required. The number of days after an ad has been viewed in which a conversion may be counted. Must be between 0 and 90 inclusive.
+          },
+        ],
+        "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000.
+      },
+      "creativeIds": [ # The IDs of the creatives associated with the line item.
+        "A String",
+      ],
+      "displayName": "A String", # Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes.
+      "entityStatus": "A String", # Required. Controls whether or not the line item can spend its budget and bid on inventory. * For CreateLineItem method, only `ENTITY_STATUS_DRAFT` is allowed. To activate a line item, use UpdateLineItem method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * A line item cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * If the line item's parent insertion order is not active, the line item can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.
+      "excludeNewExchanges": True or False, # Whether to exclude new exchanges from automatically being targeted by the line item. This field is false by default.
+      "flight": { # Settings that control the active duration of a line item. # Required. The start and end time of the line item's flight.
+        "dateRange": { # A date range. # The flight start and end dates of the line item. They are resolved relative to the parent advertiser's time zone. * Required when flight_date_type is `LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM`. Output only otherwise. * When creating a new flight, both `start_date` and `end_date` must be in the future. * An existing flight with a `start_date` in the past has a mutable `end_date` but an immutable `start_date`. * `end_date` must be the `start_date` or later, both before the year 2037.
+          "endDate": { # 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 # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
+            "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.
+          },
+          "startDate": { # 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 # The lower bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
+            "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.
+          },
+        },
+        "flightDateType": "A String", # Required. The type of the line item's flight dates.
+      },
+      "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap)
+        "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set.
+        "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set.
+        "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).
+        "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).
+        "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable.
+      },
+      "insertionOrderId": "A String", # Required. Immutable. The unique ID of the insertion order that the line item belongs to.
+      "integrationDetails": { # Integration details of an entry. # Integration details of the line item.
+        "details": "A String", # Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters.
+        "integrationCode": "A String", # An external identifier to be associated with the entry. The integration code will show up together with the entry in many places in the system, for example, reporting. Must be UTF-8 encoded with a length of no more than 500 characters.
+      },
+      "lineItemId": "A String", # Output only. The unique ID of the line item. Assigned by the system.
+      "lineItemType": "A String", # Required. Immutable. The type of the line item.
+      "mobileApp": { # A mobile app promoted by a mobile app install line item. # The mobile app promoted by the line item. This is applicable only when line_item_type is either `LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INSTALL` or `LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL`.
+        "appId": "A String", # Required. The ID of the app provided by the platform store. Android apps are identified by the bundle ID used by Android's Play store, such as `com.google.android.gm`. iOS apps are identified by a nine-digit app ID used by Apple's App store, such as `422689480`.
+        "displayName": "A String", # Output only. The app name.
+        "platform": "A String", # Output only. The app platform.
+        "publisher": "A String", # Output only. The app publisher.
+      },
+      "name": "A String", # Output only. The resource name of the line item.
+      "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the line item.
+        "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0.
+        "dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of advertiser's currency. Applicable when the budget is currency based. Must be greater than 0. For example, for 1.5 standard unit of the currency, set this field to 1500000. The value assigned will be rounded to whole billable units for the relevant currency by the following rules: any positive value less than a single billable unit will be rounded up to one billable unit and any value larger than a single billable unit will be rounded down to the nearest billable value. For example, if the currency's billable unit is 0.01, and this field is set to 10257770, it will round down to 10250000, a value of 10.25. If set to 505, it will round up to 10000, a value of 0.01.
+        "pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent. When automatic budget allocation is enabled at the insertion order via automationType, this field is output only and defaults to `PACING_PERIOD_FLIGHT`.
+        "pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be spent across the pacing_period. `PACING_TYPE_ASAP` is not compatible with pacing_period `PACING_PERIOD_FLIGHT` for insertion orders.
+      },
+      "partnerCosts": [ # The partner costs associated with the line item. If absent or empty in CreateLineItem method, the newly created line item will inherit partner costs from its parent insertion order.
+        { # Settings that control a partner cost. A partner cost is any type of expense involved in running a campaign, other than the costs of purchasing impressions (which is called the media cost) and using third-party audience segment data (data fee). Some examples of partner costs include the fees for using DV360, a third-party ad server, or a third-party ad serving verification service.
+          "costType": "A String", # Required. The type of the partner cost.
+          "feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency. Applicable when the fee_type is `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0. For example, for 1.5 standard unit of the advertiser's currency, set this field to 1500000.
+          "feePercentageMillis": "A String", # The media fee percentage in millis (1/1000 of a percent). Applicable when the fee_type is `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0. For example: 100 represents 0.1%.
+          "feeType": "A String", # Required. The fee type for this partner cost.
+          "invoiceType": "A String", # The invoice type for this partner cost. * Required when cost_type is one of: - `PARTNER_COST_TYPE_ADLOOX` - `PARTNER_COST_TYPE_DOUBLE_VERIFY` - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`. * Output only for other types.
+        },
+      ],
+      "partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item.
+        "markupAmount": "A String", # Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001).
+        "markupType": "A String", # Required. The markup type of the partner revenue model.
+      },
+      "reservationType": "A String", # Output only. The reservation type of the line item.
+      "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists.
+        "audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources.
+        "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources.
+        "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` *Warning*: Starting **March 6, 2025**, this field will stop being compatible when using the BiddingStrategy field fixed_bid. [Read more about this announced change](/display-video/api/deprecations#features.ot_fixed_bid)
+      },
+      "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system.
+      "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running.
+        "A String",
+      ],
+      "youtubeAndPartnersSettings": { # Settings for YouTube and Partners line items. # Output only. Settings specific to YouTube and Partners line items.
+        "contentCategory": "A String", # The kind of content on which the YouTube and Partners ads will be shown.
+        "effectiveContentCategory": "A String", # Output only. The content category which takes effect when serving the line item. When content category is set in both line item and advertiser, the stricter one will take effect when serving the line item.
+        "inventorySourceSettings": { # Settings that control what YouTube related inventories the YouTube and Partners line item will target. # Settings that control what YouTube and Partners inventories the line item will target.
+          "includeGoogleTv": True or False, # Optional. Whether to target inventory in video apps available with Google TV.
+          "includeYoutube": True or False, # Optional. Whether to target inventory on YouTube. This includes both search, channels and videos.
+          "includeYoutubeVideoPartners": True or False, # Whether to target inventory on a collection of partner sites and apps that follow the same brand safety standards as YouTube.
+        },
+        "leadFormId": "A String", # Optional. The ID of the form to generate leads.
+        "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed.
+        "relatedVideoIds": [ # Optional. The IDs of the videos appear below the primary video ad when the ad is playing in the YouTube app on mobile devices.
+          "A String",
+        ],
+        "targetFrequency": { # Setting that controls the average number of times the ads will show to the same person over a certain period of time. # Optional. The average number of times you want ads from this line item to show to the same person over a certain period of time.
+          "targetCount": "A String", # The target number of times, on average, the ads will be shown to the same person in the timespan dictated by time_unit and time_unit_count.
+          "timeUnit": "A String", # The unit of time in which the target frequency will be applied. The following time unit is applicable: * `TIME_UNIT_WEEKS`
+          "timeUnitCount": 42, # The number of time_unit the target frequency will last. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_WEEKS` - must be 1
+        },
+        "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third-party measurement configs of the line item.
+          "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR`
+            { # Settings that control how third-party measurement vendors are configured.
+              "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item.
+              "vendor": "A String", # The third-party measurement vendor.
+            },
+          ],
+          "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZERF` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE`
+            { # Settings that control how third-party measurement vendors are configured.
+              "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item.
+              "vendor": "A String", # The third-party measurement vendor.
+            },
+          ],
+          "reachVendorConfigs": [ # Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR`
+            { # Settings that control how third-party measurement vendors are configured.
+              "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item.
+              "vendor": "A String", # The third-party measurement vendor.
+            },
+          ],
+          "viewabilityVendorConfigs": [ # Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS`
+            { # Settings that control how third-party measurement vendors are configured.
+              "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item.
+              "vendor": "A String", # The third-party measurement vendor.
+            },
+          ],
+        },
+        "videoAdSequenceSettings": { # Settings related to VideoAdSequence. # Optional. The settings related to VideoAdSequence.
+          "minimumDuration": "A String", # The minimum time interval before the same user sees this sequence again.
+          "steps": [ # The steps of which the sequence consists.
+            { # The detail of a single step in a VideoAdSequence.
+              "adGroupId": "A String", # The ID of the corresponding ad group of the step.
+              "interactionType": "A String", # The interaction on the previous step that will lead the viewer to this step. The first step does not have interaction_type.
+              "previousStepId": "A String", # The ID of the previous step. The first step does not have previous step.
+              "stepId": "A String", # The ID of the step.
+            },
+          ],
+        },
+        "viewFrequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # The view frequency cap settings of the line item. The max_views field in this settings object must be used if assigning a limited cap. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap)
+          "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set.
+          "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set.
+          "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).
+          "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).
+          "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable.
+        },
+      },
+    },
+  ],
+  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListLineItems` method to retrieve the next page of results.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(advertiserId, lineItemId, body=None, updateMask=None, x__xgafv=None) +
Updates an existing line item. Returns the updated line item if successful. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * BulkEditAssignedTargetingOptions * BulkUpdateLineItems * assignedTargetingOptions.create * assignedTargetingOptions.delete YouTube & Partners line items cannot be created or updated using the API. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.
+
+Args:
+  advertiserId: string, Output only. The unique ID of the advertiser the line item belongs to. (required)
+  lineItemId: string, Output only. The unique ID of the line item. Assigned by the system. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A single line item.
+  "advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to.
+  "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Required. The bidding strategy of the line item.
+    "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
+      "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
+    },
+    "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, when performance_goal_type is one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , the line_item_type of the insertion order line items must be either: * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , and when performance_goal_type is either: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` the line_item_type of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+      "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).
+      "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.
+      "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.
+      "raiseBidForDeals": True or False, # Whether the strategy takes deal floor prices into account.
+    },
+    "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity.
+      "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).
+      "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency.
+      "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value.
+      "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`.
+    },
+    "youtubeAndPartnersBid": { # Settings that control the bid strategy for YouTube and Partners resources. # A bid strategy used by YouTube and Partners resources. It can only be used for a YouTube and Partners line item or ad group entity.
+      "adGroupEffectiveTargetCpaSource": "A String", # Output only. Source of the effective target CPA value for ad group.
+      "adGroupEffectiveTargetCpaValue": "A String", # Output only. The effective target CPA for ad group, in micros of advertiser's currency.
+      "type": "A String", # The type of the bidding strategy.
+      "value": "A String", # The value used by the bidding strategy. When the bidding strategy is assigned at the line item level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` When the bidding strategy is assigned at the ad group level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPV` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` If not using an applicable strategy, the value of this field will be 0.
+    },
+  },
+  "budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item.
+    "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order.
+    "budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order.
+    "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system.
+  },
+  "campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to.
+  "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item. *Warning*: Starting **April 1, 2025**, the floodlight_activity_configs field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).
+    "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. *Warning*: Starting **April 1, 2025**, this field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).
+      { # Settings that control the behavior of a single Floodlight activity config.
+        "floodlightActivityId": "A String", # Required. The ID of the Floodlight activity.
+        "postClickLookbackWindowDays": 42, # Required. The number of days after an ad has been clicked in which a conversion may be counted. Must be between 0 and 90 inclusive.
+        "postViewLookbackWindowDays": 42, # Required. The number of days after an ad has been viewed in which a conversion may be counted. Must be between 0 and 90 inclusive.
+      },
+    ],
+    "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000.
+  },
+  "creativeIds": [ # The IDs of the creatives associated with the line item.
+    "A String",
+  ],
+  "displayName": "A String", # Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "entityStatus": "A String", # Required. Controls whether or not the line item can spend its budget and bid on inventory. * For CreateLineItem method, only `ENTITY_STATUS_DRAFT` is allowed. To activate a line item, use UpdateLineItem method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * A line item cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * If the line item's parent insertion order is not active, the line item can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.
+  "excludeNewExchanges": True or False, # Whether to exclude new exchanges from automatically being targeted by the line item. This field is false by default.
+  "flight": { # Settings that control the active duration of a line item. # Required. The start and end time of the line item's flight.
+    "dateRange": { # A date range. # The flight start and end dates of the line item. They are resolved relative to the parent advertiser's time zone. * Required when flight_date_type is `LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM`. Output only otherwise. * When creating a new flight, both `start_date` and `end_date` must be in the future. * An existing flight with a `start_date` in the past has a mutable `end_date` but an immutable `start_date`. * `end_date` must be the `start_date` or later, both before the year 2037.
+      "endDate": { # 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 # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
+        "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.
+      },
+      "startDate": { # 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 # The lower bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
+        "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.
+      },
+    },
+    "flightDateType": "A String", # Required. The type of the line item's flight dates.
+  },
+  "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap)
+    "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set.
+    "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set.
+    "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).
+    "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).
+    "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable.
+  },
+  "insertionOrderId": "A String", # Required. Immutable. The unique ID of the insertion order that the line item belongs to.
+  "integrationDetails": { # Integration details of an entry. # Integration details of the line item.
+    "details": "A String", # Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters.
+    "integrationCode": "A String", # An external identifier to be associated with the entry. The integration code will show up together with the entry in many places in the system, for example, reporting. Must be UTF-8 encoded with a length of no more than 500 characters.
+  },
+  "lineItemId": "A String", # Output only. The unique ID of the line item. Assigned by the system.
+  "lineItemType": "A String", # Required. Immutable. The type of the line item.
+  "mobileApp": { # A mobile app promoted by a mobile app install line item. # The mobile app promoted by the line item. This is applicable only when line_item_type is either `LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INSTALL` or `LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL`.
+    "appId": "A String", # Required. The ID of the app provided by the platform store. Android apps are identified by the bundle ID used by Android's Play store, such as `com.google.android.gm`. iOS apps are identified by a nine-digit app ID used by Apple's App store, such as `422689480`.
+    "displayName": "A String", # Output only. The app name.
+    "platform": "A String", # Output only. The app platform.
+    "publisher": "A String", # Output only. The app publisher.
+  },
+  "name": "A String", # Output only. The resource name of the line item.
+  "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the line item.
+    "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0.
+    "dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of advertiser's currency. Applicable when the budget is currency based. Must be greater than 0. For example, for 1.5 standard unit of the currency, set this field to 1500000. The value assigned will be rounded to whole billable units for the relevant currency by the following rules: any positive value less than a single billable unit will be rounded up to one billable unit and any value larger than a single billable unit will be rounded down to the nearest billable value. For example, if the currency's billable unit is 0.01, and this field is set to 10257770, it will round down to 10250000, a value of 10.25. If set to 505, it will round up to 10000, a value of 0.01.
+    "pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent. When automatic budget allocation is enabled at the insertion order via automationType, this field is output only and defaults to `PACING_PERIOD_FLIGHT`.
+    "pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be spent across the pacing_period. `PACING_TYPE_ASAP` is not compatible with pacing_period `PACING_PERIOD_FLIGHT` for insertion orders.
+  },
+  "partnerCosts": [ # The partner costs associated with the line item. If absent or empty in CreateLineItem method, the newly created line item will inherit partner costs from its parent insertion order.
+    { # Settings that control a partner cost. A partner cost is any type of expense involved in running a campaign, other than the costs of purchasing impressions (which is called the media cost) and using third-party audience segment data (data fee). Some examples of partner costs include the fees for using DV360, a third-party ad server, or a third-party ad serving verification service.
+      "costType": "A String", # Required. The type of the partner cost.
+      "feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency. Applicable when the fee_type is `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0. For example, for 1.5 standard unit of the advertiser's currency, set this field to 1500000.
+      "feePercentageMillis": "A String", # The media fee percentage in millis (1/1000 of a percent). Applicable when the fee_type is `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0. For example: 100 represents 0.1%.
+      "feeType": "A String", # Required. The fee type for this partner cost.
+      "invoiceType": "A String", # The invoice type for this partner cost. * Required when cost_type is one of: - `PARTNER_COST_TYPE_ADLOOX` - `PARTNER_COST_TYPE_DOUBLE_VERIFY` - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`. * Output only for other types.
+    },
+  ],
+  "partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item.
+    "markupAmount": "A String", # Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001).
+    "markupType": "A String", # Required. The markup type of the partner revenue model.
+  },
+  "reservationType": "A String", # Output only. The reservation type of the line item.
+  "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists.
+    "audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources.
+    "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources.
+    "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` *Warning*: Starting **March 6, 2025**, this field will stop being compatible when using the BiddingStrategy field fixed_bid. [Read more about this announced change](/display-video/api/deprecations#features.ot_fixed_bid)
+  },
+  "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system.
+  "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running.
+    "A String",
+  ],
+  "youtubeAndPartnersSettings": { # Settings for YouTube and Partners line items. # Output only. Settings specific to YouTube and Partners line items.
+    "contentCategory": "A String", # The kind of content on which the YouTube and Partners ads will be shown.
+    "effectiveContentCategory": "A String", # Output only. The content category which takes effect when serving the line item. When content category is set in both line item and advertiser, the stricter one will take effect when serving the line item.
+    "inventorySourceSettings": { # Settings that control what YouTube related inventories the YouTube and Partners line item will target. # Settings that control what YouTube and Partners inventories the line item will target.
+      "includeGoogleTv": True or False, # Optional. Whether to target inventory in video apps available with Google TV.
+      "includeYoutube": True or False, # Optional. Whether to target inventory on YouTube. This includes both search, channels and videos.
+      "includeYoutubeVideoPartners": True or False, # Whether to target inventory on a collection of partner sites and apps that follow the same brand safety standards as YouTube.
+    },
+    "leadFormId": "A String", # Optional. The ID of the form to generate leads.
+    "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed.
+    "relatedVideoIds": [ # Optional. The IDs of the videos appear below the primary video ad when the ad is playing in the YouTube app on mobile devices.
+      "A String",
+    ],
+    "targetFrequency": { # Setting that controls the average number of times the ads will show to the same person over a certain period of time. # Optional. The average number of times you want ads from this line item to show to the same person over a certain period of time.
+      "targetCount": "A String", # The target number of times, on average, the ads will be shown to the same person in the timespan dictated by time_unit and time_unit_count.
+      "timeUnit": "A String", # The unit of time in which the target frequency will be applied. The following time unit is applicable: * `TIME_UNIT_WEEKS`
+      "timeUnitCount": 42, # The number of time_unit the target frequency will last. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_WEEKS` - must be 1
+    },
+    "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third-party measurement configs of the line item.
+      "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR`
+        { # Settings that control how third-party measurement vendors are configured.
+          "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item.
+          "vendor": "A String", # The third-party measurement vendor.
+        },
+      ],
+      "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZERF` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE`
+        { # Settings that control how third-party measurement vendors are configured.
+          "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item.
+          "vendor": "A String", # The third-party measurement vendor.
+        },
+      ],
+      "reachVendorConfigs": [ # Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR`
+        { # Settings that control how third-party measurement vendors are configured.
+          "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item.
+          "vendor": "A String", # The third-party measurement vendor.
+        },
+      ],
+      "viewabilityVendorConfigs": [ # Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS`
+        { # Settings that control how third-party measurement vendors are configured.
+          "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item.
+          "vendor": "A String", # The third-party measurement vendor.
+        },
+      ],
+    },
+    "videoAdSequenceSettings": { # Settings related to VideoAdSequence. # Optional. The settings related to VideoAdSequence.
+      "minimumDuration": "A String", # The minimum time interval before the same user sees this sequence again.
+      "steps": [ # The steps of which the sequence consists.
+        { # The detail of a single step in a VideoAdSequence.
+          "adGroupId": "A String", # The ID of the corresponding ad group of the step.
+          "interactionType": "A String", # The interaction on the previous step that will lead the viewer to this step. The first step does not have interaction_type.
+          "previousStepId": "A String", # The ID of the previous step. The first step does not have previous step.
+          "stepId": "A String", # The ID of the step.
+        },
+      ],
+    },
+    "viewFrequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # The view frequency cap settings of the line item. The max_views field in this settings object must be used if assigning a limited cap. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap)
+      "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set.
+      "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set.
+      "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).
+      "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).
+      "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable.
+    },
+  },
+}
+
+  updateMask: string, Required. The mask to control which fields to update.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single line item.
+  "advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to.
+  "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Required. The bidding strategy of the line item.
+    "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
+      "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
+    },
+    "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, when performance_goal_type is one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , the line_item_type of the insertion order line items must be either: * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , and when performance_goal_type is either: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` the line_item_type of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+      "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).
+      "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.
+      "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.
+      "raiseBidForDeals": True or False, # Whether the strategy takes deal floor prices into account.
+    },
+    "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity.
+      "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).
+      "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency.
+      "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value.
+      "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`.
+    },
+    "youtubeAndPartnersBid": { # Settings that control the bid strategy for YouTube and Partners resources. # A bid strategy used by YouTube and Partners resources. It can only be used for a YouTube and Partners line item or ad group entity.
+      "adGroupEffectiveTargetCpaSource": "A String", # Output only. Source of the effective target CPA value for ad group.
+      "adGroupEffectiveTargetCpaValue": "A String", # Output only. The effective target CPA for ad group, in micros of advertiser's currency.
+      "type": "A String", # The type of the bidding strategy.
+      "value": "A String", # The value used by the bidding strategy. When the bidding strategy is assigned at the line item level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` When the bidding strategy is assigned at the ad group level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPV` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` If not using an applicable strategy, the value of this field will be 0.
+    },
+  },
+  "budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item.
+    "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order.
+    "budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order.
+    "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system.
+  },
+  "campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to.
+  "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item. *Warning*: Starting **April 1, 2025**, the floodlight_activity_configs field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).
+    "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. *Warning*: Starting **April 1, 2025**, this field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).
+      { # Settings that control the behavior of a single Floodlight activity config.
+        "floodlightActivityId": "A String", # Required. The ID of the Floodlight activity.
+        "postClickLookbackWindowDays": 42, # Required. The number of days after an ad has been clicked in which a conversion may be counted. Must be between 0 and 90 inclusive.
+        "postViewLookbackWindowDays": 42, # Required. The number of days after an ad has been viewed in which a conversion may be counted. Must be between 0 and 90 inclusive.
+      },
+    ],
+    "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000.
+  },
+  "creativeIds": [ # The IDs of the creatives associated with the line item.
+    "A String",
+  ],
+  "displayName": "A String", # Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "entityStatus": "A String", # Required. Controls whether or not the line item can spend its budget and bid on inventory. * For CreateLineItem method, only `ENTITY_STATUS_DRAFT` is allowed. To activate a line item, use UpdateLineItem method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * A line item cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * If the line item's parent insertion order is not active, the line item can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.
+  "excludeNewExchanges": True or False, # Whether to exclude new exchanges from automatically being targeted by the line item. This field is false by default.
+  "flight": { # Settings that control the active duration of a line item. # Required. The start and end time of the line item's flight.
+    "dateRange": { # A date range. # The flight start and end dates of the line item. They are resolved relative to the parent advertiser's time zone. * Required when flight_date_type is `LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM`. Output only otherwise. * When creating a new flight, both `start_date` and `end_date` must be in the future. * An existing flight with a `start_date` in the past has a mutable `end_date` but an immutable `start_date`. * `end_date` must be the `start_date` or later, both before the year 2037.
+      "endDate": { # 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 # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
+        "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.
+      },
+      "startDate": { # 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 # The lower bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
+        "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.
+      },
+    },
+    "flightDateType": "A String", # Required. The type of the line item's flight dates.
+  },
+  "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap)
+    "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set.
+    "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set.
+    "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).
+    "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).
+    "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable.
+  },
+  "insertionOrderId": "A String", # Required. Immutable. The unique ID of the insertion order that the line item belongs to.
+  "integrationDetails": { # Integration details of an entry. # Integration details of the line item.
+    "details": "A String", # Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters.
+    "integrationCode": "A String", # An external identifier to be associated with the entry. The integration code will show up together with the entry in many places in the system, for example, reporting. Must be UTF-8 encoded with a length of no more than 500 characters.
+  },
+  "lineItemId": "A String", # Output only. The unique ID of the line item. Assigned by the system.
+  "lineItemType": "A String", # Required. Immutable. The type of the line item.
+  "mobileApp": { # A mobile app promoted by a mobile app install line item. # The mobile app promoted by the line item. This is applicable only when line_item_type is either `LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INSTALL` or `LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL`.
+    "appId": "A String", # Required. The ID of the app provided by the platform store. Android apps are identified by the bundle ID used by Android's Play store, such as `com.google.android.gm`. iOS apps are identified by a nine-digit app ID used by Apple's App store, such as `422689480`.
+    "displayName": "A String", # Output only. The app name.
+    "platform": "A String", # Output only. The app platform.
+    "publisher": "A String", # Output only. The app publisher.
+  },
+  "name": "A String", # Output only. The resource name of the line item.
+  "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the line item.
+    "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0.
+    "dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of advertiser's currency. Applicable when the budget is currency based. Must be greater than 0. For example, for 1.5 standard unit of the currency, set this field to 1500000. The value assigned will be rounded to whole billable units for the relevant currency by the following rules: any positive value less than a single billable unit will be rounded up to one billable unit and any value larger than a single billable unit will be rounded down to the nearest billable value. For example, if the currency's billable unit is 0.01, and this field is set to 10257770, it will round down to 10250000, a value of 10.25. If set to 505, it will round up to 10000, a value of 0.01.
+    "pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent. When automatic budget allocation is enabled at the insertion order via automationType, this field is output only and defaults to `PACING_PERIOD_FLIGHT`.
+    "pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be spent across the pacing_period. `PACING_TYPE_ASAP` is not compatible with pacing_period `PACING_PERIOD_FLIGHT` for insertion orders.
+  },
+  "partnerCosts": [ # The partner costs associated with the line item. If absent or empty in CreateLineItem method, the newly created line item will inherit partner costs from its parent insertion order.
+    { # Settings that control a partner cost. A partner cost is any type of expense involved in running a campaign, other than the costs of purchasing impressions (which is called the media cost) and using third-party audience segment data (data fee). Some examples of partner costs include the fees for using DV360, a third-party ad server, or a third-party ad serving verification service.
+      "costType": "A String", # Required. The type of the partner cost.
+      "feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency. Applicable when the fee_type is `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0. For example, for 1.5 standard unit of the advertiser's currency, set this field to 1500000.
+      "feePercentageMillis": "A String", # The media fee percentage in millis (1/1000 of a percent). Applicable when the fee_type is `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0. For example: 100 represents 0.1%.
+      "feeType": "A String", # Required. The fee type for this partner cost.
+      "invoiceType": "A String", # The invoice type for this partner cost. * Required when cost_type is one of: - `PARTNER_COST_TYPE_ADLOOX` - `PARTNER_COST_TYPE_DOUBLE_VERIFY` - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`. * Output only for other types.
+    },
+  ],
+  "partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item.
+    "markupAmount": "A String", # Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001).
+    "markupType": "A String", # Required. The markup type of the partner revenue model.
+  },
+  "reservationType": "A String", # Output only. The reservation type of the line item.
+  "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists.
+    "audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources.
+    "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources.
+    "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` *Warning*: Starting **March 6, 2025**, this field will stop being compatible when using the BiddingStrategy field fixed_bid. [Read more about this announced change](/display-video/api/deprecations#features.ot_fixed_bid)
+  },
+  "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system.
+  "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running.
+    "A String",
+  ],
+  "youtubeAndPartnersSettings": { # Settings for YouTube and Partners line items. # Output only. Settings specific to YouTube and Partners line items.
+    "contentCategory": "A String", # The kind of content on which the YouTube and Partners ads will be shown.
+    "effectiveContentCategory": "A String", # Output only. The content category which takes effect when serving the line item. When content category is set in both line item and advertiser, the stricter one will take effect when serving the line item.
+    "inventorySourceSettings": { # Settings that control what YouTube related inventories the YouTube and Partners line item will target. # Settings that control what YouTube and Partners inventories the line item will target.
+      "includeGoogleTv": True or False, # Optional. Whether to target inventory in video apps available with Google TV.
+      "includeYoutube": True or False, # Optional. Whether to target inventory on YouTube. This includes both search, channels and videos.
+      "includeYoutubeVideoPartners": True or False, # Whether to target inventory on a collection of partner sites and apps that follow the same brand safety standards as YouTube.
+    },
+    "leadFormId": "A String", # Optional. The ID of the form to generate leads.
+    "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed.
+    "relatedVideoIds": [ # Optional. The IDs of the videos appear below the primary video ad when the ad is playing in the YouTube app on mobile devices.
+      "A String",
+    ],
+    "targetFrequency": { # Setting that controls the average number of times the ads will show to the same person over a certain period of time. # Optional. The average number of times you want ads from this line item to show to the same person over a certain period of time.
+      "targetCount": "A String", # The target number of times, on average, the ads will be shown to the same person in the timespan dictated by time_unit and time_unit_count.
+      "timeUnit": "A String", # The unit of time in which the target frequency will be applied. The following time unit is applicable: * `TIME_UNIT_WEEKS`
+      "timeUnitCount": 42, # The number of time_unit the target frequency will last. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_WEEKS` - must be 1
+    },
+    "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third-party measurement configs of the line item.
+      "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR`
+        { # Settings that control how third-party measurement vendors are configured.
+          "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item.
+          "vendor": "A String", # The third-party measurement vendor.
+        },
+      ],
+      "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZERF` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE`
+        { # Settings that control how third-party measurement vendors are configured.
+          "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item.
+          "vendor": "A String", # The third-party measurement vendor.
+        },
+      ],
+      "reachVendorConfigs": [ # Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR`
+        { # Settings that control how third-party measurement vendors are configured.
+          "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item.
+          "vendor": "A String", # The third-party measurement vendor.
+        },
+      ],
+      "viewabilityVendorConfigs": [ # Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS`
+        { # Settings that control how third-party measurement vendors are configured.
+          "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item.
+          "vendor": "A String", # The third-party measurement vendor.
+        },
+      ],
+    },
+    "videoAdSequenceSettings": { # Settings related to VideoAdSequence. # Optional. The settings related to VideoAdSequence.
+      "minimumDuration": "A String", # The minimum time interval before the same user sees this sequence again.
+      "steps": [ # The steps of which the sequence consists.
+        { # The detail of a single step in a VideoAdSequence.
+          "adGroupId": "A String", # The ID of the corresponding ad group of the step.
+          "interactionType": "A String", # The interaction on the previous step that will lead the viewer to this step. The first step does not have interaction_type.
+          "previousStepId": "A String", # The ID of the previous step. The first step does not have previous step.
+          "stepId": "A String", # The ID of the step.
+        },
+      ],
+    },
+    "viewFrequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # The view frequency cap settings of the line item. The max_views field in this settings object must be used if assigning a limited cap. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap)
+      "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set.
+      "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set.
+      "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).
+      "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).
+      "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable.
+    },
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/displayvideo_v4.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v4.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html new file mode 100644 index 00000000000..244b63d7bb8 --- /dev/null +++ b/docs/dyn/displayvideo_v4.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html @@ -0,0 +1,1684 @@ + + + +

Display & Video 360 API . advertisers . lineItems . targetingTypes . assignedTargetingOptions

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(advertiserId, lineItemId, targetingType, body=None, x__xgafv=None)

+

Assigns a targeting option to a line item. Returns the assigned targeting option if successful. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * lineItems.bulkEditAssignedTargetingOptions * lineItems.bulkUpdate * lineItems.patch * DeleteLineItemAssignedTargetingOption YouTube & Partners line items cannot be created or updated using the API.

+

+ delete(advertiserId, lineItemId, targetingType, assignedTargetingOptionId, x__xgafv=None)

+

Deletes an assigned targeting option from a line item. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * lineItems.bulkEditAssignedTargetingOptions * lineItems.bulkUpdate * lineItems.patch * CreateLineItemAssignedTargetingOption YouTube & Partners line items cannot be created or updated using the API.

+

+ get(advertiserId, lineItemId, targetingType, assignedTargetingOptionId, x__xgafv=None)

+

Gets a single targeting option assigned to a line item.

+

+ list(advertiserId, lineItemId, targetingType, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists the targeting options assigned to a line item.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(advertiserId, lineItemId, targetingType, body=None, x__xgafv=None) +
Assigns a targeting option to a line item. Returns the assigned targeting option if successful. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * lineItems.bulkEditAssignedTargetingOptions * lineItems.bulkUpdate * lineItems.patch * DeleteLineItemAssignedTargetingOption YouTube & Partners line items cannot be created or updated using the API.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser the line item belongs to. (required)
+  lineItemId: string, Required. The ID of the line item the assigned targeting option will belong to. (required)
+  targetingType: string, Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` (required)
+    Allowed values
+      TARGETING_TYPE_UNSPECIFIED - Default value when type is not specified or is unknown in this version.
+      TARGETING_TYPE_CHANNEL - Target a channel (a custom group of related websites or apps).
+      TARGETING_TYPE_APP_CATEGORY - Target an app category (for example, education or puzzle games).
+      TARGETING_TYPE_APP - Target a specific app (for example, Angry Birds).
+      TARGETING_TYPE_URL - Target a specific url (for example, quora.com).
+      TARGETING_TYPE_DAY_AND_TIME - Target ads during a chosen time period on a specific day.
+      TARGETING_TYPE_AGE_RANGE - Target ads to a specific age range (for example, 18-24).
+      TARGETING_TYPE_REGIONAL_LOCATION_LIST - Target ads to the specified regions on a regional location list.
+      TARGETING_TYPE_PROXIMITY_LOCATION_LIST - Target ads to the specified points of interest on a proximity location list.
+      TARGETING_TYPE_GENDER - Target ads to a specific gender (for example, female or male).
+      TARGETING_TYPE_VIDEO_PLAYER_SIZE - Target a specific video player size for video ads.
+      TARGETING_TYPE_USER_REWARDED_CONTENT - Target user rewarded content for video ads.
+      TARGETING_TYPE_PARENTAL_STATUS - Target ads to a specific parental status (for example, parent or not a parent).
+      TARGETING_TYPE_CONTENT_INSTREAM_POSITION - Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).
+      TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION - Target ads in a specific content outstream position.
+      TARGETING_TYPE_DEVICE_TYPE - Target ads to a specific device type (for example, tablet or connected TV).
+      TARGETING_TYPE_AUDIENCE_GROUP - Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.
+      TARGETING_TYPE_BROWSER - Target ads to specific web browsers (for example, Chrome).
+      TARGETING_TYPE_HOUSEHOLD_INCOME - Target ads to a specific household income range (for example, top 10%).
+      TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position.
+      TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify).
+      TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).
+      TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult).
+      TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app).
+      TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).
+      TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS).
+      TARGETING_TYPE_DEVICE_MAKE_MODEL - Target ads to a specific device make or model (for example, Roku or Samsung).
+      TARGETING_TYPE_KEYWORD - Target ads to a specific keyword (for example, dog or retriever).
+      TARGETING_TYPE_NEGATIVE_KEYWORD_LIST - Target ads to a specific negative keyword list.
+      TARGETING_TYPE_VIEWABILITY - Target ads to a specific viewability (for example, 80% viewable).
+      TARGETING_TYPE_CATEGORY - Target ads to a specific content category (for example, arts & entertainment).
+      TARGETING_TYPE_INVENTORY_SOURCE - Purchase impressions from specific deals and auction packages.
+      TARGETING_TYPE_LANGUAGE - Target ads to a specific language (for example, English or Japanese).
+      TARGETING_TYPE_AUTHORIZED_SELLER_STATUS - Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.
+      TARGETING_TYPE_GEO_REGION - Target ads to a specific regional location (for example, a city or state).
+      TARGETING_TYPE_INVENTORY_SOURCE_GROUP - Purchase impressions from a group of deals and auction packages.
+      TARGETING_TYPE_EXCHANGE - Purchase impressions from specific exchanges.
+      TARGETING_TYPE_SUB_EXCHANGE - Purchase impressions from specific sub-exchanges.
+      TARGETING_TYPE_POI - Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.
+      TARGETING_TYPE_BUSINESS_CHAIN - Target ads around locations of a business chain within a specific geo region.
+      TARGETING_TYPE_CONTENT_DURATION - Target ads to a specific video content duration.
+      TARGETING_TYPE_CONTENT_STREAM_TYPE - Target ads to a specific video content stream type.
+      TARGETING_TYPE_NATIVE_CONTENT_POSITION - Target ads to a specific native content position.
+      TARGETING_TYPE_OMID - Target ads in an Open Measurement enabled inventory.
+      TARGETING_TYPE_AUDIO_CONTENT_TYPE - Target ads to a specific audio content type.
+      TARGETING_TYPE_CONTENT_GENRE - Target ads to a specific content genre.
+      TARGETING_TYPE_YOUTUBE_VIDEO - Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
+      TARGETING_TYPE_YOUTUBE_CHANNEL - Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
+      TARGETING_TYPE_SESSION_POSITION - Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings.
+  "ageRangeDetails": { # Represents a targetable age range. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AGE_RANGE`. # Age range details. This field will be populated when the targeting_type is `TARGETING_TYPE_AGE_RANGE`.
+    "ageRange": "A String", # Required. The age range of an audience. We only support targeting a continuous age range of an audience. Thus, the age range represented in this field can be 1) targeted solely, or, 2) part of a larger continuous age range. The reach of a continuous age range targeting can be expanded by also targeting an audience of an unknown age.
+  },
+  "appCategoryDetails": { # Details for assigned app category targeting option. This will be populated in the app_category_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. # App category details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
+    "displayName": "A String", # Output only. The display name of the app category.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
+  },
+  "appDetails": { # Details for assigned app targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP`. # App details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP`.
+    "appId": "A String", # Required. The ID of the app. Android's Play store app uses bundle ID, for example `com.google.android.gm`. Apple's App store app ID uses 9 digit string, for example `422689480`.
+    "appPlatform": "A String", # Indicates the platform of the targeted app. If this field is not specified, the app platform will be assumed to be mobile (i.e., Android or iOS), and we will derive the appropriate mobile platform from the app ID.
+    "displayName": "A String", # Output only. The display name of the app.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+  },
+  "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts.
+  "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`
+  "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource.
+    "excludedFirstPartyAndPartnerAudienceGroup": { # Details of first party and partner audience group. All first party and partner audience targeting settings are logically ‘OR’ of each other. # Optional. The first party and partner audience ids and recencies of the excluded first party and partner audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other.
+      "settings": [ # Required. All first party and partner audience targeting settings in first party and partner audience group. Repeated settings with the same id are not allowed.
+        { # Details of first party and partner audience targeting setting.
+          "firstPartyAndPartnerAudienceId": "A String", # Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.
+          "recency": "A String", # Required. The recency of the first party and partner audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
+        },
+      ],
+    },
+    "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other.
+      "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
+        { # Details of Google audience targeting setting.
+          "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
+        },
+      ],
+    },
+    "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only.
+      "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise.
+        { # Details of combined audience targeting setting.
+          "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id.
+        },
+      ],
+    },
+    "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only.
+      "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored.
+        { # Details of custom list targeting setting.
+          "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id.
+        },
+      ],
+    },
+    "includedFirstPartyAndPartnerAudienceGroups": [ # Optional. The first party and partner audience ids and recencies of included first party and partner audience groups. Each first party and partner audience group contains first party and partner audience ids only. The relation between each first party and partner audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored.
+      { # Details of first party and partner audience group. All first party and partner audience targeting settings are logically ‘OR’ of each other.
+        "settings": [ # Required. All first party and partner audience targeting settings in first party and partner audience group. Repeated settings with the same id are not allowed.
+          { # Details of first party and partner audience targeting setting.
+            "firstPartyAndPartnerAudienceId": "A String", # Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.
+            "recency": "A String", # Required. The recency of the first party and partner audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
+          },
+        ],
+      },
+    ],
+    "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only.
+      "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
+        { # Details of Google audience targeting setting.
+          "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
+        },
+      ],
+    },
+  },
+  "audioContentTypeDetails": { # Details for audio content type assigned targeting option. This will be populated in the audio_content_type_details field when targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`. Explicitly targeting all options is not supported. Remove all audio content type targeting options to achieve this effect. # Audio content type details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`.
+    "audioContentType": "A String", # Required. The audio content type.
+  },
+  "authorizedSellerStatusDetails": { # Represents an assigned authorized seller status. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. If a resource does not have an `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` assigned targeting option, it is using the "Authorized Direct Sellers and Resellers" option. # Authorized seller status details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. You can only target one authorized seller status option per resource. If a resource doesn't have an authorized seller status option, all authorized sellers indicated as DIRECT or RESELLER in the ads.txt file are targeted by default.
+    "authorizedSellerStatus": "A String", # Output only. The authorized seller status to target.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.
+  },
+  "browserDetails": { # Details for assigned browser targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BROWSER`. # Browser details. This field will be populated when the targeting_type is `TARGETING_TYPE_BROWSER`.
+    "displayName": "A String", # Output only. The display name of the browser.
+    "negative": True or False, # Indicates if this option is being negatively targeted. All assigned browser targeting options on the same resource must have the same value for this field.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BROWSER`.
+  },
+  "businessChainDetails": { # Details for assigned Business chain targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`. # Business chain details. This field will be populated when the targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`.
+    "displayName": "A String", # Output only. The display name of a business chain, e.g. "KFC", "Chase Bank".
+    "proximityRadiusAmount": 3.14, # Required. The radius of the area around the business chain that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`. The minimum increment for both cases is 0.1. Inputs will be rounded to the nearest acceptable value if it is too granular, e.g. 15.57 will become 15.6.
+    "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BUSINESS_CHAIN`. Accepted business chain targeting option IDs can be retrieved using SearchTargetingOptions.
+  },
+  "carrierAndIspDetails": { # Details for assigned carrier and ISP targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`. # Carrier and ISP details. This field will be populated when the targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`.
+    "displayName": "A String", # Output only. The display name of the carrier or ISP.
+    "negative": True or False, # Indicates if this option is being negatively targeted. All assigned carrier and ISP targeting options on the same resource must have the same value for this field.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`.
+  },
+  "categoryDetails": { # Assigned category targeting option details. This will be populated in the category_details field when targeting_type is `TARGETING_TYPE_CATEGORY`. # Category details. This field will be populated when the targeting_type is `TARGETING_TYPE_CATEGORY`. Targeting a category will also target its subcategories. If a category is excluded from targeting and a subcategory is included, the exclusion will take precedence.
+    "displayName": "A String", # Output only. The display name of the category.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CATEGORY`.
+  },
+  "channelDetails": { # Details for assigned channel targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CHANNEL`. # Channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_CHANNEL`.
+    "channelId": "A String", # Required. ID of the channel. Should refer to the channel ID field on a [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id) resource.
+    "negative": True or False, # Indicates if this option is being negatively targeted. For advertiser level assigned targeting option, this field must be true.
+  },
+  "contentDurationDetails": { # Details for content duration assigned targeting option. This will be populated in the content_duration_details field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`. Explicitly targeting all options is not supported. Remove all content duration targeting options to achieve this effect. # Content duration details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
+    "contentDuration": "A String", # Output only. The content duration.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
+  },
+  "contentGenreDetails": { # Details for content genre assigned targeting option. This will be populated in the content_genre_details field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`. Explicitly targeting all options is not supported. Remove all content genre targeting options to achieve this effect. # Content genre details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
+    "displayName": "A String", # Output only. The display name of the content genre.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
+  },
+  "contentInstreamPositionDetails": { # Assigned content instream position targeting option details. This will be populated in the content_instream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. # Content instream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.
+    "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`. * `AD_TYPE_AUDIO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_AUDIO_DEFAULT`.
+    "contentInstreamPosition": "A String", # Required. The content instream position for video or audio ads.
+  },
+  "contentOutstreamPositionDetails": { # Assigned content outstream position targeting option details. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. # Content outstream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.
+    "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+    "contentOutstreamPosition": "A String", # Required. The content outstream position.
+  },
+  "contentStreamTypeDetails": { # Details for content stream type assigned targeting option. This will be populated in the content_stream_type_details field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`. Explicitly targeting all options is not supported. Remove all content stream type targeting options to achieve this effect. # Content duration details. This field will be populated when the TargetingType is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
+    "contentStreamType": "A String", # Output only. The content stream type.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
+  },
+  "dayAndTimeDetails": { # Representation of a segment of time defined on a specific day of the week and with a start and end time. The time represented by `start_hour` must be before the time represented by `end_hour`. # Day and time details. This field will be populated when the targeting_type is `TARGETING_TYPE_DAY_AND_TIME`.
+    "dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting.
+    "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day).
+    "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day).
+    "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting.
+  },
+  "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
+    "displayName": "A String", # Output only. The display name of the device make and model.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
+  },
+  "deviceTypeDetails": { # Targeting details for device type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`. # Device Type details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_TYPE`.
+    "deviceType": "A String", # Required. The display name of the device type.
+    "youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items.
+  },
+  "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded.
+    "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED.
+  },
+  "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`.
+    "environment": "A String", # Required. The serving environment.
+  },
+  "exchangeDetails": { # Details for assigned exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`. # Exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_EXCHANGE`.
+    "exchange": "A String", # Required. The enum value for the exchange.
+  },
+  "genderDetails": { # Details for assigned gender targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GENDER`. # Gender details. This field will be populated when the targeting_type is `TARGETING_TYPE_GENDER`.
+    "gender": "A String", # Required. The gender of the audience.
+  },
+  "geoRegionDetails": { # Details for assigned geographic region targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GEO_REGION`. # Geographic region details. This field will be populated when the targeting_type is `TARGETING_TYPE_GEO_REGION`.
+    "displayName": "A String", # Output only. The display name of the geographic region (e.g., "Ontario, Canada").
+    "geoRegionType": "A String", # Output only. The type of geographic region targeting.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GEO_REGION`.
+  },
+  "householdIncomeDetails": { # Details for assigned household income targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`. # Household income details. This field will be populated when the targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`.
+    "householdIncome": "A String", # Required. The household income of the audience.
+  },
+  "inheritance": "A String", # Output only. The inheritance status of the assigned targeting option.
+  "inventorySourceDetails": { # Targeting details for inventory source. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`. # Inventory source details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`.
+    "inventorySourceId": "A String", # Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource.
+  },
+  "inventorySourceGroupDetails": { # Targeting details for inventory source group. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`. # Inventory source group details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`.
+    "inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource.
+  },
+  "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned.
+    "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+  },
+  "languageDetails": { # Details for assigned language targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_LANGUAGE`. # Language details. This field will be populated when the targeting_type is `TARGETING_TYPE_LANGUAGE`.
+    "displayName": "A String", # Output only. The display name of the language (e.g., "French").
+    "negative": True or False, # Indicates if this option is being negatively targeted. All assigned language targeting options on the same resource must have the same value for this field.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_LANGUAGE`.
+  },
+  "name": "A String", # Output only. The resource name for this assigned targeting option.
+  "nativeContentPositionDetails": { # Details for native content position assigned targeting option. This will be populated in the native_content_position_details field when targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`. Explicitly targeting all options is not supported. Remove all native content position targeting options to achieve this effect. # Native content position details. This field will be populated when the targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`.
+    "contentPosition": "A String", # Required. The content position.
+  },
+  "negativeKeywordListDetails": { # Targeting details for negative keyword list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. A maximum of 4 negative keyword lists can be assigned to a resource.
+    "negativeKeywordListId": "A String", # Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource.
+  },
+  "omidDetails": { # Represents a targetable Open Measurement enabled inventory type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_OMID`. # Open Measurement enabled inventory details. This field will be populated when the targeting_type is `TARGETING_TYPE_OMID`.
+    "omid": "A String", # Required. The type of Open Measurement enabled inventory.
+  },
+  "onScreenPositionDetails": { # On screen position targeting option details. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. # On screen position details. This field will be populated when the targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
+    "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+    "onScreenPosition": "A String", # Output only. The on screen position.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
+  },
+  "operatingSystemDetails": { # Assigned operating system targeting option details. This will be populated in the operating_system_details field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. # Operating system details. This field will be populated when the targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
+    "displayName": "A String", # Output only. The display name of the operating system.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting option ID populated in targeting_option_id field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
+  },
+  "parentalStatusDetails": { # Details for assigned parental status targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`. # Parental status details. This field will be populated when the targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`.
+    "parentalStatus": "A String", # Required. The parental status of the audience.
+  },
+  "poiDetails": { # Details for assigned POI targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_POI`. # POI details. This field will be populated when the targeting_type is `TARGETING_TYPE_POI`.
+    "displayName": "A String", # Output only. The display name of a POI, e.g. "Times Square", "Space Needle", followed by its full address if available.
+    "latitude": 3.14, # Output only. Latitude of the POI rounding to 6th decimal place.
+    "longitude": 3.14, # Output only. Longitude of the POI rounding to 6th decimal place.
+    "proximityRadiusAmount": 3.14, # Required. The radius of the area around the POI that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`.
+    "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_POI`. Accepted POI targeting option IDs can be retrieved using `targetingTypes.targetingOptions.search`. If targeting a specific latitude/longitude coordinate removed from an address or POI name, you can generate the necessary targeting option ID by rounding the desired coordinate values to the 6th decimal place, removing the decimals, and concatenating the string values separated by a semicolon. For example, you can target the latitude/longitude pair of 40.7414691, -74.003387 using the targeting option ID "40741469;-74003387". **Upon** **creation, this field value will be updated to append a semicolon and** **alphanumerical hash value if only latitude/longitude coordinates are** **provided.**
+  },
+  "proximityLocationListDetails": { # Targeting details for proximity location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`. # Proximity location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`.
+    "proximityLocationListId": "A String", # Required. ID of the proximity location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_PROXIMITY`.
+    "proximityRadius": 3.14, # Required. Radius expressed in the distance units set in proximity_radius_unit. This represents the size of the area around a chosen location that will be targeted. Radius should be between 1 and 500 miles or 800 kilometers.
+    "proximityRadiusUnit": "A String", # Required. Radius distance units.
+  },
+  "regionalLocationListDetails": { # Targeting details for regional location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`. # Regional location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`.
+  },
+  "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them.
+    "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED.
+  },
+  "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`.
+    "sessionPosition": "A String", # The position where the ad will show in a session.
+  },
+  "subExchangeDetails": { # Details for assigned sub-exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`. # Sub-exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`.
+  },
+  "targetingType": "A String", # Output only. Identifies the type of this assigned targeting option.
+  "thirdPartyVerifierDetails": { # Assigned third party verifier targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`. # Third party verification details. This field will be populated when the targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`.
+    "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox.
+      "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads.
+      "excludedAdlooxCategories": [ # Adloox categories to exclude.
+        "A String",
+      ],
+      "excludedFraudIvtMfaCategories": [ # Optional. Adloox's fraud IVT MFA categories to exclude.
+        "A String",
+      ],
+      "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads.
+    },
+    "doubleVerify": { # Details of DoubleVerify settings. # Third party brand verifier -- DoubleVerify.
+      "appStarRating": { # Details of DoubleVerify star ratings settings. # Avoid bidding on apps with the star ratings.
+        "avoidInsufficientStarRating": True or False, # Avoid bidding on apps with insufficient star ratings.
+        "avoidedStarRating": "A String", # Avoid bidding on apps with the star ratings.
+      },
+      "avoidedAgeRatings": [ # Avoid bidding on apps with the age rating.
+        "A String",
+      ],
+      "brandSafetyCategories": { # Settings for brand safety controls. # DV Brand Safety Controls.
+        "avoidUnknownBrandSafetyCategory": True or False, # Unknown or unrateable.
+        "avoidedHighSeverityCategories": [ # Brand safety high severity avoidance categories.
+          "A String",
+        ],
+        "avoidedMediumSeverityCategories": [ # Brand safety medium severity avoidance categories.
+          "A String",
+        ],
+      },
+      "customSegmentId": "A String", # The custom segment ID provided by DoubleVerify. The ID must start with "51" and consist of eight digits. Custom segment ID cannot be specified along with any of the following fields: * brand_safety_categories * avoided_age_ratings * app_star_rating * fraud_invalid_traffic
+      "displayViewability": { # Details of DoubleVerify display viewability settings. # Display viewability settings (applicable to display line items only).
+        "iab": "A String", # Target web and app inventory to maximize IAB viewable rate.
+        "viewableDuring": "A String", # Target web and app inventory to maximize 100% viewable duration.
+      },
+      "fraudInvalidTraffic": { # DoubleVerify Fraud & Invalid Traffic settings. # Avoid Sites and Apps with historical Fraud & IVT Rates.
+        "avoidInsufficientOption": True or False, # Insufficient Historical Fraud & IVT Stats.
+        "avoidedFraudOption": "A String", # Avoid Sites and Apps with historical Fraud & IVT.
+      },
+      "videoViewability": { # Details of DoubleVerify video viewability settings. # Video viewability settings (applicable to video line items only).
+        "playerImpressionRate": "A String", # Target inventory to maximize impressions with 400x300 or greater player size.
+        "videoIab": "A String", # Target web inventory to maximize IAB viewable rate.
+        "videoViewableRate": "A String", # Target web inventory to maximize fully viewable rate.
+      },
+    },
+    "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science.
+      "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive.
+        "A String",
+      ],
+      "displayViewability": "A String", # Display Viewability section (applicable to display line items only).
+      "excludeUnrateable": True or False, # Brand Safety - **Unrateable**.
+      "excludedAdFraudRisk": "A String", # Ad Fraud settings.
+      "excludedAdultRisk": "A String", # Brand Safety - **Adult content**.
+      "excludedAlcoholRisk": "A String", # Brand Safety - **Alcohol**.
+      "excludedDrugsRisk": "A String", # Brand Safety - **Drugs**.
+      "excludedGamblingRisk": "A String", # Brand Safety - **Gambling**.
+      "excludedHateSpeechRisk": "A String", # Brand Safety - **Hate speech**.
+      "excludedIllegalDownloadsRisk": "A String", # Brand Safety - **Illegal downloads**.
+      "excludedOffensiveLanguageRisk": "A String", # Brand Safety - **Offensive language**.
+      "excludedViolenceRisk": "A String", # Brand Safety - **Violence**.
+      "qualitySyncCustomSegmentId": [ # Optional. The quality sync custom segment ID provided by Integral Ad Science. The ID must be between `3000000` and `4999999`, inclusive.
+        "A String",
+      ],
+      "traqScoreOption": "A String", # True advertising quality (applicable to Display line items only).
+      "videoViewability": "A String", # Video Viewability Section (applicable to video line items only).
+    },
+  },
+  "urlDetails": { # Details for assigned URL targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_URL`. # URL details. This field will be populated when the targeting_type is `TARGETING_TYPE_URL`.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "url": "A String", # Required. The URL, for example `example.com`. DV360 supports two levels of subdirectory targeting, for example `www.example.com/one-subdirectory-level/second-level`, and five levels of subdomain targeting, for example `five.four.three.two.one.example.com`.
+  },
+  "userRewardedContentDetails": { # User rewarded content targeting option details. This will be populated in the user_rewarded_content_details field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. # User rewarded content details. This field will be populated when the targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
+    "userRewardedContent": "A String", # Output only. User rewarded content status for video ads.
+  },
+  "videoPlayerSizeDetails": { # Video player size targeting option details. This will be populated in the video_player_size_details field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. Explicitly targeting all options is not supported. Remove all video player size targeting options to achieve this effect. # Video player size details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.
+    "videoPlayerSize": "A String", # Required. The video player size.
+  },
+  "viewabilityDetails": { # Assigned viewability targeting option details. This will be populated in the viewability_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`. # Viewability details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIEWABILITY`. You can only target one viewability option per resource.
+    "viewability": "A String", # Required. The predicted viewability percentage.
+  },
+  "youtubeChannelDetails": { # Details for YouTube channel assigned targeting option. This will be populated in the youtube_channel_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`. # YouTube channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`.
+    "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+  },
+  "youtubeVideoDetails": { # Details for YouTube video assigned targeting option. This will be populated in the youtube_video_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`. # YouTube video details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "videoId": "A String", # YouTube video id as it appears on the YouTube watch page.
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings.
+  "ageRangeDetails": { # Represents a targetable age range. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AGE_RANGE`. # Age range details. This field will be populated when the targeting_type is `TARGETING_TYPE_AGE_RANGE`.
+    "ageRange": "A String", # Required. The age range of an audience. We only support targeting a continuous age range of an audience. Thus, the age range represented in this field can be 1) targeted solely, or, 2) part of a larger continuous age range. The reach of a continuous age range targeting can be expanded by also targeting an audience of an unknown age.
+  },
+  "appCategoryDetails": { # Details for assigned app category targeting option. This will be populated in the app_category_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. # App category details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
+    "displayName": "A String", # Output only. The display name of the app category.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
+  },
+  "appDetails": { # Details for assigned app targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP`. # App details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP`.
+    "appId": "A String", # Required. The ID of the app. Android's Play store app uses bundle ID, for example `com.google.android.gm`. Apple's App store app ID uses 9 digit string, for example `422689480`.
+    "appPlatform": "A String", # Indicates the platform of the targeted app. If this field is not specified, the app platform will be assumed to be mobile (i.e., Android or iOS), and we will derive the appropriate mobile platform from the app ID.
+    "displayName": "A String", # Output only. The display name of the app.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+  },
+  "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts.
+  "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`
+  "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource.
+    "excludedFirstPartyAndPartnerAudienceGroup": { # Details of first party and partner audience group. All first party and partner audience targeting settings are logically ‘OR’ of each other. # Optional. The first party and partner audience ids and recencies of the excluded first party and partner audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other.
+      "settings": [ # Required. All first party and partner audience targeting settings in first party and partner audience group. Repeated settings with the same id are not allowed.
+        { # Details of first party and partner audience targeting setting.
+          "firstPartyAndPartnerAudienceId": "A String", # Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.
+          "recency": "A String", # Required. The recency of the first party and partner audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
+        },
+      ],
+    },
+    "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other.
+      "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
+        { # Details of Google audience targeting setting.
+          "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
+        },
+      ],
+    },
+    "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only.
+      "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise.
+        { # Details of combined audience targeting setting.
+          "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id.
+        },
+      ],
+    },
+    "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only.
+      "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored.
+        { # Details of custom list targeting setting.
+          "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id.
+        },
+      ],
+    },
+    "includedFirstPartyAndPartnerAudienceGroups": [ # Optional. The first party and partner audience ids and recencies of included first party and partner audience groups. Each first party and partner audience group contains first party and partner audience ids only. The relation between each first party and partner audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored.
+      { # Details of first party and partner audience group. All first party and partner audience targeting settings are logically ‘OR’ of each other.
+        "settings": [ # Required. All first party and partner audience targeting settings in first party and partner audience group. Repeated settings with the same id are not allowed.
+          { # Details of first party and partner audience targeting setting.
+            "firstPartyAndPartnerAudienceId": "A String", # Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.
+            "recency": "A String", # Required. The recency of the first party and partner audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
+          },
+        ],
+      },
+    ],
+    "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only.
+      "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
+        { # Details of Google audience targeting setting.
+          "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
+        },
+      ],
+    },
+  },
+  "audioContentTypeDetails": { # Details for audio content type assigned targeting option. This will be populated in the audio_content_type_details field when targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`. Explicitly targeting all options is not supported. Remove all audio content type targeting options to achieve this effect. # Audio content type details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`.
+    "audioContentType": "A String", # Required. The audio content type.
+  },
+  "authorizedSellerStatusDetails": { # Represents an assigned authorized seller status. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. If a resource does not have an `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` assigned targeting option, it is using the "Authorized Direct Sellers and Resellers" option. # Authorized seller status details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. You can only target one authorized seller status option per resource. If a resource doesn't have an authorized seller status option, all authorized sellers indicated as DIRECT or RESELLER in the ads.txt file are targeted by default.
+    "authorizedSellerStatus": "A String", # Output only. The authorized seller status to target.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.
+  },
+  "browserDetails": { # Details for assigned browser targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BROWSER`. # Browser details. This field will be populated when the targeting_type is `TARGETING_TYPE_BROWSER`.
+    "displayName": "A String", # Output only. The display name of the browser.
+    "negative": True or False, # Indicates if this option is being negatively targeted. All assigned browser targeting options on the same resource must have the same value for this field.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BROWSER`.
+  },
+  "businessChainDetails": { # Details for assigned Business chain targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`. # Business chain details. This field will be populated when the targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`.
+    "displayName": "A String", # Output only. The display name of a business chain, e.g. "KFC", "Chase Bank".
+    "proximityRadiusAmount": 3.14, # Required. The radius of the area around the business chain that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`. The minimum increment for both cases is 0.1. Inputs will be rounded to the nearest acceptable value if it is too granular, e.g. 15.57 will become 15.6.
+    "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BUSINESS_CHAIN`. Accepted business chain targeting option IDs can be retrieved using SearchTargetingOptions.
+  },
+  "carrierAndIspDetails": { # Details for assigned carrier and ISP targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`. # Carrier and ISP details. This field will be populated when the targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`.
+    "displayName": "A String", # Output only. The display name of the carrier or ISP.
+    "negative": True or False, # Indicates if this option is being negatively targeted. All assigned carrier and ISP targeting options on the same resource must have the same value for this field.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`.
+  },
+  "categoryDetails": { # Assigned category targeting option details. This will be populated in the category_details field when targeting_type is `TARGETING_TYPE_CATEGORY`. # Category details. This field will be populated when the targeting_type is `TARGETING_TYPE_CATEGORY`. Targeting a category will also target its subcategories. If a category is excluded from targeting and a subcategory is included, the exclusion will take precedence.
+    "displayName": "A String", # Output only. The display name of the category.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CATEGORY`.
+  },
+  "channelDetails": { # Details for assigned channel targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CHANNEL`. # Channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_CHANNEL`.
+    "channelId": "A String", # Required. ID of the channel. Should refer to the channel ID field on a [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id) resource.
+    "negative": True or False, # Indicates if this option is being negatively targeted. For advertiser level assigned targeting option, this field must be true.
+  },
+  "contentDurationDetails": { # Details for content duration assigned targeting option. This will be populated in the content_duration_details field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`. Explicitly targeting all options is not supported. Remove all content duration targeting options to achieve this effect. # Content duration details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
+    "contentDuration": "A String", # Output only. The content duration.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
+  },
+  "contentGenreDetails": { # Details for content genre assigned targeting option. This will be populated in the content_genre_details field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`. Explicitly targeting all options is not supported. Remove all content genre targeting options to achieve this effect. # Content genre details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
+    "displayName": "A String", # Output only. The display name of the content genre.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
+  },
+  "contentInstreamPositionDetails": { # Assigned content instream position targeting option details. This will be populated in the content_instream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. # Content instream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.
+    "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`. * `AD_TYPE_AUDIO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_AUDIO_DEFAULT`.
+    "contentInstreamPosition": "A String", # Required. The content instream position for video or audio ads.
+  },
+  "contentOutstreamPositionDetails": { # Assigned content outstream position targeting option details. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. # Content outstream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.
+    "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+    "contentOutstreamPosition": "A String", # Required. The content outstream position.
+  },
+  "contentStreamTypeDetails": { # Details for content stream type assigned targeting option. This will be populated in the content_stream_type_details field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`. Explicitly targeting all options is not supported. Remove all content stream type targeting options to achieve this effect. # Content duration details. This field will be populated when the TargetingType is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
+    "contentStreamType": "A String", # Output only. The content stream type.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
+  },
+  "dayAndTimeDetails": { # Representation of a segment of time defined on a specific day of the week and with a start and end time. The time represented by `start_hour` must be before the time represented by `end_hour`. # Day and time details. This field will be populated when the targeting_type is `TARGETING_TYPE_DAY_AND_TIME`.
+    "dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting.
+    "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day).
+    "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day).
+    "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting.
+  },
+  "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
+    "displayName": "A String", # Output only. The display name of the device make and model.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
+  },
+  "deviceTypeDetails": { # Targeting details for device type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`. # Device Type details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_TYPE`.
+    "deviceType": "A String", # Required. The display name of the device type.
+    "youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items.
+  },
+  "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded.
+    "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED.
+  },
+  "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`.
+    "environment": "A String", # Required. The serving environment.
+  },
+  "exchangeDetails": { # Details for assigned exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`. # Exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_EXCHANGE`.
+    "exchange": "A String", # Required. The enum value for the exchange.
+  },
+  "genderDetails": { # Details for assigned gender targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GENDER`. # Gender details. This field will be populated when the targeting_type is `TARGETING_TYPE_GENDER`.
+    "gender": "A String", # Required. The gender of the audience.
+  },
+  "geoRegionDetails": { # Details for assigned geographic region targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GEO_REGION`. # Geographic region details. This field will be populated when the targeting_type is `TARGETING_TYPE_GEO_REGION`.
+    "displayName": "A String", # Output only. The display name of the geographic region (e.g., "Ontario, Canada").
+    "geoRegionType": "A String", # Output only. The type of geographic region targeting.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GEO_REGION`.
+  },
+  "householdIncomeDetails": { # Details for assigned household income targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`. # Household income details. This field will be populated when the targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`.
+    "householdIncome": "A String", # Required. The household income of the audience.
+  },
+  "inheritance": "A String", # Output only. The inheritance status of the assigned targeting option.
+  "inventorySourceDetails": { # Targeting details for inventory source. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`. # Inventory source details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`.
+    "inventorySourceId": "A String", # Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource.
+  },
+  "inventorySourceGroupDetails": { # Targeting details for inventory source group. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`. # Inventory source group details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`.
+    "inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource.
+  },
+  "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned.
+    "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+  },
+  "languageDetails": { # Details for assigned language targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_LANGUAGE`. # Language details. This field will be populated when the targeting_type is `TARGETING_TYPE_LANGUAGE`.
+    "displayName": "A String", # Output only. The display name of the language (e.g., "French").
+    "negative": True or False, # Indicates if this option is being negatively targeted. All assigned language targeting options on the same resource must have the same value for this field.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_LANGUAGE`.
+  },
+  "name": "A String", # Output only. The resource name for this assigned targeting option.
+  "nativeContentPositionDetails": { # Details for native content position assigned targeting option. This will be populated in the native_content_position_details field when targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`. Explicitly targeting all options is not supported. Remove all native content position targeting options to achieve this effect. # Native content position details. This field will be populated when the targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`.
+    "contentPosition": "A String", # Required. The content position.
+  },
+  "negativeKeywordListDetails": { # Targeting details for negative keyword list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. A maximum of 4 negative keyword lists can be assigned to a resource.
+    "negativeKeywordListId": "A String", # Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource.
+  },
+  "omidDetails": { # Represents a targetable Open Measurement enabled inventory type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_OMID`. # Open Measurement enabled inventory details. This field will be populated when the targeting_type is `TARGETING_TYPE_OMID`.
+    "omid": "A String", # Required. The type of Open Measurement enabled inventory.
+  },
+  "onScreenPositionDetails": { # On screen position targeting option details. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. # On screen position details. This field will be populated when the targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
+    "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+    "onScreenPosition": "A String", # Output only. The on screen position.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
+  },
+  "operatingSystemDetails": { # Assigned operating system targeting option details. This will be populated in the operating_system_details field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. # Operating system details. This field will be populated when the targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
+    "displayName": "A String", # Output only. The display name of the operating system.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting option ID populated in targeting_option_id field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
+  },
+  "parentalStatusDetails": { # Details for assigned parental status targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`. # Parental status details. This field will be populated when the targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`.
+    "parentalStatus": "A String", # Required. The parental status of the audience.
+  },
+  "poiDetails": { # Details for assigned POI targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_POI`. # POI details. This field will be populated when the targeting_type is `TARGETING_TYPE_POI`.
+    "displayName": "A String", # Output only. The display name of a POI, e.g. "Times Square", "Space Needle", followed by its full address if available.
+    "latitude": 3.14, # Output only. Latitude of the POI rounding to 6th decimal place.
+    "longitude": 3.14, # Output only. Longitude of the POI rounding to 6th decimal place.
+    "proximityRadiusAmount": 3.14, # Required. The radius of the area around the POI that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`.
+    "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_POI`. Accepted POI targeting option IDs can be retrieved using `targetingTypes.targetingOptions.search`. If targeting a specific latitude/longitude coordinate removed from an address or POI name, you can generate the necessary targeting option ID by rounding the desired coordinate values to the 6th decimal place, removing the decimals, and concatenating the string values separated by a semicolon. For example, you can target the latitude/longitude pair of 40.7414691, -74.003387 using the targeting option ID "40741469;-74003387". **Upon** **creation, this field value will be updated to append a semicolon and** **alphanumerical hash value if only latitude/longitude coordinates are** **provided.**
+  },
+  "proximityLocationListDetails": { # Targeting details for proximity location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`. # Proximity location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`.
+    "proximityLocationListId": "A String", # Required. ID of the proximity location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_PROXIMITY`.
+    "proximityRadius": 3.14, # Required. Radius expressed in the distance units set in proximity_radius_unit. This represents the size of the area around a chosen location that will be targeted. Radius should be between 1 and 500 miles or 800 kilometers.
+    "proximityRadiusUnit": "A String", # Required. Radius distance units.
+  },
+  "regionalLocationListDetails": { # Targeting details for regional location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`. # Regional location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`.
+  },
+  "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them.
+    "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED.
+  },
+  "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`.
+    "sessionPosition": "A String", # The position where the ad will show in a session.
+  },
+  "subExchangeDetails": { # Details for assigned sub-exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`. # Sub-exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`.
+  },
+  "targetingType": "A String", # Output only. Identifies the type of this assigned targeting option.
+  "thirdPartyVerifierDetails": { # Assigned third party verifier targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`. # Third party verification details. This field will be populated when the targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`.
+    "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox.
+      "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads.
+      "excludedAdlooxCategories": [ # Adloox categories to exclude.
+        "A String",
+      ],
+      "excludedFraudIvtMfaCategories": [ # Optional. Adloox's fraud IVT MFA categories to exclude.
+        "A String",
+      ],
+      "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads.
+    },
+    "doubleVerify": { # Details of DoubleVerify settings. # Third party brand verifier -- DoubleVerify.
+      "appStarRating": { # Details of DoubleVerify star ratings settings. # Avoid bidding on apps with the star ratings.
+        "avoidInsufficientStarRating": True or False, # Avoid bidding on apps with insufficient star ratings.
+        "avoidedStarRating": "A String", # Avoid bidding on apps with the star ratings.
+      },
+      "avoidedAgeRatings": [ # Avoid bidding on apps with the age rating.
+        "A String",
+      ],
+      "brandSafetyCategories": { # Settings for brand safety controls. # DV Brand Safety Controls.
+        "avoidUnknownBrandSafetyCategory": True or False, # Unknown or unrateable.
+        "avoidedHighSeverityCategories": [ # Brand safety high severity avoidance categories.
+          "A String",
+        ],
+        "avoidedMediumSeverityCategories": [ # Brand safety medium severity avoidance categories.
+          "A String",
+        ],
+      },
+      "customSegmentId": "A String", # The custom segment ID provided by DoubleVerify. The ID must start with "51" and consist of eight digits. Custom segment ID cannot be specified along with any of the following fields: * brand_safety_categories * avoided_age_ratings * app_star_rating * fraud_invalid_traffic
+      "displayViewability": { # Details of DoubleVerify display viewability settings. # Display viewability settings (applicable to display line items only).
+        "iab": "A String", # Target web and app inventory to maximize IAB viewable rate.
+        "viewableDuring": "A String", # Target web and app inventory to maximize 100% viewable duration.
+      },
+      "fraudInvalidTraffic": { # DoubleVerify Fraud & Invalid Traffic settings. # Avoid Sites and Apps with historical Fraud & IVT Rates.
+        "avoidInsufficientOption": True or False, # Insufficient Historical Fraud & IVT Stats.
+        "avoidedFraudOption": "A String", # Avoid Sites and Apps with historical Fraud & IVT.
+      },
+      "videoViewability": { # Details of DoubleVerify video viewability settings. # Video viewability settings (applicable to video line items only).
+        "playerImpressionRate": "A String", # Target inventory to maximize impressions with 400x300 or greater player size.
+        "videoIab": "A String", # Target web inventory to maximize IAB viewable rate.
+        "videoViewableRate": "A String", # Target web inventory to maximize fully viewable rate.
+      },
+    },
+    "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science.
+      "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive.
+        "A String",
+      ],
+      "displayViewability": "A String", # Display Viewability section (applicable to display line items only).
+      "excludeUnrateable": True or False, # Brand Safety - **Unrateable**.
+      "excludedAdFraudRisk": "A String", # Ad Fraud settings.
+      "excludedAdultRisk": "A String", # Brand Safety - **Adult content**.
+      "excludedAlcoholRisk": "A String", # Brand Safety - **Alcohol**.
+      "excludedDrugsRisk": "A String", # Brand Safety - **Drugs**.
+      "excludedGamblingRisk": "A String", # Brand Safety - **Gambling**.
+      "excludedHateSpeechRisk": "A String", # Brand Safety - **Hate speech**.
+      "excludedIllegalDownloadsRisk": "A String", # Brand Safety - **Illegal downloads**.
+      "excludedOffensiveLanguageRisk": "A String", # Brand Safety - **Offensive language**.
+      "excludedViolenceRisk": "A String", # Brand Safety - **Violence**.
+      "qualitySyncCustomSegmentId": [ # Optional. The quality sync custom segment ID provided by Integral Ad Science. The ID must be between `3000000` and `4999999`, inclusive.
+        "A String",
+      ],
+      "traqScoreOption": "A String", # True advertising quality (applicable to Display line items only).
+      "videoViewability": "A String", # Video Viewability Section (applicable to video line items only).
+    },
+  },
+  "urlDetails": { # Details for assigned URL targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_URL`. # URL details. This field will be populated when the targeting_type is `TARGETING_TYPE_URL`.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "url": "A String", # Required. The URL, for example `example.com`. DV360 supports two levels of subdirectory targeting, for example `www.example.com/one-subdirectory-level/second-level`, and five levels of subdomain targeting, for example `five.four.three.two.one.example.com`.
+  },
+  "userRewardedContentDetails": { # User rewarded content targeting option details. This will be populated in the user_rewarded_content_details field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. # User rewarded content details. This field will be populated when the targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
+    "userRewardedContent": "A String", # Output only. User rewarded content status for video ads.
+  },
+  "videoPlayerSizeDetails": { # Video player size targeting option details. This will be populated in the video_player_size_details field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. Explicitly targeting all options is not supported. Remove all video player size targeting options to achieve this effect. # Video player size details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.
+    "videoPlayerSize": "A String", # Required. The video player size.
+  },
+  "viewabilityDetails": { # Assigned viewability targeting option details. This will be populated in the viewability_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`. # Viewability details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIEWABILITY`. You can only target one viewability option per resource.
+    "viewability": "A String", # Required. The predicted viewability percentage.
+  },
+  "youtubeChannelDetails": { # Details for YouTube channel assigned targeting option. This will be populated in the youtube_channel_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`. # YouTube channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`.
+    "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+  },
+  "youtubeVideoDetails": { # Details for YouTube video assigned targeting option. This will be populated in the youtube_video_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`. # YouTube video details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "videoId": "A String", # YouTube video id as it appears on the YouTube watch page.
+  },
+}
+
+ +
+ delete(advertiserId, lineItemId, targetingType, assignedTargetingOptionId, x__xgafv=None) +
Deletes an assigned targeting option from a line item. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * lineItems.bulkEditAssignedTargetingOptions * lineItems.bulkUpdate * lineItems.patch * CreateLineItemAssignedTargetingOption YouTube & Partners line items cannot be created or updated using the API.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser the line item belongs to. (required)
+  lineItemId: string, Required. The ID of the line item the assigned targeting option belongs to. (required)
+  targetingType: string, Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` (required)
+    Allowed values
+      TARGETING_TYPE_UNSPECIFIED - Default value when type is not specified or is unknown in this version.
+      TARGETING_TYPE_CHANNEL - Target a channel (a custom group of related websites or apps).
+      TARGETING_TYPE_APP_CATEGORY - Target an app category (for example, education or puzzle games).
+      TARGETING_TYPE_APP - Target a specific app (for example, Angry Birds).
+      TARGETING_TYPE_URL - Target a specific url (for example, quora.com).
+      TARGETING_TYPE_DAY_AND_TIME - Target ads during a chosen time period on a specific day.
+      TARGETING_TYPE_AGE_RANGE - Target ads to a specific age range (for example, 18-24).
+      TARGETING_TYPE_REGIONAL_LOCATION_LIST - Target ads to the specified regions on a regional location list.
+      TARGETING_TYPE_PROXIMITY_LOCATION_LIST - Target ads to the specified points of interest on a proximity location list.
+      TARGETING_TYPE_GENDER - Target ads to a specific gender (for example, female or male).
+      TARGETING_TYPE_VIDEO_PLAYER_SIZE - Target a specific video player size for video ads.
+      TARGETING_TYPE_USER_REWARDED_CONTENT - Target user rewarded content for video ads.
+      TARGETING_TYPE_PARENTAL_STATUS - Target ads to a specific parental status (for example, parent or not a parent).
+      TARGETING_TYPE_CONTENT_INSTREAM_POSITION - Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).
+      TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION - Target ads in a specific content outstream position.
+      TARGETING_TYPE_DEVICE_TYPE - Target ads to a specific device type (for example, tablet or connected TV).
+      TARGETING_TYPE_AUDIENCE_GROUP - Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.
+      TARGETING_TYPE_BROWSER - Target ads to specific web browsers (for example, Chrome).
+      TARGETING_TYPE_HOUSEHOLD_INCOME - Target ads to a specific household income range (for example, top 10%).
+      TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position.
+      TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify).
+      TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).
+      TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult).
+      TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app).
+      TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).
+      TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS).
+      TARGETING_TYPE_DEVICE_MAKE_MODEL - Target ads to a specific device make or model (for example, Roku or Samsung).
+      TARGETING_TYPE_KEYWORD - Target ads to a specific keyword (for example, dog or retriever).
+      TARGETING_TYPE_NEGATIVE_KEYWORD_LIST - Target ads to a specific negative keyword list.
+      TARGETING_TYPE_VIEWABILITY - Target ads to a specific viewability (for example, 80% viewable).
+      TARGETING_TYPE_CATEGORY - Target ads to a specific content category (for example, arts & entertainment).
+      TARGETING_TYPE_INVENTORY_SOURCE - Purchase impressions from specific deals and auction packages.
+      TARGETING_TYPE_LANGUAGE - Target ads to a specific language (for example, English or Japanese).
+      TARGETING_TYPE_AUTHORIZED_SELLER_STATUS - Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.
+      TARGETING_TYPE_GEO_REGION - Target ads to a specific regional location (for example, a city or state).
+      TARGETING_TYPE_INVENTORY_SOURCE_GROUP - Purchase impressions from a group of deals and auction packages.
+      TARGETING_TYPE_EXCHANGE - Purchase impressions from specific exchanges.
+      TARGETING_TYPE_SUB_EXCHANGE - Purchase impressions from specific sub-exchanges.
+      TARGETING_TYPE_POI - Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.
+      TARGETING_TYPE_BUSINESS_CHAIN - Target ads around locations of a business chain within a specific geo region.
+      TARGETING_TYPE_CONTENT_DURATION - Target ads to a specific video content duration.
+      TARGETING_TYPE_CONTENT_STREAM_TYPE - Target ads to a specific video content stream type.
+      TARGETING_TYPE_NATIVE_CONTENT_POSITION - Target ads to a specific native content position.
+      TARGETING_TYPE_OMID - Target ads in an Open Measurement enabled inventory.
+      TARGETING_TYPE_AUDIO_CONTENT_TYPE - Target ads to a specific audio content type.
+      TARGETING_TYPE_CONTENT_GENRE - Target ads to a specific content genre.
+      TARGETING_TYPE_YOUTUBE_VIDEO - Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
+      TARGETING_TYPE_YOUTUBE_CHANNEL - Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
+      TARGETING_TYPE_SESSION_POSITION - Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.
+  assignedTargetingOptionId: string, Required. The ID of the assigned targeting option 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(advertiserId, lineItemId, targetingType, assignedTargetingOptionId, x__xgafv=None) +
Gets a single targeting option assigned to a line item.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser the line item belongs to. (required)
+  lineItemId: string, Required. The ID of the line item the assigned targeting option belongs to. (required)
+  targetingType: string, Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_YOUTUBE_CHANNEL` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) * `TARGETING_TYPE_YOUTUBE_VIDEO` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) (required)
+    Allowed values
+      TARGETING_TYPE_UNSPECIFIED - Default value when type is not specified or is unknown in this version.
+      TARGETING_TYPE_CHANNEL - Target a channel (a custom group of related websites or apps).
+      TARGETING_TYPE_APP_CATEGORY - Target an app category (for example, education or puzzle games).
+      TARGETING_TYPE_APP - Target a specific app (for example, Angry Birds).
+      TARGETING_TYPE_URL - Target a specific url (for example, quora.com).
+      TARGETING_TYPE_DAY_AND_TIME - Target ads during a chosen time period on a specific day.
+      TARGETING_TYPE_AGE_RANGE - Target ads to a specific age range (for example, 18-24).
+      TARGETING_TYPE_REGIONAL_LOCATION_LIST - Target ads to the specified regions on a regional location list.
+      TARGETING_TYPE_PROXIMITY_LOCATION_LIST - Target ads to the specified points of interest on a proximity location list.
+      TARGETING_TYPE_GENDER - Target ads to a specific gender (for example, female or male).
+      TARGETING_TYPE_VIDEO_PLAYER_SIZE - Target a specific video player size for video ads.
+      TARGETING_TYPE_USER_REWARDED_CONTENT - Target user rewarded content for video ads.
+      TARGETING_TYPE_PARENTAL_STATUS - Target ads to a specific parental status (for example, parent or not a parent).
+      TARGETING_TYPE_CONTENT_INSTREAM_POSITION - Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).
+      TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION - Target ads in a specific content outstream position.
+      TARGETING_TYPE_DEVICE_TYPE - Target ads to a specific device type (for example, tablet or connected TV).
+      TARGETING_TYPE_AUDIENCE_GROUP - Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.
+      TARGETING_TYPE_BROWSER - Target ads to specific web browsers (for example, Chrome).
+      TARGETING_TYPE_HOUSEHOLD_INCOME - Target ads to a specific household income range (for example, top 10%).
+      TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position.
+      TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify).
+      TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).
+      TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult).
+      TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app).
+      TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).
+      TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS).
+      TARGETING_TYPE_DEVICE_MAKE_MODEL - Target ads to a specific device make or model (for example, Roku or Samsung).
+      TARGETING_TYPE_KEYWORD - Target ads to a specific keyword (for example, dog or retriever).
+      TARGETING_TYPE_NEGATIVE_KEYWORD_LIST - Target ads to a specific negative keyword list.
+      TARGETING_TYPE_VIEWABILITY - Target ads to a specific viewability (for example, 80% viewable).
+      TARGETING_TYPE_CATEGORY - Target ads to a specific content category (for example, arts & entertainment).
+      TARGETING_TYPE_INVENTORY_SOURCE - Purchase impressions from specific deals and auction packages.
+      TARGETING_TYPE_LANGUAGE - Target ads to a specific language (for example, English or Japanese).
+      TARGETING_TYPE_AUTHORIZED_SELLER_STATUS - Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.
+      TARGETING_TYPE_GEO_REGION - Target ads to a specific regional location (for example, a city or state).
+      TARGETING_TYPE_INVENTORY_SOURCE_GROUP - Purchase impressions from a group of deals and auction packages.
+      TARGETING_TYPE_EXCHANGE - Purchase impressions from specific exchanges.
+      TARGETING_TYPE_SUB_EXCHANGE - Purchase impressions from specific sub-exchanges.
+      TARGETING_TYPE_POI - Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.
+      TARGETING_TYPE_BUSINESS_CHAIN - Target ads around locations of a business chain within a specific geo region.
+      TARGETING_TYPE_CONTENT_DURATION - Target ads to a specific video content duration.
+      TARGETING_TYPE_CONTENT_STREAM_TYPE - Target ads to a specific video content stream type.
+      TARGETING_TYPE_NATIVE_CONTENT_POSITION - Target ads to a specific native content position.
+      TARGETING_TYPE_OMID - Target ads in an Open Measurement enabled inventory.
+      TARGETING_TYPE_AUDIO_CONTENT_TYPE - Target ads to a specific audio content type.
+      TARGETING_TYPE_CONTENT_GENRE - Target ads to a specific content genre.
+      TARGETING_TYPE_YOUTUBE_VIDEO - Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
+      TARGETING_TYPE_YOUTUBE_CHANNEL - Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
+      TARGETING_TYPE_SESSION_POSITION - Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.
+  assignedTargetingOptionId: string, Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings.
+  "ageRangeDetails": { # Represents a targetable age range. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AGE_RANGE`. # Age range details. This field will be populated when the targeting_type is `TARGETING_TYPE_AGE_RANGE`.
+    "ageRange": "A String", # Required. The age range of an audience. We only support targeting a continuous age range of an audience. Thus, the age range represented in this field can be 1) targeted solely, or, 2) part of a larger continuous age range. The reach of a continuous age range targeting can be expanded by also targeting an audience of an unknown age.
+  },
+  "appCategoryDetails": { # Details for assigned app category targeting option. This will be populated in the app_category_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. # App category details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
+    "displayName": "A String", # Output only. The display name of the app category.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
+  },
+  "appDetails": { # Details for assigned app targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP`. # App details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP`.
+    "appId": "A String", # Required. The ID of the app. Android's Play store app uses bundle ID, for example `com.google.android.gm`. Apple's App store app ID uses 9 digit string, for example `422689480`.
+    "appPlatform": "A String", # Indicates the platform of the targeted app. If this field is not specified, the app platform will be assumed to be mobile (i.e., Android or iOS), and we will derive the appropriate mobile platform from the app ID.
+    "displayName": "A String", # Output only. The display name of the app.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+  },
+  "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts.
+  "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`
+  "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource.
+    "excludedFirstPartyAndPartnerAudienceGroup": { # Details of first party and partner audience group. All first party and partner audience targeting settings are logically ‘OR’ of each other. # Optional. The first party and partner audience ids and recencies of the excluded first party and partner audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other.
+      "settings": [ # Required. All first party and partner audience targeting settings in first party and partner audience group. Repeated settings with the same id are not allowed.
+        { # Details of first party and partner audience targeting setting.
+          "firstPartyAndPartnerAudienceId": "A String", # Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.
+          "recency": "A String", # Required. The recency of the first party and partner audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
+        },
+      ],
+    },
+    "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other.
+      "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
+        { # Details of Google audience targeting setting.
+          "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
+        },
+      ],
+    },
+    "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only.
+      "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise.
+        { # Details of combined audience targeting setting.
+          "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id.
+        },
+      ],
+    },
+    "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only.
+      "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored.
+        { # Details of custom list targeting setting.
+          "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id.
+        },
+      ],
+    },
+    "includedFirstPartyAndPartnerAudienceGroups": [ # Optional. The first party and partner audience ids and recencies of included first party and partner audience groups. Each first party and partner audience group contains first party and partner audience ids only. The relation between each first party and partner audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored.
+      { # Details of first party and partner audience group. All first party and partner audience targeting settings are logically ‘OR’ of each other.
+        "settings": [ # Required. All first party and partner audience targeting settings in first party and partner audience group. Repeated settings with the same id are not allowed.
+          { # Details of first party and partner audience targeting setting.
+            "firstPartyAndPartnerAudienceId": "A String", # Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.
+            "recency": "A String", # Required. The recency of the first party and partner audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
+          },
+        ],
+      },
+    ],
+    "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only.
+      "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
+        { # Details of Google audience targeting setting.
+          "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
+        },
+      ],
+    },
+  },
+  "audioContentTypeDetails": { # Details for audio content type assigned targeting option. This will be populated in the audio_content_type_details field when targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`. Explicitly targeting all options is not supported. Remove all audio content type targeting options to achieve this effect. # Audio content type details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`.
+    "audioContentType": "A String", # Required. The audio content type.
+  },
+  "authorizedSellerStatusDetails": { # Represents an assigned authorized seller status. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. If a resource does not have an `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` assigned targeting option, it is using the "Authorized Direct Sellers and Resellers" option. # Authorized seller status details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. You can only target one authorized seller status option per resource. If a resource doesn't have an authorized seller status option, all authorized sellers indicated as DIRECT or RESELLER in the ads.txt file are targeted by default.
+    "authorizedSellerStatus": "A String", # Output only. The authorized seller status to target.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.
+  },
+  "browserDetails": { # Details for assigned browser targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BROWSER`. # Browser details. This field will be populated when the targeting_type is `TARGETING_TYPE_BROWSER`.
+    "displayName": "A String", # Output only. The display name of the browser.
+    "negative": True or False, # Indicates if this option is being negatively targeted. All assigned browser targeting options on the same resource must have the same value for this field.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BROWSER`.
+  },
+  "businessChainDetails": { # Details for assigned Business chain targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`. # Business chain details. This field will be populated when the targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`.
+    "displayName": "A String", # Output only. The display name of a business chain, e.g. "KFC", "Chase Bank".
+    "proximityRadiusAmount": 3.14, # Required. The radius of the area around the business chain that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`. The minimum increment for both cases is 0.1. Inputs will be rounded to the nearest acceptable value if it is too granular, e.g. 15.57 will become 15.6.
+    "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BUSINESS_CHAIN`. Accepted business chain targeting option IDs can be retrieved using SearchTargetingOptions.
+  },
+  "carrierAndIspDetails": { # Details for assigned carrier and ISP targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`. # Carrier and ISP details. This field will be populated when the targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`.
+    "displayName": "A String", # Output only. The display name of the carrier or ISP.
+    "negative": True or False, # Indicates if this option is being negatively targeted. All assigned carrier and ISP targeting options on the same resource must have the same value for this field.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`.
+  },
+  "categoryDetails": { # Assigned category targeting option details. This will be populated in the category_details field when targeting_type is `TARGETING_TYPE_CATEGORY`. # Category details. This field will be populated when the targeting_type is `TARGETING_TYPE_CATEGORY`. Targeting a category will also target its subcategories. If a category is excluded from targeting and a subcategory is included, the exclusion will take precedence.
+    "displayName": "A String", # Output only. The display name of the category.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CATEGORY`.
+  },
+  "channelDetails": { # Details for assigned channel targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CHANNEL`. # Channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_CHANNEL`.
+    "channelId": "A String", # Required. ID of the channel. Should refer to the channel ID field on a [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id) resource.
+    "negative": True or False, # Indicates if this option is being negatively targeted. For advertiser level assigned targeting option, this field must be true.
+  },
+  "contentDurationDetails": { # Details for content duration assigned targeting option. This will be populated in the content_duration_details field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`. Explicitly targeting all options is not supported. Remove all content duration targeting options to achieve this effect. # Content duration details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
+    "contentDuration": "A String", # Output only. The content duration.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
+  },
+  "contentGenreDetails": { # Details for content genre assigned targeting option. This will be populated in the content_genre_details field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`. Explicitly targeting all options is not supported. Remove all content genre targeting options to achieve this effect. # Content genre details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
+    "displayName": "A String", # Output only. The display name of the content genre.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
+  },
+  "contentInstreamPositionDetails": { # Assigned content instream position targeting option details. This will be populated in the content_instream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. # Content instream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.
+    "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`. * `AD_TYPE_AUDIO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_AUDIO_DEFAULT`.
+    "contentInstreamPosition": "A String", # Required. The content instream position for video or audio ads.
+  },
+  "contentOutstreamPositionDetails": { # Assigned content outstream position targeting option details. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. # Content outstream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.
+    "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+    "contentOutstreamPosition": "A String", # Required. The content outstream position.
+  },
+  "contentStreamTypeDetails": { # Details for content stream type assigned targeting option. This will be populated in the content_stream_type_details field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`. Explicitly targeting all options is not supported. Remove all content stream type targeting options to achieve this effect. # Content duration details. This field will be populated when the TargetingType is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
+    "contentStreamType": "A String", # Output only. The content stream type.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
+  },
+  "dayAndTimeDetails": { # Representation of a segment of time defined on a specific day of the week and with a start and end time. The time represented by `start_hour` must be before the time represented by `end_hour`. # Day and time details. This field will be populated when the targeting_type is `TARGETING_TYPE_DAY_AND_TIME`.
+    "dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting.
+    "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day).
+    "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day).
+    "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting.
+  },
+  "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
+    "displayName": "A String", # Output only. The display name of the device make and model.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
+  },
+  "deviceTypeDetails": { # Targeting details for device type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`. # Device Type details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_TYPE`.
+    "deviceType": "A String", # Required. The display name of the device type.
+    "youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items.
+  },
+  "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded.
+    "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED.
+  },
+  "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`.
+    "environment": "A String", # Required. The serving environment.
+  },
+  "exchangeDetails": { # Details for assigned exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`. # Exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_EXCHANGE`.
+    "exchange": "A String", # Required. The enum value for the exchange.
+  },
+  "genderDetails": { # Details for assigned gender targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GENDER`. # Gender details. This field will be populated when the targeting_type is `TARGETING_TYPE_GENDER`.
+    "gender": "A String", # Required. The gender of the audience.
+  },
+  "geoRegionDetails": { # Details for assigned geographic region targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GEO_REGION`. # Geographic region details. This field will be populated when the targeting_type is `TARGETING_TYPE_GEO_REGION`.
+    "displayName": "A String", # Output only. The display name of the geographic region (e.g., "Ontario, Canada").
+    "geoRegionType": "A String", # Output only. The type of geographic region targeting.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GEO_REGION`.
+  },
+  "householdIncomeDetails": { # Details for assigned household income targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`. # Household income details. This field will be populated when the targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`.
+    "householdIncome": "A String", # Required. The household income of the audience.
+  },
+  "inheritance": "A String", # Output only. The inheritance status of the assigned targeting option.
+  "inventorySourceDetails": { # Targeting details for inventory source. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`. # Inventory source details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`.
+    "inventorySourceId": "A String", # Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource.
+  },
+  "inventorySourceGroupDetails": { # Targeting details for inventory source group. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`. # Inventory source group details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`.
+    "inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource.
+  },
+  "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned.
+    "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+  },
+  "languageDetails": { # Details for assigned language targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_LANGUAGE`. # Language details. This field will be populated when the targeting_type is `TARGETING_TYPE_LANGUAGE`.
+    "displayName": "A String", # Output only. The display name of the language (e.g., "French").
+    "negative": True or False, # Indicates if this option is being negatively targeted. All assigned language targeting options on the same resource must have the same value for this field.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_LANGUAGE`.
+  },
+  "name": "A String", # Output only. The resource name for this assigned targeting option.
+  "nativeContentPositionDetails": { # Details for native content position assigned targeting option. This will be populated in the native_content_position_details field when targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`. Explicitly targeting all options is not supported. Remove all native content position targeting options to achieve this effect. # Native content position details. This field will be populated when the targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`.
+    "contentPosition": "A String", # Required. The content position.
+  },
+  "negativeKeywordListDetails": { # Targeting details for negative keyword list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. A maximum of 4 negative keyword lists can be assigned to a resource.
+    "negativeKeywordListId": "A String", # Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource.
+  },
+  "omidDetails": { # Represents a targetable Open Measurement enabled inventory type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_OMID`. # Open Measurement enabled inventory details. This field will be populated when the targeting_type is `TARGETING_TYPE_OMID`.
+    "omid": "A String", # Required. The type of Open Measurement enabled inventory.
+  },
+  "onScreenPositionDetails": { # On screen position targeting option details. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. # On screen position details. This field will be populated when the targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
+    "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+    "onScreenPosition": "A String", # Output only. The on screen position.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
+  },
+  "operatingSystemDetails": { # Assigned operating system targeting option details. This will be populated in the operating_system_details field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. # Operating system details. This field will be populated when the targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
+    "displayName": "A String", # Output only. The display name of the operating system.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting option ID populated in targeting_option_id field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
+  },
+  "parentalStatusDetails": { # Details for assigned parental status targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`. # Parental status details. This field will be populated when the targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`.
+    "parentalStatus": "A String", # Required. The parental status of the audience.
+  },
+  "poiDetails": { # Details for assigned POI targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_POI`. # POI details. This field will be populated when the targeting_type is `TARGETING_TYPE_POI`.
+    "displayName": "A String", # Output only. The display name of a POI, e.g. "Times Square", "Space Needle", followed by its full address if available.
+    "latitude": 3.14, # Output only. Latitude of the POI rounding to 6th decimal place.
+    "longitude": 3.14, # Output only. Longitude of the POI rounding to 6th decimal place.
+    "proximityRadiusAmount": 3.14, # Required. The radius of the area around the POI that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`.
+    "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_POI`. Accepted POI targeting option IDs can be retrieved using `targetingTypes.targetingOptions.search`. If targeting a specific latitude/longitude coordinate removed from an address or POI name, you can generate the necessary targeting option ID by rounding the desired coordinate values to the 6th decimal place, removing the decimals, and concatenating the string values separated by a semicolon. For example, you can target the latitude/longitude pair of 40.7414691, -74.003387 using the targeting option ID "40741469;-74003387". **Upon** **creation, this field value will be updated to append a semicolon and** **alphanumerical hash value if only latitude/longitude coordinates are** **provided.**
+  },
+  "proximityLocationListDetails": { # Targeting details for proximity location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`. # Proximity location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`.
+    "proximityLocationListId": "A String", # Required. ID of the proximity location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_PROXIMITY`.
+    "proximityRadius": 3.14, # Required. Radius expressed in the distance units set in proximity_radius_unit. This represents the size of the area around a chosen location that will be targeted. Radius should be between 1 and 500 miles or 800 kilometers.
+    "proximityRadiusUnit": "A String", # Required. Radius distance units.
+  },
+  "regionalLocationListDetails": { # Targeting details for regional location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`. # Regional location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`.
+  },
+  "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them.
+    "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED.
+  },
+  "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`.
+    "sessionPosition": "A String", # The position where the ad will show in a session.
+  },
+  "subExchangeDetails": { # Details for assigned sub-exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`. # Sub-exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`.
+  },
+  "targetingType": "A String", # Output only. Identifies the type of this assigned targeting option.
+  "thirdPartyVerifierDetails": { # Assigned third party verifier targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`. # Third party verification details. This field will be populated when the targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`.
+    "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox.
+      "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads.
+      "excludedAdlooxCategories": [ # Adloox categories to exclude.
+        "A String",
+      ],
+      "excludedFraudIvtMfaCategories": [ # Optional. Adloox's fraud IVT MFA categories to exclude.
+        "A String",
+      ],
+      "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads.
+    },
+    "doubleVerify": { # Details of DoubleVerify settings. # Third party brand verifier -- DoubleVerify.
+      "appStarRating": { # Details of DoubleVerify star ratings settings. # Avoid bidding on apps with the star ratings.
+        "avoidInsufficientStarRating": True or False, # Avoid bidding on apps with insufficient star ratings.
+        "avoidedStarRating": "A String", # Avoid bidding on apps with the star ratings.
+      },
+      "avoidedAgeRatings": [ # Avoid bidding on apps with the age rating.
+        "A String",
+      ],
+      "brandSafetyCategories": { # Settings for brand safety controls. # DV Brand Safety Controls.
+        "avoidUnknownBrandSafetyCategory": True or False, # Unknown or unrateable.
+        "avoidedHighSeverityCategories": [ # Brand safety high severity avoidance categories.
+          "A String",
+        ],
+        "avoidedMediumSeverityCategories": [ # Brand safety medium severity avoidance categories.
+          "A String",
+        ],
+      },
+      "customSegmentId": "A String", # The custom segment ID provided by DoubleVerify. The ID must start with "51" and consist of eight digits. Custom segment ID cannot be specified along with any of the following fields: * brand_safety_categories * avoided_age_ratings * app_star_rating * fraud_invalid_traffic
+      "displayViewability": { # Details of DoubleVerify display viewability settings. # Display viewability settings (applicable to display line items only).
+        "iab": "A String", # Target web and app inventory to maximize IAB viewable rate.
+        "viewableDuring": "A String", # Target web and app inventory to maximize 100% viewable duration.
+      },
+      "fraudInvalidTraffic": { # DoubleVerify Fraud & Invalid Traffic settings. # Avoid Sites and Apps with historical Fraud & IVT Rates.
+        "avoidInsufficientOption": True or False, # Insufficient Historical Fraud & IVT Stats.
+        "avoidedFraudOption": "A String", # Avoid Sites and Apps with historical Fraud & IVT.
+      },
+      "videoViewability": { # Details of DoubleVerify video viewability settings. # Video viewability settings (applicable to video line items only).
+        "playerImpressionRate": "A String", # Target inventory to maximize impressions with 400x300 or greater player size.
+        "videoIab": "A String", # Target web inventory to maximize IAB viewable rate.
+        "videoViewableRate": "A String", # Target web inventory to maximize fully viewable rate.
+      },
+    },
+    "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science.
+      "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive.
+        "A String",
+      ],
+      "displayViewability": "A String", # Display Viewability section (applicable to display line items only).
+      "excludeUnrateable": True or False, # Brand Safety - **Unrateable**.
+      "excludedAdFraudRisk": "A String", # Ad Fraud settings.
+      "excludedAdultRisk": "A String", # Brand Safety - **Adult content**.
+      "excludedAlcoholRisk": "A String", # Brand Safety - **Alcohol**.
+      "excludedDrugsRisk": "A String", # Brand Safety - **Drugs**.
+      "excludedGamblingRisk": "A String", # Brand Safety - **Gambling**.
+      "excludedHateSpeechRisk": "A String", # Brand Safety - **Hate speech**.
+      "excludedIllegalDownloadsRisk": "A String", # Brand Safety - **Illegal downloads**.
+      "excludedOffensiveLanguageRisk": "A String", # Brand Safety - **Offensive language**.
+      "excludedViolenceRisk": "A String", # Brand Safety - **Violence**.
+      "qualitySyncCustomSegmentId": [ # Optional. The quality sync custom segment ID provided by Integral Ad Science. The ID must be between `3000000` and `4999999`, inclusive.
+        "A String",
+      ],
+      "traqScoreOption": "A String", # True advertising quality (applicable to Display line items only).
+      "videoViewability": "A String", # Video Viewability Section (applicable to video line items only).
+    },
+  },
+  "urlDetails": { # Details for assigned URL targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_URL`. # URL details. This field will be populated when the targeting_type is `TARGETING_TYPE_URL`.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "url": "A String", # Required. The URL, for example `example.com`. DV360 supports two levels of subdirectory targeting, for example `www.example.com/one-subdirectory-level/second-level`, and five levels of subdomain targeting, for example `five.four.three.two.one.example.com`.
+  },
+  "userRewardedContentDetails": { # User rewarded content targeting option details. This will be populated in the user_rewarded_content_details field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. # User rewarded content details. This field will be populated when the targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
+    "userRewardedContent": "A String", # Output only. User rewarded content status for video ads.
+  },
+  "videoPlayerSizeDetails": { # Video player size targeting option details. This will be populated in the video_player_size_details field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. Explicitly targeting all options is not supported. Remove all video player size targeting options to achieve this effect. # Video player size details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.
+    "videoPlayerSize": "A String", # Required. The video player size.
+  },
+  "viewabilityDetails": { # Assigned viewability targeting option details. This will be populated in the viewability_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`. # Viewability details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIEWABILITY`. You can only target one viewability option per resource.
+    "viewability": "A String", # Required. The predicted viewability percentage.
+  },
+  "youtubeChannelDetails": { # Details for YouTube channel assigned targeting option. This will be populated in the youtube_channel_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`. # YouTube channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`.
+    "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+  },
+  "youtubeVideoDetails": { # Details for YouTube video assigned targeting option. This will be populated in the youtube_video_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`. # YouTube video details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "videoId": "A String", # YouTube video id as it appears on the YouTube watch page.
+  },
+}
+
+ +
+ list(advertiserId, lineItemId, targetingType, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists the targeting options assigned to a line item.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser the line item belongs to. (required)
+  lineItemId: string, Required. The ID of the line item to list assigned targeting options for. (required)
+  targetingType: string, Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_YOUTUBE_CHANNEL` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) * `TARGETING_TYPE_YOUTUBE_VIDEO` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) (required)
+    Allowed values
+      TARGETING_TYPE_UNSPECIFIED - Default value when type is not specified or is unknown in this version.
+      TARGETING_TYPE_CHANNEL - Target a channel (a custom group of related websites or apps).
+      TARGETING_TYPE_APP_CATEGORY - Target an app category (for example, education or puzzle games).
+      TARGETING_TYPE_APP - Target a specific app (for example, Angry Birds).
+      TARGETING_TYPE_URL - Target a specific url (for example, quora.com).
+      TARGETING_TYPE_DAY_AND_TIME - Target ads during a chosen time period on a specific day.
+      TARGETING_TYPE_AGE_RANGE - Target ads to a specific age range (for example, 18-24).
+      TARGETING_TYPE_REGIONAL_LOCATION_LIST - Target ads to the specified regions on a regional location list.
+      TARGETING_TYPE_PROXIMITY_LOCATION_LIST - Target ads to the specified points of interest on a proximity location list.
+      TARGETING_TYPE_GENDER - Target ads to a specific gender (for example, female or male).
+      TARGETING_TYPE_VIDEO_PLAYER_SIZE - Target a specific video player size for video ads.
+      TARGETING_TYPE_USER_REWARDED_CONTENT - Target user rewarded content for video ads.
+      TARGETING_TYPE_PARENTAL_STATUS - Target ads to a specific parental status (for example, parent or not a parent).
+      TARGETING_TYPE_CONTENT_INSTREAM_POSITION - Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).
+      TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION - Target ads in a specific content outstream position.
+      TARGETING_TYPE_DEVICE_TYPE - Target ads to a specific device type (for example, tablet or connected TV).
+      TARGETING_TYPE_AUDIENCE_GROUP - Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.
+      TARGETING_TYPE_BROWSER - Target ads to specific web browsers (for example, Chrome).
+      TARGETING_TYPE_HOUSEHOLD_INCOME - Target ads to a specific household income range (for example, top 10%).
+      TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position.
+      TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify).
+      TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).
+      TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult).
+      TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app).
+      TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).
+      TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS).
+      TARGETING_TYPE_DEVICE_MAKE_MODEL - Target ads to a specific device make or model (for example, Roku or Samsung).
+      TARGETING_TYPE_KEYWORD - Target ads to a specific keyword (for example, dog or retriever).
+      TARGETING_TYPE_NEGATIVE_KEYWORD_LIST - Target ads to a specific negative keyword list.
+      TARGETING_TYPE_VIEWABILITY - Target ads to a specific viewability (for example, 80% viewable).
+      TARGETING_TYPE_CATEGORY - Target ads to a specific content category (for example, arts & entertainment).
+      TARGETING_TYPE_INVENTORY_SOURCE - Purchase impressions from specific deals and auction packages.
+      TARGETING_TYPE_LANGUAGE - Target ads to a specific language (for example, English or Japanese).
+      TARGETING_TYPE_AUTHORIZED_SELLER_STATUS - Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.
+      TARGETING_TYPE_GEO_REGION - Target ads to a specific regional location (for example, a city or state).
+      TARGETING_TYPE_INVENTORY_SOURCE_GROUP - Purchase impressions from a group of deals and auction packages.
+      TARGETING_TYPE_EXCHANGE - Purchase impressions from specific exchanges.
+      TARGETING_TYPE_SUB_EXCHANGE - Purchase impressions from specific sub-exchanges.
+      TARGETING_TYPE_POI - Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.
+      TARGETING_TYPE_BUSINESS_CHAIN - Target ads around locations of a business chain within a specific geo region.
+      TARGETING_TYPE_CONTENT_DURATION - Target ads to a specific video content duration.
+      TARGETING_TYPE_CONTENT_STREAM_TYPE - Target ads to a specific video content stream type.
+      TARGETING_TYPE_NATIVE_CONTENT_POSITION - Target ads to a specific native content position.
+      TARGETING_TYPE_OMID - Target ads in an Open Measurement enabled inventory.
+      TARGETING_TYPE_AUDIO_CONTENT_TYPE - Target ads to a specific audio content type.
+      TARGETING_TYPE_CONTENT_GENRE - Target ads to a specific content genre.
+      TARGETING_TYPE_YOUTUBE_VIDEO - Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
+      TARGETING_TYPE_YOUTUBE_CHANNEL - Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
+      TARGETING_TYPE_SESSION_POSITION - Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.
+  filter: string, Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` * `inheritance` Examples: * `AssignedTargetingOption` resources with ID 1 or 2: `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
+  orderBy: string, Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`.
+  pageSize: integer, Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
+  pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListLineItemAssignedTargetingOptions` method. If not specified, the first page of results 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:
+
+    { # Response message for ListLineItemAssignedTargetingOptions.
+  "assignedTargetingOptions": [ # The list of assigned targeting options. This list will be absent if empty.
+    { # A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings.
+      "ageRangeDetails": { # Represents a targetable age range. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AGE_RANGE`. # Age range details. This field will be populated when the targeting_type is `TARGETING_TYPE_AGE_RANGE`.
+        "ageRange": "A String", # Required. The age range of an audience. We only support targeting a continuous age range of an audience. Thus, the age range represented in this field can be 1) targeted solely, or, 2) part of a larger continuous age range. The reach of a continuous age range targeting can be expanded by also targeting an audience of an unknown age.
+      },
+      "appCategoryDetails": { # Details for assigned app category targeting option. This will be populated in the app_category_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. # App category details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
+        "displayName": "A String", # Output only. The display name of the app category.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
+      },
+      "appDetails": { # Details for assigned app targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP`. # App details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP`.
+        "appId": "A String", # Required. The ID of the app. Android's Play store app uses bundle ID, for example `com.google.android.gm`. Apple's App store app ID uses 9 digit string, for example `422689480`.
+        "appPlatform": "A String", # Indicates the platform of the targeted app. If this field is not specified, the app platform will be assumed to be mobile (i.e., Android or iOS), and we will derive the appropriate mobile platform from the app ID.
+        "displayName": "A String", # Output only. The display name of the app.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+      },
+      "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts.
+      "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`
+      "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource.
+        "excludedFirstPartyAndPartnerAudienceGroup": { # Details of first party and partner audience group. All first party and partner audience targeting settings are logically ‘OR’ of each other. # Optional. The first party and partner audience ids and recencies of the excluded first party and partner audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other.
+          "settings": [ # Required. All first party and partner audience targeting settings in first party and partner audience group. Repeated settings with the same id are not allowed.
+            { # Details of first party and partner audience targeting setting.
+              "firstPartyAndPartnerAudienceId": "A String", # Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.
+              "recency": "A String", # Required. The recency of the first party and partner audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
+            },
+          ],
+        },
+        "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other.
+          "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
+            { # Details of Google audience targeting setting.
+              "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
+            },
+          ],
+        },
+        "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only.
+          "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise.
+            { # Details of combined audience targeting setting.
+              "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id.
+            },
+          ],
+        },
+        "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only.
+          "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored.
+            { # Details of custom list targeting setting.
+              "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id.
+            },
+          ],
+        },
+        "includedFirstPartyAndPartnerAudienceGroups": [ # Optional. The first party and partner audience ids and recencies of included first party and partner audience groups. Each first party and partner audience group contains first party and partner audience ids only. The relation between each first party and partner audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored.
+          { # Details of first party and partner audience group. All first party and partner audience targeting settings are logically ‘OR’ of each other.
+            "settings": [ # Required. All first party and partner audience targeting settings in first party and partner audience group. Repeated settings with the same id are not allowed.
+              { # Details of first party and partner audience targeting setting.
+                "firstPartyAndPartnerAudienceId": "A String", # Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.
+                "recency": "A String", # Required. The recency of the first party and partner audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
+              },
+            ],
+          },
+        ],
+        "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only.
+          "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
+            { # Details of Google audience targeting setting.
+              "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
+            },
+          ],
+        },
+      },
+      "audioContentTypeDetails": { # Details for audio content type assigned targeting option. This will be populated in the audio_content_type_details field when targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`. Explicitly targeting all options is not supported. Remove all audio content type targeting options to achieve this effect. # Audio content type details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`.
+        "audioContentType": "A String", # Required. The audio content type.
+      },
+      "authorizedSellerStatusDetails": { # Represents an assigned authorized seller status. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. If a resource does not have an `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` assigned targeting option, it is using the "Authorized Direct Sellers and Resellers" option. # Authorized seller status details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. You can only target one authorized seller status option per resource. If a resource doesn't have an authorized seller status option, all authorized sellers indicated as DIRECT or RESELLER in the ads.txt file are targeted by default.
+        "authorizedSellerStatus": "A String", # Output only. The authorized seller status to target.
+        "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.
+      },
+      "browserDetails": { # Details for assigned browser targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BROWSER`. # Browser details. This field will be populated when the targeting_type is `TARGETING_TYPE_BROWSER`.
+        "displayName": "A String", # Output only. The display name of the browser.
+        "negative": True or False, # Indicates if this option is being negatively targeted. All assigned browser targeting options on the same resource must have the same value for this field.
+        "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BROWSER`.
+      },
+      "businessChainDetails": { # Details for assigned Business chain targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`. # Business chain details. This field will be populated when the targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`.
+        "displayName": "A String", # Output only. The display name of a business chain, e.g. "KFC", "Chase Bank".
+        "proximityRadiusAmount": 3.14, # Required. The radius of the area around the business chain that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`. The minimum increment for both cases is 0.1. Inputs will be rounded to the nearest acceptable value if it is too granular, e.g. 15.57 will become 15.6.
+        "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
+        "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BUSINESS_CHAIN`. Accepted business chain targeting option IDs can be retrieved using SearchTargetingOptions.
+      },
+      "carrierAndIspDetails": { # Details for assigned carrier and ISP targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`. # Carrier and ISP details. This field will be populated when the targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`.
+        "displayName": "A String", # Output only. The display name of the carrier or ISP.
+        "negative": True or False, # Indicates if this option is being negatively targeted. All assigned carrier and ISP targeting options on the same resource must have the same value for this field.
+        "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`.
+      },
+      "categoryDetails": { # Assigned category targeting option details. This will be populated in the category_details field when targeting_type is `TARGETING_TYPE_CATEGORY`. # Category details. This field will be populated when the targeting_type is `TARGETING_TYPE_CATEGORY`. Targeting a category will also target its subcategories. If a category is excluded from targeting and a subcategory is included, the exclusion will take precedence.
+        "displayName": "A String", # Output only. The display name of the category.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CATEGORY`.
+      },
+      "channelDetails": { # Details for assigned channel targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CHANNEL`. # Channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_CHANNEL`.
+        "channelId": "A String", # Required. ID of the channel. Should refer to the channel ID field on a [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id) resource.
+        "negative": True or False, # Indicates if this option is being negatively targeted. For advertiser level assigned targeting option, this field must be true.
+      },
+      "contentDurationDetails": { # Details for content duration assigned targeting option. This will be populated in the content_duration_details field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`. Explicitly targeting all options is not supported. Remove all content duration targeting options to achieve this effect. # Content duration details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
+        "contentDuration": "A String", # Output only. The content duration.
+        "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
+      },
+      "contentGenreDetails": { # Details for content genre assigned targeting option. This will be populated in the content_genre_details field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`. Explicitly targeting all options is not supported. Remove all content genre targeting options to achieve this effect. # Content genre details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
+        "displayName": "A String", # Output only. The display name of the content genre.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
+      },
+      "contentInstreamPositionDetails": { # Assigned content instream position targeting option details. This will be populated in the content_instream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. # Content instream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.
+        "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`. * `AD_TYPE_AUDIO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_AUDIO_DEFAULT`.
+        "contentInstreamPosition": "A String", # Required. The content instream position for video or audio ads.
+      },
+      "contentOutstreamPositionDetails": { # Assigned content outstream position targeting option details. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. # Content outstream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.
+        "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+        "contentOutstreamPosition": "A String", # Required. The content outstream position.
+      },
+      "contentStreamTypeDetails": { # Details for content stream type assigned targeting option. This will be populated in the content_stream_type_details field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`. Explicitly targeting all options is not supported. Remove all content stream type targeting options to achieve this effect. # Content duration details. This field will be populated when the TargetingType is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
+        "contentStreamType": "A String", # Output only. The content stream type.
+        "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
+      },
+      "dayAndTimeDetails": { # Representation of a segment of time defined on a specific day of the week and with a start and end time. The time represented by `start_hour` must be before the time represented by `end_hour`. # Day and time details. This field will be populated when the targeting_type is `TARGETING_TYPE_DAY_AND_TIME`.
+        "dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting.
+        "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day).
+        "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day).
+        "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting.
+      },
+      "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
+        "displayName": "A String", # Output only. The display name of the device make and model.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
+      },
+      "deviceTypeDetails": { # Targeting details for device type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`. # Device Type details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_TYPE`.
+        "deviceType": "A String", # Required. The display name of the device type.
+        "youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items.
+      },
+      "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded.
+        "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED.
+      },
+      "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`.
+        "environment": "A String", # Required. The serving environment.
+      },
+      "exchangeDetails": { # Details for assigned exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`. # Exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_EXCHANGE`.
+        "exchange": "A String", # Required. The enum value for the exchange.
+      },
+      "genderDetails": { # Details for assigned gender targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GENDER`. # Gender details. This field will be populated when the targeting_type is `TARGETING_TYPE_GENDER`.
+        "gender": "A String", # Required. The gender of the audience.
+      },
+      "geoRegionDetails": { # Details for assigned geographic region targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GEO_REGION`. # Geographic region details. This field will be populated when the targeting_type is `TARGETING_TYPE_GEO_REGION`.
+        "displayName": "A String", # Output only. The display name of the geographic region (e.g., "Ontario, Canada").
+        "geoRegionType": "A String", # Output only. The type of geographic region targeting.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GEO_REGION`.
+      },
+      "householdIncomeDetails": { # Details for assigned household income targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`. # Household income details. This field will be populated when the targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`.
+        "householdIncome": "A String", # Required. The household income of the audience.
+      },
+      "inheritance": "A String", # Output only. The inheritance status of the assigned targeting option.
+      "inventorySourceDetails": { # Targeting details for inventory source. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`. # Inventory source details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`.
+        "inventorySourceId": "A String", # Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource.
+      },
+      "inventorySourceGroupDetails": { # Targeting details for inventory source group. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`. # Inventory source group details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`.
+        "inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource.
+      },
+      "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned.
+        "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+      },
+      "languageDetails": { # Details for assigned language targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_LANGUAGE`. # Language details. This field will be populated when the targeting_type is `TARGETING_TYPE_LANGUAGE`.
+        "displayName": "A String", # Output only. The display name of the language (e.g., "French").
+        "negative": True or False, # Indicates if this option is being negatively targeted. All assigned language targeting options on the same resource must have the same value for this field.
+        "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_LANGUAGE`.
+      },
+      "name": "A String", # Output only. The resource name for this assigned targeting option.
+      "nativeContentPositionDetails": { # Details for native content position assigned targeting option. This will be populated in the native_content_position_details field when targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`. Explicitly targeting all options is not supported. Remove all native content position targeting options to achieve this effect. # Native content position details. This field will be populated when the targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`.
+        "contentPosition": "A String", # Required. The content position.
+      },
+      "negativeKeywordListDetails": { # Targeting details for negative keyword list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. A maximum of 4 negative keyword lists can be assigned to a resource.
+        "negativeKeywordListId": "A String", # Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource.
+      },
+      "omidDetails": { # Represents a targetable Open Measurement enabled inventory type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_OMID`. # Open Measurement enabled inventory details. This field will be populated when the targeting_type is `TARGETING_TYPE_OMID`.
+        "omid": "A String", # Required. The type of Open Measurement enabled inventory.
+      },
+      "onScreenPositionDetails": { # On screen position targeting option details. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. # On screen position details. This field will be populated when the targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
+        "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+        "onScreenPosition": "A String", # Output only. The on screen position.
+        "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
+      },
+      "operatingSystemDetails": { # Assigned operating system targeting option details. This will be populated in the operating_system_details field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. # Operating system details. This field will be populated when the targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
+        "displayName": "A String", # Output only. The display name of the operating system.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "targetingOptionId": "A String", # Required. The targeting option ID populated in targeting_option_id field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
+      },
+      "parentalStatusDetails": { # Details for assigned parental status targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`. # Parental status details. This field will be populated when the targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`.
+        "parentalStatus": "A String", # Required. The parental status of the audience.
+      },
+      "poiDetails": { # Details for assigned POI targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_POI`. # POI details. This field will be populated when the targeting_type is `TARGETING_TYPE_POI`.
+        "displayName": "A String", # Output only. The display name of a POI, e.g. "Times Square", "Space Needle", followed by its full address if available.
+        "latitude": 3.14, # Output only. Latitude of the POI rounding to 6th decimal place.
+        "longitude": 3.14, # Output only. Longitude of the POI rounding to 6th decimal place.
+        "proximityRadiusAmount": 3.14, # Required. The radius of the area around the POI that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`.
+        "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
+        "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_POI`. Accepted POI targeting option IDs can be retrieved using `targetingTypes.targetingOptions.search`. If targeting a specific latitude/longitude coordinate removed from an address or POI name, you can generate the necessary targeting option ID by rounding the desired coordinate values to the 6th decimal place, removing the decimals, and concatenating the string values separated by a semicolon. For example, you can target the latitude/longitude pair of 40.7414691, -74.003387 using the targeting option ID "40741469;-74003387". **Upon** **creation, this field value will be updated to append a semicolon and** **alphanumerical hash value if only latitude/longitude coordinates are** **provided.**
+      },
+      "proximityLocationListDetails": { # Targeting details for proximity location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`. # Proximity location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`.
+        "proximityLocationListId": "A String", # Required. ID of the proximity location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_PROXIMITY`.
+        "proximityRadius": 3.14, # Required. Radius expressed in the distance units set in proximity_radius_unit. This represents the size of the area around a chosen location that will be targeted. Radius should be between 1 and 500 miles or 800 kilometers.
+        "proximityRadiusUnit": "A String", # Required. Radius distance units.
+      },
+      "regionalLocationListDetails": { # Targeting details for regional location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`. # Regional location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`.
+      },
+      "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them.
+        "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED.
+      },
+      "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`.
+        "sessionPosition": "A String", # The position where the ad will show in a session.
+      },
+      "subExchangeDetails": { # Details for assigned sub-exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`. # Sub-exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`.
+        "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`.
+      },
+      "targetingType": "A String", # Output only. Identifies the type of this assigned targeting option.
+      "thirdPartyVerifierDetails": { # Assigned third party verifier targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`. # Third party verification details. This field will be populated when the targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`.
+        "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox.
+          "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads.
+          "excludedAdlooxCategories": [ # Adloox categories to exclude.
+            "A String",
+          ],
+          "excludedFraudIvtMfaCategories": [ # Optional. Adloox's fraud IVT MFA categories to exclude.
+            "A String",
+          ],
+          "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads.
+        },
+        "doubleVerify": { # Details of DoubleVerify settings. # Third party brand verifier -- DoubleVerify.
+          "appStarRating": { # Details of DoubleVerify star ratings settings. # Avoid bidding on apps with the star ratings.
+            "avoidInsufficientStarRating": True or False, # Avoid bidding on apps with insufficient star ratings.
+            "avoidedStarRating": "A String", # Avoid bidding on apps with the star ratings.
+          },
+          "avoidedAgeRatings": [ # Avoid bidding on apps with the age rating.
+            "A String",
+          ],
+          "brandSafetyCategories": { # Settings for brand safety controls. # DV Brand Safety Controls.
+            "avoidUnknownBrandSafetyCategory": True or False, # Unknown or unrateable.
+            "avoidedHighSeverityCategories": [ # Brand safety high severity avoidance categories.
+              "A String",
+            ],
+            "avoidedMediumSeverityCategories": [ # Brand safety medium severity avoidance categories.
+              "A String",
+            ],
+          },
+          "customSegmentId": "A String", # The custom segment ID provided by DoubleVerify. The ID must start with "51" and consist of eight digits. Custom segment ID cannot be specified along with any of the following fields: * brand_safety_categories * avoided_age_ratings * app_star_rating * fraud_invalid_traffic
+          "displayViewability": { # Details of DoubleVerify display viewability settings. # Display viewability settings (applicable to display line items only).
+            "iab": "A String", # Target web and app inventory to maximize IAB viewable rate.
+            "viewableDuring": "A String", # Target web and app inventory to maximize 100% viewable duration.
+          },
+          "fraudInvalidTraffic": { # DoubleVerify Fraud & Invalid Traffic settings. # Avoid Sites and Apps with historical Fraud & IVT Rates.
+            "avoidInsufficientOption": True or False, # Insufficient Historical Fraud & IVT Stats.
+            "avoidedFraudOption": "A String", # Avoid Sites and Apps with historical Fraud & IVT.
+          },
+          "videoViewability": { # Details of DoubleVerify video viewability settings. # Video viewability settings (applicable to video line items only).
+            "playerImpressionRate": "A String", # Target inventory to maximize impressions with 400x300 or greater player size.
+            "videoIab": "A String", # Target web inventory to maximize IAB viewable rate.
+            "videoViewableRate": "A String", # Target web inventory to maximize fully viewable rate.
+          },
+        },
+        "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science.
+          "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive.
+            "A String",
+          ],
+          "displayViewability": "A String", # Display Viewability section (applicable to display line items only).
+          "excludeUnrateable": True or False, # Brand Safety - **Unrateable**.
+          "excludedAdFraudRisk": "A String", # Ad Fraud settings.
+          "excludedAdultRisk": "A String", # Brand Safety - **Adult content**.
+          "excludedAlcoholRisk": "A String", # Brand Safety - **Alcohol**.
+          "excludedDrugsRisk": "A String", # Brand Safety - **Drugs**.
+          "excludedGamblingRisk": "A String", # Brand Safety - **Gambling**.
+          "excludedHateSpeechRisk": "A String", # Brand Safety - **Hate speech**.
+          "excludedIllegalDownloadsRisk": "A String", # Brand Safety - **Illegal downloads**.
+          "excludedOffensiveLanguageRisk": "A String", # Brand Safety - **Offensive language**.
+          "excludedViolenceRisk": "A String", # Brand Safety - **Violence**.
+          "qualitySyncCustomSegmentId": [ # Optional. The quality sync custom segment ID provided by Integral Ad Science. The ID must be between `3000000` and `4999999`, inclusive.
+            "A String",
+          ],
+          "traqScoreOption": "A String", # True advertising quality (applicable to Display line items only).
+          "videoViewability": "A String", # Video Viewability Section (applicable to video line items only).
+        },
+      },
+      "urlDetails": { # Details for assigned URL targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_URL`. # URL details. This field will be populated when the targeting_type is `TARGETING_TYPE_URL`.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "url": "A String", # Required. The URL, for example `example.com`. DV360 supports two levels of subdirectory targeting, for example `www.example.com/one-subdirectory-level/second-level`, and five levels of subdomain targeting, for example `five.four.three.two.one.example.com`.
+      },
+      "userRewardedContentDetails": { # User rewarded content targeting option details. This will be populated in the user_rewarded_content_details field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. # User rewarded content details. This field will be populated when the targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
+        "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
+        "userRewardedContent": "A String", # Output only. User rewarded content status for video ads.
+      },
+      "videoPlayerSizeDetails": { # Video player size targeting option details. This will be populated in the video_player_size_details field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. Explicitly targeting all options is not supported. Remove all video player size targeting options to achieve this effect. # Video player size details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.
+        "videoPlayerSize": "A String", # Required. The video player size.
+      },
+      "viewabilityDetails": { # Assigned viewability targeting option details. This will be populated in the viewability_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`. # Viewability details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIEWABILITY`. You can only target one viewability option per resource.
+        "viewability": "A String", # Required. The predicted viewability percentage.
+      },
+      "youtubeChannelDetails": { # Details for YouTube channel assigned targeting option. This will be populated in the youtube_channel_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`. # YouTube channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`.
+        "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+      },
+      "youtubeVideoDetails": { # Details for YouTube video assigned targeting option. This will be populated in the youtube_video_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`. # YouTube video details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "videoId": "A String", # YouTube video id as it appears on the YouTube watch page.
+      },
+    },
+  ],
+  "nextPageToken": "A String", # A token identifying the next page of results. This value should be specified as the pageToken in a subsequent ListLineItemAssignedTargetingOptionsRequest to fetch the next page of results. This token will be absent if there are no more assigned_targeting_options to return.
+}
+
+ +
+ 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/displayvideo_v4.advertisers.lineItems.targetingTypes.html b/docs/dyn/displayvideo_v4.advertisers.lineItems.targetingTypes.html new file mode 100644 index 00000000000..8d703adc84f --- /dev/null +++ b/docs/dyn/displayvideo_v4.advertisers.lineItems.targetingTypes.html @@ -0,0 +1,91 @@ + + + +

Display & Video 360 API . advertisers . lineItems . targetingTypes

+

Instance Methods

+

+ assignedTargetingOptions() +

+

Returns the assignedTargetingOptions Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/displayvideo_v4.advertisers.locationLists.assignedLocations.html b/docs/dyn/displayvideo_v4.advertisers.locationLists.assignedLocations.html new file mode 100644 index 00000000000..acafd363174 --- /dev/null +++ b/docs/dyn/displayvideo_v4.advertisers.locationLists.assignedLocations.html @@ -0,0 +1,239 @@ + + + +

Display & Video 360 API . advertisers . locationLists . assignedLocations

+

Instance Methods

+

+ bulkEdit(advertiserId, locationListId, body=None, x__xgafv=None)

+

Bulk edits multiple assignments between locations and a single location list. The operation will delete the assigned locations provided in deletedAssignedLocations and then create the assigned locations provided in createdAssignedLocations.

+

+ close()

+

Close httplib2 connections.

+

+ create(advertiserId, locationListId, body=None, x__xgafv=None)

+

Creates an assignment between a location and a location list.

+

+ delete(advertiserId, locationListId, assignedLocationId, x__xgafv=None)

+

Deletes the assignment between a location and a location list.

+

+ list(advertiserId, locationListId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists locations assigned to a location list.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ bulkEdit(advertiserId, locationListId, body=None, x__xgafv=None) +
Bulk edits multiple assignments between locations and a single location list. The operation will delete the assigned locations provided in deletedAssignedLocations and then create the assigned locations provided in createdAssignedLocations.
+
+Args:
+  advertiserId: string, Required. The ID of the DV360 advertiser to which the location list belongs. (required)
+  locationListId: string, Required. The ID of the location list to which these assignments are assigned. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for AssignedLocationService.BulkEditAssignedLocations.
+  "createdAssignedLocations": [ # The assigned locations to create in bulk, specified as a list of AssignedLocation resources.
+    { # An assignment between a location list and a relevant targeting option.
+      "assignedLocationId": "A String", # Output only. The unique ID of the assigned location. The ID is only unique within a location list. It may be reused in other contexts.
+      "name": "A String", # Output only. The resource name of the assigned location.
+      "targetingOptionId": "A String", # Required. The ID of the targeting option assigned to the location list.
+    },
+  ],
+  "deletedAssignedLocations": [ # The IDs of the assigned locations to delete in bulk, specified as a list of assignedLocationId values.
+    "A String",
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "assignedLocations": [ # The list of assigned locations that have been successfully created. This list will be absent if empty.
+    { # An assignment between a location list and a relevant targeting option.
+      "assignedLocationId": "A String", # Output only. The unique ID of the assigned location. The ID is only unique within a location list. It may be reused in other contexts.
+      "name": "A String", # Output only. The resource name of the assigned location.
+      "targetingOptionId": "A String", # Required. The ID of the targeting option assigned to the location list.
+    },
+  ],
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ create(advertiserId, locationListId, body=None, x__xgafv=None) +
Creates an assignment between a location and a location list.
+
+Args:
+  advertiserId: string, Required. The ID of the DV360 advertiser to which the location list belongs. (required)
+  locationListId: string, Required. The ID of the location list for which the assignment will be created. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # An assignment between a location list and a relevant targeting option.
+  "assignedLocationId": "A String", # Output only. The unique ID of the assigned location. The ID is only unique within a location list. It may be reused in other contexts.
+  "name": "A String", # Output only. The resource name of the assigned location.
+  "targetingOptionId": "A String", # Required. The ID of the targeting option assigned to the location list.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An assignment between a location list and a relevant targeting option.
+  "assignedLocationId": "A String", # Output only. The unique ID of the assigned location. The ID is only unique within a location list. It may be reused in other contexts.
+  "name": "A String", # Output only. The resource name of the assigned location.
+  "targetingOptionId": "A String", # Required. The ID of the targeting option assigned to the location list.
+}
+
+ +
+ delete(advertiserId, locationListId, assignedLocationId, x__xgafv=None) +
Deletes the assignment between a location and a location list.
+
+Args:
+  advertiserId: string, Required. The ID of the DV360 advertiser to which the location list belongs. (required)
+  locationListId: string, Required. The ID of the location list to which this assignment is assigned. (required)
+  assignedLocationId: string, Required. The ID of the assigned location 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); }
+}
+
+ +
+ list(advertiserId, locationListId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists locations assigned to a location list.
+
+Args:
+  advertiserId: string, Required. The ID of the DV360 advertiser to which the location list belongs. (required)
+  locationListId: string, Required. The ID of the location list to which these assignments are assigned. (required)
+  filter: string, Allows filtering by location list assignment fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedLocationId` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
+  orderBy: string, Field by which to sort the list. Acceptable values are: * `assignedLocationId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `assignedLocationId desc`.
+  pageSize: integer, Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
+  pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAssignedLocations` method. If not specified, the first page of results 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:
+
+    { # Response message for AssignedLocationService.ListAssignedLocations.
+  "assignedLocations": [ # The list of assigned locations. This list will be absent if empty.
+    { # An assignment between a location list and a relevant targeting option.
+      "assignedLocationId": "A String", # Output only. The unique ID of the assigned location. The ID is only unique within a location list. It may be reused in other contexts.
+      "name": "A String", # Output only. The resource name of the assigned location.
+      "targetingOptionId": "A String", # Required. The ID of the targeting option assigned to the location list.
+    },
+  ],
+  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListAssignedLocations` method to retrieve the next page of results.
+}
+
+ +
+ 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/displayvideo_v4.advertisers.locationLists.html b/docs/dyn/displayvideo_v4.advertisers.locationLists.html new file mode 100644 index 00000000000..4ba3741c4f8 --- /dev/null +++ b/docs/dyn/displayvideo_v4.advertisers.locationLists.html @@ -0,0 +1,246 @@ + + + +

Display & Video 360 API . advertisers . locationLists

+

Instance Methods

+

+ assignedLocations() +

+

Returns the assignedLocations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ create(advertiserId, body=None, x__xgafv=None)

+

Creates a new location list. Returns the newly created location list if successful.

+

+ get(advertiserId, locationListId, x__xgafv=None)

+

Gets a location list.

+

+ list(advertiserId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists location lists based on a given advertiser id.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(advertiserId, locationListId, body=None, updateMask=None, x__xgafv=None)

+

Updates a location list. Returns the updated location list if successful.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(advertiserId, body=None, x__xgafv=None) +
Creates a new location list. Returns the newly created location list if successful.
+
+Args:
+  advertiserId: string, Required. The ID of the DV360 advertiser to which the location list belongs. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A list of locations used for targeting.
+  "advertiserId": "A String", # Required. Immutable. The unique ID of the advertiser the location list belongs to.
+  "displayName": "A String", # Required. The display name of the location list. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "locationListId": "A String", # Output only. The unique ID of the location list. Assigned by the system.
+  "locationType": "A String", # Required. Immutable. The type of location. All locations in the list will share this type.
+  "name": "A String", # Output only. The resource name of the location list.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A list of locations used for targeting.
+  "advertiserId": "A String", # Required. Immutable. The unique ID of the advertiser the location list belongs to.
+  "displayName": "A String", # Required. The display name of the location list. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "locationListId": "A String", # Output only. The unique ID of the location list. Assigned by the system.
+  "locationType": "A String", # Required. Immutable. The type of location. All locations in the list will share this type.
+  "name": "A String", # Output only. The resource name of the location list.
+}
+
+ +
+ get(advertiserId, locationListId, x__xgafv=None) +
Gets a location list.
+
+Args:
+  advertiserId: string, Required. The ID of the DV360 advertiser to which the fetched location list belongs. (required)
+  locationListId: string, Required. The ID of the location list to fetch. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A list of locations used for targeting.
+  "advertiserId": "A String", # Required. Immutable. The unique ID of the advertiser the location list belongs to.
+  "displayName": "A String", # Required. The display name of the location list. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "locationListId": "A String", # Output only. The unique ID of the location list. Assigned by the system.
+  "locationType": "A String", # Required. Immutable. The type of location. All locations in the list will share this type.
+  "name": "A String", # Output only. The resource name of the location list.
+}
+
+ +
+ list(advertiserId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists location lists based on a given advertiser id.
+
+Args:
+  advertiserId: string, Required. The ID of the DV360 advertiser to which the fetched location lists belong. (required)
+  filter: string, Allows filtering by location list fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `locationType` Examples: * All regional location list: `locationType="TARGETING_LOCATION_TYPE_REGIONAL"` * All proximity location list: `locationType="TARGETING_LOCATION_TYPE_PROXIMITY"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
+  orderBy: string, Field by which to sort the list. Acceptable values are: * `locationListId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.
+  pageSize: integer, Requested page size. Must be between `1` and `200`. Defaults to `100` if not set. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
+  pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListLocationLists` method. If not specified, the first page of results 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:
+
+    {
+  "locationLists": [ # The list of location lists. This list will be absent if empty.
+    { # A list of locations used for targeting.
+      "advertiserId": "A String", # Required. Immutable. The unique ID of the advertiser the location list belongs to.
+      "displayName": "A String", # Required. The display name of the location list. Must be UTF-8 encoded with a maximum size of 240 bytes.
+      "locationListId": "A String", # Output only. The unique ID of the location list. Assigned by the system.
+      "locationType": "A String", # Required. Immutable. The type of location. All locations in the list will share this type.
+      "name": "A String", # Output only. The resource name of the location list.
+    },
+  ],
+  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListLocationLists` method to retrieve the next page of results.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(advertiserId, locationListId, body=None, updateMask=None, x__xgafv=None) +
Updates a location list. Returns the updated location list if successful.
+
+Args:
+  advertiserId: string, Required. The ID of the DV360 advertiser to which the location lists belongs. (required)
+  locationListId: string, Output only. The unique ID of the location list. Assigned by the system. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A list of locations used for targeting.
+  "advertiserId": "A String", # Required. Immutable. The unique ID of the advertiser the location list belongs to.
+  "displayName": "A String", # Required. The display name of the location list. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "locationListId": "A String", # Output only. The unique ID of the location list. Assigned by the system.
+  "locationType": "A String", # Required. Immutable. The type of location. All locations in the list will share this type.
+  "name": "A String", # Output only. The resource name of the location list.
+}
+
+  updateMask: string, Required. The mask to control which fields to update.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A list of locations used for targeting.
+  "advertiserId": "A String", # Required. Immutable. The unique ID of the advertiser the location list belongs to.
+  "displayName": "A String", # Required. The display name of the location list. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "locationListId": "A String", # Output only. The unique ID of the location list. Assigned by the system.
+  "locationType": "A String", # Required. Immutable. The type of location. All locations in the list will share this type.
+  "name": "A String", # Output only. The resource name of the location list.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/displayvideo_v4.advertisers.negativeKeywordLists.html b/docs/dyn/displayvideo_v4.advertisers.negativeKeywordLists.html new file mode 100644 index 00000000000..ec4a31b8725 --- /dev/null +++ b/docs/dyn/displayvideo_v4.advertisers.negativeKeywordLists.html @@ -0,0 +1,266 @@ + + + +

Display & Video 360 API . advertisers . negativeKeywordLists

+

Instance Methods

+

+ negativeKeywords() +

+

Returns the negativeKeywords Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ create(advertiserId, body=None, x__xgafv=None)

+

Creates a new negative keyword list. Returns the newly created negative keyword list if successful.

+

+ delete(advertiserId, negativeKeywordListId, x__xgafv=None)

+

Deletes a negative keyword list given an advertiser ID and a negative keyword list ID.

+

+ get(advertiserId, negativeKeywordListId, x__xgafv=None)

+

Gets a negative keyword list given an advertiser ID and a negative keyword list ID.

+

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

+

Lists negative keyword lists based on a given advertiser id.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(advertiserId, negativeKeywordListId, body=None, updateMask=None, x__xgafv=None)

+

Updates a negative keyword list. Returns the updated negative keyword list if successful.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(advertiserId, body=None, x__xgafv=None) +
Creates a new negative keyword list. Returns the newly created negative keyword list if successful.
+
+Args:
+  advertiserId: string, Required. The ID of the DV360 advertiser to which the negative keyword list will belong. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A list of negative keywords used for targeting.
+  "advertiserId": "A String", # Output only. The unique ID of the advertiser the negative keyword list belongs to.
+  "displayName": "A String", # Required. The display name of the negative keyword list. Must be UTF-8 encoded with a maximum size of 255 bytes.
+  "name": "A String", # Output only. The resource name of the negative keyword list.
+  "negativeKeywordListId": "A String", # Output only. The unique ID of the negative keyword list. Assigned by the system.
+  "targetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this negative keyword list.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A list of negative keywords used for targeting.
+  "advertiserId": "A String", # Output only. The unique ID of the advertiser the negative keyword list belongs to.
+  "displayName": "A String", # Required. The display name of the negative keyword list. Must be UTF-8 encoded with a maximum size of 255 bytes.
+  "name": "A String", # Output only. The resource name of the negative keyword list.
+  "negativeKeywordListId": "A String", # Output only. The unique ID of the negative keyword list. Assigned by the system.
+  "targetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this negative keyword list.
+}
+
+ +
+ delete(advertiserId, negativeKeywordListId, x__xgafv=None) +
Deletes a negative keyword list given an advertiser ID and a negative keyword list ID.
+
+Args:
+  advertiserId: string, Required. The ID of the DV360 advertiser to which the negative keyword list belongs. (required)
+  negativeKeywordListId: string, Required. The ID of the negative keyword list 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(advertiserId, negativeKeywordListId, x__xgafv=None) +
Gets a negative keyword list given an advertiser ID and a negative keyword list ID.
+
+Args:
+  advertiserId: string, Required. The ID of the DV360 advertiser to which the fetched negative keyword list belongs. (required)
+  negativeKeywordListId: string, Required. The ID of the negative keyword list to fetch. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A list of negative keywords used for targeting.
+  "advertiserId": "A String", # Output only. The unique ID of the advertiser the negative keyword list belongs to.
+  "displayName": "A String", # Required. The display name of the negative keyword list. Must be UTF-8 encoded with a maximum size of 255 bytes.
+  "name": "A String", # Output only. The resource name of the negative keyword list.
+  "negativeKeywordListId": "A String", # Output only. The unique ID of the negative keyword list. Assigned by the system.
+  "targetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this negative keyword list.
+}
+
+ +
+ list(advertiserId, pageSize=None, pageToken=None, x__xgafv=None) +
Lists negative keyword lists based on a given advertiser id.
+
+Args:
+  advertiserId: string, Required. The ID of the DV360 advertiser to which the fetched negative keyword lists belong. (required)
+  pageSize: integer, Requested page size. Must be between `1` and `200`. Defaults to `100` if not set. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
+  pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListNegativeKeywordLists` method. If not specified, the first page of results 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:
+
+    { # Response message for NegativeKeywordListService.ListNegativeKeywordLists.
+  "negativeKeywordLists": [ # The list of negative keyword lists. This list will be absent if empty.
+    { # A list of negative keywords used for targeting.
+      "advertiserId": "A String", # Output only. The unique ID of the advertiser the negative keyword list belongs to.
+      "displayName": "A String", # Required. The display name of the negative keyword list. Must be UTF-8 encoded with a maximum size of 255 bytes.
+      "name": "A String", # Output only. The resource name of the negative keyword list.
+      "negativeKeywordListId": "A String", # Output only. The unique ID of the negative keyword list. Assigned by the system.
+      "targetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this negative keyword list.
+    },
+  ],
+  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListNegativeKeywordLists` method to retrieve the next page of results.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(advertiserId, negativeKeywordListId, body=None, updateMask=None, x__xgafv=None) +
Updates a negative keyword list. Returns the updated negative keyword list if successful.
+
+Args:
+  advertiserId: string, Required. The ID of the DV360 advertiser to which the negative keyword list belongs. (required)
+  negativeKeywordListId: string, Output only. The unique ID of the negative keyword list. Assigned by the system. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A list of negative keywords used for targeting.
+  "advertiserId": "A String", # Output only. The unique ID of the advertiser the negative keyword list belongs to.
+  "displayName": "A String", # Required. The display name of the negative keyword list. Must be UTF-8 encoded with a maximum size of 255 bytes.
+  "name": "A String", # Output only. The resource name of the negative keyword list.
+  "negativeKeywordListId": "A String", # Output only. The unique ID of the negative keyword list. Assigned by the system.
+  "targetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this negative keyword list.
+}
+
+  updateMask: string, Required. The mask to control which fields to update.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A list of negative keywords used for targeting.
+  "advertiserId": "A String", # Output only. The unique ID of the advertiser the negative keyword list belongs to.
+  "displayName": "A String", # Required. The display name of the negative keyword list. Must be UTF-8 encoded with a maximum size of 255 bytes.
+  "name": "A String", # Output only. The resource name of the negative keyword list.
+  "negativeKeywordListId": "A String", # Output only. The unique ID of the negative keyword list. Assigned by the system.
+  "targetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this negative keyword list.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/displayvideo_v4.advertisers.negativeKeywordLists.negativeKeywords.html b/docs/dyn/displayvideo_v4.advertisers.negativeKeywordLists.negativeKeywords.html new file mode 100644 index 00000000000..588477c8186 --- /dev/null +++ b/docs/dyn/displayvideo_v4.advertisers.negativeKeywordLists.negativeKeywords.html @@ -0,0 +1,274 @@ + + + +

Display & Video 360 API . advertisers . negativeKeywordLists . negativeKeywords

+

Instance Methods

+

+ bulkEdit(advertiserId, negativeKeywordListId, body=None, x__xgafv=None)

+

Bulk edits negative keywords in a single negative keyword list. The operation will delete the negative keywords provided in BulkEditNegativeKeywordsRequest.deleted_negative_keywords and then create the negative keywords provided in BulkEditNegativeKeywordsRequest.created_negative_keywords. This operation is guaranteed to be atomic and will never result in a partial success or partial failure.

+

+ close()

+

Close httplib2 connections.

+

+ create(advertiserId, negativeKeywordListId, body=None, x__xgafv=None)

+

Creates a negative keyword in a negative keyword list.

+

+ delete(advertiserId, negativeKeywordListId, keywordValue, x__xgafv=None)

+

Deletes a negative keyword from a negative keyword list.

+

+ list(advertiserId, negativeKeywordListId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists negative keywords in a negative keyword list.

+

+ list_next()

+

Retrieves the next page of results.

+

+ replace(advertiserId, negativeKeywordListId, body=None, x__xgafv=None)

+

Replaces all negative keywords in a single negative keyword list. The operation will replace the keywords in a negative keyword list with keywords provided in ReplaceNegativeKeywordsRequest.new_negative_keywords.

+

Method Details

+
+ bulkEdit(advertiserId, negativeKeywordListId, body=None, x__xgafv=None) +
Bulk edits negative keywords in a single negative keyword list. The operation will delete the negative keywords provided in BulkEditNegativeKeywordsRequest.deleted_negative_keywords and then create the negative keywords provided in BulkEditNegativeKeywordsRequest.created_negative_keywords. This operation is guaranteed to be atomic and will never result in a partial success or partial failure.
+
+Args:
+  advertiserId: string, Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs. (required)
+  negativeKeywordListId: string, Required. The ID of the parent negative keyword list to which the negative keywords belong. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for NegativeKeywordService.BulkEditNegativeKeywords.
+  "createdNegativeKeywords": [ # The negative keywords to create in batch, specified as a list of NegativeKeywords.
+    { # A negatively targeted keyword that belongs to a negative keyword list.
+      "keywordValue": "A String", # Required. Immutable. The negatively targeted keyword, for example `car insurance`. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. Valid characters are restricted to ASCII characters only. The only URL-escaping permitted is for representing whitespace between words. Leading or trailing whitespace is ignored.
+      "name": "A String", # Output only. The resource name of the negative keyword.
+    },
+  ],
+  "deletedNegativeKeywords": [ # The negative keywords to delete in batch, specified as a list of keyword_values.
+    "A String",
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for NegativeKeywordService.BulkEditNegativeKeywords.
+  "negativeKeywords": [ # The list of negative keywords that have been successfully created. This list will be absent if empty.
+    { # A negatively targeted keyword that belongs to a negative keyword list.
+      "keywordValue": "A String", # Required. Immutable. The negatively targeted keyword, for example `car insurance`. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. Valid characters are restricted to ASCII characters only. The only URL-escaping permitted is for representing whitespace between words. Leading or trailing whitespace is ignored.
+      "name": "A String", # Output only. The resource name of the negative keyword.
+    },
+  ],
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ create(advertiserId, negativeKeywordListId, body=None, x__xgafv=None) +
Creates a negative keyword in a negative keyword list.
+
+Args:
+  advertiserId: string, Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs. (required)
+  negativeKeywordListId: string, Required. The ID of the parent negative keyword list in which the negative keyword will be created. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A negatively targeted keyword that belongs to a negative keyword list.
+  "keywordValue": "A String", # Required. Immutable. The negatively targeted keyword, for example `car insurance`. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. Valid characters are restricted to ASCII characters only. The only URL-escaping permitted is for representing whitespace between words. Leading or trailing whitespace is ignored.
+  "name": "A String", # Output only. The resource name of the negative keyword.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A negatively targeted keyword that belongs to a negative keyword list.
+  "keywordValue": "A String", # Required. Immutable. The negatively targeted keyword, for example `car insurance`. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. Valid characters are restricted to ASCII characters only. The only URL-escaping permitted is for representing whitespace between words. Leading or trailing whitespace is ignored.
+  "name": "A String", # Output only. The resource name of the negative keyword.
+}
+
+ +
+ delete(advertiserId, negativeKeywordListId, keywordValue, x__xgafv=None) +
Deletes a negative keyword from a negative keyword list.
+
+Args:
+  advertiserId: string, Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs. (required)
+  negativeKeywordListId: string, Required. The ID of the parent negative keyword list to which the negative keyword belongs. (required)
+  keywordValue: string, Required. The keyword value of the negative keyword 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); }
+}
+
+ +
+ list(advertiserId, negativeKeywordListId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists negative keywords in a negative keyword list.
+
+Args:
+  advertiserId: string, Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs. (required)
+  negativeKeywordListId: string, Required. The ID of the parent negative keyword list to which the requested negative keywords belong. (required)
+  filter: string, Allows filtering by negative keyword fields. Supported syntax: * Filter expressions for negative keywords can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `keywordValue` Examples: * All negative keywords for which the keyword value contains "google": `keywordValue : "google"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
+  orderBy: string, Field by which to sort the list. Acceptable values are: * `keywordValue` (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `keywordValue desc`.
+  pageSize: integer, Requested page size. Must be between `1` and `1000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
+  pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListNegativeKeywords` method. If not specified, the first page of results 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:
+
+    { # Response message for NegativeKeywordService.ListNegativeKeywords.
+  "negativeKeywords": [ # The list of negative keywords. This list will be absent if empty.
+    { # A negatively targeted keyword that belongs to a negative keyword list.
+      "keywordValue": "A String", # Required. Immutable. The negatively targeted keyword, for example `car insurance`. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. Valid characters are restricted to ASCII characters only. The only URL-escaping permitted is for representing whitespace between words. Leading or trailing whitespace is ignored.
+      "name": "A String", # Output only. The resource name of the negative keyword.
+    },
+  ],
+  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListNegativeKeywords` method to retrieve the next page of results.
+}
+
+ +
+ 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.
+        
+
+ +
+ replace(advertiserId, negativeKeywordListId, body=None, x__xgafv=None) +
Replaces all negative keywords in a single negative keyword list. The operation will replace the keywords in a negative keyword list with keywords provided in ReplaceNegativeKeywordsRequest.new_negative_keywords.
+
+Args:
+  advertiserId: string, Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs. (required)
+  negativeKeywordListId: string, Required. The ID of the parent negative keyword list to which the negative keywords belong. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for NegativeKeywordService.ReplaceNegativeKeywords.
+  "newNegativeKeywords": [ # The negative keywords that will replace the existing keywords in the negative keyword list, specified as a list of NegativeKeywords.
+    { # A negatively targeted keyword that belongs to a negative keyword list.
+      "keywordValue": "A String", # Required. Immutable. The negatively targeted keyword, for example `car insurance`. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. Valid characters are restricted to ASCII characters only. The only URL-escaping permitted is for representing whitespace between words. Leading or trailing whitespace is ignored.
+      "name": "A String", # Output only. The resource name of the negative keyword.
+    },
+  ],
+}
+
+  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 NegativeKeywordService.ReplaceNegativeKeywords.
+  "negativeKeywords": [ # The full list of negative keywords now present in the negative keyword list.
+    { # A negatively targeted keyword that belongs to a negative keyword list.
+      "keywordValue": "A String", # Required. Immutable. The negatively targeted keyword, for example `car insurance`. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. Valid characters are restricted to ASCII characters only. The only URL-escaping permitted is for representing whitespace between words. Leading or trailing whitespace is ignored.
+      "name": "A String", # Output only. The resource name of the negative keyword.
+    },
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/displayvideo_v4.advertisers.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v4.advertisers.targetingTypes.assignedTargetingOptions.html new file mode 100644 index 00000000000..833c792cd0c --- /dev/null +++ b/docs/dyn/displayvideo_v4.advertisers.targetingTypes.assignedTargetingOptions.html @@ -0,0 +1,1680 @@ + + + +

Display & Video 360 API . advertisers . targetingTypes . assignedTargetingOptions

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(advertiserId, targetingType, body=None, x__xgafv=None)

+

Assigns a targeting option to an advertiser. Returns the assigned targeting option if successful.

+

+ delete(advertiserId, targetingType, assignedTargetingOptionId, x__xgafv=None)

+

Deletes an assigned targeting option from an advertiser.

+

+ get(advertiserId, targetingType, assignedTargetingOptionId, x__xgafv=None)

+

Gets a single targeting option assigned to an advertiser.

+

+ list(advertiserId, targetingType, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists the targeting options assigned to an advertiser.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(advertiserId, targetingType, body=None, x__xgafv=None) +
Assigns a targeting option to an advertiser. Returns the assigned targeting option if successful.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser. (required)
+  targetingType: string, Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD` (required)
+    Allowed values
+      TARGETING_TYPE_UNSPECIFIED - Default value when type is not specified or is unknown in this version.
+      TARGETING_TYPE_CHANNEL - Target a channel (a custom group of related websites or apps).
+      TARGETING_TYPE_APP_CATEGORY - Target an app category (for example, education or puzzle games).
+      TARGETING_TYPE_APP - Target a specific app (for example, Angry Birds).
+      TARGETING_TYPE_URL - Target a specific url (for example, quora.com).
+      TARGETING_TYPE_DAY_AND_TIME - Target ads during a chosen time period on a specific day.
+      TARGETING_TYPE_AGE_RANGE - Target ads to a specific age range (for example, 18-24).
+      TARGETING_TYPE_REGIONAL_LOCATION_LIST - Target ads to the specified regions on a regional location list.
+      TARGETING_TYPE_PROXIMITY_LOCATION_LIST - Target ads to the specified points of interest on a proximity location list.
+      TARGETING_TYPE_GENDER - Target ads to a specific gender (for example, female or male).
+      TARGETING_TYPE_VIDEO_PLAYER_SIZE - Target a specific video player size for video ads.
+      TARGETING_TYPE_USER_REWARDED_CONTENT - Target user rewarded content for video ads.
+      TARGETING_TYPE_PARENTAL_STATUS - Target ads to a specific parental status (for example, parent or not a parent).
+      TARGETING_TYPE_CONTENT_INSTREAM_POSITION - Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).
+      TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION - Target ads in a specific content outstream position.
+      TARGETING_TYPE_DEVICE_TYPE - Target ads to a specific device type (for example, tablet or connected TV).
+      TARGETING_TYPE_AUDIENCE_GROUP - Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.
+      TARGETING_TYPE_BROWSER - Target ads to specific web browsers (for example, Chrome).
+      TARGETING_TYPE_HOUSEHOLD_INCOME - Target ads to a specific household income range (for example, top 10%).
+      TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position.
+      TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify).
+      TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).
+      TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult).
+      TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app).
+      TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).
+      TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS).
+      TARGETING_TYPE_DEVICE_MAKE_MODEL - Target ads to a specific device make or model (for example, Roku or Samsung).
+      TARGETING_TYPE_KEYWORD - Target ads to a specific keyword (for example, dog or retriever).
+      TARGETING_TYPE_NEGATIVE_KEYWORD_LIST - Target ads to a specific negative keyword list.
+      TARGETING_TYPE_VIEWABILITY - Target ads to a specific viewability (for example, 80% viewable).
+      TARGETING_TYPE_CATEGORY - Target ads to a specific content category (for example, arts & entertainment).
+      TARGETING_TYPE_INVENTORY_SOURCE - Purchase impressions from specific deals and auction packages.
+      TARGETING_TYPE_LANGUAGE - Target ads to a specific language (for example, English or Japanese).
+      TARGETING_TYPE_AUTHORIZED_SELLER_STATUS - Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.
+      TARGETING_TYPE_GEO_REGION - Target ads to a specific regional location (for example, a city or state).
+      TARGETING_TYPE_INVENTORY_SOURCE_GROUP - Purchase impressions from a group of deals and auction packages.
+      TARGETING_TYPE_EXCHANGE - Purchase impressions from specific exchanges.
+      TARGETING_TYPE_SUB_EXCHANGE - Purchase impressions from specific sub-exchanges.
+      TARGETING_TYPE_POI - Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.
+      TARGETING_TYPE_BUSINESS_CHAIN - Target ads around locations of a business chain within a specific geo region.
+      TARGETING_TYPE_CONTENT_DURATION - Target ads to a specific video content duration.
+      TARGETING_TYPE_CONTENT_STREAM_TYPE - Target ads to a specific video content stream type.
+      TARGETING_TYPE_NATIVE_CONTENT_POSITION - Target ads to a specific native content position.
+      TARGETING_TYPE_OMID - Target ads in an Open Measurement enabled inventory.
+      TARGETING_TYPE_AUDIO_CONTENT_TYPE - Target ads to a specific audio content type.
+      TARGETING_TYPE_CONTENT_GENRE - Target ads to a specific content genre.
+      TARGETING_TYPE_YOUTUBE_VIDEO - Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
+      TARGETING_TYPE_YOUTUBE_CHANNEL - Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
+      TARGETING_TYPE_SESSION_POSITION - Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings.
+  "ageRangeDetails": { # Represents a targetable age range. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AGE_RANGE`. # Age range details. This field will be populated when the targeting_type is `TARGETING_TYPE_AGE_RANGE`.
+    "ageRange": "A String", # Required. The age range of an audience. We only support targeting a continuous age range of an audience. Thus, the age range represented in this field can be 1) targeted solely, or, 2) part of a larger continuous age range. The reach of a continuous age range targeting can be expanded by also targeting an audience of an unknown age.
+  },
+  "appCategoryDetails": { # Details for assigned app category targeting option. This will be populated in the app_category_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. # App category details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
+    "displayName": "A String", # Output only. The display name of the app category.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
+  },
+  "appDetails": { # Details for assigned app targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP`. # App details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP`.
+    "appId": "A String", # Required. The ID of the app. Android's Play store app uses bundle ID, for example `com.google.android.gm`. Apple's App store app ID uses 9 digit string, for example `422689480`.
+    "appPlatform": "A String", # Indicates the platform of the targeted app. If this field is not specified, the app platform will be assumed to be mobile (i.e., Android or iOS), and we will derive the appropriate mobile platform from the app ID.
+    "displayName": "A String", # Output only. The display name of the app.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+  },
+  "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts.
+  "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`
+  "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource.
+    "excludedFirstPartyAndPartnerAudienceGroup": { # Details of first party and partner audience group. All first party and partner audience targeting settings are logically ‘OR’ of each other. # Optional. The first party and partner audience ids and recencies of the excluded first party and partner audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other.
+      "settings": [ # Required. All first party and partner audience targeting settings in first party and partner audience group. Repeated settings with the same id are not allowed.
+        { # Details of first party and partner audience targeting setting.
+          "firstPartyAndPartnerAudienceId": "A String", # Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.
+          "recency": "A String", # Required. The recency of the first party and partner audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
+        },
+      ],
+    },
+    "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other.
+      "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
+        { # Details of Google audience targeting setting.
+          "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
+        },
+      ],
+    },
+    "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only.
+      "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise.
+        { # Details of combined audience targeting setting.
+          "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id.
+        },
+      ],
+    },
+    "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only.
+      "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored.
+        { # Details of custom list targeting setting.
+          "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id.
+        },
+      ],
+    },
+    "includedFirstPartyAndPartnerAudienceGroups": [ # Optional. The first party and partner audience ids and recencies of included first party and partner audience groups. Each first party and partner audience group contains first party and partner audience ids only. The relation between each first party and partner audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored.
+      { # Details of first party and partner audience group. All first party and partner audience targeting settings are logically ‘OR’ of each other.
+        "settings": [ # Required. All first party and partner audience targeting settings in first party and partner audience group. Repeated settings with the same id are not allowed.
+          { # Details of first party and partner audience targeting setting.
+            "firstPartyAndPartnerAudienceId": "A String", # Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.
+            "recency": "A String", # Required. The recency of the first party and partner audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
+          },
+        ],
+      },
+    ],
+    "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only.
+      "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
+        { # Details of Google audience targeting setting.
+          "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
+        },
+      ],
+    },
+  },
+  "audioContentTypeDetails": { # Details for audio content type assigned targeting option. This will be populated in the audio_content_type_details field when targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`. Explicitly targeting all options is not supported. Remove all audio content type targeting options to achieve this effect. # Audio content type details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`.
+    "audioContentType": "A String", # Required. The audio content type.
+  },
+  "authorizedSellerStatusDetails": { # Represents an assigned authorized seller status. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. If a resource does not have an `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` assigned targeting option, it is using the "Authorized Direct Sellers and Resellers" option. # Authorized seller status details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. You can only target one authorized seller status option per resource. If a resource doesn't have an authorized seller status option, all authorized sellers indicated as DIRECT or RESELLER in the ads.txt file are targeted by default.
+    "authorizedSellerStatus": "A String", # Output only. The authorized seller status to target.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.
+  },
+  "browserDetails": { # Details for assigned browser targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BROWSER`. # Browser details. This field will be populated when the targeting_type is `TARGETING_TYPE_BROWSER`.
+    "displayName": "A String", # Output only. The display name of the browser.
+    "negative": True or False, # Indicates if this option is being negatively targeted. All assigned browser targeting options on the same resource must have the same value for this field.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BROWSER`.
+  },
+  "businessChainDetails": { # Details for assigned Business chain targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`. # Business chain details. This field will be populated when the targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`.
+    "displayName": "A String", # Output only. The display name of a business chain, e.g. "KFC", "Chase Bank".
+    "proximityRadiusAmount": 3.14, # Required. The radius of the area around the business chain that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`. The minimum increment for both cases is 0.1. Inputs will be rounded to the nearest acceptable value if it is too granular, e.g. 15.57 will become 15.6.
+    "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BUSINESS_CHAIN`. Accepted business chain targeting option IDs can be retrieved using SearchTargetingOptions.
+  },
+  "carrierAndIspDetails": { # Details for assigned carrier and ISP targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`. # Carrier and ISP details. This field will be populated when the targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`.
+    "displayName": "A String", # Output only. The display name of the carrier or ISP.
+    "negative": True or False, # Indicates if this option is being negatively targeted. All assigned carrier and ISP targeting options on the same resource must have the same value for this field.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`.
+  },
+  "categoryDetails": { # Assigned category targeting option details. This will be populated in the category_details field when targeting_type is `TARGETING_TYPE_CATEGORY`. # Category details. This field will be populated when the targeting_type is `TARGETING_TYPE_CATEGORY`. Targeting a category will also target its subcategories. If a category is excluded from targeting and a subcategory is included, the exclusion will take precedence.
+    "displayName": "A String", # Output only. The display name of the category.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CATEGORY`.
+  },
+  "channelDetails": { # Details for assigned channel targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CHANNEL`. # Channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_CHANNEL`.
+    "channelId": "A String", # Required. ID of the channel. Should refer to the channel ID field on a [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id) resource.
+    "negative": True or False, # Indicates if this option is being negatively targeted. For advertiser level assigned targeting option, this field must be true.
+  },
+  "contentDurationDetails": { # Details for content duration assigned targeting option. This will be populated in the content_duration_details field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`. Explicitly targeting all options is not supported. Remove all content duration targeting options to achieve this effect. # Content duration details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
+    "contentDuration": "A String", # Output only. The content duration.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
+  },
+  "contentGenreDetails": { # Details for content genre assigned targeting option. This will be populated in the content_genre_details field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`. Explicitly targeting all options is not supported. Remove all content genre targeting options to achieve this effect. # Content genre details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
+    "displayName": "A String", # Output only. The display name of the content genre.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
+  },
+  "contentInstreamPositionDetails": { # Assigned content instream position targeting option details. This will be populated in the content_instream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. # Content instream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.
+    "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`. * `AD_TYPE_AUDIO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_AUDIO_DEFAULT`.
+    "contentInstreamPosition": "A String", # Required. The content instream position for video or audio ads.
+  },
+  "contentOutstreamPositionDetails": { # Assigned content outstream position targeting option details. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. # Content outstream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.
+    "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+    "contentOutstreamPosition": "A String", # Required. The content outstream position.
+  },
+  "contentStreamTypeDetails": { # Details for content stream type assigned targeting option. This will be populated in the content_stream_type_details field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`. Explicitly targeting all options is not supported. Remove all content stream type targeting options to achieve this effect. # Content duration details. This field will be populated when the TargetingType is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
+    "contentStreamType": "A String", # Output only. The content stream type.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
+  },
+  "dayAndTimeDetails": { # Representation of a segment of time defined on a specific day of the week and with a start and end time. The time represented by `start_hour` must be before the time represented by `end_hour`. # Day and time details. This field will be populated when the targeting_type is `TARGETING_TYPE_DAY_AND_TIME`.
+    "dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting.
+    "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day).
+    "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day).
+    "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting.
+  },
+  "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
+    "displayName": "A String", # Output only. The display name of the device make and model.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
+  },
+  "deviceTypeDetails": { # Targeting details for device type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`. # Device Type details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_TYPE`.
+    "deviceType": "A String", # Required. The display name of the device type.
+    "youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items.
+  },
+  "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded.
+    "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED.
+  },
+  "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`.
+    "environment": "A String", # Required. The serving environment.
+  },
+  "exchangeDetails": { # Details for assigned exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`. # Exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_EXCHANGE`.
+    "exchange": "A String", # Required. The enum value for the exchange.
+  },
+  "genderDetails": { # Details for assigned gender targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GENDER`. # Gender details. This field will be populated when the targeting_type is `TARGETING_TYPE_GENDER`.
+    "gender": "A String", # Required. The gender of the audience.
+  },
+  "geoRegionDetails": { # Details for assigned geographic region targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GEO_REGION`. # Geographic region details. This field will be populated when the targeting_type is `TARGETING_TYPE_GEO_REGION`.
+    "displayName": "A String", # Output only. The display name of the geographic region (e.g., "Ontario, Canada").
+    "geoRegionType": "A String", # Output only. The type of geographic region targeting.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GEO_REGION`.
+  },
+  "householdIncomeDetails": { # Details for assigned household income targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`. # Household income details. This field will be populated when the targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`.
+    "householdIncome": "A String", # Required. The household income of the audience.
+  },
+  "inheritance": "A String", # Output only. The inheritance status of the assigned targeting option.
+  "inventorySourceDetails": { # Targeting details for inventory source. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`. # Inventory source details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`.
+    "inventorySourceId": "A String", # Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource.
+  },
+  "inventorySourceGroupDetails": { # Targeting details for inventory source group. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`. # Inventory source group details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`.
+    "inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource.
+  },
+  "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned.
+    "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+  },
+  "languageDetails": { # Details for assigned language targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_LANGUAGE`. # Language details. This field will be populated when the targeting_type is `TARGETING_TYPE_LANGUAGE`.
+    "displayName": "A String", # Output only. The display name of the language (e.g., "French").
+    "negative": True or False, # Indicates if this option is being negatively targeted. All assigned language targeting options on the same resource must have the same value for this field.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_LANGUAGE`.
+  },
+  "name": "A String", # Output only. The resource name for this assigned targeting option.
+  "nativeContentPositionDetails": { # Details for native content position assigned targeting option. This will be populated in the native_content_position_details field when targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`. Explicitly targeting all options is not supported. Remove all native content position targeting options to achieve this effect. # Native content position details. This field will be populated when the targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`.
+    "contentPosition": "A String", # Required. The content position.
+  },
+  "negativeKeywordListDetails": { # Targeting details for negative keyword list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. A maximum of 4 negative keyword lists can be assigned to a resource.
+    "negativeKeywordListId": "A String", # Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource.
+  },
+  "omidDetails": { # Represents a targetable Open Measurement enabled inventory type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_OMID`. # Open Measurement enabled inventory details. This field will be populated when the targeting_type is `TARGETING_TYPE_OMID`.
+    "omid": "A String", # Required. The type of Open Measurement enabled inventory.
+  },
+  "onScreenPositionDetails": { # On screen position targeting option details. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. # On screen position details. This field will be populated when the targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
+    "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+    "onScreenPosition": "A String", # Output only. The on screen position.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
+  },
+  "operatingSystemDetails": { # Assigned operating system targeting option details. This will be populated in the operating_system_details field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. # Operating system details. This field will be populated when the targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
+    "displayName": "A String", # Output only. The display name of the operating system.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting option ID populated in targeting_option_id field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
+  },
+  "parentalStatusDetails": { # Details for assigned parental status targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`. # Parental status details. This field will be populated when the targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`.
+    "parentalStatus": "A String", # Required. The parental status of the audience.
+  },
+  "poiDetails": { # Details for assigned POI targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_POI`. # POI details. This field will be populated when the targeting_type is `TARGETING_TYPE_POI`.
+    "displayName": "A String", # Output only. The display name of a POI, e.g. "Times Square", "Space Needle", followed by its full address if available.
+    "latitude": 3.14, # Output only. Latitude of the POI rounding to 6th decimal place.
+    "longitude": 3.14, # Output only. Longitude of the POI rounding to 6th decimal place.
+    "proximityRadiusAmount": 3.14, # Required. The radius of the area around the POI that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`.
+    "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_POI`. Accepted POI targeting option IDs can be retrieved using `targetingTypes.targetingOptions.search`. If targeting a specific latitude/longitude coordinate removed from an address or POI name, you can generate the necessary targeting option ID by rounding the desired coordinate values to the 6th decimal place, removing the decimals, and concatenating the string values separated by a semicolon. For example, you can target the latitude/longitude pair of 40.7414691, -74.003387 using the targeting option ID "40741469;-74003387". **Upon** **creation, this field value will be updated to append a semicolon and** **alphanumerical hash value if only latitude/longitude coordinates are** **provided.**
+  },
+  "proximityLocationListDetails": { # Targeting details for proximity location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`. # Proximity location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`.
+    "proximityLocationListId": "A String", # Required. ID of the proximity location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_PROXIMITY`.
+    "proximityRadius": 3.14, # Required. Radius expressed in the distance units set in proximity_radius_unit. This represents the size of the area around a chosen location that will be targeted. Radius should be between 1 and 500 miles or 800 kilometers.
+    "proximityRadiusUnit": "A String", # Required. Radius distance units.
+  },
+  "regionalLocationListDetails": { # Targeting details for regional location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`. # Regional location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`.
+  },
+  "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them.
+    "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED.
+  },
+  "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`.
+    "sessionPosition": "A String", # The position where the ad will show in a session.
+  },
+  "subExchangeDetails": { # Details for assigned sub-exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`. # Sub-exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`.
+  },
+  "targetingType": "A String", # Output only. Identifies the type of this assigned targeting option.
+  "thirdPartyVerifierDetails": { # Assigned third party verifier targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`. # Third party verification details. This field will be populated when the targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`.
+    "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox.
+      "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads.
+      "excludedAdlooxCategories": [ # Adloox categories to exclude.
+        "A String",
+      ],
+      "excludedFraudIvtMfaCategories": [ # Optional. Adloox's fraud IVT MFA categories to exclude.
+        "A String",
+      ],
+      "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads.
+    },
+    "doubleVerify": { # Details of DoubleVerify settings. # Third party brand verifier -- DoubleVerify.
+      "appStarRating": { # Details of DoubleVerify star ratings settings. # Avoid bidding on apps with the star ratings.
+        "avoidInsufficientStarRating": True or False, # Avoid bidding on apps with insufficient star ratings.
+        "avoidedStarRating": "A String", # Avoid bidding on apps with the star ratings.
+      },
+      "avoidedAgeRatings": [ # Avoid bidding on apps with the age rating.
+        "A String",
+      ],
+      "brandSafetyCategories": { # Settings for brand safety controls. # DV Brand Safety Controls.
+        "avoidUnknownBrandSafetyCategory": True or False, # Unknown or unrateable.
+        "avoidedHighSeverityCategories": [ # Brand safety high severity avoidance categories.
+          "A String",
+        ],
+        "avoidedMediumSeverityCategories": [ # Brand safety medium severity avoidance categories.
+          "A String",
+        ],
+      },
+      "customSegmentId": "A String", # The custom segment ID provided by DoubleVerify. The ID must start with "51" and consist of eight digits. Custom segment ID cannot be specified along with any of the following fields: * brand_safety_categories * avoided_age_ratings * app_star_rating * fraud_invalid_traffic
+      "displayViewability": { # Details of DoubleVerify display viewability settings. # Display viewability settings (applicable to display line items only).
+        "iab": "A String", # Target web and app inventory to maximize IAB viewable rate.
+        "viewableDuring": "A String", # Target web and app inventory to maximize 100% viewable duration.
+      },
+      "fraudInvalidTraffic": { # DoubleVerify Fraud & Invalid Traffic settings. # Avoid Sites and Apps with historical Fraud & IVT Rates.
+        "avoidInsufficientOption": True or False, # Insufficient Historical Fraud & IVT Stats.
+        "avoidedFraudOption": "A String", # Avoid Sites and Apps with historical Fraud & IVT.
+      },
+      "videoViewability": { # Details of DoubleVerify video viewability settings. # Video viewability settings (applicable to video line items only).
+        "playerImpressionRate": "A String", # Target inventory to maximize impressions with 400x300 or greater player size.
+        "videoIab": "A String", # Target web inventory to maximize IAB viewable rate.
+        "videoViewableRate": "A String", # Target web inventory to maximize fully viewable rate.
+      },
+    },
+    "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science.
+      "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive.
+        "A String",
+      ],
+      "displayViewability": "A String", # Display Viewability section (applicable to display line items only).
+      "excludeUnrateable": True or False, # Brand Safety - **Unrateable**.
+      "excludedAdFraudRisk": "A String", # Ad Fraud settings.
+      "excludedAdultRisk": "A String", # Brand Safety - **Adult content**.
+      "excludedAlcoholRisk": "A String", # Brand Safety - **Alcohol**.
+      "excludedDrugsRisk": "A String", # Brand Safety - **Drugs**.
+      "excludedGamblingRisk": "A String", # Brand Safety - **Gambling**.
+      "excludedHateSpeechRisk": "A String", # Brand Safety - **Hate speech**.
+      "excludedIllegalDownloadsRisk": "A String", # Brand Safety - **Illegal downloads**.
+      "excludedOffensiveLanguageRisk": "A String", # Brand Safety - **Offensive language**.
+      "excludedViolenceRisk": "A String", # Brand Safety - **Violence**.
+      "qualitySyncCustomSegmentId": [ # Optional. The quality sync custom segment ID provided by Integral Ad Science. The ID must be between `3000000` and `4999999`, inclusive.
+        "A String",
+      ],
+      "traqScoreOption": "A String", # True advertising quality (applicable to Display line items only).
+      "videoViewability": "A String", # Video Viewability Section (applicable to video line items only).
+    },
+  },
+  "urlDetails": { # Details for assigned URL targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_URL`. # URL details. This field will be populated when the targeting_type is `TARGETING_TYPE_URL`.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "url": "A String", # Required. The URL, for example `example.com`. DV360 supports two levels of subdirectory targeting, for example `www.example.com/one-subdirectory-level/second-level`, and five levels of subdomain targeting, for example `five.four.three.two.one.example.com`.
+  },
+  "userRewardedContentDetails": { # User rewarded content targeting option details. This will be populated in the user_rewarded_content_details field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. # User rewarded content details. This field will be populated when the targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
+    "userRewardedContent": "A String", # Output only. User rewarded content status for video ads.
+  },
+  "videoPlayerSizeDetails": { # Video player size targeting option details. This will be populated in the video_player_size_details field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. Explicitly targeting all options is not supported. Remove all video player size targeting options to achieve this effect. # Video player size details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.
+    "videoPlayerSize": "A String", # Required. The video player size.
+  },
+  "viewabilityDetails": { # Assigned viewability targeting option details. This will be populated in the viewability_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`. # Viewability details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIEWABILITY`. You can only target one viewability option per resource.
+    "viewability": "A String", # Required. The predicted viewability percentage.
+  },
+  "youtubeChannelDetails": { # Details for YouTube channel assigned targeting option. This will be populated in the youtube_channel_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`. # YouTube channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`.
+    "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+  },
+  "youtubeVideoDetails": { # Details for YouTube video assigned targeting option. This will be populated in the youtube_video_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`. # YouTube video details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "videoId": "A String", # YouTube video id as it appears on the YouTube watch page.
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings.
+  "ageRangeDetails": { # Represents a targetable age range. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AGE_RANGE`. # Age range details. This field will be populated when the targeting_type is `TARGETING_TYPE_AGE_RANGE`.
+    "ageRange": "A String", # Required. The age range of an audience. We only support targeting a continuous age range of an audience. Thus, the age range represented in this field can be 1) targeted solely, or, 2) part of a larger continuous age range. The reach of a continuous age range targeting can be expanded by also targeting an audience of an unknown age.
+  },
+  "appCategoryDetails": { # Details for assigned app category targeting option. This will be populated in the app_category_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. # App category details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
+    "displayName": "A String", # Output only. The display name of the app category.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
+  },
+  "appDetails": { # Details for assigned app targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP`. # App details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP`.
+    "appId": "A String", # Required. The ID of the app. Android's Play store app uses bundle ID, for example `com.google.android.gm`. Apple's App store app ID uses 9 digit string, for example `422689480`.
+    "appPlatform": "A String", # Indicates the platform of the targeted app. If this field is not specified, the app platform will be assumed to be mobile (i.e., Android or iOS), and we will derive the appropriate mobile platform from the app ID.
+    "displayName": "A String", # Output only. The display name of the app.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+  },
+  "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts.
+  "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`
+  "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource.
+    "excludedFirstPartyAndPartnerAudienceGroup": { # Details of first party and partner audience group. All first party and partner audience targeting settings are logically ‘OR’ of each other. # Optional. The first party and partner audience ids and recencies of the excluded first party and partner audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other.
+      "settings": [ # Required. All first party and partner audience targeting settings in first party and partner audience group. Repeated settings with the same id are not allowed.
+        { # Details of first party and partner audience targeting setting.
+          "firstPartyAndPartnerAudienceId": "A String", # Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.
+          "recency": "A String", # Required. The recency of the first party and partner audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
+        },
+      ],
+    },
+    "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other.
+      "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
+        { # Details of Google audience targeting setting.
+          "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
+        },
+      ],
+    },
+    "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only.
+      "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise.
+        { # Details of combined audience targeting setting.
+          "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id.
+        },
+      ],
+    },
+    "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only.
+      "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored.
+        { # Details of custom list targeting setting.
+          "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id.
+        },
+      ],
+    },
+    "includedFirstPartyAndPartnerAudienceGroups": [ # Optional. The first party and partner audience ids and recencies of included first party and partner audience groups. Each first party and partner audience group contains first party and partner audience ids only. The relation between each first party and partner audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored.
+      { # Details of first party and partner audience group. All first party and partner audience targeting settings are logically ‘OR’ of each other.
+        "settings": [ # Required. All first party and partner audience targeting settings in first party and partner audience group. Repeated settings with the same id are not allowed.
+          { # Details of first party and partner audience targeting setting.
+            "firstPartyAndPartnerAudienceId": "A String", # Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.
+            "recency": "A String", # Required. The recency of the first party and partner audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
+          },
+        ],
+      },
+    ],
+    "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only.
+      "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
+        { # Details of Google audience targeting setting.
+          "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
+        },
+      ],
+    },
+  },
+  "audioContentTypeDetails": { # Details for audio content type assigned targeting option. This will be populated in the audio_content_type_details field when targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`. Explicitly targeting all options is not supported. Remove all audio content type targeting options to achieve this effect. # Audio content type details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`.
+    "audioContentType": "A String", # Required. The audio content type.
+  },
+  "authorizedSellerStatusDetails": { # Represents an assigned authorized seller status. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. If a resource does not have an `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` assigned targeting option, it is using the "Authorized Direct Sellers and Resellers" option. # Authorized seller status details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. You can only target one authorized seller status option per resource. If a resource doesn't have an authorized seller status option, all authorized sellers indicated as DIRECT or RESELLER in the ads.txt file are targeted by default.
+    "authorizedSellerStatus": "A String", # Output only. The authorized seller status to target.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.
+  },
+  "browserDetails": { # Details for assigned browser targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BROWSER`. # Browser details. This field will be populated when the targeting_type is `TARGETING_TYPE_BROWSER`.
+    "displayName": "A String", # Output only. The display name of the browser.
+    "negative": True or False, # Indicates if this option is being negatively targeted. All assigned browser targeting options on the same resource must have the same value for this field.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BROWSER`.
+  },
+  "businessChainDetails": { # Details for assigned Business chain targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`. # Business chain details. This field will be populated when the targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`.
+    "displayName": "A String", # Output only. The display name of a business chain, e.g. "KFC", "Chase Bank".
+    "proximityRadiusAmount": 3.14, # Required. The radius of the area around the business chain that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`. The minimum increment for both cases is 0.1. Inputs will be rounded to the nearest acceptable value if it is too granular, e.g. 15.57 will become 15.6.
+    "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BUSINESS_CHAIN`. Accepted business chain targeting option IDs can be retrieved using SearchTargetingOptions.
+  },
+  "carrierAndIspDetails": { # Details for assigned carrier and ISP targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`. # Carrier and ISP details. This field will be populated when the targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`.
+    "displayName": "A String", # Output only. The display name of the carrier or ISP.
+    "negative": True or False, # Indicates if this option is being negatively targeted. All assigned carrier and ISP targeting options on the same resource must have the same value for this field.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`.
+  },
+  "categoryDetails": { # Assigned category targeting option details. This will be populated in the category_details field when targeting_type is `TARGETING_TYPE_CATEGORY`. # Category details. This field will be populated when the targeting_type is `TARGETING_TYPE_CATEGORY`. Targeting a category will also target its subcategories. If a category is excluded from targeting and a subcategory is included, the exclusion will take precedence.
+    "displayName": "A String", # Output only. The display name of the category.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CATEGORY`.
+  },
+  "channelDetails": { # Details for assigned channel targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CHANNEL`. # Channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_CHANNEL`.
+    "channelId": "A String", # Required. ID of the channel. Should refer to the channel ID field on a [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id) resource.
+    "negative": True or False, # Indicates if this option is being negatively targeted. For advertiser level assigned targeting option, this field must be true.
+  },
+  "contentDurationDetails": { # Details for content duration assigned targeting option. This will be populated in the content_duration_details field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`. Explicitly targeting all options is not supported. Remove all content duration targeting options to achieve this effect. # Content duration details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
+    "contentDuration": "A String", # Output only. The content duration.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
+  },
+  "contentGenreDetails": { # Details for content genre assigned targeting option. This will be populated in the content_genre_details field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`. Explicitly targeting all options is not supported. Remove all content genre targeting options to achieve this effect. # Content genre details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
+    "displayName": "A String", # Output only. The display name of the content genre.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
+  },
+  "contentInstreamPositionDetails": { # Assigned content instream position targeting option details. This will be populated in the content_instream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. # Content instream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.
+    "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`. * `AD_TYPE_AUDIO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_AUDIO_DEFAULT`.
+    "contentInstreamPosition": "A String", # Required. The content instream position for video or audio ads.
+  },
+  "contentOutstreamPositionDetails": { # Assigned content outstream position targeting option details. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. # Content outstream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.
+    "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+    "contentOutstreamPosition": "A String", # Required. The content outstream position.
+  },
+  "contentStreamTypeDetails": { # Details for content stream type assigned targeting option. This will be populated in the content_stream_type_details field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`. Explicitly targeting all options is not supported. Remove all content stream type targeting options to achieve this effect. # Content duration details. This field will be populated when the TargetingType is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
+    "contentStreamType": "A String", # Output only. The content stream type.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
+  },
+  "dayAndTimeDetails": { # Representation of a segment of time defined on a specific day of the week and with a start and end time. The time represented by `start_hour` must be before the time represented by `end_hour`. # Day and time details. This field will be populated when the targeting_type is `TARGETING_TYPE_DAY_AND_TIME`.
+    "dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting.
+    "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day).
+    "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day).
+    "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting.
+  },
+  "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
+    "displayName": "A String", # Output only. The display name of the device make and model.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
+  },
+  "deviceTypeDetails": { # Targeting details for device type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`. # Device Type details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_TYPE`.
+    "deviceType": "A String", # Required. The display name of the device type.
+    "youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items.
+  },
+  "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded.
+    "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED.
+  },
+  "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`.
+    "environment": "A String", # Required. The serving environment.
+  },
+  "exchangeDetails": { # Details for assigned exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`. # Exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_EXCHANGE`.
+    "exchange": "A String", # Required. The enum value for the exchange.
+  },
+  "genderDetails": { # Details for assigned gender targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GENDER`. # Gender details. This field will be populated when the targeting_type is `TARGETING_TYPE_GENDER`.
+    "gender": "A String", # Required. The gender of the audience.
+  },
+  "geoRegionDetails": { # Details for assigned geographic region targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GEO_REGION`. # Geographic region details. This field will be populated when the targeting_type is `TARGETING_TYPE_GEO_REGION`.
+    "displayName": "A String", # Output only. The display name of the geographic region (e.g., "Ontario, Canada").
+    "geoRegionType": "A String", # Output only. The type of geographic region targeting.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GEO_REGION`.
+  },
+  "householdIncomeDetails": { # Details for assigned household income targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`. # Household income details. This field will be populated when the targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`.
+    "householdIncome": "A String", # Required. The household income of the audience.
+  },
+  "inheritance": "A String", # Output only. The inheritance status of the assigned targeting option.
+  "inventorySourceDetails": { # Targeting details for inventory source. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`. # Inventory source details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`.
+    "inventorySourceId": "A String", # Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource.
+  },
+  "inventorySourceGroupDetails": { # Targeting details for inventory source group. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`. # Inventory source group details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`.
+    "inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource.
+  },
+  "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned.
+    "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+  },
+  "languageDetails": { # Details for assigned language targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_LANGUAGE`. # Language details. This field will be populated when the targeting_type is `TARGETING_TYPE_LANGUAGE`.
+    "displayName": "A String", # Output only. The display name of the language (e.g., "French").
+    "negative": True or False, # Indicates if this option is being negatively targeted. All assigned language targeting options on the same resource must have the same value for this field.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_LANGUAGE`.
+  },
+  "name": "A String", # Output only. The resource name for this assigned targeting option.
+  "nativeContentPositionDetails": { # Details for native content position assigned targeting option. This will be populated in the native_content_position_details field when targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`. Explicitly targeting all options is not supported. Remove all native content position targeting options to achieve this effect. # Native content position details. This field will be populated when the targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`.
+    "contentPosition": "A String", # Required. The content position.
+  },
+  "negativeKeywordListDetails": { # Targeting details for negative keyword list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. A maximum of 4 negative keyword lists can be assigned to a resource.
+    "negativeKeywordListId": "A String", # Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource.
+  },
+  "omidDetails": { # Represents a targetable Open Measurement enabled inventory type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_OMID`. # Open Measurement enabled inventory details. This field will be populated when the targeting_type is `TARGETING_TYPE_OMID`.
+    "omid": "A String", # Required. The type of Open Measurement enabled inventory.
+  },
+  "onScreenPositionDetails": { # On screen position targeting option details. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. # On screen position details. This field will be populated when the targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
+    "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+    "onScreenPosition": "A String", # Output only. The on screen position.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
+  },
+  "operatingSystemDetails": { # Assigned operating system targeting option details. This will be populated in the operating_system_details field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. # Operating system details. This field will be populated when the targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
+    "displayName": "A String", # Output only. The display name of the operating system.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting option ID populated in targeting_option_id field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
+  },
+  "parentalStatusDetails": { # Details for assigned parental status targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`. # Parental status details. This field will be populated when the targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`.
+    "parentalStatus": "A String", # Required. The parental status of the audience.
+  },
+  "poiDetails": { # Details for assigned POI targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_POI`. # POI details. This field will be populated when the targeting_type is `TARGETING_TYPE_POI`.
+    "displayName": "A String", # Output only. The display name of a POI, e.g. "Times Square", "Space Needle", followed by its full address if available.
+    "latitude": 3.14, # Output only. Latitude of the POI rounding to 6th decimal place.
+    "longitude": 3.14, # Output only. Longitude of the POI rounding to 6th decimal place.
+    "proximityRadiusAmount": 3.14, # Required. The radius of the area around the POI that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`.
+    "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_POI`. Accepted POI targeting option IDs can be retrieved using `targetingTypes.targetingOptions.search`. If targeting a specific latitude/longitude coordinate removed from an address or POI name, you can generate the necessary targeting option ID by rounding the desired coordinate values to the 6th decimal place, removing the decimals, and concatenating the string values separated by a semicolon. For example, you can target the latitude/longitude pair of 40.7414691, -74.003387 using the targeting option ID "40741469;-74003387". **Upon** **creation, this field value will be updated to append a semicolon and** **alphanumerical hash value if only latitude/longitude coordinates are** **provided.**
+  },
+  "proximityLocationListDetails": { # Targeting details for proximity location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`. # Proximity location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`.
+    "proximityLocationListId": "A String", # Required. ID of the proximity location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_PROXIMITY`.
+    "proximityRadius": 3.14, # Required. Radius expressed in the distance units set in proximity_radius_unit. This represents the size of the area around a chosen location that will be targeted. Radius should be between 1 and 500 miles or 800 kilometers.
+    "proximityRadiusUnit": "A String", # Required. Radius distance units.
+  },
+  "regionalLocationListDetails": { # Targeting details for regional location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`. # Regional location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`.
+  },
+  "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them.
+    "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED.
+  },
+  "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`.
+    "sessionPosition": "A String", # The position where the ad will show in a session.
+  },
+  "subExchangeDetails": { # Details for assigned sub-exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`. # Sub-exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`.
+  },
+  "targetingType": "A String", # Output only. Identifies the type of this assigned targeting option.
+  "thirdPartyVerifierDetails": { # Assigned third party verifier targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`. # Third party verification details. This field will be populated when the targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`.
+    "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox.
+      "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads.
+      "excludedAdlooxCategories": [ # Adloox categories to exclude.
+        "A String",
+      ],
+      "excludedFraudIvtMfaCategories": [ # Optional. Adloox's fraud IVT MFA categories to exclude.
+        "A String",
+      ],
+      "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads.
+    },
+    "doubleVerify": { # Details of DoubleVerify settings. # Third party brand verifier -- DoubleVerify.
+      "appStarRating": { # Details of DoubleVerify star ratings settings. # Avoid bidding on apps with the star ratings.
+        "avoidInsufficientStarRating": True or False, # Avoid bidding on apps with insufficient star ratings.
+        "avoidedStarRating": "A String", # Avoid bidding on apps with the star ratings.
+      },
+      "avoidedAgeRatings": [ # Avoid bidding on apps with the age rating.
+        "A String",
+      ],
+      "brandSafetyCategories": { # Settings for brand safety controls. # DV Brand Safety Controls.
+        "avoidUnknownBrandSafetyCategory": True or False, # Unknown or unrateable.
+        "avoidedHighSeverityCategories": [ # Brand safety high severity avoidance categories.
+          "A String",
+        ],
+        "avoidedMediumSeverityCategories": [ # Brand safety medium severity avoidance categories.
+          "A String",
+        ],
+      },
+      "customSegmentId": "A String", # The custom segment ID provided by DoubleVerify. The ID must start with "51" and consist of eight digits. Custom segment ID cannot be specified along with any of the following fields: * brand_safety_categories * avoided_age_ratings * app_star_rating * fraud_invalid_traffic
+      "displayViewability": { # Details of DoubleVerify display viewability settings. # Display viewability settings (applicable to display line items only).
+        "iab": "A String", # Target web and app inventory to maximize IAB viewable rate.
+        "viewableDuring": "A String", # Target web and app inventory to maximize 100% viewable duration.
+      },
+      "fraudInvalidTraffic": { # DoubleVerify Fraud & Invalid Traffic settings. # Avoid Sites and Apps with historical Fraud & IVT Rates.
+        "avoidInsufficientOption": True or False, # Insufficient Historical Fraud & IVT Stats.
+        "avoidedFraudOption": "A String", # Avoid Sites and Apps with historical Fraud & IVT.
+      },
+      "videoViewability": { # Details of DoubleVerify video viewability settings. # Video viewability settings (applicable to video line items only).
+        "playerImpressionRate": "A String", # Target inventory to maximize impressions with 400x300 or greater player size.
+        "videoIab": "A String", # Target web inventory to maximize IAB viewable rate.
+        "videoViewableRate": "A String", # Target web inventory to maximize fully viewable rate.
+      },
+    },
+    "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science.
+      "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive.
+        "A String",
+      ],
+      "displayViewability": "A String", # Display Viewability section (applicable to display line items only).
+      "excludeUnrateable": True or False, # Brand Safety - **Unrateable**.
+      "excludedAdFraudRisk": "A String", # Ad Fraud settings.
+      "excludedAdultRisk": "A String", # Brand Safety - **Adult content**.
+      "excludedAlcoholRisk": "A String", # Brand Safety - **Alcohol**.
+      "excludedDrugsRisk": "A String", # Brand Safety - **Drugs**.
+      "excludedGamblingRisk": "A String", # Brand Safety - **Gambling**.
+      "excludedHateSpeechRisk": "A String", # Brand Safety - **Hate speech**.
+      "excludedIllegalDownloadsRisk": "A String", # Brand Safety - **Illegal downloads**.
+      "excludedOffensiveLanguageRisk": "A String", # Brand Safety - **Offensive language**.
+      "excludedViolenceRisk": "A String", # Brand Safety - **Violence**.
+      "qualitySyncCustomSegmentId": [ # Optional. The quality sync custom segment ID provided by Integral Ad Science. The ID must be between `3000000` and `4999999`, inclusive.
+        "A String",
+      ],
+      "traqScoreOption": "A String", # True advertising quality (applicable to Display line items only).
+      "videoViewability": "A String", # Video Viewability Section (applicable to video line items only).
+    },
+  },
+  "urlDetails": { # Details for assigned URL targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_URL`. # URL details. This field will be populated when the targeting_type is `TARGETING_TYPE_URL`.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "url": "A String", # Required. The URL, for example `example.com`. DV360 supports two levels of subdirectory targeting, for example `www.example.com/one-subdirectory-level/second-level`, and five levels of subdomain targeting, for example `five.four.three.two.one.example.com`.
+  },
+  "userRewardedContentDetails": { # User rewarded content targeting option details. This will be populated in the user_rewarded_content_details field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. # User rewarded content details. This field will be populated when the targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
+    "userRewardedContent": "A String", # Output only. User rewarded content status for video ads.
+  },
+  "videoPlayerSizeDetails": { # Video player size targeting option details. This will be populated in the video_player_size_details field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. Explicitly targeting all options is not supported. Remove all video player size targeting options to achieve this effect. # Video player size details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.
+    "videoPlayerSize": "A String", # Required. The video player size.
+  },
+  "viewabilityDetails": { # Assigned viewability targeting option details. This will be populated in the viewability_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`. # Viewability details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIEWABILITY`. You can only target one viewability option per resource.
+    "viewability": "A String", # Required. The predicted viewability percentage.
+  },
+  "youtubeChannelDetails": { # Details for YouTube channel assigned targeting option. This will be populated in the youtube_channel_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`. # YouTube channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`.
+    "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+  },
+  "youtubeVideoDetails": { # Details for YouTube video assigned targeting option. This will be populated in the youtube_video_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`. # YouTube video details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "videoId": "A String", # YouTube video id as it appears on the YouTube watch page.
+  },
+}
+
+ +
+ delete(advertiserId, targetingType, assignedTargetingOptionId, x__xgafv=None) +
Deletes an assigned targeting option from an advertiser.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser. (required)
+  targetingType: string, Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD` (required)
+    Allowed values
+      TARGETING_TYPE_UNSPECIFIED - Default value when type is not specified or is unknown in this version.
+      TARGETING_TYPE_CHANNEL - Target a channel (a custom group of related websites or apps).
+      TARGETING_TYPE_APP_CATEGORY - Target an app category (for example, education or puzzle games).
+      TARGETING_TYPE_APP - Target a specific app (for example, Angry Birds).
+      TARGETING_TYPE_URL - Target a specific url (for example, quora.com).
+      TARGETING_TYPE_DAY_AND_TIME - Target ads during a chosen time period on a specific day.
+      TARGETING_TYPE_AGE_RANGE - Target ads to a specific age range (for example, 18-24).
+      TARGETING_TYPE_REGIONAL_LOCATION_LIST - Target ads to the specified regions on a regional location list.
+      TARGETING_TYPE_PROXIMITY_LOCATION_LIST - Target ads to the specified points of interest on a proximity location list.
+      TARGETING_TYPE_GENDER - Target ads to a specific gender (for example, female or male).
+      TARGETING_TYPE_VIDEO_PLAYER_SIZE - Target a specific video player size for video ads.
+      TARGETING_TYPE_USER_REWARDED_CONTENT - Target user rewarded content for video ads.
+      TARGETING_TYPE_PARENTAL_STATUS - Target ads to a specific parental status (for example, parent or not a parent).
+      TARGETING_TYPE_CONTENT_INSTREAM_POSITION - Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).
+      TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION - Target ads in a specific content outstream position.
+      TARGETING_TYPE_DEVICE_TYPE - Target ads to a specific device type (for example, tablet or connected TV).
+      TARGETING_TYPE_AUDIENCE_GROUP - Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.
+      TARGETING_TYPE_BROWSER - Target ads to specific web browsers (for example, Chrome).
+      TARGETING_TYPE_HOUSEHOLD_INCOME - Target ads to a specific household income range (for example, top 10%).
+      TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position.
+      TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify).
+      TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).
+      TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult).
+      TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app).
+      TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).
+      TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS).
+      TARGETING_TYPE_DEVICE_MAKE_MODEL - Target ads to a specific device make or model (for example, Roku or Samsung).
+      TARGETING_TYPE_KEYWORD - Target ads to a specific keyword (for example, dog or retriever).
+      TARGETING_TYPE_NEGATIVE_KEYWORD_LIST - Target ads to a specific negative keyword list.
+      TARGETING_TYPE_VIEWABILITY - Target ads to a specific viewability (for example, 80% viewable).
+      TARGETING_TYPE_CATEGORY - Target ads to a specific content category (for example, arts & entertainment).
+      TARGETING_TYPE_INVENTORY_SOURCE - Purchase impressions from specific deals and auction packages.
+      TARGETING_TYPE_LANGUAGE - Target ads to a specific language (for example, English or Japanese).
+      TARGETING_TYPE_AUTHORIZED_SELLER_STATUS - Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.
+      TARGETING_TYPE_GEO_REGION - Target ads to a specific regional location (for example, a city or state).
+      TARGETING_TYPE_INVENTORY_SOURCE_GROUP - Purchase impressions from a group of deals and auction packages.
+      TARGETING_TYPE_EXCHANGE - Purchase impressions from specific exchanges.
+      TARGETING_TYPE_SUB_EXCHANGE - Purchase impressions from specific sub-exchanges.
+      TARGETING_TYPE_POI - Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.
+      TARGETING_TYPE_BUSINESS_CHAIN - Target ads around locations of a business chain within a specific geo region.
+      TARGETING_TYPE_CONTENT_DURATION - Target ads to a specific video content duration.
+      TARGETING_TYPE_CONTENT_STREAM_TYPE - Target ads to a specific video content stream type.
+      TARGETING_TYPE_NATIVE_CONTENT_POSITION - Target ads to a specific native content position.
+      TARGETING_TYPE_OMID - Target ads in an Open Measurement enabled inventory.
+      TARGETING_TYPE_AUDIO_CONTENT_TYPE - Target ads to a specific audio content type.
+      TARGETING_TYPE_CONTENT_GENRE - Target ads to a specific content genre.
+      TARGETING_TYPE_YOUTUBE_VIDEO - Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
+      TARGETING_TYPE_YOUTUBE_CHANNEL - Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
+      TARGETING_TYPE_SESSION_POSITION - Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.
+  assignedTargetingOptionId: string, Required. The ID of the assigned targeting option 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(advertiserId, targetingType, assignedTargetingOptionId, x__xgafv=None) +
Gets a single targeting option assigned to an advertiser.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser. (required)
+  targetingType: string, Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_YOUTUBE_VIDEO` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_KEYWORD` (required)
+    Allowed values
+      TARGETING_TYPE_UNSPECIFIED - Default value when type is not specified or is unknown in this version.
+      TARGETING_TYPE_CHANNEL - Target a channel (a custom group of related websites or apps).
+      TARGETING_TYPE_APP_CATEGORY - Target an app category (for example, education or puzzle games).
+      TARGETING_TYPE_APP - Target a specific app (for example, Angry Birds).
+      TARGETING_TYPE_URL - Target a specific url (for example, quora.com).
+      TARGETING_TYPE_DAY_AND_TIME - Target ads during a chosen time period on a specific day.
+      TARGETING_TYPE_AGE_RANGE - Target ads to a specific age range (for example, 18-24).
+      TARGETING_TYPE_REGIONAL_LOCATION_LIST - Target ads to the specified regions on a regional location list.
+      TARGETING_TYPE_PROXIMITY_LOCATION_LIST - Target ads to the specified points of interest on a proximity location list.
+      TARGETING_TYPE_GENDER - Target ads to a specific gender (for example, female or male).
+      TARGETING_TYPE_VIDEO_PLAYER_SIZE - Target a specific video player size for video ads.
+      TARGETING_TYPE_USER_REWARDED_CONTENT - Target user rewarded content for video ads.
+      TARGETING_TYPE_PARENTAL_STATUS - Target ads to a specific parental status (for example, parent or not a parent).
+      TARGETING_TYPE_CONTENT_INSTREAM_POSITION - Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).
+      TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION - Target ads in a specific content outstream position.
+      TARGETING_TYPE_DEVICE_TYPE - Target ads to a specific device type (for example, tablet or connected TV).
+      TARGETING_TYPE_AUDIENCE_GROUP - Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.
+      TARGETING_TYPE_BROWSER - Target ads to specific web browsers (for example, Chrome).
+      TARGETING_TYPE_HOUSEHOLD_INCOME - Target ads to a specific household income range (for example, top 10%).
+      TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position.
+      TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify).
+      TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).
+      TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult).
+      TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app).
+      TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).
+      TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS).
+      TARGETING_TYPE_DEVICE_MAKE_MODEL - Target ads to a specific device make or model (for example, Roku or Samsung).
+      TARGETING_TYPE_KEYWORD - Target ads to a specific keyword (for example, dog or retriever).
+      TARGETING_TYPE_NEGATIVE_KEYWORD_LIST - Target ads to a specific negative keyword list.
+      TARGETING_TYPE_VIEWABILITY - Target ads to a specific viewability (for example, 80% viewable).
+      TARGETING_TYPE_CATEGORY - Target ads to a specific content category (for example, arts & entertainment).
+      TARGETING_TYPE_INVENTORY_SOURCE - Purchase impressions from specific deals and auction packages.
+      TARGETING_TYPE_LANGUAGE - Target ads to a specific language (for example, English or Japanese).
+      TARGETING_TYPE_AUTHORIZED_SELLER_STATUS - Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.
+      TARGETING_TYPE_GEO_REGION - Target ads to a specific regional location (for example, a city or state).
+      TARGETING_TYPE_INVENTORY_SOURCE_GROUP - Purchase impressions from a group of deals and auction packages.
+      TARGETING_TYPE_EXCHANGE - Purchase impressions from specific exchanges.
+      TARGETING_TYPE_SUB_EXCHANGE - Purchase impressions from specific sub-exchanges.
+      TARGETING_TYPE_POI - Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.
+      TARGETING_TYPE_BUSINESS_CHAIN - Target ads around locations of a business chain within a specific geo region.
+      TARGETING_TYPE_CONTENT_DURATION - Target ads to a specific video content duration.
+      TARGETING_TYPE_CONTENT_STREAM_TYPE - Target ads to a specific video content stream type.
+      TARGETING_TYPE_NATIVE_CONTENT_POSITION - Target ads to a specific native content position.
+      TARGETING_TYPE_OMID - Target ads in an Open Measurement enabled inventory.
+      TARGETING_TYPE_AUDIO_CONTENT_TYPE - Target ads to a specific audio content type.
+      TARGETING_TYPE_CONTENT_GENRE - Target ads to a specific content genre.
+      TARGETING_TYPE_YOUTUBE_VIDEO - Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
+      TARGETING_TYPE_YOUTUBE_CHANNEL - Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
+      TARGETING_TYPE_SESSION_POSITION - Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.
+  assignedTargetingOptionId: string, Required. An identifier unique to the targeting type in this advertiser that identifies the assigned targeting option being requested. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings.
+  "ageRangeDetails": { # Represents a targetable age range. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AGE_RANGE`. # Age range details. This field will be populated when the targeting_type is `TARGETING_TYPE_AGE_RANGE`.
+    "ageRange": "A String", # Required. The age range of an audience. We only support targeting a continuous age range of an audience. Thus, the age range represented in this field can be 1) targeted solely, or, 2) part of a larger continuous age range. The reach of a continuous age range targeting can be expanded by also targeting an audience of an unknown age.
+  },
+  "appCategoryDetails": { # Details for assigned app category targeting option. This will be populated in the app_category_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. # App category details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
+    "displayName": "A String", # Output only. The display name of the app category.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
+  },
+  "appDetails": { # Details for assigned app targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP`. # App details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP`.
+    "appId": "A String", # Required. The ID of the app. Android's Play store app uses bundle ID, for example `com.google.android.gm`. Apple's App store app ID uses 9 digit string, for example `422689480`.
+    "appPlatform": "A String", # Indicates the platform of the targeted app. If this field is not specified, the app platform will be assumed to be mobile (i.e., Android or iOS), and we will derive the appropriate mobile platform from the app ID.
+    "displayName": "A String", # Output only. The display name of the app.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+  },
+  "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts.
+  "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`
+  "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource.
+    "excludedFirstPartyAndPartnerAudienceGroup": { # Details of first party and partner audience group. All first party and partner audience targeting settings are logically ‘OR’ of each other. # Optional. The first party and partner audience ids and recencies of the excluded first party and partner audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other.
+      "settings": [ # Required. All first party and partner audience targeting settings in first party and partner audience group. Repeated settings with the same id are not allowed.
+        { # Details of first party and partner audience targeting setting.
+          "firstPartyAndPartnerAudienceId": "A String", # Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.
+          "recency": "A String", # Required. The recency of the first party and partner audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
+        },
+      ],
+    },
+    "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other.
+      "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
+        { # Details of Google audience targeting setting.
+          "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
+        },
+      ],
+    },
+    "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only.
+      "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise.
+        { # Details of combined audience targeting setting.
+          "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id.
+        },
+      ],
+    },
+    "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only.
+      "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored.
+        { # Details of custom list targeting setting.
+          "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id.
+        },
+      ],
+    },
+    "includedFirstPartyAndPartnerAudienceGroups": [ # Optional. The first party and partner audience ids and recencies of included first party and partner audience groups. Each first party and partner audience group contains first party and partner audience ids only. The relation between each first party and partner audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored.
+      { # Details of first party and partner audience group. All first party and partner audience targeting settings are logically ‘OR’ of each other.
+        "settings": [ # Required. All first party and partner audience targeting settings in first party and partner audience group. Repeated settings with the same id are not allowed.
+          { # Details of first party and partner audience targeting setting.
+            "firstPartyAndPartnerAudienceId": "A String", # Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.
+            "recency": "A String", # Required. The recency of the first party and partner audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
+          },
+        ],
+      },
+    ],
+    "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only.
+      "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
+        { # Details of Google audience targeting setting.
+          "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
+        },
+      ],
+    },
+  },
+  "audioContentTypeDetails": { # Details for audio content type assigned targeting option. This will be populated in the audio_content_type_details field when targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`. Explicitly targeting all options is not supported. Remove all audio content type targeting options to achieve this effect. # Audio content type details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`.
+    "audioContentType": "A String", # Required. The audio content type.
+  },
+  "authorizedSellerStatusDetails": { # Represents an assigned authorized seller status. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. If a resource does not have an `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` assigned targeting option, it is using the "Authorized Direct Sellers and Resellers" option. # Authorized seller status details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. You can only target one authorized seller status option per resource. If a resource doesn't have an authorized seller status option, all authorized sellers indicated as DIRECT or RESELLER in the ads.txt file are targeted by default.
+    "authorizedSellerStatus": "A String", # Output only. The authorized seller status to target.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.
+  },
+  "browserDetails": { # Details for assigned browser targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BROWSER`. # Browser details. This field will be populated when the targeting_type is `TARGETING_TYPE_BROWSER`.
+    "displayName": "A String", # Output only. The display name of the browser.
+    "negative": True or False, # Indicates if this option is being negatively targeted. All assigned browser targeting options on the same resource must have the same value for this field.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BROWSER`.
+  },
+  "businessChainDetails": { # Details for assigned Business chain targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`. # Business chain details. This field will be populated when the targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`.
+    "displayName": "A String", # Output only. The display name of a business chain, e.g. "KFC", "Chase Bank".
+    "proximityRadiusAmount": 3.14, # Required. The radius of the area around the business chain that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`. The minimum increment for both cases is 0.1. Inputs will be rounded to the nearest acceptable value if it is too granular, e.g. 15.57 will become 15.6.
+    "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BUSINESS_CHAIN`. Accepted business chain targeting option IDs can be retrieved using SearchTargetingOptions.
+  },
+  "carrierAndIspDetails": { # Details for assigned carrier and ISP targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`. # Carrier and ISP details. This field will be populated when the targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`.
+    "displayName": "A String", # Output only. The display name of the carrier or ISP.
+    "negative": True or False, # Indicates if this option is being negatively targeted. All assigned carrier and ISP targeting options on the same resource must have the same value for this field.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`.
+  },
+  "categoryDetails": { # Assigned category targeting option details. This will be populated in the category_details field when targeting_type is `TARGETING_TYPE_CATEGORY`. # Category details. This field will be populated when the targeting_type is `TARGETING_TYPE_CATEGORY`. Targeting a category will also target its subcategories. If a category is excluded from targeting and a subcategory is included, the exclusion will take precedence.
+    "displayName": "A String", # Output only. The display name of the category.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CATEGORY`.
+  },
+  "channelDetails": { # Details for assigned channel targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CHANNEL`. # Channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_CHANNEL`.
+    "channelId": "A String", # Required. ID of the channel. Should refer to the channel ID field on a [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id) resource.
+    "negative": True or False, # Indicates if this option is being negatively targeted. For advertiser level assigned targeting option, this field must be true.
+  },
+  "contentDurationDetails": { # Details for content duration assigned targeting option. This will be populated in the content_duration_details field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`. Explicitly targeting all options is not supported. Remove all content duration targeting options to achieve this effect. # Content duration details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
+    "contentDuration": "A String", # Output only. The content duration.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
+  },
+  "contentGenreDetails": { # Details for content genre assigned targeting option. This will be populated in the content_genre_details field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`. Explicitly targeting all options is not supported. Remove all content genre targeting options to achieve this effect. # Content genre details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
+    "displayName": "A String", # Output only. The display name of the content genre.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
+  },
+  "contentInstreamPositionDetails": { # Assigned content instream position targeting option details. This will be populated in the content_instream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. # Content instream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.
+    "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`. * `AD_TYPE_AUDIO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_AUDIO_DEFAULT`.
+    "contentInstreamPosition": "A String", # Required. The content instream position for video or audio ads.
+  },
+  "contentOutstreamPositionDetails": { # Assigned content outstream position targeting option details. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. # Content outstream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.
+    "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+    "contentOutstreamPosition": "A String", # Required. The content outstream position.
+  },
+  "contentStreamTypeDetails": { # Details for content stream type assigned targeting option. This will be populated in the content_stream_type_details field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`. Explicitly targeting all options is not supported. Remove all content stream type targeting options to achieve this effect. # Content duration details. This field will be populated when the TargetingType is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
+    "contentStreamType": "A String", # Output only. The content stream type.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
+  },
+  "dayAndTimeDetails": { # Representation of a segment of time defined on a specific day of the week and with a start and end time. The time represented by `start_hour` must be before the time represented by `end_hour`. # Day and time details. This field will be populated when the targeting_type is `TARGETING_TYPE_DAY_AND_TIME`.
+    "dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting.
+    "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day).
+    "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day).
+    "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting.
+  },
+  "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
+    "displayName": "A String", # Output only. The display name of the device make and model.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
+  },
+  "deviceTypeDetails": { # Targeting details for device type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`. # Device Type details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_TYPE`.
+    "deviceType": "A String", # Required. The display name of the device type.
+    "youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items.
+  },
+  "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded.
+    "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED.
+  },
+  "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`.
+    "environment": "A String", # Required. The serving environment.
+  },
+  "exchangeDetails": { # Details for assigned exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`. # Exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_EXCHANGE`.
+    "exchange": "A String", # Required. The enum value for the exchange.
+  },
+  "genderDetails": { # Details for assigned gender targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GENDER`. # Gender details. This field will be populated when the targeting_type is `TARGETING_TYPE_GENDER`.
+    "gender": "A String", # Required. The gender of the audience.
+  },
+  "geoRegionDetails": { # Details for assigned geographic region targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GEO_REGION`. # Geographic region details. This field will be populated when the targeting_type is `TARGETING_TYPE_GEO_REGION`.
+    "displayName": "A String", # Output only. The display name of the geographic region (e.g., "Ontario, Canada").
+    "geoRegionType": "A String", # Output only. The type of geographic region targeting.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GEO_REGION`.
+  },
+  "householdIncomeDetails": { # Details for assigned household income targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`. # Household income details. This field will be populated when the targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`.
+    "householdIncome": "A String", # Required. The household income of the audience.
+  },
+  "inheritance": "A String", # Output only. The inheritance status of the assigned targeting option.
+  "inventorySourceDetails": { # Targeting details for inventory source. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`. # Inventory source details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`.
+    "inventorySourceId": "A String", # Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource.
+  },
+  "inventorySourceGroupDetails": { # Targeting details for inventory source group. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`. # Inventory source group details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`.
+    "inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource.
+  },
+  "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned.
+    "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+  },
+  "languageDetails": { # Details for assigned language targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_LANGUAGE`. # Language details. This field will be populated when the targeting_type is `TARGETING_TYPE_LANGUAGE`.
+    "displayName": "A String", # Output only. The display name of the language (e.g., "French").
+    "negative": True or False, # Indicates if this option is being negatively targeted. All assigned language targeting options on the same resource must have the same value for this field.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_LANGUAGE`.
+  },
+  "name": "A String", # Output only. The resource name for this assigned targeting option.
+  "nativeContentPositionDetails": { # Details for native content position assigned targeting option. This will be populated in the native_content_position_details field when targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`. Explicitly targeting all options is not supported. Remove all native content position targeting options to achieve this effect. # Native content position details. This field will be populated when the targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`.
+    "contentPosition": "A String", # Required. The content position.
+  },
+  "negativeKeywordListDetails": { # Targeting details for negative keyword list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. A maximum of 4 negative keyword lists can be assigned to a resource.
+    "negativeKeywordListId": "A String", # Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource.
+  },
+  "omidDetails": { # Represents a targetable Open Measurement enabled inventory type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_OMID`. # Open Measurement enabled inventory details. This field will be populated when the targeting_type is `TARGETING_TYPE_OMID`.
+    "omid": "A String", # Required. The type of Open Measurement enabled inventory.
+  },
+  "onScreenPositionDetails": { # On screen position targeting option details. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. # On screen position details. This field will be populated when the targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
+    "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+    "onScreenPosition": "A String", # Output only. The on screen position.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
+  },
+  "operatingSystemDetails": { # Assigned operating system targeting option details. This will be populated in the operating_system_details field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. # Operating system details. This field will be populated when the targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
+    "displayName": "A String", # Output only. The display name of the operating system.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting option ID populated in targeting_option_id field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
+  },
+  "parentalStatusDetails": { # Details for assigned parental status targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`. # Parental status details. This field will be populated when the targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`.
+    "parentalStatus": "A String", # Required. The parental status of the audience.
+  },
+  "poiDetails": { # Details for assigned POI targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_POI`. # POI details. This field will be populated when the targeting_type is `TARGETING_TYPE_POI`.
+    "displayName": "A String", # Output only. The display name of a POI, e.g. "Times Square", "Space Needle", followed by its full address if available.
+    "latitude": 3.14, # Output only. Latitude of the POI rounding to 6th decimal place.
+    "longitude": 3.14, # Output only. Longitude of the POI rounding to 6th decimal place.
+    "proximityRadiusAmount": 3.14, # Required. The radius of the area around the POI that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`.
+    "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_POI`. Accepted POI targeting option IDs can be retrieved using `targetingTypes.targetingOptions.search`. If targeting a specific latitude/longitude coordinate removed from an address or POI name, you can generate the necessary targeting option ID by rounding the desired coordinate values to the 6th decimal place, removing the decimals, and concatenating the string values separated by a semicolon. For example, you can target the latitude/longitude pair of 40.7414691, -74.003387 using the targeting option ID "40741469;-74003387". **Upon** **creation, this field value will be updated to append a semicolon and** **alphanumerical hash value if only latitude/longitude coordinates are** **provided.**
+  },
+  "proximityLocationListDetails": { # Targeting details for proximity location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`. # Proximity location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`.
+    "proximityLocationListId": "A String", # Required. ID of the proximity location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_PROXIMITY`.
+    "proximityRadius": 3.14, # Required. Radius expressed in the distance units set in proximity_radius_unit. This represents the size of the area around a chosen location that will be targeted. Radius should be between 1 and 500 miles or 800 kilometers.
+    "proximityRadiusUnit": "A String", # Required. Radius distance units.
+  },
+  "regionalLocationListDetails": { # Targeting details for regional location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`. # Regional location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`.
+  },
+  "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them.
+    "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED.
+  },
+  "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`.
+    "sessionPosition": "A String", # The position where the ad will show in a session.
+  },
+  "subExchangeDetails": { # Details for assigned sub-exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`. # Sub-exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`.
+  },
+  "targetingType": "A String", # Output only. Identifies the type of this assigned targeting option.
+  "thirdPartyVerifierDetails": { # Assigned third party verifier targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`. # Third party verification details. This field will be populated when the targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`.
+    "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox.
+      "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads.
+      "excludedAdlooxCategories": [ # Adloox categories to exclude.
+        "A String",
+      ],
+      "excludedFraudIvtMfaCategories": [ # Optional. Adloox's fraud IVT MFA categories to exclude.
+        "A String",
+      ],
+      "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads.
+    },
+    "doubleVerify": { # Details of DoubleVerify settings. # Third party brand verifier -- DoubleVerify.
+      "appStarRating": { # Details of DoubleVerify star ratings settings. # Avoid bidding on apps with the star ratings.
+        "avoidInsufficientStarRating": True or False, # Avoid bidding on apps with insufficient star ratings.
+        "avoidedStarRating": "A String", # Avoid bidding on apps with the star ratings.
+      },
+      "avoidedAgeRatings": [ # Avoid bidding on apps with the age rating.
+        "A String",
+      ],
+      "brandSafetyCategories": { # Settings for brand safety controls. # DV Brand Safety Controls.
+        "avoidUnknownBrandSafetyCategory": True or False, # Unknown or unrateable.
+        "avoidedHighSeverityCategories": [ # Brand safety high severity avoidance categories.
+          "A String",
+        ],
+        "avoidedMediumSeverityCategories": [ # Brand safety medium severity avoidance categories.
+          "A String",
+        ],
+      },
+      "customSegmentId": "A String", # The custom segment ID provided by DoubleVerify. The ID must start with "51" and consist of eight digits. Custom segment ID cannot be specified along with any of the following fields: * brand_safety_categories * avoided_age_ratings * app_star_rating * fraud_invalid_traffic
+      "displayViewability": { # Details of DoubleVerify display viewability settings. # Display viewability settings (applicable to display line items only).
+        "iab": "A String", # Target web and app inventory to maximize IAB viewable rate.
+        "viewableDuring": "A String", # Target web and app inventory to maximize 100% viewable duration.
+      },
+      "fraudInvalidTraffic": { # DoubleVerify Fraud & Invalid Traffic settings. # Avoid Sites and Apps with historical Fraud & IVT Rates.
+        "avoidInsufficientOption": True or False, # Insufficient Historical Fraud & IVT Stats.
+        "avoidedFraudOption": "A String", # Avoid Sites and Apps with historical Fraud & IVT.
+      },
+      "videoViewability": { # Details of DoubleVerify video viewability settings. # Video viewability settings (applicable to video line items only).
+        "playerImpressionRate": "A String", # Target inventory to maximize impressions with 400x300 or greater player size.
+        "videoIab": "A String", # Target web inventory to maximize IAB viewable rate.
+        "videoViewableRate": "A String", # Target web inventory to maximize fully viewable rate.
+      },
+    },
+    "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science.
+      "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive.
+        "A String",
+      ],
+      "displayViewability": "A String", # Display Viewability section (applicable to display line items only).
+      "excludeUnrateable": True or False, # Brand Safety - **Unrateable**.
+      "excludedAdFraudRisk": "A String", # Ad Fraud settings.
+      "excludedAdultRisk": "A String", # Brand Safety - **Adult content**.
+      "excludedAlcoholRisk": "A String", # Brand Safety - **Alcohol**.
+      "excludedDrugsRisk": "A String", # Brand Safety - **Drugs**.
+      "excludedGamblingRisk": "A String", # Brand Safety - **Gambling**.
+      "excludedHateSpeechRisk": "A String", # Brand Safety - **Hate speech**.
+      "excludedIllegalDownloadsRisk": "A String", # Brand Safety - **Illegal downloads**.
+      "excludedOffensiveLanguageRisk": "A String", # Brand Safety - **Offensive language**.
+      "excludedViolenceRisk": "A String", # Brand Safety - **Violence**.
+      "qualitySyncCustomSegmentId": [ # Optional. The quality sync custom segment ID provided by Integral Ad Science. The ID must be between `3000000` and `4999999`, inclusive.
+        "A String",
+      ],
+      "traqScoreOption": "A String", # True advertising quality (applicable to Display line items only).
+      "videoViewability": "A String", # Video Viewability Section (applicable to video line items only).
+    },
+  },
+  "urlDetails": { # Details for assigned URL targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_URL`. # URL details. This field will be populated when the targeting_type is `TARGETING_TYPE_URL`.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "url": "A String", # Required. The URL, for example `example.com`. DV360 supports two levels of subdirectory targeting, for example `www.example.com/one-subdirectory-level/second-level`, and five levels of subdomain targeting, for example `five.four.three.two.one.example.com`.
+  },
+  "userRewardedContentDetails": { # User rewarded content targeting option details. This will be populated in the user_rewarded_content_details field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. # User rewarded content details. This field will be populated when the targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
+    "userRewardedContent": "A String", # Output only. User rewarded content status for video ads.
+  },
+  "videoPlayerSizeDetails": { # Video player size targeting option details. This will be populated in the video_player_size_details field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. Explicitly targeting all options is not supported. Remove all video player size targeting options to achieve this effect. # Video player size details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.
+    "videoPlayerSize": "A String", # Required. The video player size.
+  },
+  "viewabilityDetails": { # Assigned viewability targeting option details. This will be populated in the viewability_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`. # Viewability details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIEWABILITY`. You can only target one viewability option per resource.
+    "viewability": "A String", # Required. The predicted viewability percentage.
+  },
+  "youtubeChannelDetails": { # Details for YouTube channel assigned targeting option. This will be populated in the youtube_channel_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`. # YouTube channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`.
+    "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+  },
+  "youtubeVideoDetails": { # Details for YouTube video assigned targeting option. This will be populated in the youtube_video_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`. # YouTube video details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "videoId": "A String", # YouTube video id as it appears on the YouTube watch page.
+  },
+}
+
+ +
+ list(advertiserId, targetingType, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists the targeting options assigned to an advertiser.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser. (required)
+  targetingType: string, Required. Identifies the type of assigned targeting options to list. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_YOUTUBE_VIDEO` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_KEYWORD` (required)
+    Allowed values
+      TARGETING_TYPE_UNSPECIFIED - Default value when type is not specified or is unknown in this version.
+      TARGETING_TYPE_CHANNEL - Target a channel (a custom group of related websites or apps).
+      TARGETING_TYPE_APP_CATEGORY - Target an app category (for example, education or puzzle games).
+      TARGETING_TYPE_APP - Target a specific app (for example, Angry Birds).
+      TARGETING_TYPE_URL - Target a specific url (for example, quora.com).
+      TARGETING_TYPE_DAY_AND_TIME - Target ads during a chosen time period on a specific day.
+      TARGETING_TYPE_AGE_RANGE - Target ads to a specific age range (for example, 18-24).
+      TARGETING_TYPE_REGIONAL_LOCATION_LIST - Target ads to the specified regions on a regional location list.
+      TARGETING_TYPE_PROXIMITY_LOCATION_LIST - Target ads to the specified points of interest on a proximity location list.
+      TARGETING_TYPE_GENDER - Target ads to a specific gender (for example, female or male).
+      TARGETING_TYPE_VIDEO_PLAYER_SIZE - Target a specific video player size for video ads.
+      TARGETING_TYPE_USER_REWARDED_CONTENT - Target user rewarded content for video ads.
+      TARGETING_TYPE_PARENTAL_STATUS - Target ads to a specific parental status (for example, parent or not a parent).
+      TARGETING_TYPE_CONTENT_INSTREAM_POSITION - Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).
+      TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION - Target ads in a specific content outstream position.
+      TARGETING_TYPE_DEVICE_TYPE - Target ads to a specific device type (for example, tablet or connected TV).
+      TARGETING_TYPE_AUDIENCE_GROUP - Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.
+      TARGETING_TYPE_BROWSER - Target ads to specific web browsers (for example, Chrome).
+      TARGETING_TYPE_HOUSEHOLD_INCOME - Target ads to a specific household income range (for example, top 10%).
+      TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position.
+      TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify).
+      TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).
+      TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult).
+      TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app).
+      TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).
+      TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS).
+      TARGETING_TYPE_DEVICE_MAKE_MODEL - Target ads to a specific device make or model (for example, Roku or Samsung).
+      TARGETING_TYPE_KEYWORD - Target ads to a specific keyword (for example, dog or retriever).
+      TARGETING_TYPE_NEGATIVE_KEYWORD_LIST - Target ads to a specific negative keyword list.
+      TARGETING_TYPE_VIEWABILITY - Target ads to a specific viewability (for example, 80% viewable).
+      TARGETING_TYPE_CATEGORY - Target ads to a specific content category (for example, arts & entertainment).
+      TARGETING_TYPE_INVENTORY_SOURCE - Purchase impressions from specific deals and auction packages.
+      TARGETING_TYPE_LANGUAGE - Target ads to a specific language (for example, English or Japanese).
+      TARGETING_TYPE_AUTHORIZED_SELLER_STATUS - Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.
+      TARGETING_TYPE_GEO_REGION - Target ads to a specific regional location (for example, a city or state).
+      TARGETING_TYPE_INVENTORY_SOURCE_GROUP - Purchase impressions from a group of deals and auction packages.
+      TARGETING_TYPE_EXCHANGE - Purchase impressions from specific exchanges.
+      TARGETING_TYPE_SUB_EXCHANGE - Purchase impressions from specific sub-exchanges.
+      TARGETING_TYPE_POI - Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.
+      TARGETING_TYPE_BUSINESS_CHAIN - Target ads around locations of a business chain within a specific geo region.
+      TARGETING_TYPE_CONTENT_DURATION - Target ads to a specific video content duration.
+      TARGETING_TYPE_CONTENT_STREAM_TYPE - Target ads to a specific video content stream type.
+      TARGETING_TYPE_NATIVE_CONTENT_POSITION - Target ads to a specific native content position.
+      TARGETING_TYPE_OMID - Target ads in an Open Measurement enabled inventory.
+      TARGETING_TYPE_AUDIO_CONTENT_TYPE - Target ads to a specific audio content type.
+      TARGETING_TYPE_CONTENT_GENRE - Target ads to a specific content genre.
+      TARGETING_TYPE_YOUTUBE_VIDEO - Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
+      TARGETING_TYPE_YOUTUBE_CHANNEL - Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
+      TARGETING_TYPE_SESSION_POSITION - Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.
+  filter: string, Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` Examples: * `AssignedTargetingOption` with ID 123456: `assignedTargetingOptionId="123456"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
+  orderBy: string, Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`.
+  pageSize: integer, Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
+  pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdvertiserAssignedTargetingOptions` method. If not specified, the first page of results 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:
+
+    { # Response message for ListAdvertiserAssignedTargetingOptions.
+  "assignedTargetingOptions": [ # The list of assigned targeting options. This list will be absent if empty.
+    { # A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings.
+      "ageRangeDetails": { # Represents a targetable age range. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AGE_RANGE`. # Age range details. This field will be populated when the targeting_type is `TARGETING_TYPE_AGE_RANGE`.
+        "ageRange": "A String", # Required. The age range of an audience. We only support targeting a continuous age range of an audience. Thus, the age range represented in this field can be 1) targeted solely, or, 2) part of a larger continuous age range. The reach of a continuous age range targeting can be expanded by also targeting an audience of an unknown age.
+      },
+      "appCategoryDetails": { # Details for assigned app category targeting option. This will be populated in the app_category_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. # App category details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
+        "displayName": "A String", # Output only. The display name of the app category.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
+      },
+      "appDetails": { # Details for assigned app targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP`. # App details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP`.
+        "appId": "A String", # Required. The ID of the app. Android's Play store app uses bundle ID, for example `com.google.android.gm`. Apple's App store app ID uses 9 digit string, for example `422689480`.
+        "appPlatform": "A String", # Indicates the platform of the targeted app. If this field is not specified, the app platform will be assumed to be mobile (i.e., Android or iOS), and we will derive the appropriate mobile platform from the app ID.
+        "displayName": "A String", # Output only. The display name of the app.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+      },
+      "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts.
+      "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`
+      "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource.
+        "excludedFirstPartyAndPartnerAudienceGroup": { # Details of first party and partner audience group. All first party and partner audience targeting settings are logically ‘OR’ of each other. # Optional. The first party and partner audience ids and recencies of the excluded first party and partner audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other.
+          "settings": [ # Required. All first party and partner audience targeting settings in first party and partner audience group. Repeated settings with the same id are not allowed.
+            { # Details of first party and partner audience targeting setting.
+              "firstPartyAndPartnerAudienceId": "A String", # Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.
+              "recency": "A String", # Required. The recency of the first party and partner audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
+            },
+          ],
+        },
+        "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other.
+          "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
+            { # Details of Google audience targeting setting.
+              "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
+            },
+          ],
+        },
+        "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only.
+          "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise.
+            { # Details of combined audience targeting setting.
+              "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id.
+            },
+          ],
+        },
+        "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only.
+          "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored.
+            { # Details of custom list targeting setting.
+              "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id.
+            },
+          ],
+        },
+        "includedFirstPartyAndPartnerAudienceGroups": [ # Optional. The first party and partner audience ids and recencies of included first party and partner audience groups. Each first party and partner audience group contains first party and partner audience ids only. The relation between each first party and partner audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored.
+          { # Details of first party and partner audience group. All first party and partner audience targeting settings are logically ‘OR’ of each other.
+            "settings": [ # Required. All first party and partner audience targeting settings in first party and partner audience group. Repeated settings with the same id are not allowed.
+              { # Details of first party and partner audience targeting setting.
+                "firstPartyAndPartnerAudienceId": "A String", # Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.
+                "recency": "A String", # Required. The recency of the first party and partner audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
+              },
+            ],
+          },
+        ],
+        "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only.
+          "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
+            { # Details of Google audience targeting setting.
+              "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
+            },
+          ],
+        },
+      },
+      "audioContentTypeDetails": { # Details for audio content type assigned targeting option. This will be populated in the audio_content_type_details field when targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`. Explicitly targeting all options is not supported. Remove all audio content type targeting options to achieve this effect. # Audio content type details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`.
+        "audioContentType": "A String", # Required. The audio content type.
+      },
+      "authorizedSellerStatusDetails": { # Represents an assigned authorized seller status. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. If a resource does not have an `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` assigned targeting option, it is using the "Authorized Direct Sellers and Resellers" option. # Authorized seller status details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. You can only target one authorized seller status option per resource. If a resource doesn't have an authorized seller status option, all authorized sellers indicated as DIRECT or RESELLER in the ads.txt file are targeted by default.
+        "authorizedSellerStatus": "A String", # Output only. The authorized seller status to target.
+        "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.
+      },
+      "browserDetails": { # Details for assigned browser targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BROWSER`. # Browser details. This field will be populated when the targeting_type is `TARGETING_TYPE_BROWSER`.
+        "displayName": "A String", # Output only. The display name of the browser.
+        "negative": True or False, # Indicates if this option is being negatively targeted. All assigned browser targeting options on the same resource must have the same value for this field.
+        "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BROWSER`.
+      },
+      "businessChainDetails": { # Details for assigned Business chain targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`. # Business chain details. This field will be populated when the targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`.
+        "displayName": "A String", # Output only. The display name of a business chain, e.g. "KFC", "Chase Bank".
+        "proximityRadiusAmount": 3.14, # Required. The radius of the area around the business chain that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`. The minimum increment for both cases is 0.1. Inputs will be rounded to the nearest acceptable value if it is too granular, e.g. 15.57 will become 15.6.
+        "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
+        "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BUSINESS_CHAIN`. Accepted business chain targeting option IDs can be retrieved using SearchTargetingOptions.
+      },
+      "carrierAndIspDetails": { # Details for assigned carrier and ISP targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`. # Carrier and ISP details. This field will be populated when the targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`.
+        "displayName": "A String", # Output only. The display name of the carrier or ISP.
+        "negative": True or False, # Indicates if this option is being negatively targeted. All assigned carrier and ISP targeting options on the same resource must have the same value for this field.
+        "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`.
+      },
+      "categoryDetails": { # Assigned category targeting option details. This will be populated in the category_details field when targeting_type is `TARGETING_TYPE_CATEGORY`. # Category details. This field will be populated when the targeting_type is `TARGETING_TYPE_CATEGORY`. Targeting a category will also target its subcategories. If a category is excluded from targeting and a subcategory is included, the exclusion will take precedence.
+        "displayName": "A String", # Output only. The display name of the category.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CATEGORY`.
+      },
+      "channelDetails": { # Details for assigned channel targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CHANNEL`. # Channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_CHANNEL`.
+        "channelId": "A String", # Required. ID of the channel. Should refer to the channel ID field on a [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id) resource.
+        "negative": True or False, # Indicates if this option is being negatively targeted. For advertiser level assigned targeting option, this field must be true.
+      },
+      "contentDurationDetails": { # Details for content duration assigned targeting option. This will be populated in the content_duration_details field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`. Explicitly targeting all options is not supported. Remove all content duration targeting options to achieve this effect. # Content duration details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
+        "contentDuration": "A String", # Output only. The content duration.
+        "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
+      },
+      "contentGenreDetails": { # Details for content genre assigned targeting option. This will be populated in the content_genre_details field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`. Explicitly targeting all options is not supported. Remove all content genre targeting options to achieve this effect. # Content genre details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
+        "displayName": "A String", # Output only. The display name of the content genre.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
+      },
+      "contentInstreamPositionDetails": { # Assigned content instream position targeting option details. This will be populated in the content_instream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. # Content instream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.
+        "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`. * `AD_TYPE_AUDIO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_AUDIO_DEFAULT`.
+        "contentInstreamPosition": "A String", # Required. The content instream position for video or audio ads.
+      },
+      "contentOutstreamPositionDetails": { # Assigned content outstream position targeting option details. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. # Content outstream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.
+        "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+        "contentOutstreamPosition": "A String", # Required. The content outstream position.
+      },
+      "contentStreamTypeDetails": { # Details for content stream type assigned targeting option. This will be populated in the content_stream_type_details field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`. Explicitly targeting all options is not supported. Remove all content stream type targeting options to achieve this effect. # Content duration details. This field will be populated when the TargetingType is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
+        "contentStreamType": "A String", # Output only. The content stream type.
+        "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
+      },
+      "dayAndTimeDetails": { # Representation of a segment of time defined on a specific day of the week and with a start and end time. The time represented by `start_hour` must be before the time represented by `end_hour`. # Day and time details. This field will be populated when the targeting_type is `TARGETING_TYPE_DAY_AND_TIME`.
+        "dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting.
+        "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day).
+        "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day).
+        "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting.
+      },
+      "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
+        "displayName": "A String", # Output only. The display name of the device make and model.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
+      },
+      "deviceTypeDetails": { # Targeting details for device type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`. # Device Type details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_TYPE`.
+        "deviceType": "A String", # Required. The display name of the device type.
+        "youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items.
+      },
+      "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded.
+        "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED.
+      },
+      "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`.
+        "environment": "A String", # Required. The serving environment.
+      },
+      "exchangeDetails": { # Details for assigned exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`. # Exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_EXCHANGE`.
+        "exchange": "A String", # Required. The enum value for the exchange.
+      },
+      "genderDetails": { # Details for assigned gender targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GENDER`. # Gender details. This field will be populated when the targeting_type is `TARGETING_TYPE_GENDER`.
+        "gender": "A String", # Required. The gender of the audience.
+      },
+      "geoRegionDetails": { # Details for assigned geographic region targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GEO_REGION`. # Geographic region details. This field will be populated when the targeting_type is `TARGETING_TYPE_GEO_REGION`.
+        "displayName": "A String", # Output only. The display name of the geographic region (e.g., "Ontario, Canada").
+        "geoRegionType": "A String", # Output only. The type of geographic region targeting.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GEO_REGION`.
+      },
+      "householdIncomeDetails": { # Details for assigned household income targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`. # Household income details. This field will be populated when the targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`.
+        "householdIncome": "A String", # Required. The household income of the audience.
+      },
+      "inheritance": "A String", # Output only. The inheritance status of the assigned targeting option.
+      "inventorySourceDetails": { # Targeting details for inventory source. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`. # Inventory source details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`.
+        "inventorySourceId": "A String", # Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource.
+      },
+      "inventorySourceGroupDetails": { # Targeting details for inventory source group. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`. # Inventory source group details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`.
+        "inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource.
+      },
+      "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned.
+        "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+      },
+      "languageDetails": { # Details for assigned language targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_LANGUAGE`. # Language details. This field will be populated when the targeting_type is `TARGETING_TYPE_LANGUAGE`.
+        "displayName": "A String", # Output only. The display name of the language (e.g., "French").
+        "negative": True or False, # Indicates if this option is being negatively targeted. All assigned language targeting options on the same resource must have the same value for this field.
+        "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_LANGUAGE`.
+      },
+      "name": "A String", # Output only. The resource name for this assigned targeting option.
+      "nativeContentPositionDetails": { # Details for native content position assigned targeting option. This will be populated in the native_content_position_details field when targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`. Explicitly targeting all options is not supported. Remove all native content position targeting options to achieve this effect. # Native content position details. This field will be populated when the targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`.
+        "contentPosition": "A String", # Required. The content position.
+      },
+      "negativeKeywordListDetails": { # Targeting details for negative keyword list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. A maximum of 4 negative keyword lists can be assigned to a resource.
+        "negativeKeywordListId": "A String", # Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource.
+      },
+      "omidDetails": { # Represents a targetable Open Measurement enabled inventory type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_OMID`. # Open Measurement enabled inventory details. This field will be populated when the targeting_type is `TARGETING_TYPE_OMID`.
+        "omid": "A String", # Required. The type of Open Measurement enabled inventory.
+      },
+      "onScreenPositionDetails": { # On screen position targeting option details. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. # On screen position details. This field will be populated when the targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
+        "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+        "onScreenPosition": "A String", # Output only. The on screen position.
+        "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
+      },
+      "operatingSystemDetails": { # Assigned operating system targeting option details. This will be populated in the operating_system_details field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. # Operating system details. This field will be populated when the targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
+        "displayName": "A String", # Output only. The display name of the operating system.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "targetingOptionId": "A String", # Required. The targeting option ID populated in targeting_option_id field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
+      },
+      "parentalStatusDetails": { # Details for assigned parental status targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`. # Parental status details. This field will be populated when the targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`.
+        "parentalStatus": "A String", # Required. The parental status of the audience.
+      },
+      "poiDetails": { # Details for assigned POI targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_POI`. # POI details. This field will be populated when the targeting_type is `TARGETING_TYPE_POI`.
+        "displayName": "A String", # Output only. The display name of a POI, e.g. "Times Square", "Space Needle", followed by its full address if available.
+        "latitude": 3.14, # Output only. Latitude of the POI rounding to 6th decimal place.
+        "longitude": 3.14, # Output only. Longitude of the POI rounding to 6th decimal place.
+        "proximityRadiusAmount": 3.14, # Required. The radius of the area around the POI that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`.
+        "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
+        "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_POI`. Accepted POI targeting option IDs can be retrieved using `targetingTypes.targetingOptions.search`. If targeting a specific latitude/longitude coordinate removed from an address or POI name, you can generate the necessary targeting option ID by rounding the desired coordinate values to the 6th decimal place, removing the decimals, and concatenating the string values separated by a semicolon. For example, you can target the latitude/longitude pair of 40.7414691, -74.003387 using the targeting option ID "40741469;-74003387". **Upon** **creation, this field value will be updated to append a semicolon and** **alphanumerical hash value if only latitude/longitude coordinates are** **provided.**
+      },
+      "proximityLocationListDetails": { # Targeting details for proximity location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`. # Proximity location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`.
+        "proximityLocationListId": "A String", # Required. ID of the proximity location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_PROXIMITY`.
+        "proximityRadius": 3.14, # Required. Radius expressed in the distance units set in proximity_radius_unit. This represents the size of the area around a chosen location that will be targeted. Radius should be between 1 and 500 miles or 800 kilometers.
+        "proximityRadiusUnit": "A String", # Required. Radius distance units.
+      },
+      "regionalLocationListDetails": { # Targeting details for regional location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`. # Regional location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`.
+      },
+      "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them.
+        "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED.
+      },
+      "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`.
+        "sessionPosition": "A String", # The position where the ad will show in a session.
+      },
+      "subExchangeDetails": { # Details for assigned sub-exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`. # Sub-exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`.
+        "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`.
+      },
+      "targetingType": "A String", # Output only. Identifies the type of this assigned targeting option.
+      "thirdPartyVerifierDetails": { # Assigned third party verifier targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`. # Third party verification details. This field will be populated when the targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`.
+        "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox.
+          "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads.
+          "excludedAdlooxCategories": [ # Adloox categories to exclude.
+            "A String",
+          ],
+          "excludedFraudIvtMfaCategories": [ # Optional. Adloox's fraud IVT MFA categories to exclude.
+            "A String",
+          ],
+          "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads.
+        },
+        "doubleVerify": { # Details of DoubleVerify settings. # Third party brand verifier -- DoubleVerify.
+          "appStarRating": { # Details of DoubleVerify star ratings settings. # Avoid bidding on apps with the star ratings.
+            "avoidInsufficientStarRating": True or False, # Avoid bidding on apps with insufficient star ratings.
+            "avoidedStarRating": "A String", # Avoid bidding on apps with the star ratings.
+          },
+          "avoidedAgeRatings": [ # Avoid bidding on apps with the age rating.
+            "A String",
+          ],
+          "brandSafetyCategories": { # Settings for brand safety controls. # DV Brand Safety Controls.
+            "avoidUnknownBrandSafetyCategory": True or False, # Unknown or unrateable.
+            "avoidedHighSeverityCategories": [ # Brand safety high severity avoidance categories.
+              "A String",
+            ],
+            "avoidedMediumSeverityCategories": [ # Brand safety medium severity avoidance categories.
+              "A String",
+            ],
+          },
+          "customSegmentId": "A String", # The custom segment ID provided by DoubleVerify. The ID must start with "51" and consist of eight digits. Custom segment ID cannot be specified along with any of the following fields: * brand_safety_categories * avoided_age_ratings * app_star_rating * fraud_invalid_traffic
+          "displayViewability": { # Details of DoubleVerify display viewability settings. # Display viewability settings (applicable to display line items only).
+            "iab": "A String", # Target web and app inventory to maximize IAB viewable rate.
+            "viewableDuring": "A String", # Target web and app inventory to maximize 100% viewable duration.
+          },
+          "fraudInvalidTraffic": { # DoubleVerify Fraud & Invalid Traffic settings. # Avoid Sites and Apps with historical Fraud & IVT Rates.
+            "avoidInsufficientOption": True or False, # Insufficient Historical Fraud & IVT Stats.
+            "avoidedFraudOption": "A String", # Avoid Sites and Apps with historical Fraud & IVT.
+          },
+          "videoViewability": { # Details of DoubleVerify video viewability settings. # Video viewability settings (applicable to video line items only).
+            "playerImpressionRate": "A String", # Target inventory to maximize impressions with 400x300 or greater player size.
+            "videoIab": "A String", # Target web inventory to maximize IAB viewable rate.
+            "videoViewableRate": "A String", # Target web inventory to maximize fully viewable rate.
+          },
+        },
+        "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science.
+          "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive.
+            "A String",
+          ],
+          "displayViewability": "A String", # Display Viewability section (applicable to display line items only).
+          "excludeUnrateable": True or False, # Brand Safety - **Unrateable**.
+          "excludedAdFraudRisk": "A String", # Ad Fraud settings.
+          "excludedAdultRisk": "A String", # Brand Safety - **Adult content**.
+          "excludedAlcoholRisk": "A String", # Brand Safety - **Alcohol**.
+          "excludedDrugsRisk": "A String", # Brand Safety - **Drugs**.
+          "excludedGamblingRisk": "A String", # Brand Safety - **Gambling**.
+          "excludedHateSpeechRisk": "A String", # Brand Safety - **Hate speech**.
+          "excludedIllegalDownloadsRisk": "A String", # Brand Safety - **Illegal downloads**.
+          "excludedOffensiveLanguageRisk": "A String", # Brand Safety - **Offensive language**.
+          "excludedViolenceRisk": "A String", # Brand Safety - **Violence**.
+          "qualitySyncCustomSegmentId": [ # Optional. The quality sync custom segment ID provided by Integral Ad Science. The ID must be between `3000000` and `4999999`, inclusive.
+            "A String",
+          ],
+          "traqScoreOption": "A String", # True advertising quality (applicable to Display line items only).
+          "videoViewability": "A String", # Video Viewability Section (applicable to video line items only).
+        },
+      },
+      "urlDetails": { # Details for assigned URL targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_URL`. # URL details. This field will be populated when the targeting_type is `TARGETING_TYPE_URL`.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "url": "A String", # Required. The URL, for example `example.com`. DV360 supports two levels of subdirectory targeting, for example `www.example.com/one-subdirectory-level/second-level`, and five levels of subdomain targeting, for example `five.four.three.two.one.example.com`.
+      },
+      "userRewardedContentDetails": { # User rewarded content targeting option details. This will be populated in the user_rewarded_content_details field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. # User rewarded content details. This field will be populated when the targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
+        "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
+        "userRewardedContent": "A String", # Output only. User rewarded content status for video ads.
+      },
+      "videoPlayerSizeDetails": { # Video player size targeting option details. This will be populated in the video_player_size_details field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. Explicitly targeting all options is not supported. Remove all video player size targeting options to achieve this effect. # Video player size details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.
+        "videoPlayerSize": "A String", # Required. The video player size.
+      },
+      "viewabilityDetails": { # Assigned viewability targeting option details. This will be populated in the viewability_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`. # Viewability details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIEWABILITY`. You can only target one viewability option per resource.
+        "viewability": "A String", # Required. The predicted viewability percentage.
+      },
+      "youtubeChannelDetails": { # Details for YouTube channel assigned targeting option. This will be populated in the youtube_channel_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`. # YouTube channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`.
+        "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+      },
+      "youtubeVideoDetails": { # Details for YouTube video assigned targeting option. This will be populated in the youtube_video_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`. # YouTube video details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "videoId": "A String", # YouTube video id as it appears on the YouTube watch page.
+      },
+    },
+  ],
+  "nextPageToken": "A String", # A token identifying the next page of results. This value should be specified as the pageToken in a subsequent ListAdvertiserAssignedTargetingOptionsRequest to fetch the next page of results. This token will be absent if there are no more assigned_targeting_options to return.
+}
+
+ +
+ 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/displayvideo_v4.advertisers.targetingTypes.html b/docs/dyn/displayvideo_v4.advertisers.targetingTypes.html new file mode 100644 index 00000000000..99a10dece8e --- /dev/null +++ b/docs/dyn/displayvideo_v4.advertisers.targetingTypes.html @@ -0,0 +1,91 @@ + + + +

Display & Video 360 API . advertisers . targetingTypes

+

Instance Methods

+

+ assignedTargetingOptions() +

+

Returns the assignedTargetingOptions Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/displayvideo_v4.combinedAudiences.html b/docs/dyn/displayvideo_v4.combinedAudiences.html new file mode 100644 index 00000000000..44644114147 --- /dev/null +++ b/docs/dyn/displayvideo_v4.combinedAudiences.html @@ -0,0 +1,163 @@ + + + +

Display & Video 360 API . combinedAudiences

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(combinedAudienceId, advertiserId=None, partnerId=None, x__xgafv=None)

+

Gets a combined audience.

+

+ list(advertiserId=None, filter=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None)

+

Lists combined audiences. The order is defined by the order_by parameter.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(combinedAudienceId, advertiserId=None, partnerId=None, x__xgafv=None) +
Gets a combined audience.
+
+Args:
+  combinedAudienceId: string, Required. The ID of the combined audience to fetch. (required)
+  advertiserId: string, The ID of the advertiser that has access to the fetched combined audience.
+  partnerId: string, The ID of the partner that has access to the fetched combined audience.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Describes a combined audience resource.
+  "combinedAudienceId": "A String", # Output only. The unique ID of the combined audience. Assigned by the system.
+  "displayName": "A String", # Output only. The display name of the combined audience. .
+  "name": "A String", # Output only. The resource name of the combined audience.
+}
+
+ +
+ list(advertiserId=None, filter=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None) +
Lists combined audiences. The order is defined by the order_by parameter.
+
+Args:
+  advertiserId: string, The ID of the advertiser that has access to the fetched combined audiences.
+  filter: string, Allows filtering by combined audience fields. Supported syntax: * Filter expressions for combined audiences can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All combined audiences for which the display name contains "Google": `displayName : "Google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
+  orderBy: string, Field by which to sort the list. Acceptable values are: * `combinedAudienceId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.
+  pageSize: integer, Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
+  pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCombinedAudiences` method. If not specified, the first page of results will be returned.
+  partnerId: string, The ID of the partner that has access to the fetched combined audiences.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "combinedAudiences": [ # The list of combined audiences. This list will be absent if empty.
+    { # Describes a combined audience resource.
+      "combinedAudienceId": "A String", # Output only. The unique ID of the combined audience. Assigned by the system.
+      "displayName": "A String", # Output only. The display name of the combined audience. .
+      "name": "A String", # Output only. The resource name of the combined audience.
+    },
+  ],
+  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListCombinedAudiences` method to retrieve the next page of results.
+}
+
+ +
+ 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/displayvideo_v4.customBiddingAlgorithms.html b/docs/dyn/displayvideo_v4.customBiddingAlgorithms.html new file mode 100644 index 00000000000..3e00cc367e3 --- /dev/null +++ b/docs/dyn/displayvideo_v4.customBiddingAlgorithms.html @@ -0,0 +1,371 @@ + + + +

Display & Video 360 API . customBiddingAlgorithms

+

Instance Methods

+

+ rules() +

+

Returns the rules Resource.

+ +

+ scripts() +

+

Returns the scripts Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ create(body=None, x__xgafv=None)

+

Creates a new custom bidding algorithm. Returns the newly created custom bidding algorithm if successful.

+

+ get(customBiddingAlgorithmId, advertiserId=None, partnerId=None, x__xgafv=None)

+

Gets a custom bidding algorithm.

+

+ list(advertiserId=None, filter=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None)

+

Lists custom bidding algorithms that are accessible to the current user and can be used in bidding stratgies. The order is defined by the order_by parameter.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(customBiddingAlgorithmId, body=None, updateMask=None, x__xgafv=None)

+

Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful. *Warning*: Starting **April 1, 2025**, requests updating custom bidding algorithms that are assigned to line items will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).

+

+ uploadRules(customBiddingAlgorithmId, advertiserId=None, partnerId=None, x__xgafv=None)

+

Creates a rules reference object for an AlgorithmRules file. The resulting reference object provides a resource path where the AlgorithmRules file should be uploaded. This reference object should be included when creating a new CustomBiddingAlgorithmRules resource.

+

+ uploadScript(customBiddingAlgorithmId, advertiserId=None, partnerId=None, x__xgafv=None)

+

Creates a custom bidding script reference object for a script file. The resulting reference object provides a resource path to which the script file should be uploaded. This reference object should be included in when creating a new custom bidding script object.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(body=None, x__xgafv=None) +
Creates a new custom bidding algorithm. Returns the newly created custom bidding algorithm if successful.
+
+Args:
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A single custom bidding algorithm.
+  "advertiserId": "A String", # Immutable. The unique ID of the advertiser that owns the custom bidding algorithm.
+  "customBiddingAlgorithmId": "A String", # Output only. The unique ID of the custom bidding algorithm. Assigned by the system.
+  "customBiddingAlgorithmType": "A String", # Required. Immutable. The type of custom bidding algorithm.
+  "displayName": "A String", # Required. The display name of the custom bidding algorithm. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "entityStatus": "A String", # Controls whether or not the custom bidding algorithm can be used as a bidding strategy. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED`
+  "modelDetails": [ # Output only. The details of custom bidding models for each advertiser who has access. This field may only include the details of the queried advertiser if the algorithm [`owner`](/display-video/api/reference/rest/v1/customBiddingAlgorithms#CustomBiddingAlgorithm.FIELDS.oneof_owner) is a partner and is being retrieved using an advertiser [`accessor`](/display-video/api/reference/rest/v1/customBiddingAlgorithms/list#body.QUERY_PARAMETERS.oneof_accessor).
+    { # The details of a custom bidding algorithm model for a single shared advertiser.
+      "advertiserId": "A String", # The unique ID of the relevant advertiser.
+      "readinessState": "A String", # The readiness state of custom bidding model.
+      "suspensionState": "A String", # Output only. The suspension state of custom bidding model.
+    },
+  ],
+  "name": "A String", # Output only. The resource name of the custom bidding algorithm.
+  "partnerId": "A String", # Immutable. The unique ID of the partner that owns the custom bidding algorithm.
+  "sharedAdvertiserIds": [ # The IDs of the advertisers who have access to this algorithm. If advertiser_id is set, this field will only consist of that value. This field will not be set if the algorithm [`owner`](/display-video/api/reference/rest/v1/customBiddingAlgorithms#CustomBiddingAlgorithm.FIELDS.oneof_owner) is a partner and is being retrieved using an advertiser [`accessor`](/display-video/api/reference/rest/v1/customBiddingAlgorithms/list#body.QUERY_PARAMETERS.oneof_accessor).
+    "A String",
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single custom bidding algorithm.
+  "advertiserId": "A String", # Immutable. The unique ID of the advertiser that owns the custom bidding algorithm.
+  "customBiddingAlgorithmId": "A String", # Output only. The unique ID of the custom bidding algorithm. Assigned by the system.
+  "customBiddingAlgorithmType": "A String", # Required. Immutable. The type of custom bidding algorithm.
+  "displayName": "A String", # Required. The display name of the custom bidding algorithm. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "entityStatus": "A String", # Controls whether or not the custom bidding algorithm can be used as a bidding strategy. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED`
+  "modelDetails": [ # Output only. The details of custom bidding models for each advertiser who has access. This field may only include the details of the queried advertiser if the algorithm [`owner`](/display-video/api/reference/rest/v1/customBiddingAlgorithms#CustomBiddingAlgorithm.FIELDS.oneof_owner) is a partner and is being retrieved using an advertiser [`accessor`](/display-video/api/reference/rest/v1/customBiddingAlgorithms/list#body.QUERY_PARAMETERS.oneof_accessor).
+    { # The details of a custom bidding algorithm model for a single shared advertiser.
+      "advertiserId": "A String", # The unique ID of the relevant advertiser.
+      "readinessState": "A String", # The readiness state of custom bidding model.
+      "suspensionState": "A String", # Output only. The suspension state of custom bidding model.
+    },
+  ],
+  "name": "A String", # Output only. The resource name of the custom bidding algorithm.
+  "partnerId": "A String", # Immutable. The unique ID of the partner that owns the custom bidding algorithm.
+  "sharedAdvertiserIds": [ # The IDs of the advertisers who have access to this algorithm. If advertiser_id is set, this field will only consist of that value. This field will not be set if the algorithm [`owner`](/display-video/api/reference/rest/v1/customBiddingAlgorithms#CustomBiddingAlgorithm.FIELDS.oneof_owner) is a partner and is being retrieved using an advertiser [`accessor`](/display-video/api/reference/rest/v1/customBiddingAlgorithms/list#body.QUERY_PARAMETERS.oneof_accessor).
+    "A String",
+  ],
+}
+
+ +
+ get(customBiddingAlgorithmId, advertiserId=None, partnerId=None, x__xgafv=None) +
Gets a custom bidding algorithm.
+
+Args:
+  customBiddingAlgorithmId: string, Required. The ID of the custom bidding algorithm to fetch. (required)
+  advertiserId: string, The ID of the DV360 partner that has access to the custom bidding algorithm.
+  partnerId: string, The ID of the DV360 partner that has access to the custom bidding algorithm.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single custom bidding algorithm.
+  "advertiserId": "A String", # Immutable. The unique ID of the advertiser that owns the custom bidding algorithm.
+  "customBiddingAlgorithmId": "A String", # Output only. The unique ID of the custom bidding algorithm. Assigned by the system.
+  "customBiddingAlgorithmType": "A String", # Required. Immutable. The type of custom bidding algorithm.
+  "displayName": "A String", # Required. The display name of the custom bidding algorithm. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "entityStatus": "A String", # Controls whether or not the custom bidding algorithm can be used as a bidding strategy. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED`
+  "modelDetails": [ # Output only. The details of custom bidding models for each advertiser who has access. This field may only include the details of the queried advertiser if the algorithm [`owner`](/display-video/api/reference/rest/v1/customBiddingAlgorithms#CustomBiddingAlgorithm.FIELDS.oneof_owner) is a partner and is being retrieved using an advertiser [`accessor`](/display-video/api/reference/rest/v1/customBiddingAlgorithms/list#body.QUERY_PARAMETERS.oneof_accessor).
+    { # The details of a custom bidding algorithm model for a single shared advertiser.
+      "advertiserId": "A String", # The unique ID of the relevant advertiser.
+      "readinessState": "A String", # The readiness state of custom bidding model.
+      "suspensionState": "A String", # Output only. The suspension state of custom bidding model.
+    },
+  ],
+  "name": "A String", # Output only. The resource name of the custom bidding algorithm.
+  "partnerId": "A String", # Immutable. The unique ID of the partner that owns the custom bidding algorithm.
+  "sharedAdvertiserIds": [ # The IDs of the advertisers who have access to this algorithm. If advertiser_id is set, this field will only consist of that value. This field will not be set if the algorithm [`owner`](/display-video/api/reference/rest/v1/customBiddingAlgorithms#CustomBiddingAlgorithm.FIELDS.oneof_owner) is a partner and is being retrieved using an advertiser [`accessor`](/display-video/api/reference/rest/v1/customBiddingAlgorithms/list#body.QUERY_PARAMETERS.oneof_accessor).
+    "A String",
+  ],
+}
+
+ +
+ list(advertiserId=None, filter=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None) +
Lists custom bidding algorithms that are accessible to the current user and can be used in bidding stratgies. The order is defined by the order_by parameter.
+
+Args:
+  advertiserId: string, The ID of the DV360 advertiser that has access to the custom bidding algorithm.
+  filter: string, Allows filtering by custom bidding algorithm fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND`. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `customBiddingAlgorithmType` field must use the `EQUALS (=)` operator. * The `displayName` field must use the `HAS (:)` operator. Supported fields: * `customBiddingAlgorithmType` * `displayName` Examples: * All custom bidding algorithms for which the display name contains "politics": `displayName:"politics"`. * All custom bidding algorithms for which the type is "SCRIPT_BASED": `customBiddingAlgorithmType=SCRIPT_BASED` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
+  orderBy: string, Field by which to sort the list. Acceptable values are: * `displayName` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.
+  pageSize: integer, Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
+  pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCustomBiddingAlgorithms` method. If not specified, the first page of results will be returned.
+  partnerId: string, The ID of the DV360 partner that has access to the custom bidding algorithm.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "customBiddingAlgorithms": [ # The list of custom bidding algorithms. This list will be absent if empty.
+    { # A single custom bidding algorithm.
+      "advertiserId": "A String", # Immutable. The unique ID of the advertiser that owns the custom bidding algorithm.
+      "customBiddingAlgorithmId": "A String", # Output only. The unique ID of the custom bidding algorithm. Assigned by the system.
+      "customBiddingAlgorithmType": "A String", # Required. Immutable. The type of custom bidding algorithm.
+      "displayName": "A String", # Required. The display name of the custom bidding algorithm. Must be UTF-8 encoded with a maximum size of 240 bytes.
+      "entityStatus": "A String", # Controls whether or not the custom bidding algorithm can be used as a bidding strategy. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED`
+      "modelDetails": [ # Output only. The details of custom bidding models for each advertiser who has access. This field may only include the details of the queried advertiser if the algorithm [`owner`](/display-video/api/reference/rest/v1/customBiddingAlgorithms#CustomBiddingAlgorithm.FIELDS.oneof_owner) is a partner and is being retrieved using an advertiser [`accessor`](/display-video/api/reference/rest/v1/customBiddingAlgorithms/list#body.QUERY_PARAMETERS.oneof_accessor).
+        { # The details of a custom bidding algorithm model for a single shared advertiser.
+          "advertiserId": "A String", # The unique ID of the relevant advertiser.
+          "readinessState": "A String", # The readiness state of custom bidding model.
+          "suspensionState": "A String", # Output only. The suspension state of custom bidding model.
+        },
+      ],
+      "name": "A String", # Output only. The resource name of the custom bidding algorithm.
+      "partnerId": "A String", # Immutable. The unique ID of the partner that owns the custom bidding algorithm.
+      "sharedAdvertiserIds": [ # The IDs of the advertisers who have access to this algorithm. If advertiser_id is set, this field will only consist of that value. This field will not be set if the algorithm [`owner`](/display-video/api/reference/rest/v1/customBiddingAlgorithms#CustomBiddingAlgorithm.FIELDS.oneof_owner) is a partner and is being retrieved using an advertiser [`accessor`](/display-video/api/reference/rest/v1/customBiddingAlgorithms/list#body.QUERY_PARAMETERS.oneof_accessor).
+        "A String",
+      ],
+    },
+  ],
+  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListCustomBiddingAlgorithmsRequest` method to retrieve the next page of results. If this field is null, it means this is the last page.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(customBiddingAlgorithmId, body=None, updateMask=None, x__xgafv=None) +
Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful. *Warning*: Starting **April 1, 2025**, requests updating custom bidding algorithms that are assigned to line items will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).
+
+Args:
+  customBiddingAlgorithmId: string, Output only. The unique ID of the custom bidding algorithm. Assigned by the system. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A single custom bidding algorithm.
+  "advertiserId": "A String", # Immutable. The unique ID of the advertiser that owns the custom bidding algorithm.
+  "customBiddingAlgorithmId": "A String", # Output only. The unique ID of the custom bidding algorithm. Assigned by the system.
+  "customBiddingAlgorithmType": "A String", # Required. Immutable. The type of custom bidding algorithm.
+  "displayName": "A String", # Required. The display name of the custom bidding algorithm. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "entityStatus": "A String", # Controls whether or not the custom bidding algorithm can be used as a bidding strategy. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED`
+  "modelDetails": [ # Output only. The details of custom bidding models for each advertiser who has access. This field may only include the details of the queried advertiser if the algorithm [`owner`](/display-video/api/reference/rest/v1/customBiddingAlgorithms#CustomBiddingAlgorithm.FIELDS.oneof_owner) is a partner and is being retrieved using an advertiser [`accessor`](/display-video/api/reference/rest/v1/customBiddingAlgorithms/list#body.QUERY_PARAMETERS.oneof_accessor).
+    { # The details of a custom bidding algorithm model for a single shared advertiser.
+      "advertiserId": "A String", # The unique ID of the relevant advertiser.
+      "readinessState": "A String", # The readiness state of custom bidding model.
+      "suspensionState": "A String", # Output only. The suspension state of custom bidding model.
+    },
+  ],
+  "name": "A String", # Output only. The resource name of the custom bidding algorithm.
+  "partnerId": "A String", # Immutable. The unique ID of the partner that owns the custom bidding algorithm.
+  "sharedAdvertiserIds": [ # The IDs of the advertisers who have access to this algorithm. If advertiser_id is set, this field will only consist of that value. This field will not be set if the algorithm [`owner`](/display-video/api/reference/rest/v1/customBiddingAlgorithms#CustomBiddingAlgorithm.FIELDS.oneof_owner) is a partner and is being retrieved using an advertiser [`accessor`](/display-video/api/reference/rest/v1/customBiddingAlgorithms/list#body.QUERY_PARAMETERS.oneof_accessor).
+    "A String",
+  ],
+}
+
+  updateMask: string, Required. The mask to control which fields to update.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single custom bidding algorithm.
+  "advertiserId": "A String", # Immutable. The unique ID of the advertiser that owns the custom bidding algorithm.
+  "customBiddingAlgorithmId": "A String", # Output only. The unique ID of the custom bidding algorithm. Assigned by the system.
+  "customBiddingAlgorithmType": "A String", # Required. Immutable. The type of custom bidding algorithm.
+  "displayName": "A String", # Required. The display name of the custom bidding algorithm. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "entityStatus": "A String", # Controls whether or not the custom bidding algorithm can be used as a bidding strategy. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED`
+  "modelDetails": [ # Output only. The details of custom bidding models for each advertiser who has access. This field may only include the details of the queried advertiser if the algorithm [`owner`](/display-video/api/reference/rest/v1/customBiddingAlgorithms#CustomBiddingAlgorithm.FIELDS.oneof_owner) is a partner and is being retrieved using an advertiser [`accessor`](/display-video/api/reference/rest/v1/customBiddingAlgorithms/list#body.QUERY_PARAMETERS.oneof_accessor).
+    { # The details of a custom bidding algorithm model for a single shared advertiser.
+      "advertiserId": "A String", # The unique ID of the relevant advertiser.
+      "readinessState": "A String", # The readiness state of custom bidding model.
+      "suspensionState": "A String", # Output only. The suspension state of custom bidding model.
+    },
+  ],
+  "name": "A String", # Output only. The resource name of the custom bidding algorithm.
+  "partnerId": "A String", # Immutable. The unique ID of the partner that owns the custom bidding algorithm.
+  "sharedAdvertiserIds": [ # The IDs of the advertisers who have access to this algorithm. If advertiser_id is set, this field will only consist of that value. This field will not be set if the algorithm [`owner`](/display-video/api/reference/rest/v1/customBiddingAlgorithms#CustomBiddingAlgorithm.FIELDS.oneof_owner) is a partner and is being retrieved using an advertiser [`accessor`](/display-video/api/reference/rest/v1/customBiddingAlgorithms/list#body.QUERY_PARAMETERS.oneof_accessor).
+    "A String",
+  ],
+}
+
+ +
+ uploadRules(customBiddingAlgorithmId, advertiserId=None, partnerId=None, x__xgafv=None) +
Creates a rules reference object for an AlgorithmRules file. The resulting reference object provides a resource path where the AlgorithmRules file should be uploaded. This reference object should be included when creating a new CustomBiddingAlgorithmRules resource.
+
+Args:
+  customBiddingAlgorithmId: string, Required. The ID of the custom bidding algorithm that owns the rules resource. (required)
+  advertiserId: string, The ID of the advertiser that owns the parent custom bidding algorithm.
+  partnerId: string, The ID of the partner that owns the parent custom bidding algorithm.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The reference to the uploaded AlgorithmRules file. Retrieve the location to upload new AlgorithmRules file to using customBiddingAlgorithms.uploadRules.
+  "resourceName": "A String", # A resource name to be used in media.download to download the rules files. Or media.upload to upload the rules files. Resource names have the format `customBiddingAlgorithms/{custom_bidding_algorithm_id}/rulesRef/{ref_id}`.
+}
+
+ +
+ uploadScript(customBiddingAlgorithmId, advertiserId=None, partnerId=None, x__xgafv=None) +
Creates a custom bidding script reference object for a script file. The resulting reference object provides a resource path to which the script file should be uploaded. This reference object should be included in when creating a new custom bidding script object.
+
+Args:
+  customBiddingAlgorithmId: string, Required. The ID of the custom bidding algorithm owns the script. (required)
+  advertiserId: string, The ID of the advertiser that owns the parent custom bidding algorithm.
+  partnerId: string, The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The reference to the uploaded custom bidding script file.
+  "resourceName": "A String", # A resource name to be used in media.download to Download the script files. Or media.upload to Upload the script files. Resource names have the format `customBiddingAlgorithms/{custom_bidding_algorithm_id}/scriptRef/{ref_id}`.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/displayvideo_v4.customBiddingAlgorithms.rules.html b/docs/dyn/displayvideo_v4.customBiddingAlgorithms.rules.html new file mode 100644 index 00000000000..43fab0f30e0 --- /dev/null +++ b/docs/dyn/displayvideo_v4.customBiddingAlgorithms.rules.html @@ -0,0 +1,235 @@ + + + +

Display & Video 360 API . customBiddingAlgorithms . rules

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(customBiddingAlgorithmId, advertiserId=None, body=None, partnerId=None, x__xgafv=None)

+

Creates a new rules resource. Returns the newly created rules resource if successful. *Warning*: Starting **April 1, 2025**, requests updating custom bidding algorithms that are assigned to line items will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).

+

+ get(customBiddingAlgorithmId, customBiddingAlgorithmRulesId, advertiserId=None, partnerId=None, x__xgafv=None)

+

Retrieves a rules resource.

+

+ list(customBiddingAlgorithmId, advertiserId=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None)

+

Lists rules resources that belong to the given algorithm. The order is defined by the order_by parameter.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(customBiddingAlgorithmId, advertiserId=None, body=None, partnerId=None, x__xgafv=None) +
Creates a new rules resource. Returns the newly created rules resource if successful. *Warning*: Starting **April 1, 2025**, requests updating custom bidding algorithms that are assigned to line items will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).
+
+Args:
+  customBiddingAlgorithmId: string, Required. The ID of the custom bidding algorithm that owns the rules resource. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A single custom bidding algorithm rules.
+  "active": True or False, # Output only. Whether the rules resource is currently being used for scoring by the parent algorithm.
+  "createTime": "A String", # Output only. The time when the rules resource was created.
+  "customBiddingAlgorithmId": "A String", # Output only. The unique ID of the custom bidding algorithm that the rules resource belongs to.
+  "customBiddingAlgorithmRulesId": "A String", # Output only. The unique ID of the rules resource.
+  "error": { # An error message for a CustomBiddingAlgorithmRules resource. # Output only. Error code of the rejected rules resource. This field will only be populated when the state is `REJECTED`.
+    "errorCode": "A String", # The type of error.
+  },
+  "name": "A String", # Output only. The resource name of the rules resource.
+  "rules": { # The reference to the uploaded AlgorithmRules file. Retrieve the location to upload new AlgorithmRules file to using customBiddingAlgorithms.uploadRules. # Required. Immutable. The reference to the uploaded AlgorithmRules file.
+    "resourceName": "A String", # A resource name to be used in media.download to download the rules files. Or media.upload to upload the rules files. Resource names have the format `customBiddingAlgorithms/{custom_bidding_algorithm_id}/rulesRef/{ref_id}`.
+  },
+  "state": "A String", # Output only. The state of the rules resource.
+}
+
+  advertiserId: string, The ID of the advertiser that owns the parent custom bidding algorithm.
+  partnerId: string, The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this rules resource.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single custom bidding algorithm rules.
+  "active": True or False, # Output only. Whether the rules resource is currently being used for scoring by the parent algorithm.
+  "createTime": "A String", # Output only. The time when the rules resource was created.
+  "customBiddingAlgorithmId": "A String", # Output only. The unique ID of the custom bidding algorithm that the rules resource belongs to.
+  "customBiddingAlgorithmRulesId": "A String", # Output only. The unique ID of the rules resource.
+  "error": { # An error message for a CustomBiddingAlgorithmRules resource. # Output only. Error code of the rejected rules resource. This field will only be populated when the state is `REJECTED`.
+    "errorCode": "A String", # The type of error.
+  },
+  "name": "A String", # Output only. The resource name of the rules resource.
+  "rules": { # The reference to the uploaded AlgorithmRules file. Retrieve the location to upload new AlgorithmRules file to using customBiddingAlgorithms.uploadRules. # Required. Immutable. The reference to the uploaded AlgorithmRules file.
+    "resourceName": "A String", # A resource name to be used in media.download to download the rules files. Or media.upload to upload the rules files. Resource names have the format `customBiddingAlgorithms/{custom_bidding_algorithm_id}/rulesRef/{ref_id}`.
+  },
+  "state": "A String", # Output only. The state of the rules resource.
+}
+
+ +
+ get(customBiddingAlgorithmId, customBiddingAlgorithmRulesId, advertiserId=None, partnerId=None, x__xgafv=None) +
Retrieves a rules resource.
+
+Args:
+  customBiddingAlgorithmId: string, Required. The ID of the custom bidding algorithm that owns the rules resource. (required)
+  customBiddingAlgorithmRulesId: string, Required. The ID of the rules resource to fetch. (required)
+  advertiserId: string, The ID of the advertiser that owns the parent custom bidding algorithm.
+  partnerId: string, The ID of the partner that owns the parent custom bidding algorithm.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single custom bidding algorithm rules.
+  "active": True or False, # Output only. Whether the rules resource is currently being used for scoring by the parent algorithm.
+  "createTime": "A String", # Output only. The time when the rules resource was created.
+  "customBiddingAlgorithmId": "A String", # Output only. The unique ID of the custom bidding algorithm that the rules resource belongs to.
+  "customBiddingAlgorithmRulesId": "A String", # Output only. The unique ID of the rules resource.
+  "error": { # An error message for a CustomBiddingAlgorithmRules resource. # Output only. Error code of the rejected rules resource. This field will only be populated when the state is `REJECTED`.
+    "errorCode": "A String", # The type of error.
+  },
+  "name": "A String", # Output only. The resource name of the rules resource.
+  "rules": { # The reference to the uploaded AlgorithmRules file. Retrieve the location to upload new AlgorithmRules file to using customBiddingAlgorithms.uploadRules. # Required. Immutable. The reference to the uploaded AlgorithmRules file.
+    "resourceName": "A String", # A resource name to be used in media.download to download the rules files. Or media.upload to upload the rules files. Resource names have the format `customBiddingAlgorithms/{custom_bidding_algorithm_id}/rulesRef/{ref_id}`.
+  },
+  "state": "A String", # Output only. The state of the rules resource.
+}
+
+ +
+ list(customBiddingAlgorithmId, advertiserId=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None) +
Lists rules resources that belong to the given algorithm. The order is defined by the order_by parameter.
+
+Args:
+  customBiddingAlgorithmId: string, Required. The ID of the custom bidding algorithm that owns the rules resource. (required)
+  advertiserId: string, The ID of the advertiser that owns the parent custom bidding algorithm.
+  orderBy: string, Field by which to sort the list. Acceptable values are: * `createTime desc` (default) The default sorting order is descending. To specify ascending order for a field, the suffix "desc" should be removed. Example: `createTime`.
+  pageSize: integer, Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
+  pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCustomBiddingAlgorithmRules` method. If not specified, the first page of results will be returned.
+  partnerId: string, The ID of the partner that owns the parent custom bidding algorithm.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "customBiddingRules": [ # The list of CustomBiddingAlgorithmRules resources. This list will be absent if empty.
+    { # A single custom bidding algorithm rules.
+      "active": True or False, # Output only. Whether the rules resource is currently being used for scoring by the parent algorithm.
+      "createTime": "A String", # Output only. The time when the rules resource was created.
+      "customBiddingAlgorithmId": "A String", # Output only. The unique ID of the custom bidding algorithm that the rules resource belongs to.
+      "customBiddingAlgorithmRulesId": "A String", # Output only. The unique ID of the rules resource.
+      "error": { # An error message for a CustomBiddingAlgorithmRules resource. # Output only. Error code of the rejected rules resource. This field will only be populated when the state is `REJECTED`.
+        "errorCode": "A String", # The type of error.
+      },
+      "name": "A String", # Output only. The resource name of the rules resource.
+      "rules": { # The reference to the uploaded AlgorithmRules file. Retrieve the location to upload new AlgorithmRules file to using customBiddingAlgorithms.uploadRules. # Required. Immutable. The reference to the uploaded AlgorithmRules file.
+        "resourceName": "A String", # A resource name to be used in media.download to download the rules files. Or media.upload to upload the rules files. Resource names have the format `customBiddingAlgorithms/{custom_bidding_algorithm_id}/rulesRef/{ref_id}`.
+      },
+      "state": "A String", # Output only. The state of the rules resource.
+    },
+  ],
+  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListCustomBiddingAlgorithmRulesRequest` method to retrieve the next page of results. If this field is null, it means this is the last page.
+}
+
+ +
+ 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/displayvideo_v4.customBiddingAlgorithms.scripts.html b/docs/dyn/displayvideo_v4.customBiddingAlgorithms.scripts.html new file mode 100644 index 00000000000..49247e33453 --- /dev/null +++ b/docs/dyn/displayvideo_v4.customBiddingAlgorithms.scripts.html @@ -0,0 +1,255 @@ + + + +

Display & Video 360 API . customBiddingAlgorithms . scripts

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(customBiddingAlgorithmId, advertiserId=None, body=None, partnerId=None, x__xgafv=None)

+

Creates a new custom bidding script. Returns the newly created script if successful. *Warning*: Starting **April 1, 2025**, requests updating custom bidding algorithms that are assigned to line items will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).

+

+ get(customBiddingAlgorithmId, customBiddingScriptId, advertiserId=None, partnerId=None, x__xgafv=None)

+

Gets a custom bidding script.

+

+ list(customBiddingAlgorithmId, advertiserId=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None)

+

Lists custom bidding scripts that belong to the given algorithm. The order is defined by the order_by parameter.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(customBiddingAlgorithmId, advertiserId=None, body=None, partnerId=None, x__xgafv=None) +
Creates a new custom bidding script. Returns the newly created script if successful. *Warning*: Starting **April 1, 2025**, requests updating custom bidding algorithms that are assigned to line items will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).
+
+Args:
+  customBiddingAlgorithmId: string, Required. The ID of the custom bidding algorithm that owns the script. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A single custom bidding script.
+  "active": True or False, # Output only. Whether the script is currently being used for scoring by the parent algorithm.
+  "createTime": "A String", # Output only. The time when the script was created.
+  "customBiddingAlgorithmId": "A String", # Output only. The unique ID of the custom bidding algorithm the script belongs to.
+  "customBiddingScriptId": "A String", # Output only. The unique ID of the custom bidding script.
+  "errors": [ # Output only. Error details of a rejected custom bidding script. This field will only be populated when state is REJECTED.
+    { # An error message for a custom bidding script.
+      "column": "A String", # The column number in the script where the error was thrown.
+      "errorCode": "A String", # The type of error.
+      "errorMessage": "A String", # The detailed error message.
+      "line": "A String", # The line number in the script where the error was thrown.
+    },
+  ],
+  "name": "A String", # Output only. The resource name of the custom bidding script.
+  "script": { # The reference to the uploaded custom bidding script file. # The reference to the uploaded script file.
+    "resourceName": "A String", # A resource name to be used in media.download to Download the script files. Or media.upload to Upload the script files. Resource names have the format `customBiddingAlgorithms/{custom_bidding_algorithm_id}/scriptRef/{ref_id}`.
+  },
+  "state": "A String", # Output only. The state of the custom bidding script.
+}
+
+  advertiserId: string, The ID of the advertiser that owns the parent custom bidding algorithm.
+  partnerId: string, The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single custom bidding script.
+  "active": True or False, # Output only. Whether the script is currently being used for scoring by the parent algorithm.
+  "createTime": "A String", # Output only. The time when the script was created.
+  "customBiddingAlgorithmId": "A String", # Output only. The unique ID of the custom bidding algorithm the script belongs to.
+  "customBiddingScriptId": "A String", # Output only. The unique ID of the custom bidding script.
+  "errors": [ # Output only. Error details of a rejected custom bidding script. This field will only be populated when state is REJECTED.
+    { # An error message for a custom bidding script.
+      "column": "A String", # The column number in the script where the error was thrown.
+      "errorCode": "A String", # The type of error.
+      "errorMessage": "A String", # The detailed error message.
+      "line": "A String", # The line number in the script where the error was thrown.
+    },
+  ],
+  "name": "A String", # Output only. The resource name of the custom bidding script.
+  "script": { # The reference to the uploaded custom bidding script file. # The reference to the uploaded script file.
+    "resourceName": "A String", # A resource name to be used in media.download to Download the script files. Or media.upload to Upload the script files. Resource names have the format `customBiddingAlgorithms/{custom_bidding_algorithm_id}/scriptRef/{ref_id}`.
+  },
+  "state": "A String", # Output only. The state of the custom bidding script.
+}
+
+ +
+ get(customBiddingAlgorithmId, customBiddingScriptId, advertiserId=None, partnerId=None, x__xgafv=None) +
Gets a custom bidding script.
+
+Args:
+  customBiddingAlgorithmId: string, Required. The ID of the custom bidding algorithm owns the script. (required)
+  customBiddingScriptId: string, Required. The ID of the custom bidding script to fetch. (required)
+  advertiserId: string, The ID of the advertiser that owns the parent custom bidding algorithm.
+  partnerId: string, The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single custom bidding script.
+  "active": True or False, # Output only. Whether the script is currently being used for scoring by the parent algorithm.
+  "createTime": "A String", # Output only. The time when the script was created.
+  "customBiddingAlgorithmId": "A String", # Output only. The unique ID of the custom bidding algorithm the script belongs to.
+  "customBiddingScriptId": "A String", # Output only. The unique ID of the custom bidding script.
+  "errors": [ # Output only. Error details of a rejected custom bidding script. This field will only be populated when state is REJECTED.
+    { # An error message for a custom bidding script.
+      "column": "A String", # The column number in the script where the error was thrown.
+      "errorCode": "A String", # The type of error.
+      "errorMessage": "A String", # The detailed error message.
+      "line": "A String", # The line number in the script where the error was thrown.
+    },
+  ],
+  "name": "A String", # Output only. The resource name of the custom bidding script.
+  "script": { # The reference to the uploaded custom bidding script file. # The reference to the uploaded script file.
+    "resourceName": "A String", # A resource name to be used in media.download to Download the script files. Or media.upload to Upload the script files. Resource names have the format `customBiddingAlgorithms/{custom_bidding_algorithm_id}/scriptRef/{ref_id}`.
+  },
+  "state": "A String", # Output only. The state of the custom bidding script.
+}
+
+ +
+ list(customBiddingAlgorithmId, advertiserId=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None) +
Lists custom bidding scripts that belong to the given algorithm. The order is defined by the order_by parameter.
+
+Args:
+  customBiddingAlgorithmId: string, Required. The ID of the custom bidding algorithm owns the script. (required)
+  advertiserId: string, The ID of the advertiser that owns the parent custom bidding algorithm.
+  orderBy: string, Field by which to sort the list. Acceptable values are: * `createTime desc` (default) The default sorting order is descending. To specify ascending order for a field, the suffix "desc" should be removed. Example: `createTime`.
+  pageSize: integer, Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
+  pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCustomBiddingScripts` method. If not specified, the first page of results will be returned.
+  partnerId: string, The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "customBiddingScripts": [ # The list of custom bidding scripts. This list will be absent if empty.
+    { # A single custom bidding script.
+      "active": True or False, # Output only. Whether the script is currently being used for scoring by the parent algorithm.
+      "createTime": "A String", # Output only. The time when the script was created.
+      "customBiddingAlgorithmId": "A String", # Output only. The unique ID of the custom bidding algorithm the script belongs to.
+      "customBiddingScriptId": "A String", # Output only. The unique ID of the custom bidding script.
+      "errors": [ # Output only. Error details of a rejected custom bidding script. This field will only be populated when state is REJECTED.
+        { # An error message for a custom bidding script.
+          "column": "A String", # The column number in the script where the error was thrown.
+          "errorCode": "A String", # The type of error.
+          "errorMessage": "A String", # The detailed error message.
+          "line": "A String", # The line number in the script where the error was thrown.
+        },
+      ],
+      "name": "A String", # Output only. The resource name of the custom bidding script.
+      "script": { # The reference to the uploaded custom bidding script file. # The reference to the uploaded script file.
+        "resourceName": "A String", # A resource name to be used in media.download to Download the script files. Or media.upload to Upload the script files. Resource names have the format `customBiddingAlgorithms/{custom_bidding_algorithm_id}/scriptRef/{ref_id}`.
+      },
+      "state": "A String", # Output only. The state of the custom bidding script.
+    },
+  ],
+  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListCustomBiddingScriptsRequest` method to retrieve the next page of results. If this field is null, it means this is the last page.
+}
+
+ +
+ 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/displayvideo_v4.customLists.html b/docs/dyn/displayvideo_v4.customLists.html new file mode 100644 index 00000000000..ce40d8438ee --- /dev/null +++ b/docs/dyn/displayvideo_v4.customLists.html @@ -0,0 +1,161 @@ + + + +

Display & Video 360 API . customLists

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(customListId, advertiserId=None, x__xgafv=None)

+

Gets a custom list.

+

+ list(advertiserId=None, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists custom lists. The order is defined by the order_by parameter.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(customListId, advertiserId=None, x__xgafv=None) +
Gets a custom list.
+
+Args:
+  customListId: string, Required. The ID of the custom list to fetch. (required)
+  advertiserId: string, The ID of the DV360 advertiser that has access to the fetched custom lists.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Describes a custom list entity, such as a custom affinity or custom intent audience list.
+  "customListId": "A String", # Output only. The unique ID of the custom list. Assigned by the system.
+  "displayName": "A String", # Output only. The display name of the custom list. .
+  "name": "A String", # Output only. The resource name of the custom list.
+}
+
+ +
+ list(advertiserId=None, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists custom lists. The order is defined by the order_by parameter.
+
+Args:
+  advertiserId: string, The ID of the DV360 advertiser that has access to the fetched custom lists.
+  filter: string, Allows filtering by custom list fields. Supported syntax: * Filter expressions for custom lists can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All custom lists for which the display name contains "Google": `displayName:"Google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
+  orderBy: string, Field by which to sort the list. Acceptable values are: * `customListId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.
+  pageSize: integer, Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
+  pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCustomLists` method. If not specified, the first page of results 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:
+
+    {
+  "customLists": [ # The list of custom lists. This list will be absent if empty.
+    { # Describes a custom list entity, such as a custom affinity or custom intent audience list.
+      "customListId": "A String", # Output only. The unique ID of the custom list. Assigned by the system.
+      "displayName": "A String", # Output only. The display name of the custom list. .
+      "name": "A String", # Output only. The resource name of the custom list.
+    },
+  ],
+  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListCustomLists` method to retrieve the next page of results.
+}
+
+ +
+ 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/displayvideo_v4.firstPartyAndPartnerAudiences.html b/docs/dyn/displayvideo_v4.firstPartyAndPartnerAudiences.html new file mode 100644 index 00000000000..0b7130a0072 --- /dev/null +++ b/docs/dyn/displayvideo_v4.firstPartyAndPartnerAudiences.html @@ -0,0 +1,586 @@ + + + +

Display & Video 360 API . firstPartyAndPartnerAudiences

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(advertiserId=None, body=None, x__xgafv=None)

+

Creates a FirstPartyAndPartnerAudience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`

+

+ editCustomerMatchMembers(firstPartyAndPartnerAudienceId, body=None, x__xgafv=None)

+

Updates the member list of a Customer Match audience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`

+

+ get(firstPartyAndPartnerAudienceId, advertiserId=None, partnerId=None, x__xgafv=None)

+

Gets a first party or partner audience.

+

+ list(advertiserId=None, filter=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None)

+

Lists first party and partner audiences. The order is defined by the order_by parameter.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(firstPartyAndPartnerAudienceId, advertiserId=None, body=None, updateMask=None, x__xgafv=None)

+

Updates an existing FirstPartyAndPartnerAudience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(advertiserId=None, body=None, x__xgafv=None) +
Creates a FirstPartyAndPartnerAudience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`
+
+Args:
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Describes a first or partner audience list used for targeting. First party audiences are created via usage of client data. Partner audiences are provided by Third Party data providers and can only be licensed to customers.
+  "activeDisplayAudienceSize": "A String", # Output only. The estimated audience size for the Display network in the past month. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only returned in GET request.
+  "appId": "A String", # Optional. The app_id matches with the type of the mobile_device_ids being uploaded. Only applicable to audience_type `CUSTOMER_MATCH_DEVICE_ID`
+  "audienceSource": "A String", # Output only. The source of the audience.
+  "audienceType": "A String", # Output only. The type of the audience.
+  "contactInfoList": { # Wrapper message for a list of contact information defining Customer Match audience members. # Input only. A list of contact information to define the initial audience members. Only applicable to audience_type `CUSTOMER_MATCH_CONTACT_INFO`
+    "consent": { # User consent status. # Input only. The consent setting for the users in contact_infos. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error.
+      "adPersonalization": "A String", # Represents consent for ad personalization.
+      "adUserData": "A String", # Represents consent for ad user data.
+    },
+    "contactInfos": [ # A list of ContactInfo objects defining Customer Match audience members. The size of members after splitting the contact_infos mustn't be greater than 500,000.
+      { # Contact information defining a Customer Match audience member.
+        "countryCode": "A String", # Country code of the member. Must also be set with the following fields: * hashed_first_name * hashed_last_name * zip_codes
+        "hashedEmails": [ # A list of SHA256 hashed email of the member. Before hashing, remove all whitespace and make sure the string is all lowercase.
+          "A String",
+        ],
+        "hashedFirstName": "A String", # SHA256 hashed first name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_last_name * zip_codes
+        "hashedLastName": "A String", # SHA256 hashed last name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_first_name * zip_codes
+        "hashedPhoneNumbers": [ # A list of SHA256 hashed phone numbers of the member. Before hashing, all phone numbers must be formatted using the [E.164 format](//en.wikipedia.org/wiki/E.164) and include the country calling code.
+          "A String",
+        ],
+        "zipCodes": [ # A list of zip codes of the member. Must also be set with the following fields: * country_code * hashed_first_name * hashed_last_name
+          "A String",
+        ],
+      },
+    ],
+  },
+  "description": "A String", # Output only. The user-provided description of the audience. Only applicable to first party audiences.
+  "displayAudienceSize": "A String", # Output only. The estimated audience size for the Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only returned in GET request.
+  "displayDesktopAudienceSize": "A String", # Output only. The estimated desktop audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
+  "displayMobileAppAudienceSize": "A String", # Output only. The estimated mobile app audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
+  "displayMobileWebAudienceSize": "A String", # Output only. The estimated mobile web audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
+  "displayName": "A String", # Output only. The display name of the first party and partner audience.
+  "firstPartyAndPartnerAudienceId": "A String", # Identifier. The unique ID of the first party and partner audience. Assigned by the system.
+  "firstPartyAndPartnerAudienceType": "A String", # Output only. Whether the audience is a first party and partner audience.
+  "gmailAudienceSize": "A String", # Output only. The estimated audience size for Gmail network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
+  "membershipDurationDays": "A String", # Output only. The duration in days that an entry remains in the audience after the qualifying event. If the audience has no expiration, set the value of this field to 10000. Otherwise, the set value must be greater than 0 and less than or equal to 540. Only applicable to first party audiences. This field is required if one of the following audience_type is used: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`
+  "mobileDeviceIdList": { # Wrapper message for a list of mobile device IDs defining Customer Match audience members. # Input only. A list of mobile device IDs to define the initial audience members. Only applicable to audience_type `CUSTOMER_MATCH_DEVICE_ID`
+    "consent": { # User consent status. # Input only. The consent setting for the users in mobile_device_ids. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error.
+      "adPersonalization": "A String", # Represents consent for ad personalization.
+      "adUserData": "A String", # Represents consent for ad user data.
+    },
+    "mobileDeviceIds": [ # A list of mobile device IDs defining Customer Match audience members. The size of mobile_device_ids mustn't be greater than 500,000.
+      "A String",
+    ],
+  },
+  "name": "A String", # Output only. The resource name of the first party and partner audience.
+  "youtubeAudienceSize": "A String", # Output only. The estimated audience size for YouTube network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
+}
+
+  advertiserId: string, Required. The ID of the advertiser under whom the FirstPartyAndPartnerAudience will be created.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Describes a first or partner audience list used for targeting. First party audiences are created via usage of client data. Partner audiences are provided by Third Party data providers and can only be licensed to customers.
+  "activeDisplayAudienceSize": "A String", # Output only. The estimated audience size for the Display network in the past month. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only returned in GET request.
+  "appId": "A String", # Optional. The app_id matches with the type of the mobile_device_ids being uploaded. Only applicable to audience_type `CUSTOMER_MATCH_DEVICE_ID`
+  "audienceSource": "A String", # Output only. The source of the audience.
+  "audienceType": "A String", # Output only. The type of the audience.
+  "contactInfoList": { # Wrapper message for a list of contact information defining Customer Match audience members. # Input only. A list of contact information to define the initial audience members. Only applicable to audience_type `CUSTOMER_MATCH_CONTACT_INFO`
+    "consent": { # User consent status. # Input only. The consent setting for the users in contact_infos. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error.
+      "adPersonalization": "A String", # Represents consent for ad personalization.
+      "adUserData": "A String", # Represents consent for ad user data.
+    },
+    "contactInfos": [ # A list of ContactInfo objects defining Customer Match audience members. The size of members after splitting the contact_infos mustn't be greater than 500,000.
+      { # Contact information defining a Customer Match audience member.
+        "countryCode": "A String", # Country code of the member. Must also be set with the following fields: * hashed_first_name * hashed_last_name * zip_codes
+        "hashedEmails": [ # A list of SHA256 hashed email of the member. Before hashing, remove all whitespace and make sure the string is all lowercase.
+          "A String",
+        ],
+        "hashedFirstName": "A String", # SHA256 hashed first name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_last_name * zip_codes
+        "hashedLastName": "A String", # SHA256 hashed last name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_first_name * zip_codes
+        "hashedPhoneNumbers": [ # A list of SHA256 hashed phone numbers of the member. Before hashing, all phone numbers must be formatted using the [E.164 format](//en.wikipedia.org/wiki/E.164) and include the country calling code.
+          "A String",
+        ],
+        "zipCodes": [ # A list of zip codes of the member. Must also be set with the following fields: * country_code * hashed_first_name * hashed_last_name
+          "A String",
+        ],
+      },
+    ],
+  },
+  "description": "A String", # Output only. The user-provided description of the audience. Only applicable to first party audiences.
+  "displayAudienceSize": "A String", # Output only. The estimated audience size for the Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only returned in GET request.
+  "displayDesktopAudienceSize": "A String", # Output only. The estimated desktop audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
+  "displayMobileAppAudienceSize": "A String", # Output only. The estimated mobile app audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
+  "displayMobileWebAudienceSize": "A String", # Output only. The estimated mobile web audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
+  "displayName": "A String", # Output only. The display name of the first party and partner audience.
+  "firstPartyAndPartnerAudienceId": "A String", # Identifier. The unique ID of the first party and partner audience. Assigned by the system.
+  "firstPartyAndPartnerAudienceType": "A String", # Output only. Whether the audience is a first party and partner audience.
+  "gmailAudienceSize": "A String", # Output only. The estimated audience size for Gmail network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
+  "membershipDurationDays": "A String", # Output only. The duration in days that an entry remains in the audience after the qualifying event. If the audience has no expiration, set the value of this field to 10000. Otherwise, the set value must be greater than 0 and less than or equal to 540. Only applicable to first party audiences. This field is required if one of the following audience_type is used: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`
+  "mobileDeviceIdList": { # Wrapper message for a list of mobile device IDs defining Customer Match audience members. # Input only. A list of mobile device IDs to define the initial audience members. Only applicable to audience_type `CUSTOMER_MATCH_DEVICE_ID`
+    "consent": { # User consent status. # Input only. The consent setting for the users in mobile_device_ids. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error.
+      "adPersonalization": "A String", # Represents consent for ad personalization.
+      "adUserData": "A String", # Represents consent for ad user data.
+    },
+    "mobileDeviceIds": [ # A list of mobile device IDs defining Customer Match audience members. The size of mobile_device_ids mustn't be greater than 500,000.
+      "A String",
+    ],
+  },
+  "name": "A String", # Output only. The resource name of the first party and partner audience.
+  "youtubeAudienceSize": "A String", # Output only. The estimated audience size for YouTube network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
+}
+
+ +
+ editCustomerMatchMembers(firstPartyAndPartnerAudienceId, body=None, x__xgafv=None) +
Updates the member list of a Customer Match audience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`
+
+Args:
+  firstPartyAndPartnerAudienceId: string, Required. The ID of the Customer Match FirstPartyAndPartnerAudience whose members will be edited. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for FirstAndThirdPartyAudienceService.EditCustomerMatchMembers.
+  "addedContactInfoList": { # Wrapper message for a list of contact information defining Customer Match audience members. # Input only. A list of contact information to define the members to be added.
+    "consent": { # User consent status. # Input only. The consent setting for the users in contact_infos. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error.
+      "adPersonalization": "A String", # Represents consent for ad personalization.
+      "adUserData": "A String", # Represents consent for ad user data.
+    },
+    "contactInfos": [ # A list of ContactInfo objects defining Customer Match audience members. The size of members after splitting the contact_infos mustn't be greater than 500,000.
+      { # Contact information defining a Customer Match audience member.
+        "countryCode": "A String", # Country code of the member. Must also be set with the following fields: * hashed_first_name * hashed_last_name * zip_codes
+        "hashedEmails": [ # A list of SHA256 hashed email of the member. Before hashing, remove all whitespace and make sure the string is all lowercase.
+          "A String",
+        ],
+        "hashedFirstName": "A String", # SHA256 hashed first name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_last_name * zip_codes
+        "hashedLastName": "A String", # SHA256 hashed last name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_first_name * zip_codes
+        "hashedPhoneNumbers": [ # A list of SHA256 hashed phone numbers of the member. Before hashing, all phone numbers must be formatted using the [E.164 format](//en.wikipedia.org/wiki/E.164) and include the country calling code.
+          "A String",
+        ],
+        "zipCodes": [ # A list of zip codes of the member. Must also be set with the following fields: * country_code * hashed_first_name * hashed_last_name
+          "A String",
+        ],
+      },
+    ],
+  },
+  "addedMobileDeviceIdList": { # Wrapper message for a list of mobile device IDs defining Customer Match audience members. # Input only. A list of mobile device IDs to define the members to be added.
+    "consent": { # User consent status. # Input only. The consent setting for the users in mobile_device_ids. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error.
+      "adPersonalization": "A String", # Represents consent for ad personalization.
+      "adUserData": "A String", # Represents consent for ad user data.
+    },
+    "mobileDeviceIds": [ # A list of mobile device IDs defining Customer Match audience members. The size of mobile_device_ids mustn't be greater than 500,000.
+      "A String",
+    ],
+  },
+  "advertiserId": "A String", # Required. The ID of the owner advertiser of the updated Customer Match FirstAndThirdPartyAudience.
+  "removedContactInfoList": { # Wrapper message for a list of contact information defining Customer Match audience members. # Input only. A list of contact information to define the members to be removed.
+    "consent": { # User consent status. # Input only. The consent setting for the users in contact_infos. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error.
+      "adPersonalization": "A String", # Represents consent for ad personalization.
+      "adUserData": "A String", # Represents consent for ad user data.
+    },
+    "contactInfos": [ # A list of ContactInfo objects defining Customer Match audience members. The size of members after splitting the contact_infos mustn't be greater than 500,000.
+      { # Contact information defining a Customer Match audience member.
+        "countryCode": "A String", # Country code of the member. Must also be set with the following fields: * hashed_first_name * hashed_last_name * zip_codes
+        "hashedEmails": [ # A list of SHA256 hashed email of the member. Before hashing, remove all whitespace and make sure the string is all lowercase.
+          "A String",
+        ],
+        "hashedFirstName": "A String", # SHA256 hashed first name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_last_name * zip_codes
+        "hashedLastName": "A String", # SHA256 hashed last name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_first_name * zip_codes
+        "hashedPhoneNumbers": [ # A list of SHA256 hashed phone numbers of the member. Before hashing, all phone numbers must be formatted using the [E.164 format](//en.wikipedia.org/wiki/E.164) and include the country calling code.
+          "A String",
+        ],
+        "zipCodes": [ # A list of zip codes of the member. Must also be set with the following fields: * country_code * hashed_first_name * hashed_last_name
+          "A String",
+        ],
+      },
+    ],
+  },
+  "removedMobileDeviceIdList": { # Wrapper message for a list of mobile device IDs defining Customer Match audience members. # Input only. A list of mobile device IDs to define the members to be removed.
+    "consent": { # User consent status. # Input only. The consent setting for the users in mobile_device_ids. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error.
+      "adPersonalization": "A String", # Represents consent for ad personalization.
+      "adUserData": "A String", # Represents consent for ad user data.
+    },
+    "mobileDeviceIds": [ # A list of mobile device IDs defining Customer Match audience members. The size of mobile_device_ids mustn't be greater than 500,000.
+      "A String",
+    ],
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response of FirstAndThirdPartyAudienceService.EditCustomerMatchMembers.
+  "firstPartyAndPartnerAudienceId": "A String", # Required. The ID of the updated Customer Match FirstPartyAndPartnerAudience.
+}
+
+ +
+ get(firstPartyAndPartnerAudienceId, advertiserId=None, partnerId=None, x__xgafv=None) +
Gets a first party or partner audience.
+
+Args:
+  firstPartyAndPartnerAudienceId: string, Required. The ID of the first party and partner audience to fetch. (required)
+  advertiserId: string, The ID of the advertiser that has access to the fetched first party and partner audience.
+  partnerId: string, The ID of the partner that has access to the fetched first party and partner audience.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Describes a first or partner audience list used for targeting. First party audiences are created via usage of client data. Partner audiences are provided by Third Party data providers and can only be licensed to customers.
+  "activeDisplayAudienceSize": "A String", # Output only. The estimated audience size for the Display network in the past month. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only returned in GET request.
+  "appId": "A String", # Optional. The app_id matches with the type of the mobile_device_ids being uploaded. Only applicable to audience_type `CUSTOMER_MATCH_DEVICE_ID`
+  "audienceSource": "A String", # Output only. The source of the audience.
+  "audienceType": "A String", # Output only. The type of the audience.
+  "contactInfoList": { # Wrapper message for a list of contact information defining Customer Match audience members. # Input only. A list of contact information to define the initial audience members. Only applicable to audience_type `CUSTOMER_MATCH_CONTACT_INFO`
+    "consent": { # User consent status. # Input only. The consent setting for the users in contact_infos. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error.
+      "adPersonalization": "A String", # Represents consent for ad personalization.
+      "adUserData": "A String", # Represents consent for ad user data.
+    },
+    "contactInfos": [ # A list of ContactInfo objects defining Customer Match audience members. The size of members after splitting the contact_infos mustn't be greater than 500,000.
+      { # Contact information defining a Customer Match audience member.
+        "countryCode": "A String", # Country code of the member. Must also be set with the following fields: * hashed_first_name * hashed_last_name * zip_codes
+        "hashedEmails": [ # A list of SHA256 hashed email of the member. Before hashing, remove all whitespace and make sure the string is all lowercase.
+          "A String",
+        ],
+        "hashedFirstName": "A String", # SHA256 hashed first name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_last_name * zip_codes
+        "hashedLastName": "A String", # SHA256 hashed last name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_first_name * zip_codes
+        "hashedPhoneNumbers": [ # A list of SHA256 hashed phone numbers of the member. Before hashing, all phone numbers must be formatted using the [E.164 format](//en.wikipedia.org/wiki/E.164) and include the country calling code.
+          "A String",
+        ],
+        "zipCodes": [ # A list of zip codes of the member. Must also be set with the following fields: * country_code * hashed_first_name * hashed_last_name
+          "A String",
+        ],
+      },
+    ],
+  },
+  "description": "A String", # Output only. The user-provided description of the audience. Only applicable to first party audiences.
+  "displayAudienceSize": "A String", # Output only. The estimated audience size for the Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only returned in GET request.
+  "displayDesktopAudienceSize": "A String", # Output only. The estimated desktop audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
+  "displayMobileAppAudienceSize": "A String", # Output only. The estimated mobile app audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
+  "displayMobileWebAudienceSize": "A String", # Output only. The estimated mobile web audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
+  "displayName": "A String", # Output only. The display name of the first party and partner audience.
+  "firstPartyAndPartnerAudienceId": "A String", # Identifier. The unique ID of the first party and partner audience. Assigned by the system.
+  "firstPartyAndPartnerAudienceType": "A String", # Output only. Whether the audience is a first party and partner audience.
+  "gmailAudienceSize": "A String", # Output only. The estimated audience size for Gmail network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
+  "membershipDurationDays": "A String", # Output only. The duration in days that an entry remains in the audience after the qualifying event. If the audience has no expiration, set the value of this field to 10000. Otherwise, the set value must be greater than 0 and less than or equal to 540. Only applicable to first party audiences. This field is required if one of the following audience_type is used: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`
+  "mobileDeviceIdList": { # Wrapper message for a list of mobile device IDs defining Customer Match audience members. # Input only. A list of mobile device IDs to define the initial audience members. Only applicable to audience_type `CUSTOMER_MATCH_DEVICE_ID`
+    "consent": { # User consent status. # Input only. The consent setting for the users in mobile_device_ids. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error.
+      "adPersonalization": "A String", # Represents consent for ad personalization.
+      "adUserData": "A String", # Represents consent for ad user data.
+    },
+    "mobileDeviceIds": [ # A list of mobile device IDs defining Customer Match audience members. The size of mobile_device_ids mustn't be greater than 500,000.
+      "A String",
+    ],
+  },
+  "name": "A String", # Output only. The resource name of the first party and partner audience.
+  "youtubeAudienceSize": "A String", # Output only. The estimated audience size for YouTube network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
+}
+
+ +
+ list(advertiserId=None, filter=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None) +
Lists first party and partner audiences. The order is defined by the order_by parameter.
+
+Args:
+  advertiserId: string, The ID of the advertiser that has access to the fetched first party and partner audiences.
+  filter: string, Optional. Allows filtering by first party and partner audience fields. Supported syntax: * Filter expressions for first party and partner audiences can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All first party and partner audiences for which the display name contains "Google": `displayName:"Google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
+  orderBy: string, Optional. Field by which to sort the list. Acceptable values are: * `FirstPartyAndPartnerAudienceId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.
+  pageSize: integer, Optional. Requested page size. Must be between `1` and `5000`. If unspecified, this value defaults to `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
+  pageToken: string, Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListFirstPartyAndPartnerAudiences` method. If not specified, the first page of results will be returned.
+  partnerId: string, The ID of the partner that has access to the fetched first party and partner audiences.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "firstPartyAndPartnerAudiences": [ # The list of first party and partner audiences. Audience size properties will not be included. This list will be absent if empty.
+    { # Describes a first or partner audience list used for targeting. First party audiences are created via usage of client data. Partner audiences are provided by Third Party data providers and can only be licensed to customers.
+      "activeDisplayAudienceSize": "A String", # Output only. The estimated audience size for the Display network in the past month. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only returned in GET request.
+      "appId": "A String", # Optional. The app_id matches with the type of the mobile_device_ids being uploaded. Only applicable to audience_type `CUSTOMER_MATCH_DEVICE_ID`
+      "audienceSource": "A String", # Output only. The source of the audience.
+      "audienceType": "A String", # Output only. The type of the audience.
+      "contactInfoList": { # Wrapper message for a list of contact information defining Customer Match audience members. # Input only. A list of contact information to define the initial audience members. Only applicable to audience_type `CUSTOMER_MATCH_CONTACT_INFO`
+        "consent": { # User consent status. # Input only. The consent setting for the users in contact_infos. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error.
+          "adPersonalization": "A String", # Represents consent for ad personalization.
+          "adUserData": "A String", # Represents consent for ad user data.
+        },
+        "contactInfos": [ # A list of ContactInfo objects defining Customer Match audience members. The size of members after splitting the contact_infos mustn't be greater than 500,000.
+          { # Contact information defining a Customer Match audience member.
+            "countryCode": "A String", # Country code of the member. Must also be set with the following fields: * hashed_first_name * hashed_last_name * zip_codes
+            "hashedEmails": [ # A list of SHA256 hashed email of the member. Before hashing, remove all whitespace and make sure the string is all lowercase.
+              "A String",
+            ],
+            "hashedFirstName": "A String", # SHA256 hashed first name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_last_name * zip_codes
+            "hashedLastName": "A String", # SHA256 hashed last name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_first_name * zip_codes
+            "hashedPhoneNumbers": [ # A list of SHA256 hashed phone numbers of the member. Before hashing, all phone numbers must be formatted using the [E.164 format](//en.wikipedia.org/wiki/E.164) and include the country calling code.
+              "A String",
+            ],
+            "zipCodes": [ # A list of zip codes of the member. Must also be set with the following fields: * country_code * hashed_first_name * hashed_last_name
+              "A String",
+            ],
+          },
+        ],
+      },
+      "description": "A String", # Output only. The user-provided description of the audience. Only applicable to first party audiences.
+      "displayAudienceSize": "A String", # Output only. The estimated audience size for the Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only returned in GET request.
+      "displayDesktopAudienceSize": "A String", # Output only. The estimated desktop audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
+      "displayMobileAppAudienceSize": "A String", # Output only. The estimated mobile app audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
+      "displayMobileWebAudienceSize": "A String", # Output only. The estimated mobile web audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
+      "displayName": "A String", # Output only. The display name of the first party and partner audience.
+      "firstPartyAndPartnerAudienceId": "A String", # Identifier. The unique ID of the first party and partner audience. Assigned by the system.
+      "firstPartyAndPartnerAudienceType": "A String", # Output only. Whether the audience is a first party and partner audience.
+      "gmailAudienceSize": "A String", # Output only. The estimated audience size for Gmail network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
+      "membershipDurationDays": "A String", # Output only. The duration in days that an entry remains in the audience after the qualifying event. If the audience has no expiration, set the value of this field to 10000. Otherwise, the set value must be greater than 0 and less than or equal to 540. Only applicable to first party audiences. This field is required if one of the following audience_type is used: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`
+      "mobileDeviceIdList": { # Wrapper message for a list of mobile device IDs defining Customer Match audience members. # Input only. A list of mobile device IDs to define the initial audience members. Only applicable to audience_type `CUSTOMER_MATCH_DEVICE_ID`
+        "consent": { # User consent status. # Input only. The consent setting for the users in mobile_device_ids. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error.
+          "adPersonalization": "A String", # Represents consent for ad personalization.
+          "adUserData": "A String", # Represents consent for ad user data.
+        },
+        "mobileDeviceIds": [ # A list of mobile device IDs defining Customer Match audience members. The size of mobile_device_ids mustn't be greater than 500,000.
+          "A String",
+        ],
+      },
+      "name": "A String", # Output only. The resource name of the first party and partner audience.
+      "youtubeAudienceSize": "A String", # Output only. The estimated audience size for YouTube network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
+    },
+  ],
+  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListFirstPartyAndPartnerAudiences` method to retrieve the next page of results.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(firstPartyAndPartnerAudienceId, advertiserId=None, body=None, updateMask=None, x__xgafv=None) +
Updates an existing FirstPartyAndPartnerAudience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`
+
+Args:
+  firstPartyAndPartnerAudienceId: string, Identifier. The unique ID of the first party and partner audience. Assigned by the system. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Describes a first or partner audience list used for targeting. First party audiences are created via usage of client data. Partner audiences are provided by Third Party data providers and can only be licensed to customers.
+  "activeDisplayAudienceSize": "A String", # Output only. The estimated audience size for the Display network in the past month. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only returned in GET request.
+  "appId": "A String", # Optional. The app_id matches with the type of the mobile_device_ids being uploaded. Only applicable to audience_type `CUSTOMER_MATCH_DEVICE_ID`
+  "audienceSource": "A String", # Output only. The source of the audience.
+  "audienceType": "A String", # Output only. The type of the audience.
+  "contactInfoList": { # Wrapper message for a list of contact information defining Customer Match audience members. # Input only. A list of contact information to define the initial audience members. Only applicable to audience_type `CUSTOMER_MATCH_CONTACT_INFO`
+    "consent": { # User consent status. # Input only. The consent setting for the users in contact_infos. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error.
+      "adPersonalization": "A String", # Represents consent for ad personalization.
+      "adUserData": "A String", # Represents consent for ad user data.
+    },
+    "contactInfos": [ # A list of ContactInfo objects defining Customer Match audience members. The size of members after splitting the contact_infos mustn't be greater than 500,000.
+      { # Contact information defining a Customer Match audience member.
+        "countryCode": "A String", # Country code of the member. Must also be set with the following fields: * hashed_first_name * hashed_last_name * zip_codes
+        "hashedEmails": [ # A list of SHA256 hashed email of the member. Before hashing, remove all whitespace and make sure the string is all lowercase.
+          "A String",
+        ],
+        "hashedFirstName": "A String", # SHA256 hashed first name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_last_name * zip_codes
+        "hashedLastName": "A String", # SHA256 hashed last name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_first_name * zip_codes
+        "hashedPhoneNumbers": [ # A list of SHA256 hashed phone numbers of the member. Before hashing, all phone numbers must be formatted using the [E.164 format](//en.wikipedia.org/wiki/E.164) and include the country calling code.
+          "A String",
+        ],
+        "zipCodes": [ # A list of zip codes of the member. Must also be set with the following fields: * country_code * hashed_first_name * hashed_last_name
+          "A String",
+        ],
+      },
+    ],
+  },
+  "description": "A String", # Output only. The user-provided description of the audience. Only applicable to first party audiences.
+  "displayAudienceSize": "A String", # Output only. The estimated audience size for the Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only returned in GET request.
+  "displayDesktopAudienceSize": "A String", # Output only. The estimated desktop audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
+  "displayMobileAppAudienceSize": "A String", # Output only. The estimated mobile app audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
+  "displayMobileWebAudienceSize": "A String", # Output only. The estimated mobile web audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
+  "displayName": "A String", # Output only. The display name of the first party and partner audience.
+  "firstPartyAndPartnerAudienceId": "A String", # Identifier. The unique ID of the first party and partner audience. Assigned by the system.
+  "firstPartyAndPartnerAudienceType": "A String", # Output only. Whether the audience is a first party and partner audience.
+  "gmailAudienceSize": "A String", # Output only. The estimated audience size for Gmail network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
+  "membershipDurationDays": "A String", # Output only. The duration in days that an entry remains in the audience after the qualifying event. If the audience has no expiration, set the value of this field to 10000. Otherwise, the set value must be greater than 0 and less than or equal to 540. Only applicable to first party audiences. This field is required if one of the following audience_type is used: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`
+  "mobileDeviceIdList": { # Wrapper message for a list of mobile device IDs defining Customer Match audience members. # Input only. A list of mobile device IDs to define the initial audience members. Only applicable to audience_type `CUSTOMER_MATCH_DEVICE_ID`
+    "consent": { # User consent status. # Input only. The consent setting for the users in mobile_device_ids. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error.
+      "adPersonalization": "A String", # Represents consent for ad personalization.
+      "adUserData": "A String", # Represents consent for ad user data.
+    },
+    "mobileDeviceIds": [ # A list of mobile device IDs defining Customer Match audience members. The size of mobile_device_ids mustn't be greater than 500,000.
+      "A String",
+    ],
+  },
+  "name": "A String", # Output only. The resource name of the first party and partner audience.
+  "youtubeAudienceSize": "A String", # Output only. The estimated audience size for YouTube network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
+}
+
+  advertiserId: string, Required. The ID of the owner advertiser of the updated FirstPartyAndPartnerAudience.
+  updateMask: string, Required. The mask to control which fields to update. Updates are only supported for the following fields: * `displayName` * `description` * `membershipDurationDays`
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Describes a first or partner audience list used for targeting. First party audiences are created via usage of client data. Partner audiences are provided by Third Party data providers and can only be licensed to customers.
+  "activeDisplayAudienceSize": "A String", # Output only. The estimated audience size for the Display network in the past month. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only returned in GET request.
+  "appId": "A String", # Optional. The app_id matches with the type of the mobile_device_ids being uploaded. Only applicable to audience_type `CUSTOMER_MATCH_DEVICE_ID`
+  "audienceSource": "A String", # Output only. The source of the audience.
+  "audienceType": "A String", # Output only. The type of the audience.
+  "contactInfoList": { # Wrapper message for a list of contact information defining Customer Match audience members. # Input only. A list of contact information to define the initial audience members. Only applicable to audience_type `CUSTOMER_MATCH_CONTACT_INFO`
+    "consent": { # User consent status. # Input only. The consent setting for the users in contact_infos. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error.
+      "adPersonalization": "A String", # Represents consent for ad personalization.
+      "adUserData": "A String", # Represents consent for ad user data.
+    },
+    "contactInfos": [ # A list of ContactInfo objects defining Customer Match audience members. The size of members after splitting the contact_infos mustn't be greater than 500,000.
+      { # Contact information defining a Customer Match audience member.
+        "countryCode": "A String", # Country code of the member. Must also be set with the following fields: * hashed_first_name * hashed_last_name * zip_codes
+        "hashedEmails": [ # A list of SHA256 hashed email of the member. Before hashing, remove all whitespace and make sure the string is all lowercase.
+          "A String",
+        ],
+        "hashedFirstName": "A String", # SHA256 hashed first name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_last_name * zip_codes
+        "hashedLastName": "A String", # SHA256 hashed last name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_first_name * zip_codes
+        "hashedPhoneNumbers": [ # A list of SHA256 hashed phone numbers of the member. Before hashing, all phone numbers must be formatted using the [E.164 format](//en.wikipedia.org/wiki/E.164) and include the country calling code.
+          "A String",
+        ],
+        "zipCodes": [ # A list of zip codes of the member. Must also be set with the following fields: * country_code * hashed_first_name * hashed_last_name
+          "A String",
+        ],
+      },
+    ],
+  },
+  "description": "A String", # Output only. The user-provided description of the audience. Only applicable to first party audiences.
+  "displayAudienceSize": "A String", # Output only. The estimated audience size for the Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only returned in GET request.
+  "displayDesktopAudienceSize": "A String", # Output only. The estimated desktop audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
+  "displayMobileAppAudienceSize": "A String", # Output only. The estimated mobile app audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
+  "displayMobileWebAudienceSize": "A String", # Output only. The estimated mobile web audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
+  "displayName": "A String", # Output only. The display name of the first party and partner audience.
+  "firstPartyAndPartnerAudienceId": "A String", # Identifier. The unique ID of the first party and partner audience. Assigned by the system.
+  "firstPartyAndPartnerAudienceType": "A String", # Output only. Whether the audience is a first party and partner audience.
+  "gmailAudienceSize": "A String", # Output only. The estimated audience size for Gmail network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
+  "membershipDurationDays": "A String", # Output only. The duration in days that an entry remains in the audience after the qualifying event. If the audience has no expiration, set the value of this field to 10000. Otherwise, the set value must be greater than 0 and less than or equal to 540. Only applicable to first party audiences. This field is required if one of the following audience_type is used: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`
+  "mobileDeviceIdList": { # Wrapper message for a list of mobile device IDs defining Customer Match audience members. # Input only. A list of mobile device IDs to define the initial audience members. Only applicable to audience_type `CUSTOMER_MATCH_DEVICE_ID`
+    "consent": { # User consent status. # Input only. The consent setting for the users in mobile_device_ids. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error.
+      "adPersonalization": "A String", # Represents consent for ad personalization.
+      "adUserData": "A String", # Represents consent for ad user data.
+    },
+    "mobileDeviceIds": [ # A list of mobile device IDs defining Customer Match audience members. The size of mobile_device_ids mustn't be greater than 500,000.
+      "A String",
+    ],
+  },
+  "name": "A String", # Output only. The resource name of the first party and partner audience.
+  "youtubeAudienceSize": "A String", # Output only. The estimated audience size for YouTube network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/displayvideo_v4.floodlightGroups.floodlightActivities.html b/docs/dyn/displayvideo_v4.floodlightGroups.floodlightActivities.html new file mode 100644 index 00000000000..5942d439f4b --- /dev/null +++ b/docs/dyn/displayvideo_v4.floodlightGroups.floodlightActivities.html @@ -0,0 +1,186 @@ + + + +

Display & Video 360 API . floodlightGroups . floodlightActivities

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(floodlightGroupId, floodlightActivityId, partnerId=None, x__xgafv=None)

+

Gets a Floodlight activity.

+

+ list(floodlightGroupId, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None)

+

Lists Floodlight activities in a Floodlight group.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(floodlightGroupId, floodlightActivityId, partnerId=None, x__xgafv=None) +
Gets a Floodlight activity.
+
+Args:
+  floodlightGroupId: string, Required. The ID of the parent Floodlight group to which the requested Floodlight activity belongs. (required)
+  floodlightActivityId: string, Required. The ID of the Floodlight activity to fetch. (required)
+  partnerId: string, Required. The ID of the partner through which the Floodlight activity is being accessed.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single Floodlight activity.
+  "advertiserIds": [ # Output only. IDs of the advertisers that have access to the parent Floodlight group. Only advertisers under the provided partner ID will be listed in this field.
+    "A String",
+  ],
+  "displayName": "A String", # Required. The display name of the Floodlight activity.
+  "floodlightActivityId": "A String", # Output only. The unique ID of the Floodlight activity. Assigned by the system.
+  "floodlightGroupId": "A String", # Required. Immutable. The ID of the parent Floodlight group.
+  "name": "A String", # Output only. The resource name of the Floodlight activity.
+  "remarketingConfigs": [ # Output only. A list of configuration objects designating whether remarketing for this Floodlight Activity is enabled and available for a specifc advertiser. If enabled, this Floodlight Activity generates a remarketing user list that is able to be used in targeting under the advertiser.
+    { # Settings that control the whether remarketing is enabled for the given identified advertiser.
+      "advertiserId": "A String", # Output only. The ID of the advertiser.
+      "remarketingEnabled": True or False, # Output only. Whether the Floodlight activity remarketing user list is available to the identified advertiser.
+    },
+  ],
+  "servingStatus": "A String", # Optional. Whether the Floodlight activity is served.
+  "sslRequired": True or False, # Output only. Whether tags are required to be compliant.
+}
+
+ +
+ list(floodlightGroupId, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None) +
Lists Floodlight activities in a Floodlight group.
+
+Args:
+  floodlightGroupId: string, Required. The ID of the parent Floodlight group to which the requested Floodlight activities belong. (required)
+  orderBy: string, Optional. Field by which to sort the list. Acceptable values are: * `displayName` (default) * `floodlightActivityId` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.
+  pageSize: integer, Optional. Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
+  pageToken: string, Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListFloodlightActivities` method. If not specified, the first page of results will be returned.
+  partnerId: string, Required. The ID of the partner through which the Floodlight activities are being accessed.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "floodlightActivities": [ # The list of Floodlight activities. This list will be absent if empty.
+    { # A single Floodlight activity.
+      "advertiserIds": [ # Output only. IDs of the advertisers that have access to the parent Floodlight group. Only advertisers under the provided partner ID will be listed in this field.
+        "A String",
+      ],
+      "displayName": "A String", # Required. The display name of the Floodlight activity.
+      "floodlightActivityId": "A String", # Output only. The unique ID of the Floodlight activity. Assigned by the system.
+      "floodlightGroupId": "A String", # Required. Immutable. The ID of the parent Floodlight group.
+      "name": "A String", # Output only. The resource name of the Floodlight activity.
+      "remarketingConfigs": [ # Output only. A list of configuration objects designating whether remarketing for this Floodlight Activity is enabled and available for a specifc advertiser. If enabled, this Floodlight Activity generates a remarketing user list that is able to be used in targeting under the advertiser.
+        { # Settings that control the whether remarketing is enabled for the given identified advertiser.
+          "advertiserId": "A String", # Output only. The ID of the advertiser.
+          "remarketingEnabled": True or False, # Output only. Whether the Floodlight activity remarketing user list is available to the identified advertiser.
+        },
+      ],
+      "servingStatus": "A String", # Optional. Whether the Floodlight activity is served.
+      "sslRequired": True or False, # Output only. Whether tags are required to be compliant.
+    },
+  ],
+  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListFloodlightActivities` method to retrieve the next page of results.
+}
+
+ +
+ 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/displayvideo_v4.floodlightGroups.html b/docs/dyn/displayvideo_v4.floodlightGroups.html new file mode 100644 index 00000000000..eaa3f283fc4 --- /dev/null +++ b/docs/dyn/displayvideo_v4.floodlightGroups.html @@ -0,0 +1,196 @@ + + + +

Display & Video 360 API . floodlightGroups

+

Instance Methods

+

+ floodlightActivities() +

+

Returns the floodlightActivities Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ get(floodlightGroupId, partnerId=None, x__xgafv=None)

+

Gets a Floodlight group.

+

+ patch(floodlightGroupId, body=None, partnerId=None, updateMask=None, x__xgafv=None)

+

Updates an existing Floodlight group. Returns the updated Floodlight group if successful.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(floodlightGroupId, partnerId=None, x__xgafv=None) +
Gets a Floodlight group.
+
+Args:
+  floodlightGroupId: string, Required. The ID of the Floodlight group to fetch. (required)
+  partnerId: string, Required. The partner context by which the Floodlight group is being accessed.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single Floodlight group.
+  "activeViewConfig": { # Configuration for custom Active View video viewability metrics. # The Active View video viewability metric configuration for the Floodlight group.
+    "displayName": "A String", # Required. The display name of the custom metric.
+    "minimumDuration": "A String", # The minimum visible video duration required (in seconds) in order for an impression to be recorded. You must specify minimum_duration, minimum_quartile or both. If both are specified, an impression meets the metric criteria if either requirement is met (whichever happens first).
+    "minimumQuartile": "A String", # The minimum visible video duration required, based on the video quartiles, in order for an impression to be recorded. You must specify minimum_duration, minimum_quartile or both. If both are specified, an impression meets the metric criteria if either requirement is met (whichever happens first).
+    "minimumViewability": "A String", # Required. The minimum percentage of the video ad's pixels visible on the screen in order for an impression to be recorded.
+    "minimumVolume": "A String", # Required. The minimum percentage of the video ad's volume required in order for an impression to be recorded.
+  },
+  "customVariables": { # User-defined custom variables owned by the Floodlight group. Use custom Floodlight variables to create reporting data that is tailored to your unique business needs. Custom Floodlight variables use the keys `U1=`, `U2=`, and so on, and can take any values that you choose to pass to them. You can use them to track virtually any type of data that you collect about your customers, such as the genre of movie that a customer purchases, the country to which the item is shipped, and so on. Custom Floodlight variables may not be used to pass any data that could be used or recognized as personally identifiable information (PII). Example: `custom_variables { fields { "U1": value { number_value: 123.4 }, "U2": value { string_value: "MyVariable2" }, "U3": value { string_value: "MyVariable3" } } }` Acceptable values for keys are "U1" through "U100", inclusive. String values must be less than 64 characters long, and cannot contain the following characters: `"<>`.
+    "a_key": "", # Properties of the object.
+  },
+  "displayName": "A String", # Required. The display name of the Floodlight group.
+  "floodlightGroupId": "A String", # Output only. The unique ID of the Floodlight group. Assigned by the system.
+  "lookbackWindow": { # Specifies how many days into the past to look when determining whether to record a conversion. # Required. The lookback window for the Floodlight group. Both click_days and impression_days are required. Acceptable values for both are `0` to `90`, inclusive.
+    "clickDays": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads.
+    "impressionDays": 42, # Lookback window, in days, from the last time a given user viewed one of your ads.
+  },
+  "name": "A String", # Output only. The resource name of the Floodlight group.
+  "webTagType": "A String", # Required. The web tag type enabled for the Floodlight group.
+}
+
+ +
+ patch(floodlightGroupId, body=None, partnerId=None, updateMask=None, x__xgafv=None) +
Updates an existing Floodlight group. Returns the updated Floodlight group if successful.
+
+Args:
+  floodlightGroupId: string, Output only. The unique ID of the Floodlight group. Assigned by the system. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A single Floodlight group.
+  "activeViewConfig": { # Configuration for custom Active View video viewability metrics. # The Active View video viewability metric configuration for the Floodlight group.
+    "displayName": "A String", # Required. The display name of the custom metric.
+    "minimumDuration": "A String", # The minimum visible video duration required (in seconds) in order for an impression to be recorded. You must specify minimum_duration, minimum_quartile or both. If both are specified, an impression meets the metric criteria if either requirement is met (whichever happens first).
+    "minimumQuartile": "A String", # The minimum visible video duration required, based on the video quartiles, in order for an impression to be recorded. You must specify minimum_duration, minimum_quartile or both. If both are specified, an impression meets the metric criteria if either requirement is met (whichever happens first).
+    "minimumViewability": "A String", # Required. The minimum percentage of the video ad's pixels visible on the screen in order for an impression to be recorded.
+    "minimumVolume": "A String", # Required. The minimum percentage of the video ad's volume required in order for an impression to be recorded.
+  },
+  "customVariables": { # User-defined custom variables owned by the Floodlight group. Use custom Floodlight variables to create reporting data that is tailored to your unique business needs. Custom Floodlight variables use the keys `U1=`, `U2=`, and so on, and can take any values that you choose to pass to them. You can use them to track virtually any type of data that you collect about your customers, such as the genre of movie that a customer purchases, the country to which the item is shipped, and so on. Custom Floodlight variables may not be used to pass any data that could be used or recognized as personally identifiable information (PII). Example: `custom_variables { fields { "U1": value { number_value: 123.4 }, "U2": value { string_value: "MyVariable2" }, "U3": value { string_value: "MyVariable3" } } }` Acceptable values for keys are "U1" through "U100", inclusive. String values must be less than 64 characters long, and cannot contain the following characters: `"<>`.
+    "a_key": "", # Properties of the object.
+  },
+  "displayName": "A String", # Required. The display name of the Floodlight group.
+  "floodlightGroupId": "A String", # Output only. The unique ID of the Floodlight group. Assigned by the system.
+  "lookbackWindow": { # Specifies how many days into the past to look when determining whether to record a conversion. # Required. The lookback window for the Floodlight group. Both click_days and impression_days are required. Acceptable values for both are `0` to `90`, inclusive.
+    "clickDays": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads.
+    "impressionDays": 42, # Lookback window, in days, from the last time a given user viewed one of your ads.
+  },
+  "name": "A String", # Output only. The resource name of the Floodlight group.
+  "webTagType": "A String", # Required. The web tag type enabled for the Floodlight group.
+}
+
+  partnerId: string, Required. The partner context by which the Floodlight group is being accessed.
+  updateMask: string, Required. The mask to control which fields to update.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single Floodlight group.
+  "activeViewConfig": { # Configuration for custom Active View video viewability metrics. # The Active View video viewability metric configuration for the Floodlight group.
+    "displayName": "A String", # Required. The display name of the custom metric.
+    "minimumDuration": "A String", # The minimum visible video duration required (in seconds) in order for an impression to be recorded. You must specify minimum_duration, minimum_quartile or both. If both are specified, an impression meets the metric criteria if either requirement is met (whichever happens first).
+    "minimumQuartile": "A String", # The minimum visible video duration required, based on the video quartiles, in order for an impression to be recorded. You must specify minimum_duration, minimum_quartile or both. If both are specified, an impression meets the metric criteria if either requirement is met (whichever happens first).
+    "minimumViewability": "A String", # Required. The minimum percentage of the video ad's pixels visible on the screen in order for an impression to be recorded.
+    "minimumVolume": "A String", # Required. The minimum percentage of the video ad's volume required in order for an impression to be recorded.
+  },
+  "customVariables": { # User-defined custom variables owned by the Floodlight group. Use custom Floodlight variables to create reporting data that is tailored to your unique business needs. Custom Floodlight variables use the keys `U1=`, `U2=`, and so on, and can take any values that you choose to pass to them. You can use them to track virtually any type of data that you collect about your customers, such as the genre of movie that a customer purchases, the country to which the item is shipped, and so on. Custom Floodlight variables may not be used to pass any data that could be used or recognized as personally identifiable information (PII). Example: `custom_variables { fields { "U1": value { number_value: 123.4 }, "U2": value { string_value: "MyVariable2" }, "U3": value { string_value: "MyVariable3" } } }` Acceptable values for keys are "U1" through "U100", inclusive. String values must be less than 64 characters long, and cannot contain the following characters: `"<>`.
+    "a_key": "", # Properties of the object.
+  },
+  "displayName": "A String", # Required. The display name of the Floodlight group.
+  "floodlightGroupId": "A String", # Output only. The unique ID of the Floodlight group. Assigned by the system.
+  "lookbackWindow": { # Specifies how many days into the past to look when determining whether to record a conversion. # Required. The lookback window for the Floodlight group. Both click_days and impression_days are required. Acceptable values for both are `0` to `90`, inclusive.
+    "clickDays": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads.
+    "impressionDays": 42, # Lookback window, in days, from the last time a given user viewed one of your ads.
+  },
+  "name": "A String", # Output only. The resource name of the Floodlight group.
+  "webTagType": "A String", # Required. The web tag type enabled for the Floodlight group.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/displayvideo_v4.googleAudiences.html b/docs/dyn/displayvideo_v4.googleAudiences.html new file mode 100644 index 00000000000..ce6dae88c33 --- /dev/null +++ b/docs/dyn/displayvideo_v4.googleAudiences.html @@ -0,0 +1,165 @@ + + + +

Display & Video 360 API . googleAudiences

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(googleAudienceId, advertiserId=None, partnerId=None, x__xgafv=None)

+

Gets a Google audience.

+

+ list(advertiserId=None, filter=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None)

+

Lists Google audiences. The order is defined by the order_by parameter.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(googleAudienceId, advertiserId=None, partnerId=None, x__xgafv=None) +
Gets a Google audience.
+
+Args:
+  googleAudienceId: string, Required. The ID of the Google audience to fetch. (required)
+  advertiserId: string, The ID of the advertiser that has access to the fetched Google audience.
+  partnerId: string, The ID of the partner that has access to the fetched Google audience.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Describes a Google audience resource. Includes Google audience lists.
+  "displayName": "A String", # Output only. The display name of the Google audience. .
+  "googleAudienceId": "A String", # Output only. The unique ID of the Google audience. Assigned by the system.
+  "googleAudienceType": "A String", # Output only. The type of Google audience. .
+  "name": "A String", # Output only. The resource name of the google audience.
+}
+
+ +
+ list(advertiserId=None, filter=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None) +
Lists Google audiences. The order is defined by the order_by parameter.
+
+Args:
+  advertiserId: string, The ID of the advertiser that has access to the fetched Google audiences.
+  filter: string, Allows filtering by Google audience fields. Supported syntax: * Filter expressions for Google audiences can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All Google audiences for which the display name contains "Google": `displayName:"Google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
+  orderBy: string, Field by which to sort the list. Acceptable values are: * `googleAudienceId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.
+  pageSize: integer, Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
+  pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListGoogleAudiences` method. If not specified, the first page of results will be returned.
+  partnerId: string, The ID of the partner that has access to the fetched Google audiences.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "googleAudiences": [ # The list of Google audiences. This list will be absent if empty.
+    { # Describes a Google audience resource. Includes Google audience lists.
+      "displayName": "A String", # Output only. The display name of the Google audience. .
+      "googleAudienceId": "A String", # Output only. The unique ID of the Google audience. Assigned by the system.
+      "googleAudienceType": "A String", # Output only. The type of Google audience. .
+      "name": "A String", # Output only. The resource name of the google audience.
+    },
+  ],
+  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListGoogleAudiences` method to retrieve the next page of results.
+}
+
+ +
+ 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/displayvideo_v4.guaranteedOrders.html b/docs/dyn/displayvideo_v4.guaranteedOrders.html new file mode 100644 index 00000000000..313909e3265 --- /dev/null +++ b/docs/dyn/displayvideo_v4.guaranteedOrders.html @@ -0,0 +1,374 @@ + + + +

Display & Video 360 API . guaranteedOrders

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(advertiserId=None, body=None, partnerId=None, x__xgafv=None)

+

Creates a new guaranteed order. Returns the newly created guaranteed order if successful.

+

+ editGuaranteedOrderReadAccessors(guaranteedOrderId, body=None, x__xgafv=None)

+

Edits read advertisers of a guaranteed order.

+

+ get(guaranteedOrderId, advertiserId=None, partnerId=None, x__xgafv=None)

+

Gets a guaranteed order.

+

+ list(advertiserId=None, filter=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None)

+

Lists guaranteed orders that are accessible to the current user. The order is defined by the order_by parameter. If a filter by entity_status is not specified, guaranteed orders with entity status `ENTITY_STATUS_ARCHIVED` will not be included in the results.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(guaranteedOrderId, advertiserId=None, body=None, partnerId=None, updateMask=None, x__xgafv=None)

+

Updates an existing guaranteed order. Returns the updated guaranteed order if successful.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(advertiserId=None, body=None, partnerId=None, x__xgafv=None) +
Creates a new guaranteed order. Returns the newly created guaranteed order if successful.
+
+Args:
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A guaranteed order. Guaranteed orders are parent entity of guaranteed inventory sources. When creating a guaranteed inventory source, a guaranteed order ID must be assigned to the inventory source.
+  "defaultAdvertiserId": "A String", # Output only. The ID of default advertiser of the guaranteed order. The default advertiser is either the read_write_advertiser_id or, if that is not set, the first advertiser listed in read_advertiser_ids. Otherwise, there is no default advertiser.
+  "defaultCampaignId": "A String", # The ID of the default campaign that is assigned to the guaranteed order. The default campaign must belong to the default advertiser.
+  "displayName": "A String", # Required. The display name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "exchange": "A String", # Required. Immutable. The exchange where the guaranteed order originated.
+  "guaranteedOrderId": "A String", # Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format `{exchange}-{legacy_guaranteed_order_id}`.
+  "legacyGuaranteedOrderId": "A String", # Output only. The legacy ID of the guaranteed order. Assigned by the original exchange. The legacy ID is unique within one exchange, but is not guaranteed to be unique across all guaranteed orders. This ID is used in SDF and UI.
+  "name": "A String", # Output only. The resource name of the guaranteed order.
+  "publisherName": "A String", # Required. The publisher name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "readAccessInherited": True or False, # Whether all advertisers of read_write_partner_id have read access to the guaranteed order. Only applicable if read_write_partner_id is set. If True, overrides read_advertiser_ids.
+  "readAdvertiserIds": [ # The IDs of advertisers with read access to the guaranteed order. This field must not include the advertiser assigned to read_write_advertiser_id if it is set. All advertisers in this field must belong to read_write_partner_id or the same partner as read_write_advertiser_id.
+    "A String",
+  ],
+  "readWriteAdvertiserId": "A String", # The advertiser with read/write access to the guaranteed order. This is also the default advertiser of the guaranteed order.
+  "readWritePartnerId": "A String", # The partner with read/write access to the guaranteed order.
+  "status": { # The status settings of the guaranteed order. # The status settings of the guaranteed order.
+    "configStatus": "A String", # Output only. The configuration status of the guaranteed order. Acceptable values are `PENDING` and `COMPLETED`. A guaranteed order must be configured (fill in the required fields, choose creatives, and select a default campaign) before it can serve. Currently the configuration action can only be performed via UI.
+    "entityPauseReason": "A String", # The user-provided reason for pausing this guaranteed order. Must be UTF-8 encoded with a maximum length of 100 bytes. Only applicable when entity_status is set to `ENTITY_STATUS_PAUSED`.
+    "entityStatus": "A String", # Whether or not the guaranteed order is servable. Acceptable values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. Default value is `ENTITY_STATUS_ACTIVE`.
+  },
+  "updateTime": "A String", # Output only. The timestamp when the guaranteed order was last updated. Assigned by the system.
+}
+
+  advertiserId: string, The ID of the advertiser that the request is being made within.
+  partnerId: string, The ID of the partner that the request is being made within.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A guaranteed order. Guaranteed orders are parent entity of guaranteed inventory sources. When creating a guaranteed inventory source, a guaranteed order ID must be assigned to the inventory source.
+  "defaultAdvertiserId": "A String", # Output only. The ID of default advertiser of the guaranteed order. The default advertiser is either the read_write_advertiser_id or, if that is not set, the first advertiser listed in read_advertiser_ids. Otherwise, there is no default advertiser.
+  "defaultCampaignId": "A String", # The ID of the default campaign that is assigned to the guaranteed order. The default campaign must belong to the default advertiser.
+  "displayName": "A String", # Required. The display name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "exchange": "A String", # Required. Immutable. The exchange where the guaranteed order originated.
+  "guaranteedOrderId": "A String", # Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format `{exchange}-{legacy_guaranteed_order_id}`.
+  "legacyGuaranteedOrderId": "A String", # Output only. The legacy ID of the guaranteed order. Assigned by the original exchange. The legacy ID is unique within one exchange, but is not guaranteed to be unique across all guaranteed orders. This ID is used in SDF and UI.
+  "name": "A String", # Output only. The resource name of the guaranteed order.
+  "publisherName": "A String", # Required. The publisher name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "readAccessInherited": True or False, # Whether all advertisers of read_write_partner_id have read access to the guaranteed order. Only applicable if read_write_partner_id is set. If True, overrides read_advertiser_ids.
+  "readAdvertiserIds": [ # The IDs of advertisers with read access to the guaranteed order. This field must not include the advertiser assigned to read_write_advertiser_id if it is set. All advertisers in this field must belong to read_write_partner_id or the same partner as read_write_advertiser_id.
+    "A String",
+  ],
+  "readWriteAdvertiserId": "A String", # The advertiser with read/write access to the guaranteed order. This is also the default advertiser of the guaranteed order.
+  "readWritePartnerId": "A String", # The partner with read/write access to the guaranteed order.
+  "status": { # The status settings of the guaranteed order. # The status settings of the guaranteed order.
+    "configStatus": "A String", # Output only. The configuration status of the guaranteed order. Acceptable values are `PENDING` and `COMPLETED`. A guaranteed order must be configured (fill in the required fields, choose creatives, and select a default campaign) before it can serve. Currently the configuration action can only be performed via UI.
+    "entityPauseReason": "A String", # The user-provided reason for pausing this guaranteed order. Must be UTF-8 encoded with a maximum length of 100 bytes. Only applicable when entity_status is set to `ENTITY_STATUS_PAUSED`.
+    "entityStatus": "A String", # Whether or not the guaranteed order is servable. Acceptable values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. Default value is `ENTITY_STATUS_ACTIVE`.
+  },
+  "updateTime": "A String", # Output only. The timestamp when the guaranteed order was last updated. Assigned by the system.
+}
+
+ +
+ editGuaranteedOrderReadAccessors(guaranteedOrderId, body=None, x__xgafv=None) +
Edits read advertisers of a guaranteed order.
+
+Args:
+  guaranteedOrderId: string, Required. The ID of the guaranteed order to edit. The ID is of the format `{exchange}-{legacy_guaranteed_order_id}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for GuaranteedOrderService.EditGuaranteedOrderReadAccessors.
+  "addedAdvertisers": [ # The advertisers to add as read accessors to the guaranteed order.
+    "A String",
+  ],
+  "partnerId": "A String", # Required. The partner context in which the change is being made.
+  "readAccessInherited": True or False, # Whether to give all advertisers of the read/write accessor partner read access to the guaranteed order. Only applicable if read_write_partner_id is set in the guaranteed order.
+  "removedAdvertisers": [ # The advertisers to remove as read accessors to the guaranteed order.
+    "A String",
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "readAccessInherited": True or False, # Whether all advertisers of read_write_partner_id have read access to the guaranteed order.
+  "readAdvertiserIds": [ # The IDs of advertisers with read access to the guaranteed order.
+    "A String",
+  ],
+}
+
+ +
+ get(guaranteedOrderId, advertiserId=None, partnerId=None, x__xgafv=None) +
Gets a guaranteed order.
+
+Args:
+  guaranteedOrderId: string, Required. The ID of the guaranteed order to fetch. The ID is of the format `{exchange}-{legacy_guaranteed_order_id}` (required)
+  advertiserId: string, The ID of the advertiser that has access to the guaranteed order.
+  partnerId: string, The ID of the partner that has access to the guaranteed order.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A guaranteed order. Guaranteed orders are parent entity of guaranteed inventory sources. When creating a guaranteed inventory source, a guaranteed order ID must be assigned to the inventory source.
+  "defaultAdvertiserId": "A String", # Output only. The ID of default advertiser of the guaranteed order. The default advertiser is either the read_write_advertiser_id or, if that is not set, the first advertiser listed in read_advertiser_ids. Otherwise, there is no default advertiser.
+  "defaultCampaignId": "A String", # The ID of the default campaign that is assigned to the guaranteed order. The default campaign must belong to the default advertiser.
+  "displayName": "A String", # Required. The display name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "exchange": "A String", # Required. Immutable. The exchange where the guaranteed order originated.
+  "guaranteedOrderId": "A String", # Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format `{exchange}-{legacy_guaranteed_order_id}`.
+  "legacyGuaranteedOrderId": "A String", # Output only. The legacy ID of the guaranteed order. Assigned by the original exchange. The legacy ID is unique within one exchange, but is not guaranteed to be unique across all guaranteed orders. This ID is used in SDF and UI.
+  "name": "A String", # Output only. The resource name of the guaranteed order.
+  "publisherName": "A String", # Required. The publisher name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "readAccessInherited": True or False, # Whether all advertisers of read_write_partner_id have read access to the guaranteed order. Only applicable if read_write_partner_id is set. If True, overrides read_advertiser_ids.
+  "readAdvertiserIds": [ # The IDs of advertisers with read access to the guaranteed order. This field must not include the advertiser assigned to read_write_advertiser_id if it is set. All advertisers in this field must belong to read_write_partner_id or the same partner as read_write_advertiser_id.
+    "A String",
+  ],
+  "readWriteAdvertiserId": "A String", # The advertiser with read/write access to the guaranteed order. This is also the default advertiser of the guaranteed order.
+  "readWritePartnerId": "A String", # The partner with read/write access to the guaranteed order.
+  "status": { # The status settings of the guaranteed order. # The status settings of the guaranteed order.
+    "configStatus": "A String", # Output only. The configuration status of the guaranteed order. Acceptable values are `PENDING` and `COMPLETED`. A guaranteed order must be configured (fill in the required fields, choose creatives, and select a default campaign) before it can serve. Currently the configuration action can only be performed via UI.
+    "entityPauseReason": "A String", # The user-provided reason for pausing this guaranteed order. Must be UTF-8 encoded with a maximum length of 100 bytes. Only applicable when entity_status is set to `ENTITY_STATUS_PAUSED`.
+    "entityStatus": "A String", # Whether or not the guaranteed order is servable. Acceptable values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. Default value is `ENTITY_STATUS_ACTIVE`.
+  },
+  "updateTime": "A String", # Output only. The timestamp when the guaranteed order was last updated. Assigned by the system.
+}
+
+ +
+ list(advertiserId=None, filter=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None) +
Lists guaranteed orders that are accessible to the current user. The order is defined by the order_by parameter. If a filter by entity_status is not specified, guaranteed orders with entity status `ENTITY_STATUS_ARCHIVED` will not be included in the results.
+
+Args:
+  advertiserId: string, The ID of the advertiser that has access to the guaranteed order.
+  filter: string, Allows filtering by guaranteed order fields. * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `guaranteed_order_id` * `exchange` * `display_name` * `status.entityStatus` Examples: * All active guaranteed orders: `status.entityStatus="ENTITY_STATUS_ACTIVE"` * Guaranteed orders belonging to Google Ad Manager or Rubicon exchanges: `exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
+  orderBy: string, Field by which to sort the list. Acceptable values are: * `displayName` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`.
+  pageSize: integer, Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
+  pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListGuaranteedOrders` method. If not specified, the first page of results will be returned.
+  partnerId: string, The ID of the partner that has access to the guaranteed order.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "guaranteedOrders": [ # The list of guaranteed orders. This list will be absent if empty.
+    { # A guaranteed order. Guaranteed orders are parent entity of guaranteed inventory sources. When creating a guaranteed inventory source, a guaranteed order ID must be assigned to the inventory source.
+      "defaultAdvertiserId": "A String", # Output only. The ID of default advertiser of the guaranteed order. The default advertiser is either the read_write_advertiser_id or, if that is not set, the first advertiser listed in read_advertiser_ids. Otherwise, there is no default advertiser.
+      "defaultCampaignId": "A String", # The ID of the default campaign that is assigned to the guaranteed order. The default campaign must belong to the default advertiser.
+      "displayName": "A String", # Required. The display name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes.
+      "exchange": "A String", # Required. Immutable. The exchange where the guaranteed order originated.
+      "guaranteedOrderId": "A String", # Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format `{exchange}-{legacy_guaranteed_order_id}`.
+      "legacyGuaranteedOrderId": "A String", # Output only. The legacy ID of the guaranteed order. Assigned by the original exchange. The legacy ID is unique within one exchange, but is not guaranteed to be unique across all guaranteed orders. This ID is used in SDF and UI.
+      "name": "A String", # Output only. The resource name of the guaranteed order.
+      "publisherName": "A String", # Required. The publisher name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes.
+      "readAccessInherited": True or False, # Whether all advertisers of read_write_partner_id have read access to the guaranteed order. Only applicable if read_write_partner_id is set. If True, overrides read_advertiser_ids.
+      "readAdvertiserIds": [ # The IDs of advertisers with read access to the guaranteed order. This field must not include the advertiser assigned to read_write_advertiser_id if it is set. All advertisers in this field must belong to read_write_partner_id or the same partner as read_write_advertiser_id.
+        "A String",
+      ],
+      "readWriteAdvertiserId": "A String", # The advertiser with read/write access to the guaranteed order. This is also the default advertiser of the guaranteed order.
+      "readWritePartnerId": "A String", # The partner with read/write access to the guaranteed order.
+      "status": { # The status settings of the guaranteed order. # The status settings of the guaranteed order.
+        "configStatus": "A String", # Output only. The configuration status of the guaranteed order. Acceptable values are `PENDING` and `COMPLETED`. A guaranteed order must be configured (fill in the required fields, choose creatives, and select a default campaign) before it can serve. Currently the configuration action can only be performed via UI.
+        "entityPauseReason": "A String", # The user-provided reason for pausing this guaranteed order. Must be UTF-8 encoded with a maximum length of 100 bytes. Only applicable when entity_status is set to `ENTITY_STATUS_PAUSED`.
+        "entityStatus": "A String", # Whether or not the guaranteed order is servable. Acceptable values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. Default value is `ENTITY_STATUS_ACTIVE`.
+      },
+      "updateTime": "A String", # Output only. The timestamp when the guaranteed order was last updated. Assigned by the system.
+    },
+  ],
+  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListGuaranteedOrders` method to retrieve the next page of results.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(guaranteedOrderId, advertiserId=None, body=None, partnerId=None, updateMask=None, x__xgafv=None) +
Updates an existing guaranteed order. Returns the updated guaranteed order if successful.
+
+Args:
+  guaranteedOrderId: string, Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format `{exchange}-{legacy_guaranteed_order_id}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A guaranteed order. Guaranteed orders are parent entity of guaranteed inventory sources. When creating a guaranteed inventory source, a guaranteed order ID must be assigned to the inventory source.
+  "defaultAdvertiserId": "A String", # Output only. The ID of default advertiser of the guaranteed order. The default advertiser is either the read_write_advertiser_id or, if that is not set, the first advertiser listed in read_advertiser_ids. Otherwise, there is no default advertiser.
+  "defaultCampaignId": "A String", # The ID of the default campaign that is assigned to the guaranteed order. The default campaign must belong to the default advertiser.
+  "displayName": "A String", # Required. The display name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "exchange": "A String", # Required. Immutable. The exchange where the guaranteed order originated.
+  "guaranteedOrderId": "A String", # Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format `{exchange}-{legacy_guaranteed_order_id}`.
+  "legacyGuaranteedOrderId": "A String", # Output only. The legacy ID of the guaranteed order. Assigned by the original exchange. The legacy ID is unique within one exchange, but is not guaranteed to be unique across all guaranteed orders. This ID is used in SDF and UI.
+  "name": "A String", # Output only. The resource name of the guaranteed order.
+  "publisherName": "A String", # Required. The publisher name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "readAccessInherited": True or False, # Whether all advertisers of read_write_partner_id have read access to the guaranteed order. Only applicable if read_write_partner_id is set. If True, overrides read_advertiser_ids.
+  "readAdvertiserIds": [ # The IDs of advertisers with read access to the guaranteed order. This field must not include the advertiser assigned to read_write_advertiser_id if it is set. All advertisers in this field must belong to read_write_partner_id or the same partner as read_write_advertiser_id.
+    "A String",
+  ],
+  "readWriteAdvertiserId": "A String", # The advertiser with read/write access to the guaranteed order. This is also the default advertiser of the guaranteed order.
+  "readWritePartnerId": "A String", # The partner with read/write access to the guaranteed order.
+  "status": { # The status settings of the guaranteed order. # The status settings of the guaranteed order.
+    "configStatus": "A String", # Output only. The configuration status of the guaranteed order. Acceptable values are `PENDING` and `COMPLETED`. A guaranteed order must be configured (fill in the required fields, choose creatives, and select a default campaign) before it can serve. Currently the configuration action can only be performed via UI.
+    "entityPauseReason": "A String", # The user-provided reason for pausing this guaranteed order. Must be UTF-8 encoded with a maximum length of 100 bytes. Only applicable when entity_status is set to `ENTITY_STATUS_PAUSED`.
+    "entityStatus": "A String", # Whether or not the guaranteed order is servable. Acceptable values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. Default value is `ENTITY_STATUS_ACTIVE`.
+  },
+  "updateTime": "A String", # Output only. The timestamp when the guaranteed order was last updated. Assigned by the system.
+}
+
+  advertiserId: string, The ID of the advertiser that the request is being made within.
+  partnerId: string, The ID of the partner that the request is being made within.
+  updateMask: string, Required. The mask to control which fields to update.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A guaranteed order. Guaranteed orders are parent entity of guaranteed inventory sources. When creating a guaranteed inventory source, a guaranteed order ID must be assigned to the inventory source.
+  "defaultAdvertiserId": "A String", # Output only. The ID of default advertiser of the guaranteed order. The default advertiser is either the read_write_advertiser_id or, if that is not set, the first advertiser listed in read_advertiser_ids. Otherwise, there is no default advertiser.
+  "defaultCampaignId": "A String", # The ID of the default campaign that is assigned to the guaranteed order. The default campaign must belong to the default advertiser.
+  "displayName": "A String", # Required. The display name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "exchange": "A String", # Required. Immutable. The exchange where the guaranteed order originated.
+  "guaranteedOrderId": "A String", # Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format `{exchange}-{legacy_guaranteed_order_id}`.
+  "legacyGuaranteedOrderId": "A String", # Output only. The legacy ID of the guaranteed order. Assigned by the original exchange. The legacy ID is unique within one exchange, but is not guaranteed to be unique across all guaranteed orders. This ID is used in SDF and UI.
+  "name": "A String", # Output only. The resource name of the guaranteed order.
+  "publisherName": "A String", # Required. The publisher name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "readAccessInherited": True or False, # Whether all advertisers of read_write_partner_id have read access to the guaranteed order. Only applicable if read_write_partner_id is set. If True, overrides read_advertiser_ids.
+  "readAdvertiserIds": [ # The IDs of advertisers with read access to the guaranteed order. This field must not include the advertiser assigned to read_write_advertiser_id if it is set. All advertisers in this field must belong to read_write_partner_id or the same partner as read_write_advertiser_id.
+    "A String",
+  ],
+  "readWriteAdvertiserId": "A String", # The advertiser with read/write access to the guaranteed order. This is also the default advertiser of the guaranteed order.
+  "readWritePartnerId": "A String", # The partner with read/write access to the guaranteed order.
+  "status": { # The status settings of the guaranteed order. # The status settings of the guaranteed order.
+    "configStatus": "A String", # Output only. The configuration status of the guaranteed order. Acceptable values are `PENDING` and `COMPLETED`. A guaranteed order must be configured (fill in the required fields, choose creatives, and select a default campaign) before it can serve. Currently the configuration action can only be performed via UI.
+    "entityPauseReason": "A String", # The user-provided reason for pausing this guaranteed order. Must be UTF-8 encoded with a maximum length of 100 bytes. Only applicable when entity_status is set to `ENTITY_STATUS_PAUSED`.
+    "entityStatus": "A String", # Whether or not the guaranteed order is servable. Acceptable values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. Default value is `ENTITY_STATUS_ACTIVE`.
+  },
+  "updateTime": "A String", # Output only. The timestamp when the guaranteed order was last updated. Assigned by the system.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/displayvideo_v4.html b/docs/dyn/displayvideo_v4.html index bf14e277db8..665812b562a 100644 --- a/docs/dyn/displayvideo_v4.html +++ b/docs/dyn/displayvideo_v4.html @@ -74,11 +74,66 @@

Display & Video 360 API

Instance Methods

+

+ advertisers() +

+

Returns the advertisers Resource.

+ +

+ combinedAudiences() +

+

Returns the combinedAudiences Resource.

+ +

+ customBiddingAlgorithms() +

+

Returns the customBiddingAlgorithms Resource.

+ +

+ customLists() +

+

Returns the customLists Resource.

+ +

+ firstPartyAndPartnerAudiences() +

+

Returns the firstPartyAndPartnerAudiences Resource.

+ +

+ floodlightGroups() +

+

Returns the floodlightGroups Resource.

+ +

+ googleAudiences() +

+

Returns the googleAudiences Resource.

+ +

+ guaranteedOrders() +

+

Returns the guaranteedOrders Resource.

+ +

+ inventorySourceGroups() +

+

Returns the inventorySourceGroups Resource.

+ +

+ inventorySources() +

+

Returns the inventorySources Resource.

+

media()

Returns the media Resource.

+

+ partners() +

+

Returns the partners Resource.

+

sdfdownloadtasks()

@@ -89,6 +144,16 @@

Instance Methods

Returns the sdfuploadtasks Resource.

+

+ targetingTypes() +

+

Returns the targetingTypes Resource.

+ +

+ users() +

+

Returns the users Resource.

+

close()

Close httplib2 connections.

diff --git a/docs/dyn/displayvideo_v4.inventorySourceGroups.assignedInventorySources.html b/docs/dyn/displayvideo_v4.inventorySourceGroups.assignedInventorySources.html new file mode 100644 index 00000000000..99fcf1e86c9 --- /dev/null +++ b/docs/dyn/displayvideo_v4.inventorySourceGroups.assignedInventorySources.html @@ -0,0 +1,243 @@ + + + +

Display & Video 360 API . inventorySourceGroups . assignedInventorySources

+

Instance Methods

+

+ bulkEdit(inventorySourceGroupId, body=None, x__xgafv=None)

+

Bulk edits multiple assignments between inventory sources and a single inventory source group. The operation will delete the assigned inventory sources provided in BulkEditAssignedInventorySourcesRequest.deleted_assigned_inventory_sources and then create the assigned inventory sources provided in BulkEditAssignedInventorySourcesRequest.created_assigned_inventory_sources.

+

+ close()

+

Close httplib2 connections.

+

+ create(inventorySourceGroupId, advertiserId=None, body=None, partnerId=None, x__xgafv=None)

+

Creates an assignment between an inventory source and an inventory source group.

+

+ delete(inventorySourceGroupId, assignedInventorySourceId, advertiserId=None, partnerId=None, x__xgafv=None)

+

Deletes the assignment between an inventory source and an inventory source group.

+

+ list(inventorySourceGroupId, advertiserId=None, filter=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None)

+

Lists inventory sources assigned to an inventory source group.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ bulkEdit(inventorySourceGroupId, body=None, x__xgafv=None) +
Bulk edits multiple assignments between inventory sources and a single inventory source group. The operation will delete the assigned inventory sources provided in BulkEditAssignedInventorySourcesRequest.deleted_assigned_inventory_sources and then create the assigned inventory sources provided in BulkEditAssignedInventorySourcesRequest.created_assigned_inventory_sources.
+
+Args:
+  inventorySourceGroupId: string, Required. The ID of the inventory source group to which the assignments are assigned. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for AssignedInventorySourceService.BulkEdit.
+  "advertiserId": "A String", # The ID of the advertiser that owns the parent inventory source group. The parent partner does not have access to these assigned inventory sources.
+  "createdAssignedInventorySources": [ # The assigned inventory sources to create in bulk, specified as a list of AssignedInventorySources.
+    { # An assignment between a targetable inventory source and an inventory source group.
+      "assignedInventorySourceId": "A String", # Output only. The unique ID of the assigned inventory source. The ID is only unique within a given inventory source group. It may be reused in other contexts.
+      "inventorySourceId": "A String", # Required. The ID of the inventory source entity being targeted.
+      "name": "A String", # Output only. The resource name of the assigned inventory source.
+    },
+  ],
+  "deletedAssignedInventorySources": [ # The IDs of the assigned inventory sources to delete in bulk, specified as a list of assigned_inventory_source_ids.
+    "A String",
+  ],
+  "partnerId": "A String", # The ID of the partner that owns the inventory source group. Only this partner has write access to these assigned inventory sources.
+}
+
+  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 AssignedInventorySourceService.BulkEdit.
+  "assignedInventorySources": [ # The list of assigned inventory sources that have been successfully created. This list will be absent if empty.
+    { # An assignment between a targetable inventory source and an inventory source group.
+      "assignedInventorySourceId": "A String", # Output only. The unique ID of the assigned inventory source. The ID is only unique within a given inventory source group. It may be reused in other contexts.
+      "inventorySourceId": "A String", # Required. The ID of the inventory source entity being targeted.
+      "name": "A String", # Output only. The resource name of the assigned inventory source.
+    },
+  ],
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ create(inventorySourceGroupId, advertiserId=None, body=None, partnerId=None, x__xgafv=None) +
Creates an assignment between an inventory source and an inventory source group.
+
+Args:
+  inventorySourceGroupId: string, Required. The ID of the inventory source group to which the assignment will be assigned. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # An assignment between a targetable inventory source and an inventory source group.
+  "assignedInventorySourceId": "A String", # Output only. The unique ID of the assigned inventory source. The ID is only unique within a given inventory source group. It may be reused in other contexts.
+  "inventorySourceId": "A String", # Required. The ID of the inventory source entity being targeted.
+  "name": "A String", # Output only. The resource name of the assigned inventory source.
+}
+
+  advertiserId: string, The ID of the advertiser that owns the parent inventory source group. The parent partner will not have access to this assigned inventory source.
+  partnerId: string, The ID of the partner that owns the parent inventory source group. Only this partner will have write access to this assigned inventory source.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An assignment between a targetable inventory source and an inventory source group.
+  "assignedInventorySourceId": "A String", # Output only. The unique ID of the assigned inventory source. The ID is only unique within a given inventory source group. It may be reused in other contexts.
+  "inventorySourceId": "A String", # Required. The ID of the inventory source entity being targeted.
+  "name": "A String", # Output only. The resource name of the assigned inventory source.
+}
+
+ +
+ delete(inventorySourceGroupId, assignedInventorySourceId, advertiserId=None, partnerId=None, x__xgafv=None) +
Deletes the assignment between an inventory source and an inventory source group.
+
+Args:
+  inventorySourceGroupId: string, Required. The ID of the inventory source group to which this assignment is assigned. (required)
+  assignedInventorySourceId: string, Required. The ID of the assigned inventory source to delete. (required)
+  advertiserId: string, The ID of the advertiser that owns the parent inventory source group. The parent partner does not have access to this assigned inventory source.
+  partnerId: string, The ID of the partner that owns the parent inventory source group. Only this partner has write access to this assigned inventory source.
+  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); }
+}
+
+ +
+ list(inventorySourceGroupId, advertiserId=None, filter=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None) +
Lists inventory sources assigned to an inventory source group.
+
+Args:
+  inventorySourceGroupId: string, Required. The ID of the inventory source group to which these assignments are assigned. (required)
+  advertiserId: string, The ID of the advertiser that has access to the assignment. If the parent inventory source group is partner-owned, only advertisers to which the parent group is explicitly shared can access the assigned inventory source.
+  filter: string, Allows filtering by assigned inventory source fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedInventorySourceId` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
+  orderBy: string, Field by which to sort the list. Acceptable values are: * `assignedInventorySourceId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `assignedInventorySourceId desc`.
+  pageSize: integer, Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
+  pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAssignedInventorySources` method. If not specified, the first page of results will be returned.
+  partnerId: string, The ID of the partner that has access to the assignment. If the parent inventory source group is advertiser-owned, the assignment cannot be accessed via a partner.
+  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 AssignedInventorySourceService.ListAssignedInventorySources.
+  "assignedInventorySources": [ # The list of assigned inventory sources. This list will be absent if empty.
+    { # An assignment between a targetable inventory source and an inventory source group.
+      "assignedInventorySourceId": "A String", # Output only. The unique ID of the assigned inventory source. The ID is only unique within a given inventory source group. It may be reused in other contexts.
+      "inventorySourceId": "A String", # Required. The ID of the inventory source entity being targeted.
+      "name": "A String", # Output only. The resource name of the assigned inventory source.
+    },
+  ],
+  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListAssignedInventorySources` method to retrieve the next page of results.
+}
+
+ +
+ 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/displayvideo_v4.inventorySourceGroups.html b/docs/dyn/displayvideo_v4.inventorySourceGroups.html new file mode 100644 index 00000000000..fcc3eaee5ca --- /dev/null +++ b/docs/dyn/displayvideo_v4.inventorySourceGroups.html @@ -0,0 +1,261 @@ + + + +

Display & Video 360 API . inventorySourceGroups

+

Instance Methods

+

+ assignedInventorySources() +

+

Returns the assignedInventorySources Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ create(advertiserId=None, body=None, partnerId=None, x__xgafv=None)

+

Creates a new inventory source group. Returns the newly created inventory source group if successful.

+

+ delete(inventorySourceGroupId, advertiserId=None, partnerId=None, x__xgafv=None)

+

Deletes an inventory source group.

+

+ get(inventorySourceGroupId, advertiserId=None, partnerId=None, x__xgafv=None)

+

Gets an inventory source group.

+

+ list(advertiserId=None, filter=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None)

+

Lists inventory source groups that are accessible to the current user. The order is defined by the order_by parameter.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(inventorySourceGroupId, advertiserId=None, body=None, partnerId=None, updateMask=None, x__xgafv=None)

+

Updates an inventory source group. Returns the updated inventory source group if successful.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(advertiserId=None, body=None, partnerId=None, x__xgafv=None) +
Creates a new inventory source group. Returns the newly created inventory source group if successful.
+
+Args:
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A collection of targetable inventory sources.
+  "displayName": "A String", # Required. The display name of the inventory source group. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "inventorySourceGroupId": "A String", # Output only. The unique ID of the inventory source group. Assigned by the system.
+  "name": "A String", # Output only. The resource name of the inventory source group.
+}
+
+  advertiserId: string, The ID of the advertiser that owns the inventory source group. The parent partner will not have access to this group.
+  partnerId: string, The ID of the partner that owns the inventory source group. Only this partner will have write access to this group. Only advertisers to which this group is explicitly shared will have read access to this group.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A collection of targetable inventory sources.
+  "displayName": "A String", # Required. The display name of the inventory source group. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "inventorySourceGroupId": "A String", # Output only. The unique ID of the inventory source group. Assigned by the system.
+  "name": "A String", # Output only. The resource name of the inventory source group.
+}
+
+ +
+ delete(inventorySourceGroupId, advertiserId=None, partnerId=None, x__xgafv=None) +
Deletes an inventory source group.
+
+Args:
+  inventorySourceGroupId: string, Required. The ID of the inventory source group to delete. (required)
+  advertiserId: string, The ID of the advertiser that owns the inventory source group. The parent partner does not have access to this group.
+  partnerId: string, The ID of the partner that owns the inventory source group. Only this partner has write access to this group.
+  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(inventorySourceGroupId, advertiserId=None, partnerId=None, x__xgafv=None) +
Gets an inventory source group.
+
+Args:
+  inventorySourceGroupId: string, Required. The ID of the inventory source group to fetch. (required)
+  advertiserId: string, The ID of the advertiser that has access to the inventory source group. If an inventory source group is partner-owned, only advertisers to which the group is explicitly shared can access the group.
+  partnerId: string, The ID of the partner that has access to the inventory source group. A partner cannot access an advertiser-owned inventory source group.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A collection of targetable inventory sources.
+  "displayName": "A String", # Required. The display name of the inventory source group. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "inventorySourceGroupId": "A String", # Output only. The unique ID of the inventory source group. Assigned by the system.
+  "name": "A String", # Output only. The resource name of the inventory source group.
+}
+
+ +
+ list(advertiserId=None, filter=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None) +
Lists inventory source groups that are accessible to the current user. The order is defined by the order_by parameter.
+
+Args:
+  advertiserId: string, The ID of the advertiser that has access to the inventory source group. If an inventory source group is partner-owned, only advertisers to which the group is explicitly shared can access the group.
+  filter: string, Allows filtering by inventory source group fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `inventorySourceGroupId` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
+  orderBy: string, Field by which to sort the list. Acceptable values are: * `displayName` (default) * `inventorySourceGroupId` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`.
+  pageSize: integer, Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
+  pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInventorySources` method. If not specified, the first page of results will be returned.
+  partnerId: string, The ID of the partner that has access to the inventory source group. A partner cannot access advertiser-owned inventory source groups.
+  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 InventorySourceGroupService.ListInventorySourceGroups.
+  "inventorySourceGroups": [ # The list of inventory source groups. This list will be absent if empty.
+    { # A collection of targetable inventory sources.
+      "displayName": "A String", # Required. The display name of the inventory source group. Must be UTF-8 encoded with a maximum size of 240 bytes.
+      "inventorySourceGroupId": "A String", # Output only. The unique ID of the inventory source group. Assigned by the system.
+      "name": "A String", # Output only. The resource name of the inventory source group.
+    },
+  ],
+  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListInventorySourceGroups` method to retrieve the next page of results.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(inventorySourceGroupId, advertiserId=None, body=None, partnerId=None, updateMask=None, x__xgafv=None) +
Updates an inventory source group. Returns the updated inventory source group if successful.
+
+Args:
+  inventorySourceGroupId: string, Output only. The unique ID of the inventory source group. Assigned by the system. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A collection of targetable inventory sources.
+  "displayName": "A String", # Required. The display name of the inventory source group. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "inventorySourceGroupId": "A String", # Output only. The unique ID of the inventory source group. Assigned by the system.
+  "name": "A String", # Output only. The resource name of the inventory source group.
+}
+
+  advertiserId: string, The ID of the advertiser that owns the inventory source group. The parent partner does not have access to this group.
+  partnerId: string, The ID of the partner that owns the inventory source group. Only this partner has write access to this group.
+  updateMask: string, Required. The mask to control which fields to update.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A collection of targetable inventory sources.
+  "displayName": "A String", # Required. The display name of the inventory source group. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "inventorySourceGroupId": "A String", # Output only. The unique ID of the inventory source group. Assigned by the system.
+  "name": "A String", # Output only. The resource name of the inventory source group.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/displayvideo_v4.inventorySources.html b/docs/dyn/displayvideo_v4.inventorySources.html new file mode 100644 index 00000000000..850b7f64e05 --- /dev/null +++ b/docs/dyn/displayvideo_v4.inventorySources.html @@ -0,0 +1,662 @@ + + + +

Display & Video 360 API . inventorySources

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(advertiserId=None, body=None, partnerId=None, x__xgafv=None)

+

Creates a new inventory source. Returns the newly created inventory source if successful.

+

+ editInventorySourceReadWriteAccessors(inventorySourceId, body=None, x__xgafv=None)

+

Edits read/write accessors of an inventory source. Returns the updated read_write_accessors for the inventory source.

+

+ get(inventorySourceId, advertiserId=None, partnerId=None, x__xgafv=None)

+

Gets an inventory source.

+

+ list(advertiserId=None, filter=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None)

+

Lists inventory sources that are accessible to the current user. The order is defined by the order_by parameter. If a filter by entity_status is not specified, inventory sources with entity status `ENTITY_STATUS_ARCHIVED` will not be included in the results.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(inventorySourceId, advertiserId=None, body=None, partnerId=None, updateMask=None, x__xgafv=None)

+

Updates an existing inventory source. Returns the updated inventory source if successful.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(advertiserId=None, body=None, partnerId=None, x__xgafv=None) +
Creates a new inventory source. Returns the newly created inventory source if successful.
+
+Args:
+  body: object, The request body.
+    The object takes the form of:
+
+{ # An inventory source.
+  "commitment": "A String", # Whether the inventory source has a guaranteed or non-guaranteed delivery.
+  "creativeConfigs": [ # The creative requirements of the inventory source. Not applicable for auction packages.
+    { # Creative requirements configuration for the inventory source.
+      "creativeType": "A String", # The type of creative that can be assigned to the inventory source. Only the following types are supported: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_VIDEO`
+      "displayCreativeConfig": { # The configuration for display creatives. # The configuration for display creatives. Applicable when creative_type is `CREATIVE_TYPE_STANDARD`.
+        "creativeSize": { # Dimensions. # The size requirements for display creatives that can be assigned to the inventory source.
+          "heightPixels": 42, # The height in pixels.
+          "widthPixels": 42, # The width in pixels.
+        },
+      },
+      "videoCreativeConfig": { # The configuration for video creatives. # The configuration for video creatives. Applicable when creative_type is `CREATIVE_TYPE_VIDEO`.
+        "duration": "A String", # The duration requirements for the video creatives that can be assigned to the inventory source.
+      },
+    },
+  ],
+  "dealId": "A String", # The ID in the exchange space that uniquely identifies the inventory source. Must be unique across buyers within each exchange but not necessarily unique across exchanges.
+  "deliveryMethod": "A String", # The delivery method of the inventory source. * For non-guaranteed inventory sources, the only acceptable value is `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`. * For guaranteed inventory sources, acceptable values are `INVENTORY_SOURCE_DELIVERY_METHOD_TAG` and `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`.
+  "displayName": "A String", # The display name of the inventory source. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "exchange": "A String", # The exchange to which the inventory source belongs.
+  "guaranteedOrderId": "A String", # Immutable. The ID of the guaranteed order that this inventory source belongs to. Only applicable when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`.
+  "inventorySourceId": "A String", # Output only. The unique ID of the inventory source. Assigned by the system.
+  "inventorySourceProductType": "A String", # Output only. The product type of the inventory source, denoting the way through which it sells inventory.
+  "inventorySourceType": "A String", # Denotes the type of the inventory source.
+  "name": "A String", # Output only. The resource name of the inventory source.
+  "publisherName": "A String", # The publisher/seller name of the inventory source.
+  "rateDetails": { # The rate related settings of the inventory source. # Required. The rate details of the inventory source.
+    "inventorySourceRateType": "A String", # The rate type. Acceptable values are `INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED`, `INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR`, and `INVENTORY_SOURCE_RATE_TYPE_CPD`.
+    "minimumSpend": { # Represents an amount of money with its currency type. # Output only. The amount that the buyer has committed to spending on the inventory source up front. Only applicable for guaranteed inventory sources.
+      "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+      "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+      "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+    },
+    "rate": { # Represents an amount of money with its currency type. # The rate for the inventory source.
+      "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+      "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+      "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+    },
+    "unitsPurchased": "A String", # Required for guaranteed inventory sources. The number of impressions guaranteed by the seller.
+  },
+  "readAdvertiserIds": [ # Output only. The IDs of advertisers with read-only access to the inventory source.
+    "A String",
+  ],
+  "readPartnerIds": [ # Output only. The IDs of partners with read-only access to the inventory source. All advertisers of partners in this field inherit read-only access to the inventory source.
+    "A String",
+  ],
+  "readWriteAccessors": { # The partner or advertisers with access to the inventory source. # The partner or advertisers that have read/write access to the inventory source. Output only when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`, in which case the read/write accessors are inherited from the parent guaranteed order. Required when commitment is `INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED`. If commitment is `INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED` and a partner is set in this field, all advertisers under this partner will automatically have read-only access to the inventory source. These advertisers will not be included in read_advertiser_ids.
+    "advertisers": { # The advertisers with access to the inventory source. # The advertisers with access to the inventory source. All advertisers must belong to the same partner.
+      "advertiserIds": [ # The IDs of the advertisers.
+        "A String",
+      ],
+    },
+    "partner": { # The partner with access to the inventory source. # The partner with access to the inventory source.
+      "partnerId": "A String", # The ID of the partner.
+    },
+  },
+  "status": { # The status related settings of the inventory source. # The status settings of the inventory source.
+    "configStatus": "A String", # Output only. The configuration status of the inventory source. Only applicable for guaranteed inventory sources. Acceptable values are `INVENTORY_SOURCE_CONFIG_STATUS_PENDING` and `INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED`. An inventory source must be configured (fill in the required fields, choose creatives, and select a default campaign) before it can serve.
+    "entityPauseReason": "A String", # The user-provided reason for pausing this inventory source. Must not exceed 100 characters. Only applicable when entity_status is set to `ENTITY_STATUS_PAUSED`.
+    "entityStatus": "A String", # Whether or not the inventory source is servable. Acceptable values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. Default value is `ENTITY_STATUS_ACTIVE`.
+    "sellerPauseReason": "A String", # Output only. The seller-provided reason for pausing this inventory source. Only applicable for inventory sources synced directly from the publishers and when seller_status is set to `ENTITY_STATUS_PAUSED`.
+    "sellerStatus": "A String", # Output only. The status set by the seller for the inventory source. Only applicable for inventory sources synced directly from the publishers. Acceptable values are `ENTITY_STATUS_ACTIVE` and `ENTITY_STATUS_PAUSED`.
+  },
+  "timeRange": { # A time range. # The time range when this inventory source starts and stops serving.
+    "endTime": "A String", # Required. The upper bound of a time range, inclusive.
+    "startTime": "A String", # Required. The lower bound of a time range, inclusive.
+  },
+  "updateTime": "A String", # Output only. The timestamp when the inventory source was last updated. Assigned by the system.
+}
+
+  advertiserId: string, The ID of the advertiser that the request is being made within.
+  partnerId: string, The ID of the partner that the request is being made within.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An inventory source.
+  "commitment": "A String", # Whether the inventory source has a guaranteed or non-guaranteed delivery.
+  "creativeConfigs": [ # The creative requirements of the inventory source. Not applicable for auction packages.
+    { # Creative requirements configuration for the inventory source.
+      "creativeType": "A String", # The type of creative that can be assigned to the inventory source. Only the following types are supported: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_VIDEO`
+      "displayCreativeConfig": { # The configuration for display creatives. # The configuration for display creatives. Applicable when creative_type is `CREATIVE_TYPE_STANDARD`.
+        "creativeSize": { # Dimensions. # The size requirements for display creatives that can be assigned to the inventory source.
+          "heightPixels": 42, # The height in pixels.
+          "widthPixels": 42, # The width in pixels.
+        },
+      },
+      "videoCreativeConfig": { # The configuration for video creatives. # The configuration for video creatives. Applicable when creative_type is `CREATIVE_TYPE_VIDEO`.
+        "duration": "A String", # The duration requirements for the video creatives that can be assigned to the inventory source.
+      },
+    },
+  ],
+  "dealId": "A String", # The ID in the exchange space that uniquely identifies the inventory source. Must be unique across buyers within each exchange but not necessarily unique across exchanges.
+  "deliveryMethod": "A String", # The delivery method of the inventory source. * For non-guaranteed inventory sources, the only acceptable value is `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`. * For guaranteed inventory sources, acceptable values are `INVENTORY_SOURCE_DELIVERY_METHOD_TAG` and `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`.
+  "displayName": "A String", # The display name of the inventory source. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "exchange": "A String", # The exchange to which the inventory source belongs.
+  "guaranteedOrderId": "A String", # Immutable. The ID of the guaranteed order that this inventory source belongs to. Only applicable when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`.
+  "inventorySourceId": "A String", # Output only. The unique ID of the inventory source. Assigned by the system.
+  "inventorySourceProductType": "A String", # Output only. The product type of the inventory source, denoting the way through which it sells inventory.
+  "inventorySourceType": "A String", # Denotes the type of the inventory source.
+  "name": "A String", # Output only. The resource name of the inventory source.
+  "publisherName": "A String", # The publisher/seller name of the inventory source.
+  "rateDetails": { # The rate related settings of the inventory source. # Required. The rate details of the inventory source.
+    "inventorySourceRateType": "A String", # The rate type. Acceptable values are `INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED`, `INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR`, and `INVENTORY_SOURCE_RATE_TYPE_CPD`.
+    "minimumSpend": { # Represents an amount of money with its currency type. # Output only. The amount that the buyer has committed to spending on the inventory source up front. Only applicable for guaranteed inventory sources.
+      "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+      "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+      "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+    },
+    "rate": { # Represents an amount of money with its currency type. # The rate for the inventory source.
+      "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+      "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+      "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+    },
+    "unitsPurchased": "A String", # Required for guaranteed inventory sources. The number of impressions guaranteed by the seller.
+  },
+  "readAdvertiserIds": [ # Output only. The IDs of advertisers with read-only access to the inventory source.
+    "A String",
+  ],
+  "readPartnerIds": [ # Output only. The IDs of partners with read-only access to the inventory source. All advertisers of partners in this field inherit read-only access to the inventory source.
+    "A String",
+  ],
+  "readWriteAccessors": { # The partner or advertisers with access to the inventory source. # The partner or advertisers that have read/write access to the inventory source. Output only when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`, in which case the read/write accessors are inherited from the parent guaranteed order. Required when commitment is `INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED`. If commitment is `INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED` and a partner is set in this field, all advertisers under this partner will automatically have read-only access to the inventory source. These advertisers will not be included in read_advertiser_ids.
+    "advertisers": { # The advertisers with access to the inventory source. # The advertisers with access to the inventory source. All advertisers must belong to the same partner.
+      "advertiserIds": [ # The IDs of the advertisers.
+        "A String",
+      ],
+    },
+    "partner": { # The partner with access to the inventory source. # The partner with access to the inventory source.
+      "partnerId": "A String", # The ID of the partner.
+    },
+  },
+  "status": { # The status related settings of the inventory source. # The status settings of the inventory source.
+    "configStatus": "A String", # Output only. The configuration status of the inventory source. Only applicable for guaranteed inventory sources. Acceptable values are `INVENTORY_SOURCE_CONFIG_STATUS_PENDING` and `INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED`. An inventory source must be configured (fill in the required fields, choose creatives, and select a default campaign) before it can serve.
+    "entityPauseReason": "A String", # The user-provided reason for pausing this inventory source. Must not exceed 100 characters. Only applicable when entity_status is set to `ENTITY_STATUS_PAUSED`.
+    "entityStatus": "A String", # Whether or not the inventory source is servable. Acceptable values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. Default value is `ENTITY_STATUS_ACTIVE`.
+    "sellerPauseReason": "A String", # Output only. The seller-provided reason for pausing this inventory source. Only applicable for inventory sources synced directly from the publishers and when seller_status is set to `ENTITY_STATUS_PAUSED`.
+    "sellerStatus": "A String", # Output only. The status set by the seller for the inventory source. Only applicable for inventory sources synced directly from the publishers. Acceptable values are `ENTITY_STATUS_ACTIVE` and `ENTITY_STATUS_PAUSED`.
+  },
+  "timeRange": { # A time range. # The time range when this inventory source starts and stops serving.
+    "endTime": "A String", # Required. The upper bound of a time range, inclusive.
+    "startTime": "A String", # Required. The lower bound of a time range, inclusive.
+  },
+  "updateTime": "A String", # Output only. The timestamp when the inventory source was last updated. Assigned by the system.
+}
+
+ +
+ editInventorySourceReadWriteAccessors(inventorySourceId, body=None, x__xgafv=None) +
Edits read/write accessors of an inventory source. Returns the updated read_write_accessors for the inventory source.
+
+Args:
+  inventorySourceId: string, Required. The ID of inventory source to update. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for InventorySourceService.EditInventorySourceReadWriteAccessors.
+  "advertisersUpdate": { # Update to the list of advertisers with read/write access to the inventory source. # The advertisers to add or remove from the list of advertisers that have read/write access to the inventory source. This change will remove an existing partner read/write accessor.
+    "addedAdvertisers": [ # The advertisers to add.
+      "A String",
+    ],
+    "removedAdvertisers": [ # The advertisers to remove.
+      "A String",
+    ],
+  },
+  "assignPartner": True or False, # Set the partner context as read/write accessor of the inventory source. This will remove all other current read/write advertiser accessors.
+  "partnerId": "A String", # Required. The partner context by which the accessors change is being made.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The partner or advertisers with access to the inventory source.
+  "advertisers": { # The advertisers with access to the inventory source. # The advertisers with access to the inventory source. All advertisers must belong to the same partner.
+    "advertiserIds": [ # The IDs of the advertisers.
+      "A String",
+    ],
+  },
+  "partner": { # The partner with access to the inventory source. # The partner with access to the inventory source.
+    "partnerId": "A String", # The ID of the partner.
+  },
+}
+
+ +
+ get(inventorySourceId, advertiserId=None, partnerId=None, x__xgafv=None) +
Gets an inventory source.
+
+Args:
+  inventorySourceId: string, Required. The ID of the inventory source to fetch. (required)
+  advertiserId: string, Optional. The ID of the DV360 advertiser to which the fetched inventory source is permissioned. If the user only has access to the advertiser and not the parent partner, use this field to specify the relevant advertiser.
+  partnerId: string, Required. The ID of the DV360 partner to which the fetched inventory source is permissioned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An inventory source.
+  "commitment": "A String", # Whether the inventory source has a guaranteed or non-guaranteed delivery.
+  "creativeConfigs": [ # The creative requirements of the inventory source. Not applicable for auction packages.
+    { # Creative requirements configuration for the inventory source.
+      "creativeType": "A String", # The type of creative that can be assigned to the inventory source. Only the following types are supported: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_VIDEO`
+      "displayCreativeConfig": { # The configuration for display creatives. # The configuration for display creatives. Applicable when creative_type is `CREATIVE_TYPE_STANDARD`.
+        "creativeSize": { # Dimensions. # The size requirements for display creatives that can be assigned to the inventory source.
+          "heightPixels": 42, # The height in pixels.
+          "widthPixels": 42, # The width in pixels.
+        },
+      },
+      "videoCreativeConfig": { # The configuration for video creatives. # The configuration for video creatives. Applicable when creative_type is `CREATIVE_TYPE_VIDEO`.
+        "duration": "A String", # The duration requirements for the video creatives that can be assigned to the inventory source.
+      },
+    },
+  ],
+  "dealId": "A String", # The ID in the exchange space that uniquely identifies the inventory source. Must be unique across buyers within each exchange but not necessarily unique across exchanges.
+  "deliveryMethod": "A String", # The delivery method of the inventory source. * For non-guaranteed inventory sources, the only acceptable value is `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`. * For guaranteed inventory sources, acceptable values are `INVENTORY_SOURCE_DELIVERY_METHOD_TAG` and `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`.
+  "displayName": "A String", # The display name of the inventory source. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "exchange": "A String", # The exchange to which the inventory source belongs.
+  "guaranteedOrderId": "A String", # Immutable. The ID of the guaranteed order that this inventory source belongs to. Only applicable when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`.
+  "inventorySourceId": "A String", # Output only. The unique ID of the inventory source. Assigned by the system.
+  "inventorySourceProductType": "A String", # Output only. The product type of the inventory source, denoting the way through which it sells inventory.
+  "inventorySourceType": "A String", # Denotes the type of the inventory source.
+  "name": "A String", # Output only. The resource name of the inventory source.
+  "publisherName": "A String", # The publisher/seller name of the inventory source.
+  "rateDetails": { # The rate related settings of the inventory source. # Required. The rate details of the inventory source.
+    "inventorySourceRateType": "A String", # The rate type. Acceptable values are `INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED`, `INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR`, and `INVENTORY_SOURCE_RATE_TYPE_CPD`.
+    "minimumSpend": { # Represents an amount of money with its currency type. # Output only. The amount that the buyer has committed to spending on the inventory source up front. Only applicable for guaranteed inventory sources.
+      "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+      "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+      "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+    },
+    "rate": { # Represents an amount of money with its currency type. # The rate for the inventory source.
+      "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+      "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+      "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+    },
+    "unitsPurchased": "A String", # Required for guaranteed inventory sources. The number of impressions guaranteed by the seller.
+  },
+  "readAdvertiserIds": [ # Output only. The IDs of advertisers with read-only access to the inventory source.
+    "A String",
+  ],
+  "readPartnerIds": [ # Output only. The IDs of partners with read-only access to the inventory source. All advertisers of partners in this field inherit read-only access to the inventory source.
+    "A String",
+  ],
+  "readWriteAccessors": { # The partner or advertisers with access to the inventory source. # The partner or advertisers that have read/write access to the inventory source. Output only when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`, in which case the read/write accessors are inherited from the parent guaranteed order. Required when commitment is `INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED`. If commitment is `INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED` and a partner is set in this field, all advertisers under this partner will automatically have read-only access to the inventory source. These advertisers will not be included in read_advertiser_ids.
+    "advertisers": { # The advertisers with access to the inventory source. # The advertisers with access to the inventory source. All advertisers must belong to the same partner.
+      "advertiserIds": [ # The IDs of the advertisers.
+        "A String",
+      ],
+    },
+    "partner": { # The partner with access to the inventory source. # The partner with access to the inventory source.
+      "partnerId": "A String", # The ID of the partner.
+    },
+  },
+  "status": { # The status related settings of the inventory source. # The status settings of the inventory source.
+    "configStatus": "A String", # Output only. The configuration status of the inventory source. Only applicable for guaranteed inventory sources. Acceptable values are `INVENTORY_SOURCE_CONFIG_STATUS_PENDING` and `INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED`. An inventory source must be configured (fill in the required fields, choose creatives, and select a default campaign) before it can serve.
+    "entityPauseReason": "A String", # The user-provided reason for pausing this inventory source. Must not exceed 100 characters. Only applicable when entity_status is set to `ENTITY_STATUS_PAUSED`.
+    "entityStatus": "A String", # Whether or not the inventory source is servable. Acceptable values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. Default value is `ENTITY_STATUS_ACTIVE`.
+    "sellerPauseReason": "A String", # Output only. The seller-provided reason for pausing this inventory source. Only applicable for inventory sources synced directly from the publishers and when seller_status is set to `ENTITY_STATUS_PAUSED`.
+    "sellerStatus": "A String", # Output only. The status set by the seller for the inventory source. Only applicable for inventory sources synced directly from the publishers. Acceptable values are `ENTITY_STATUS_ACTIVE` and `ENTITY_STATUS_PAUSED`.
+  },
+  "timeRange": { # A time range. # The time range when this inventory source starts and stops serving.
+    "endTime": "A String", # Required. The upper bound of a time range, inclusive.
+    "startTime": "A String", # Required. The lower bound of a time range, inclusive.
+  },
+  "updateTime": "A String", # Output only. The timestamp when the inventory source was last updated. Assigned by the system.
+}
+
+ +
+ list(advertiserId=None, filter=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None) +
Lists inventory sources that are accessible to the current user. The order is defined by the order_by parameter. If a filter by entity_status is not specified, inventory sources with entity status `ENTITY_STATUS_ARCHIVED` will not be included in the results.
+
+Args:
+  advertiserId: string, The ID of the advertiser that has access to the inventory source.
+  filter: string, Allows filtering by inventory source fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `status.entityStatus` * `commitment` * `deliveryMethod` * `rateDetails.rateType` * `exchange` Examples: * All active inventory sources: `status.entityStatus="ENTITY_STATUS_ACTIVE"` * Inventory sources belonging to Google Ad Manager or Rubicon exchanges: `exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
+  orderBy: string, Field by which to sort the list. Acceptable values are: * `displayName` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`.
+  pageSize: integer, Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
+  pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInventorySources` method. If not specified, the first page of results will be returned.
+  partnerId: string, The ID of the partner that has access to the inventory source.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "inventorySources": [ # The list of inventory sources. This list will be absent if empty.
+    { # An inventory source.
+      "commitment": "A String", # Whether the inventory source has a guaranteed or non-guaranteed delivery.
+      "creativeConfigs": [ # The creative requirements of the inventory source. Not applicable for auction packages.
+        { # Creative requirements configuration for the inventory source.
+          "creativeType": "A String", # The type of creative that can be assigned to the inventory source. Only the following types are supported: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_VIDEO`
+          "displayCreativeConfig": { # The configuration for display creatives. # The configuration for display creatives. Applicable when creative_type is `CREATIVE_TYPE_STANDARD`.
+            "creativeSize": { # Dimensions. # The size requirements for display creatives that can be assigned to the inventory source.
+              "heightPixels": 42, # The height in pixels.
+              "widthPixels": 42, # The width in pixels.
+            },
+          },
+          "videoCreativeConfig": { # The configuration for video creatives. # The configuration for video creatives. Applicable when creative_type is `CREATIVE_TYPE_VIDEO`.
+            "duration": "A String", # The duration requirements for the video creatives that can be assigned to the inventory source.
+          },
+        },
+      ],
+      "dealId": "A String", # The ID in the exchange space that uniquely identifies the inventory source. Must be unique across buyers within each exchange but not necessarily unique across exchanges.
+      "deliveryMethod": "A String", # The delivery method of the inventory source. * For non-guaranteed inventory sources, the only acceptable value is `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`. * For guaranteed inventory sources, acceptable values are `INVENTORY_SOURCE_DELIVERY_METHOD_TAG` and `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`.
+      "displayName": "A String", # The display name of the inventory source. Must be UTF-8 encoded with a maximum size of 240 bytes.
+      "exchange": "A String", # The exchange to which the inventory source belongs.
+      "guaranteedOrderId": "A String", # Immutable. The ID of the guaranteed order that this inventory source belongs to. Only applicable when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`.
+      "inventorySourceId": "A String", # Output only. The unique ID of the inventory source. Assigned by the system.
+      "inventorySourceProductType": "A String", # Output only. The product type of the inventory source, denoting the way through which it sells inventory.
+      "inventorySourceType": "A String", # Denotes the type of the inventory source.
+      "name": "A String", # Output only. The resource name of the inventory source.
+      "publisherName": "A String", # The publisher/seller name of the inventory source.
+      "rateDetails": { # The rate related settings of the inventory source. # Required. The rate details of the inventory source.
+        "inventorySourceRateType": "A String", # The rate type. Acceptable values are `INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED`, `INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR`, and `INVENTORY_SOURCE_RATE_TYPE_CPD`.
+        "minimumSpend": { # Represents an amount of money with its currency type. # Output only. The amount that the buyer has committed to spending on the inventory source up front. Only applicable for guaranteed inventory sources.
+          "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+          "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+          "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+        },
+        "rate": { # Represents an amount of money with its currency type. # The rate for the inventory source.
+          "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+          "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+          "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+        },
+        "unitsPurchased": "A String", # Required for guaranteed inventory sources. The number of impressions guaranteed by the seller.
+      },
+      "readAdvertiserIds": [ # Output only. The IDs of advertisers with read-only access to the inventory source.
+        "A String",
+      ],
+      "readPartnerIds": [ # Output only. The IDs of partners with read-only access to the inventory source. All advertisers of partners in this field inherit read-only access to the inventory source.
+        "A String",
+      ],
+      "readWriteAccessors": { # The partner or advertisers with access to the inventory source. # The partner or advertisers that have read/write access to the inventory source. Output only when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`, in which case the read/write accessors are inherited from the parent guaranteed order. Required when commitment is `INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED`. If commitment is `INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED` and a partner is set in this field, all advertisers under this partner will automatically have read-only access to the inventory source. These advertisers will not be included in read_advertiser_ids.
+        "advertisers": { # The advertisers with access to the inventory source. # The advertisers with access to the inventory source. All advertisers must belong to the same partner.
+          "advertiserIds": [ # The IDs of the advertisers.
+            "A String",
+          ],
+        },
+        "partner": { # The partner with access to the inventory source. # The partner with access to the inventory source.
+          "partnerId": "A String", # The ID of the partner.
+        },
+      },
+      "status": { # The status related settings of the inventory source. # The status settings of the inventory source.
+        "configStatus": "A String", # Output only. The configuration status of the inventory source. Only applicable for guaranteed inventory sources. Acceptable values are `INVENTORY_SOURCE_CONFIG_STATUS_PENDING` and `INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED`. An inventory source must be configured (fill in the required fields, choose creatives, and select a default campaign) before it can serve.
+        "entityPauseReason": "A String", # The user-provided reason for pausing this inventory source. Must not exceed 100 characters. Only applicable when entity_status is set to `ENTITY_STATUS_PAUSED`.
+        "entityStatus": "A String", # Whether or not the inventory source is servable. Acceptable values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. Default value is `ENTITY_STATUS_ACTIVE`.
+        "sellerPauseReason": "A String", # Output only. The seller-provided reason for pausing this inventory source. Only applicable for inventory sources synced directly from the publishers and when seller_status is set to `ENTITY_STATUS_PAUSED`.
+        "sellerStatus": "A String", # Output only. The status set by the seller for the inventory source. Only applicable for inventory sources synced directly from the publishers. Acceptable values are `ENTITY_STATUS_ACTIVE` and `ENTITY_STATUS_PAUSED`.
+      },
+      "timeRange": { # A time range. # The time range when this inventory source starts and stops serving.
+        "endTime": "A String", # Required. The upper bound of a time range, inclusive.
+        "startTime": "A String", # Required. The lower bound of a time range, inclusive.
+      },
+      "updateTime": "A String", # Output only. The timestamp when the inventory source was last updated. Assigned by the system.
+    },
+  ],
+  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListInventorySources` method to retrieve the next page of results.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(inventorySourceId, advertiserId=None, body=None, partnerId=None, updateMask=None, x__xgafv=None) +
Updates an existing inventory source. Returns the updated inventory source if successful.
+
+Args:
+  inventorySourceId: string, Output only. The unique ID of the inventory source. Assigned by the system. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # An inventory source.
+  "commitment": "A String", # Whether the inventory source has a guaranteed or non-guaranteed delivery.
+  "creativeConfigs": [ # The creative requirements of the inventory source. Not applicable for auction packages.
+    { # Creative requirements configuration for the inventory source.
+      "creativeType": "A String", # The type of creative that can be assigned to the inventory source. Only the following types are supported: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_VIDEO`
+      "displayCreativeConfig": { # The configuration for display creatives. # The configuration for display creatives. Applicable when creative_type is `CREATIVE_TYPE_STANDARD`.
+        "creativeSize": { # Dimensions. # The size requirements for display creatives that can be assigned to the inventory source.
+          "heightPixels": 42, # The height in pixels.
+          "widthPixels": 42, # The width in pixels.
+        },
+      },
+      "videoCreativeConfig": { # The configuration for video creatives. # The configuration for video creatives. Applicable when creative_type is `CREATIVE_TYPE_VIDEO`.
+        "duration": "A String", # The duration requirements for the video creatives that can be assigned to the inventory source.
+      },
+    },
+  ],
+  "dealId": "A String", # The ID in the exchange space that uniquely identifies the inventory source. Must be unique across buyers within each exchange but not necessarily unique across exchanges.
+  "deliveryMethod": "A String", # The delivery method of the inventory source. * For non-guaranteed inventory sources, the only acceptable value is `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`. * For guaranteed inventory sources, acceptable values are `INVENTORY_SOURCE_DELIVERY_METHOD_TAG` and `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`.
+  "displayName": "A String", # The display name of the inventory source. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "exchange": "A String", # The exchange to which the inventory source belongs.
+  "guaranteedOrderId": "A String", # Immutable. The ID of the guaranteed order that this inventory source belongs to. Only applicable when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`.
+  "inventorySourceId": "A String", # Output only. The unique ID of the inventory source. Assigned by the system.
+  "inventorySourceProductType": "A String", # Output only. The product type of the inventory source, denoting the way through which it sells inventory.
+  "inventorySourceType": "A String", # Denotes the type of the inventory source.
+  "name": "A String", # Output only. The resource name of the inventory source.
+  "publisherName": "A String", # The publisher/seller name of the inventory source.
+  "rateDetails": { # The rate related settings of the inventory source. # Required. The rate details of the inventory source.
+    "inventorySourceRateType": "A String", # The rate type. Acceptable values are `INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED`, `INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR`, and `INVENTORY_SOURCE_RATE_TYPE_CPD`.
+    "minimumSpend": { # Represents an amount of money with its currency type. # Output only. The amount that the buyer has committed to spending on the inventory source up front. Only applicable for guaranteed inventory sources.
+      "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+      "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+      "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+    },
+    "rate": { # Represents an amount of money with its currency type. # The rate for the inventory source.
+      "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+      "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+      "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+    },
+    "unitsPurchased": "A String", # Required for guaranteed inventory sources. The number of impressions guaranteed by the seller.
+  },
+  "readAdvertiserIds": [ # Output only. The IDs of advertisers with read-only access to the inventory source.
+    "A String",
+  ],
+  "readPartnerIds": [ # Output only. The IDs of partners with read-only access to the inventory source. All advertisers of partners in this field inherit read-only access to the inventory source.
+    "A String",
+  ],
+  "readWriteAccessors": { # The partner or advertisers with access to the inventory source. # The partner or advertisers that have read/write access to the inventory source. Output only when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`, in which case the read/write accessors are inherited from the parent guaranteed order. Required when commitment is `INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED`. If commitment is `INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED` and a partner is set in this field, all advertisers under this partner will automatically have read-only access to the inventory source. These advertisers will not be included in read_advertiser_ids.
+    "advertisers": { # The advertisers with access to the inventory source. # The advertisers with access to the inventory source. All advertisers must belong to the same partner.
+      "advertiserIds": [ # The IDs of the advertisers.
+        "A String",
+      ],
+    },
+    "partner": { # The partner with access to the inventory source. # The partner with access to the inventory source.
+      "partnerId": "A String", # The ID of the partner.
+    },
+  },
+  "status": { # The status related settings of the inventory source. # The status settings of the inventory source.
+    "configStatus": "A String", # Output only. The configuration status of the inventory source. Only applicable for guaranteed inventory sources. Acceptable values are `INVENTORY_SOURCE_CONFIG_STATUS_PENDING` and `INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED`. An inventory source must be configured (fill in the required fields, choose creatives, and select a default campaign) before it can serve.
+    "entityPauseReason": "A String", # The user-provided reason for pausing this inventory source. Must not exceed 100 characters. Only applicable when entity_status is set to `ENTITY_STATUS_PAUSED`.
+    "entityStatus": "A String", # Whether or not the inventory source is servable. Acceptable values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. Default value is `ENTITY_STATUS_ACTIVE`.
+    "sellerPauseReason": "A String", # Output only. The seller-provided reason for pausing this inventory source. Only applicable for inventory sources synced directly from the publishers and when seller_status is set to `ENTITY_STATUS_PAUSED`.
+    "sellerStatus": "A String", # Output only. The status set by the seller for the inventory source. Only applicable for inventory sources synced directly from the publishers. Acceptable values are `ENTITY_STATUS_ACTIVE` and `ENTITY_STATUS_PAUSED`.
+  },
+  "timeRange": { # A time range. # The time range when this inventory source starts and stops serving.
+    "endTime": "A String", # Required. The upper bound of a time range, inclusive.
+    "startTime": "A String", # Required. The lower bound of a time range, inclusive.
+  },
+  "updateTime": "A String", # Output only. The timestamp when the inventory source was last updated. Assigned by the system.
+}
+
+  advertiserId: string, The ID of the advertiser that the request is being made within.
+  partnerId: string, The ID of the partner that the request is being made within.
+  updateMask: string, Required. The mask to control which fields to update.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An inventory source.
+  "commitment": "A String", # Whether the inventory source has a guaranteed or non-guaranteed delivery.
+  "creativeConfigs": [ # The creative requirements of the inventory source. Not applicable for auction packages.
+    { # Creative requirements configuration for the inventory source.
+      "creativeType": "A String", # The type of creative that can be assigned to the inventory source. Only the following types are supported: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_VIDEO`
+      "displayCreativeConfig": { # The configuration for display creatives. # The configuration for display creatives. Applicable when creative_type is `CREATIVE_TYPE_STANDARD`.
+        "creativeSize": { # Dimensions. # The size requirements for display creatives that can be assigned to the inventory source.
+          "heightPixels": 42, # The height in pixels.
+          "widthPixels": 42, # The width in pixels.
+        },
+      },
+      "videoCreativeConfig": { # The configuration for video creatives. # The configuration for video creatives. Applicable when creative_type is `CREATIVE_TYPE_VIDEO`.
+        "duration": "A String", # The duration requirements for the video creatives that can be assigned to the inventory source.
+      },
+    },
+  ],
+  "dealId": "A String", # The ID in the exchange space that uniquely identifies the inventory source. Must be unique across buyers within each exchange but not necessarily unique across exchanges.
+  "deliveryMethod": "A String", # The delivery method of the inventory source. * For non-guaranteed inventory sources, the only acceptable value is `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`. * For guaranteed inventory sources, acceptable values are `INVENTORY_SOURCE_DELIVERY_METHOD_TAG` and `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`.
+  "displayName": "A String", # The display name of the inventory source. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "exchange": "A String", # The exchange to which the inventory source belongs.
+  "guaranteedOrderId": "A String", # Immutable. The ID of the guaranteed order that this inventory source belongs to. Only applicable when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`.
+  "inventorySourceId": "A String", # Output only. The unique ID of the inventory source. Assigned by the system.
+  "inventorySourceProductType": "A String", # Output only. The product type of the inventory source, denoting the way through which it sells inventory.
+  "inventorySourceType": "A String", # Denotes the type of the inventory source.
+  "name": "A String", # Output only. The resource name of the inventory source.
+  "publisherName": "A String", # The publisher/seller name of the inventory source.
+  "rateDetails": { # The rate related settings of the inventory source. # Required. The rate details of the inventory source.
+    "inventorySourceRateType": "A String", # The rate type. Acceptable values are `INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED`, `INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR`, and `INVENTORY_SOURCE_RATE_TYPE_CPD`.
+    "minimumSpend": { # Represents an amount of money with its currency type. # Output only. The amount that the buyer has committed to spending on the inventory source up front. Only applicable for guaranteed inventory sources.
+      "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+      "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+      "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+    },
+    "rate": { # Represents an amount of money with its currency type. # The rate for the inventory source.
+      "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+      "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+      "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+    },
+    "unitsPurchased": "A String", # Required for guaranteed inventory sources. The number of impressions guaranteed by the seller.
+  },
+  "readAdvertiserIds": [ # Output only. The IDs of advertisers with read-only access to the inventory source.
+    "A String",
+  ],
+  "readPartnerIds": [ # Output only. The IDs of partners with read-only access to the inventory source. All advertisers of partners in this field inherit read-only access to the inventory source.
+    "A String",
+  ],
+  "readWriteAccessors": { # The partner or advertisers with access to the inventory source. # The partner or advertisers that have read/write access to the inventory source. Output only when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`, in which case the read/write accessors are inherited from the parent guaranteed order. Required when commitment is `INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED`. If commitment is `INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED` and a partner is set in this field, all advertisers under this partner will automatically have read-only access to the inventory source. These advertisers will not be included in read_advertiser_ids.
+    "advertisers": { # The advertisers with access to the inventory source. # The advertisers with access to the inventory source. All advertisers must belong to the same partner.
+      "advertiserIds": [ # The IDs of the advertisers.
+        "A String",
+      ],
+    },
+    "partner": { # The partner with access to the inventory source. # The partner with access to the inventory source.
+      "partnerId": "A String", # The ID of the partner.
+    },
+  },
+  "status": { # The status related settings of the inventory source. # The status settings of the inventory source.
+    "configStatus": "A String", # Output only. The configuration status of the inventory source. Only applicable for guaranteed inventory sources. Acceptable values are `INVENTORY_SOURCE_CONFIG_STATUS_PENDING` and `INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED`. An inventory source must be configured (fill in the required fields, choose creatives, and select a default campaign) before it can serve.
+    "entityPauseReason": "A String", # The user-provided reason for pausing this inventory source. Must not exceed 100 characters. Only applicable when entity_status is set to `ENTITY_STATUS_PAUSED`.
+    "entityStatus": "A String", # Whether or not the inventory source is servable. Acceptable values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. Default value is `ENTITY_STATUS_ACTIVE`.
+    "sellerPauseReason": "A String", # Output only. The seller-provided reason for pausing this inventory source. Only applicable for inventory sources synced directly from the publishers and when seller_status is set to `ENTITY_STATUS_PAUSED`.
+    "sellerStatus": "A String", # Output only. The status set by the seller for the inventory source. Only applicable for inventory sources synced directly from the publishers. Acceptable values are `ENTITY_STATUS_ACTIVE` and `ENTITY_STATUS_PAUSED`.
+  },
+  "timeRange": { # A time range. # The time range when this inventory source starts and stops serving.
+    "endTime": "A String", # Required. The upper bound of a time range, inclusive.
+    "startTime": "A String", # Required. The lower bound of a time range, inclusive.
+  },
+  "updateTime": "A String", # Output only. The timestamp when the inventory source was last updated. Assigned by the system.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/displayvideo_v4.partners.channels.html b/docs/dyn/displayvideo_v4.partners.channels.html new file mode 100644 index 00000000000..31707a7e3e8 --- /dev/null +++ b/docs/dyn/displayvideo_v4.partners.channels.html @@ -0,0 +1,262 @@ + + + +

Display & Video 360 API . partners . channels

+

Instance Methods

+

+ sites() +

+

Returns the sites Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ create(partnerId, advertiserId=None, body=None, x__xgafv=None)

+

Creates a new channel. Returns the newly created channel if successful.

+

+ get(partnerId, channelId, advertiserId=None, x__xgafv=None)

+

Gets a channel for a partner or advertiser.

+

+ list(partnerId, advertiserId=None, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists channels for a partner or advertiser.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(partnerId, channelId, advertiserId=None, body=None, updateMask=None, x__xgafv=None)

+

Updates a channel. Returns the updated channel if successful.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(partnerId, advertiserId=None, body=None, x__xgafv=None) +
Creates a new channel. Returns the newly created channel if successful.
+
+Args:
+  partnerId: string, The ID of the partner that owns the created channel. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A single channel. Channels are custom groups of related websites and apps.
+  "advertiserId": "A String", # The ID of the advertiser that owns the channel.
+  "channelId": "A String", # Output only. The unique ID of the channel. Assigned by the system.
+  "displayName": "A String", # Required. The display name of the channel. Must be UTF-8 encoded with a maximum length of 240 bytes.
+  "name": "A String", # Output only. The resource name of the channel.
+  "negativelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel negatively.
+  "partnerId": "A String", # The ID of the partner that owns the channel.
+  "positivelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel positively.
+}
+
+  advertiserId: string, The ID of the advertiser that owns the created channel.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single channel. Channels are custom groups of related websites and apps.
+  "advertiserId": "A String", # The ID of the advertiser that owns the channel.
+  "channelId": "A String", # Output only. The unique ID of the channel. Assigned by the system.
+  "displayName": "A String", # Required. The display name of the channel. Must be UTF-8 encoded with a maximum length of 240 bytes.
+  "name": "A String", # Output only. The resource name of the channel.
+  "negativelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel negatively.
+  "partnerId": "A String", # The ID of the partner that owns the channel.
+  "positivelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel positively.
+}
+
+ +
+ get(partnerId, channelId, advertiserId=None, x__xgafv=None) +
Gets a channel for a partner or advertiser.
+
+Args:
+  partnerId: string, The ID of the partner that owns the fetched channel. (required)
+  channelId: string, Required. The ID of the channel to fetch. (required)
+  advertiserId: string, The ID of the advertiser that owns the fetched channel.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single channel. Channels are custom groups of related websites and apps.
+  "advertiserId": "A String", # The ID of the advertiser that owns the channel.
+  "channelId": "A String", # Output only. The unique ID of the channel. Assigned by the system.
+  "displayName": "A String", # Required. The display name of the channel. Must be UTF-8 encoded with a maximum length of 240 bytes.
+  "name": "A String", # Output only. The resource name of the channel.
+  "negativelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel negatively.
+  "partnerId": "A String", # The ID of the partner that owns the channel.
+  "positivelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel positively.
+}
+
+ +
+ list(partnerId, advertiserId=None, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists channels for a partner or advertiser.
+
+Args:
+  partnerId: string, The ID of the partner that owns the channels. (required)
+  advertiserId: string, The ID of the advertiser that owns the channels.
+  filter: string, Allows filtering by channel fields. Supported syntax: * Filter expressions for channel can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All channels for which the display name contains "google": `displayName : "google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
+  orderBy: string, Field by which to sort the list. Acceptable values are: * `displayName` (default) * `channelId` The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `displayName desc`.
+  pageSize: integer, Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
+  pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListChannels` method. If not specified, the first page of results 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:
+
+    {
+  "channels": [ # The list of channels. This list will be absent if empty.
+    { # A single channel. Channels are custom groups of related websites and apps.
+      "advertiserId": "A String", # The ID of the advertiser that owns the channel.
+      "channelId": "A String", # Output only. The unique ID of the channel. Assigned by the system.
+      "displayName": "A String", # Required. The display name of the channel. Must be UTF-8 encoded with a maximum length of 240 bytes.
+      "name": "A String", # Output only. The resource name of the channel.
+      "negativelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel negatively.
+      "partnerId": "A String", # The ID of the partner that owns the channel.
+      "positivelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel positively.
+    },
+  ],
+  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListChannels` method to retrieve the next page of results.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(partnerId, channelId, advertiserId=None, body=None, updateMask=None, x__xgafv=None) +
Updates a channel. Returns the updated channel if successful.
+
+Args:
+  partnerId: string, The ID of the partner that owns the created channel. (required)
+  channelId: string, Output only. The unique ID of the channel. Assigned by the system. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A single channel. Channels are custom groups of related websites and apps.
+  "advertiserId": "A String", # The ID of the advertiser that owns the channel.
+  "channelId": "A String", # Output only. The unique ID of the channel. Assigned by the system.
+  "displayName": "A String", # Required. The display name of the channel. Must be UTF-8 encoded with a maximum length of 240 bytes.
+  "name": "A String", # Output only. The resource name of the channel.
+  "negativelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel negatively.
+  "partnerId": "A String", # The ID of the partner that owns the channel.
+  "positivelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel positively.
+}
+
+  advertiserId: string, The ID of the advertiser that owns the created channel.
+  updateMask: string, Required. The mask to control which fields to update.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single channel. Channels are custom groups of related websites and apps.
+  "advertiserId": "A String", # The ID of the advertiser that owns the channel.
+  "channelId": "A String", # Output only. The unique ID of the channel. Assigned by the system.
+  "displayName": "A String", # Required. The display name of the channel. Must be UTF-8 encoded with a maximum length of 240 bytes.
+  "name": "A String", # Output only. The resource name of the channel.
+  "negativelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel negatively.
+  "partnerId": "A String", # The ID of the partner that owns the channel.
+  "positivelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel positively.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/displayvideo_v4.partners.channels.sites.html b/docs/dyn/displayvideo_v4.partners.channels.sites.html new file mode 100644 index 00000000000..8d540815e04 --- /dev/null +++ b/docs/dyn/displayvideo_v4.partners.channels.sites.html @@ -0,0 +1,281 @@ + + + +

Display & Video 360 API . partners . channels . sites

+

Instance Methods

+

+ bulkEdit(partnerId, channelId, body=None, x__xgafv=None)

+

Bulk edits sites under a single channel. The operation will delete the sites provided in BulkEditSitesRequest.deleted_sites and then create the sites provided in BulkEditSitesRequest.created_sites.

+

+ close()

+

Close httplib2 connections.

+

+ create(partnerId, channelId, advertiserId=None, body=None, x__xgafv=None)

+

Creates a site in a channel.

+

+ delete(partnerId, channelId, urlOrAppId, advertiserId=None, x__xgafv=None)

+

Deletes a site from a channel.

+

+ list(partnerId, channelId, advertiserId=None, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists sites in a channel.

+

+ list_next()

+

Retrieves the next page of results.

+

+ replace(partnerId, channelId, body=None, x__xgafv=None)

+

Replaces all of the sites under a single channel. The operation will replace the sites under a channel with the sites provided in ReplaceSitesRequest.new_sites. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.

+

Method Details

+
+ bulkEdit(partnerId, channelId, body=None, x__xgafv=None) +
Bulk edits sites under a single channel. The operation will delete the sites provided in BulkEditSitesRequest.deleted_sites and then create the sites provided in BulkEditSitesRequest.created_sites.
+
+Args:
+  partnerId: string, The ID of the partner that owns the parent channel. (required)
+  channelId: string, Required. The ID of the parent channel to which the sites belong. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for SiteService.BulkEditSites.
+  "advertiserId": "A String", # The ID of the advertiser that owns the parent channel.
+  "createdSites": [ # The sites to create in batch, specified as a list of Sites.
+    { # A single site. Sites are apps or websites belonging to a channel.
+      "name": "A String", # Output only. The resource name of the site.
+      "urlOrAppId": "A String", # Required. The app ID or URL of the site. Must be UTF-8 encoded with a maximum length of 240 bytes.
+    },
+  ],
+  "deletedSites": [ # The sites to delete in batch, specified as a list of site url_or_app_ids.
+    "A String",
+  ],
+  "partnerId": "A String", # The ID of the partner that owns the parent channel.
+}
+
+  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 SiteService.BulkEditSites.
+  "sites": [ # The list of sites that have been successfully created. This list will be absent if empty.
+    { # A single site. Sites are apps or websites belonging to a channel.
+      "name": "A String", # Output only. The resource name of the site.
+      "urlOrAppId": "A String", # Required. The app ID or URL of the site. Must be UTF-8 encoded with a maximum length of 240 bytes.
+    },
+  ],
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ create(partnerId, channelId, advertiserId=None, body=None, x__xgafv=None) +
Creates a site in a channel.
+
+Args:
+  partnerId: string, The ID of the partner that owns the parent channel. (required)
+  channelId: string, Required. The ID of the parent channel in which the site will be created. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A single site. Sites are apps or websites belonging to a channel.
+  "name": "A String", # Output only. The resource name of the site.
+  "urlOrAppId": "A String", # Required. The app ID or URL of the site. Must be UTF-8 encoded with a maximum length of 240 bytes.
+}
+
+  advertiserId: string, The ID of the advertiser that owns the parent channel.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single site. Sites are apps or websites belonging to a channel.
+  "name": "A String", # Output only. The resource name of the site.
+  "urlOrAppId": "A String", # Required. The app ID or URL of the site. Must be UTF-8 encoded with a maximum length of 240 bytes.
+}
+
+ +
+ delete(partnerId, channelId, urlOrAppId, advertiserId=None, x__xgafv=None) +
Deletes a site from a channel.
+
+Args:
+  partnerId: string, The ID of the partner that owns the parent channel. (required)
+  channelId: string, Required. The ID of the parent channel to which the site belongs. (required)
+  urlOrAppId: string, Required. The URL or app ID of the site to delete. (required)
+  advertiserId: string, The ID of the advertiser that owns the parent channel.
+  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); }
+}
+
+ +
+ list(partnerId, channelId, advertiserId=None, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists sites in a channel.
+
+Args:
+  partnerId: string, The ID of the partner that owns the parent channel. (required)
+  channelId: string, Required. The ID of the parent channel to which the requested sites belong. (required)
+  advertiserId: string, The ID of the advertiser that owns the parent channel.
+  filter: string, Allows filtering by site fields. Supported syntax: * Filter expressions for site retrieval can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `urlOrAppId` Examples: * All sites for which the URL or app ID contains "google": `urlOrAppId : "google"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
+  orderBy: string, Field by which to sort the list. Acceptable values are: * `urlOrAppId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `urlOrAppId desc`.
+  pageSize: integer, Requested page size. Must be between `1` and `10000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
+  pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListSites` method. If not specified, the first page of results 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:
+
+    { # Response message for SiteService.ListSites.
+  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListSites` method to retrieve the next page of results.
+  "sites": [ # The list of sites. This list will be absent if empty.
+    { # A single site. Sites are apps or websites belonging to a channel.
+      "name": "A String", # Output only. The resource name of the site.
+      "urlOrAppId": "A String", # Required. The app ID or URL of the site. Must be UTF-8 encoded with a maximum length of 240 bytes.
+    },
+  ],
+}
+
+ +
+ 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.
+        
+
+ +
+ replace(partnerId, channelId, body=None, x__xgafv=None) +
Replaces all of the sites under a single channel. The operation will replace the sites under a channel with the sites provided in ReplaceSitesRequest.new_sites. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.
+
+Args:
+  partnerId: string, The ID of the partner that owns the parent channel. (required)
+  channelId: string, Required. The ID of the parent channel whose sites will be replaced. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for SiteService.ReplaceSites.
+  "advertiserId": "A String", # The ID of the advertiser that owns the parent channel.
+  "newSites": [ # The sites that will replace the existing sites assigned to the channel, specified as a list of Sites.
+    { # A single site. Sites are apps or websites belonging to a channel.
+      "name": "A String", # Output only. The resource name of the site.
+      "urlOrAppId": "A String", # Required. The app ID or URL of the site. Must be UTF-8 encoded with a maximum length of 240 bytes.
+    },
+  ],
+  "partnerId": "A String", # The ID of the partner that owns the parent channel.
+}
+
+  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 SiteService.ReplaceSites.
+  "sites": [ # The list of sites in the channel after replacing.
+    { # A single site. Sites are apps or websites belonging to a channel.
+      "name": "A String", # Output only. The resource name of the site.
+      "urlOrAppId": "A String", # Required. The app ID or URL of the site. Must be UTF-8 encoded with a maximum length of 240 bytes.
+    },
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/displayvideo_v4.partners.html b/docs/dyn/displayvideo_v4.partners.html new file mode 100644 index 00000000000..30af967852a --- /dev/null +++ b/docs/dyn/displayvideo_v4.partners.html @@ -0,0 +1,915 @@ + + + +

Display & Video 360 API . partners

+

Instance Methods

+

+ channels() +

+

Returns the channels Resource.

+ +

+ targetingTypes() +

+

Returns the targetingTypes Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ editAssignedTargetingOptions(partnerId, body=None, x__xgafv=None)

+

Edits targeting options under a single partner. The operation will delete the assigned targeting options provided in BulkEditPartnerAssignedTargetingOptionsRequest.deleteRequests and then create the assigned targeting options provided in BulkEditPartnerAssignedTargetingOptionsRequest.createRequests .

+

+ get(partnerId, x__xgafv=None)

+

Gets a partner.

+

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

+

Lists partners that are accessible to the current user. The order is defined by the order_by parameter.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ editAssignedTargetingOptions(partnerId, body=None, x__xgafv=None) +
Edits targeting options under a single partner. The operation will delete the assigned targeting options provided in BulkEditPartnerAssignedTargetingOptionsRequest.deleteRequests and then create the assigned targeting options provided in BulkEditPartnerAssignedTargetingOptionsRequest.createRequests .
+
+Args:
+  partnerId: string, Required. The ID of the partner. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for BulkEditPartnerAssignedTargetingOptions.
+  "createRequests": [ # The assigned targeting options to create in batch, specified as a list of `CreateAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL`
+    { # A request listing which assigned targeting options of a given targeting type should be created and added.
+      "assignedTargetingOptions": [ # Required. The assigned targeting options to create and add.
+        { # A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings.
+          "ageRangeDetails": { # Represents a targetable age range. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AGE_RANGE`. # Age range details. This field will be populated when the targeting_type is `TARGETING_TYPE_AGE_RANGE`.
+            "ageRange": "A String", # Required. The age range of an audience. We only support targeting a continuous age range of an audience. Thus, the age range represented in this field can be 1) targeted solely, or, 2) part of a larger continuous age range. The reach of a continuous age range targeting can be expanded by also targeting an audience of an unknown age.
+          },
+          "appCategoryDetails": { # Details for assigned app category targeting option. This will be populated in the app_category_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. # App category details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
+            "displayName": "A String", # Output only. The display name of the app category.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+            "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
+          },
+          "appDetails": { # Details for assigned app targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP`. # App details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP`.
+            "appId": "A String", # Required. The ID of the app. Android's Play store app uses bundle ID, for example `com.google.android.gm`. Apple's App store app ID uses 9 digit string, for example `422689480`.
+            "appPlatform": "A String", # Indicates the platform of the targeted app. If this field is not specified, the app platform will be assumed to be mobile (i.e., Android or iOS), and we will derive the appropriate mobile platform from the app ID.
+            "displayName": "A String", # Output only. The display name of the app.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+          },
+          "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts.
+          "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`
+          "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource.
+            "excludedFirstPartyAndPartnerAudienceGroup": { # Details of first party and partner audience group. All first party and partner audience targeting settings are logically ‘OR’ of each other. # Optional. The first party and partner audience ids and recencies of the excluded first party and partner audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other.
+              "settings": [ # Required. All first party and partner audience targeting settings in first party and partner audience group. Repeated settings with the same id are not allowed.
+                { # Details of first party and partner audience targeting setting.
+                  "firstPartyAndPartnerAudienceId": "A String", # Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.
+                  "recency": "A String", # Required. The recency of the first party and partner audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
+                },
+              ],
+            },
+            "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other.
+              "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
+                { # Details of Google audience targeting setting.
+                  "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
+                },
+              ],
+            },
+            "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only.
+              "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise.
+                { # Details of combined audience targeting setting.
+                  "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id.
+                },
+              ],
+            },
+            "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only.
+              "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored.
+                { # Details of custom list targeting setting.
+                  "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id.
+                },
+              ],
+            },
+            "includedFirstPartyAndPartnerAudienceGroups": [ # Optional. The first party and partner audience ids and recencies of included first party and partner audience groups. Each first party and partner audience group contains first party and partner audience ids only. The relation between each first party and partner audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored.
+              { # Details of first party and partner audience group. All first party and partner audience targeting settings are logically ‘OR’ of each other.
+                "settings": [ # Required. All first party and partner audience targeting settings in first party and partner audience group. Repeated settings with the same id are not allowed.
+                  { # Details of first party and partner audience targeting setting.
+                    "firstPartyAndPartnerAudienceId": "A String", # Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.
+                    "recency": "A String", # Required. The recency of the first party and partner audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
+                  },
+                ],
+              },
+            ],
+            "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only.
+              "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
+                { # Details of Google audience targeting setting.
+                  "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
+                },
+              ],
+            },
+          },
+          "audioContentTypeDetails": { # Details for audio content type assigned targeting option. This will be populated in the audio_content_type_details field when targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`. Explicitly targeting all options is not supported. Remove all audio content type targeting options to achieve this effect. # Audio content type details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`.
+            "audioContentType": "A String", # Required. The audio content type.
+          },
+          "authorizedSellerStatusDetails": { # Represents an assigned authorized seller status. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. If a resource does not have an `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` assigned targeting option, it is using the "Authorized Direct Sellers and Resellers" option. # Authorized seller status details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. You can only target one authorized seller status option per resource. If a resource doesn't have an authorized seller status option, all authorized sellers indicated as DIRECT or RESELLER in the ads.txt file are targeted by default.
+            "authorizedSellerStatus": "A String", # Output only. The authorized seller status to target.
+            "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.
+          },
+          "browserDetails": { # Details for assigned browser targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BROWSER`. # Browser details. This field will be populated when the targeting_type is `TARGETING_TYPE_BROWSER`.
+            "displayName": "A String", # Output only. The display name of the browser.
+            "negative": True or False, # Indicates if this option is being negatively targeted. All assigned browser targeting options on the same resource must have the same value for this field.
+            "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BROWSER`.
+          },
+          "businessChainDetails": { # Details for assigned Business chain targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`. # Business chain details. This field will be populated when the targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`.
+            "displayName": "A String", # Output only. The display name of a business chain, e.g. "KFC", "Chase Bank".
+            "proximityRadiusAmount": 3.14, # Required. The radius of the area around the business chain that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`. The minimum increment for both cases is 0.1. Inputs will be rounded to the nearest acceptable value if it is too granular, e.g. 15.57 will become 15.6.
+            "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
+            "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BUSINESS_CHAIN`. Accepted business chain targeting option IDs can be retrieved using SearchTargetingOptions.
+          },
+          "carrierAndIspDetails": { # Details for assigned carrier and ISP targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`. # Carrier and ISP details. This field will be populated when the targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`.
+            "displayName": "A String", # Output only. The display name of the carrier or ISP.
+            "negative": True or False, # Indicates if this option is being negatively targeted. All assigned carrier and ISP targeting options on the same resource must have the same value for this field.
+            "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`.
+          },
+          "categoryDetails": { # Assigned category targeting option details. This will be populated in the category_details field when targeting_type is `TARGETING_TYPE_CATEGORY`. # Category details. This field will be populated when the targeting_type is `TARGETING_TYPE_CATEGORY`. Targeting a category will also target its subcategories. If a category is excluded from targeting and a subcategory is included, the exclusion will take precedence.
+            "displayName": "A String", # Output only. The display name of the category.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+            "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CATEGORY`.
+          },
+          "channelDetails": { # Details for assigned channel targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CHANNEL`. # Channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_CHANNEL`.
+            "channelId": "A String", # Required. ID of the channel. Should refer to the channel ID field on a [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id) resource.
+            "negative": True or False, # Indicates if this option is being negatively targeted. For advertiser level assigned targeting option, this field must be true.
+          },
+          "contentDurationDetails": { # Details for content duration assigned targeting option. This will be populated in the content_duration_details field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`. Explicitly targeting all options is not supported. Remove all content duration targeting options to achieve this effect. # Content duration details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
+            "contentDuration": "A String", # Output only. The content duration.
+            "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
+          },
+          "contentGenreDetails": { # Details for content genre assigned targeting option. This will be populated in the content_genre_details field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`. Explicitly targeting all options is not supported. Remove all content genre targeting options to achieve this effect. # Content genre details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
+            "displayName": "A String", # Output only. The display name of the content genre.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+            "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
+          },
+          "contentInstreamPositionDetails": { # Assigned content instream position targeting option details. This will be populated in the content_instream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. # Content instream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.
+            "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`. * `AD_TYPE_AUDIO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_AUDIO_DEFAULT`.
+            "contentInstreamPosition": "A String", # Required. The content instream position for video or audio ads.
+          },
+          "contentOutstreamPositionDetails": { # Assigned content outstream position targeting option details. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. # Content outstream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.
+            "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+            "contentOutstreamPosition": "A String", # Required. The content outstream position.
+          },
+          "contentStreamTypeDetails": { # Details for content stream type assigned targeting option. This will be populated in the content_stream_type_details field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`. Explicitly targeting all options is not supported. Remove all content stream type targeting options to achieve this effect. # Content duration details. This field will be populated when the TargetingType is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
+            "contentStreamType": "A String", # Output only. The content stream type.
+            "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
+          },
+          "dayAndTimeDetails": { # Representation of a segment of time defined on a specific day of the week and with a start and end time. The time represented by `start_hour` must be before the time represented by `end_hour`. # Day and time details. This field will be populated when the targeting_type is `TARGETING_TYPE_DAY_AND_TIME`.
+            "dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting.
+            "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day).
+            "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day).
+            "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting.
+          },
+          "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
+            "displayName": "A String", # Output only. The display name of the device make and model.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+            "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
+          },
+          "deviceTypeDetails": { # Targeting details for device type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`. # Device Type details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_TYPE`.
+            "deviceType": "A String", # Required. The display name of the device type.
+            "youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items.
+          },
+          "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded.
+            "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED.
+          },
+          "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`.
+            "environment": "A String", # Required. The serving environment.
+          },
+          "exchangeDetails": { # Details for assigned exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`. # Exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_EXCHANGE`.
+            "exchange": "A String", # Required. The enum value for the exchange.
+          },
+          "genderDetails": { # Details for assigned gender targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GENDER`. # Gender details. This field will be populated when the targeting_type is `TARGETING_TYPE_GENDER`.
+            "gender": "A String", # Required. The gender of the audience.
+          },
+          "geoRegionDetails": { # Details for assigned geographic region targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GEO_REGION`. # Geographic region details. This field will be populated when the targeting_type is `TARGETING_TYPE_GEO_REGION`.
+            "displayName": "A String", # Output only. The display name of the geographic region (e.g., "Ontario, Canada").
+            "geoRegionType": "A String", # Output only. The type of geographic region targeting.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+            "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GEO_REGION`.
+          },
+          "householdIncomeDetails": { # Details for assigned household income targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`. # Household income details. This field will be populated when the targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`.
+            "householdIncome": "A String", # Required. The household income of the audience.
+          },
+          "inheritance": "A String", # Output only. The inheritance status of the assigned targeting option.
+          "inventorySourceDetails": { # Targeting details for inventory source. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`. # Inventory source details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`.
+            "inventorySourceId": "A String", # Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource.
+          },
+          "inventorySourceGroupDetails": { # Targeting details for inventory source group. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`. # Inventory source group details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`.
+            "inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource.
+          },
+          "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned.
+            "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+          },
+          "languageDetails": { # Details for assigned language targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_LANGUAGE`. # Language details. This field will be populated when the targeting_type is `TARGETING_TYPE_LANGUAGE`.
+            "displayName": "A String", # Output only. The display name of the language (e.g., "French").
+            "negative": True or False, # Indicates if this option is being negatively targeted. All assigned language targeting options on the same resource must have the same value for this field.
+            "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_LANGUAGE`.
+          },
+          "name": "A String", # Output only. The resource name for this assigned targeting option.
+          "nativeContentPositionDetails": { # Details for native content position assigned targeting option. This will be populated in the native_content_position_details field when targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`. Explicitly targeting all options is not supported. Remove all native content position targeting options to achieve this effect. # Native content position details. This field will be populated when the targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`.
+            "contentPosition": "A String", # Required. The content position.
+          },
+          "negativeKeywordListDetails": { # Targeting details for negative keyword list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. A maximum of 4 negative keyword lists can be assigned to a resource.
+            "negativeKeywordListId": "A String", # Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource.
+          },
+          "omidDetails": { # Represents a targetable Open Measurement enabled inventory type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_OMID`. # Open Measurement enabled inventory details. This field will be populated when the targeting_type is `TARGETING_TYPE_OMID`.
+            "omid": "A String", # Required. The type of Open Measurement enabled inventory.
+          },
+          "onScreenPositionDetails": { # On screen position targeting option details. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. # On screen position details. This field will be populated when the targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
+            "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+            "onScreenPosition": "A String", # Output only. The on screen position.
+            "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
+          },
+          "operatingSystemDetails": { # Assigned operating system targeting option details. This will be populated in the operating_system_details field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. # Operating system details. This field will be populated when the targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
+            "displayName": "A String", # Output only. The display name of the operating system.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+            "targetingOptionId": "A String", # Required. The targeting option ID populated in targeting_option_id field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
+          },
+          "parentalStatusDetails": { # Details for assigned parental status targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`. # Parental status details. This field will be populated when the targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`.
+            "parentalStatus": "A String", # Required. The parental status of the audience.
+          },
+          "poiDetails": { # Details for assigned POI targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_POI`. # POI details. This field will be populated when the targeting_type is `TARGETING_TYPE_POI`.
+            "displayName": "A String", # Output only. The display name of a POI, e.g. "Times Square", "Space Needle", followed by its full address if available.
+            "latitude": 3.14, # Output only. Latitude of the POI rounding to 6th decimal place.
+            "longitude": 3.14, # Output only. Longitude of the POI rounding to 6th decimal place.
+            "proximityRadiusAmount": 3.14, # Required. The radius of the area around the POI that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`.
+            "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
+            "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_POI`. Accepted POI targeting option IDs can be retrieved using `targetingTypes.targetingOptions.search`. If targeting a specific latitude/longitude coordinate removed from an address or POI name, you can generate the necessary targeting option ID by rounding the desired coordinate values to the 6th decimal place, removing the decimals, and concatenating the string values separated by a semicolon. For example, you can target the latitude/longitude pair of 40.7414691, -74.003387 using the targeting option ID "40741469;-74003387". **Upon** **creation, this field value will be updated to append a semicolon and** **alphanumerical hash value if only latitude/longitude coordinates are** **provided.**
+          },
+          "proximityLocationListDetails": { # Targeting details for proximity location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`. # Proximity location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`.
+            "proximityLocationListId": "A String", # Required. ID of the proximity location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_PROXIMITY`.
+            "proximityRadius": 3.14, # Required. Radius expressed in the distance units set in proximity_radius_unit. This represents the size of the area around a chosen location that will be targeted. Radius should be between 1 and 500 miles or 800 kilometers.
+            "proximityRadiusUnit": "A String", # Required. Radius distance units.
+          },
+          "regionalLocationListDetails": { # Targeting details for regional location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`. # Regional location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+            "regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`.
+          },
+          "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them.
+            "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED.
+          },
+          "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`.
+            "sessionPosition": "A String", # The position where the ad will show in a session.
+          },
+          "subExchangeDetails": { # Details for assigned sub-exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`. # Sub-exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`.
+            "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`.
+          },
+          "targetingType": "A String", # Output only. Identifies the type of this assigned targeting option.
+          "thirdPartyVerifierDetails": { # Assigned third party verifier targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`. # Third party verification details. This field will be populated when the targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`.
+            "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox.
+              "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads.
+              "excludedAdlooxCategories": [ # Adloox categories to exclude.
+                "A String",
+              ],
+              "excludedFraudIvtMfaCategories": [ # Optional. Adloox's fraud IVT MFA categories to exclude.
+                "A String",
+              ],
+              "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads.
+            },
+            "doubleVerify": { # Details of DoubleVerify settings. # Third party brand verifier -- DoubleVerify.
+              "appStarRating": { # Details of DoubleVerify star ratings settings. # Avoid bidding on apps with the star ratings.
+                "avoidInsufficientStarRating": True or False, # Avoid bidding on apps with insufficient star ratings.
+                "avoidedStarRating": "A String", # Avoid bidding on apps with the star ratings.
+              },
+              "avoidedAgeRatings": [ # Avoid bidding on apps with the age rating.
+                "A String",
+              ],
+              "brandSafetyCategories": { # Settings for brand safety controls. # DV Brand Safety Controls.
+                "avoidUnknownBrandSafetyCategory": True or False, # Unknown or unrateable.
+                "avoidedHighSeverityCategories": [ # Brand safety high severity avoidance categories.
+                  "A String",
+                ],
+                "avoidedMediumSeverityCategories": [ # Brand safety medium severity avoidance categories.
+                  "A String",
+                ],
+              },
+              "customSegmentId": "A String", # The custom segment ID provided by DoubleVerify. The ID must start with "51" and consist of eight digits. Custom segment ID cannot be specified along with any of the following fields: * brand_safety_categories * avoided_age_ratings * app_star_rating * fraud_invalid_traffic
+              "displayViewability": { # Details of DoubleVerify display viewability settings. # Display viewability settings (applicable to display line items only).
+                "iab": "A String", # Target web and app inventory to maximize IAB viewable rate.
+                "viewableDuring": "A String", # Target web and app inventory to maximize 100% viewable duration.
+              },
+              "fraudInvalidTraffic": { # DoubleVerify Fraud & Invalid Traffic settings. # Avoid Sites and Apps with historical Fraud & IVT Rates.
+                "avoidInsufficientOption": True or False, # Insufficient Historical Fraud & IVT Stats.
+                "avoidedFraudOption": "A String", # Avoid Sites and Apps with historical Fraud & IVT.
+              },
+              "videoViewability": { # Details of DoubleVerify video viewability settings. # Video viewability settings (applicable to video line items only).
+                "playerImpressionRate": "A String", # Target inventory to maximize impressions with 400x300 or greater player size.
+                "videoIab": "A String", # Target web inventory to maximize IAB viewable rate.
+                "videoViewableRate": "A String", # Target web inventory to maximize fully viewable rate.
+              },
+            },
+            "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science.
+              "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive.
+                "A String",
+              ],
+              "displayViewability": "A String", # Display Viewability section (applicable to display line items only).
+              "excludeUnrateable": True or False, # Brand Safety - **Unrateable**.
+              "excludedAdFraudRisk": "A String", # Ad Fraud settings.
+              "excludedAdultRisk": "A String", # Brand Safety - **Adult content**.
+              "excludedAlcoholRisk": "A String", # Brand Safety - **Alcohol**.
+              "excludedDrugsRisk": "A String", # Brand Safety - **Drugs**.
+              "excludedGamblingRisk": "A String", # Brand Safety - **Gambling**.
+              "excludedHateSpeechRisk": "A String", # Brand Safety - **Hate speech**.
+              "excludedIllegalDownloadsRisk": "A String", # Brand Safety - **Illegal downloads**.
+              "excludedOffensiveLanguageRisk": "A String", # Brand Safety - **Offensive language**.
+              "excludedViolenceRisk": "A String", # Brand Safety - **Violence**.
+              "qualitySyncCustomSegmentId": [ # Optional. The quality sync custom segment ID provided by Integral Ad Science. The ID must be between `3000000` and `4999999`, inclusive.
+                "A String",
+              ],
+              "traqScoreOption": "A String", # True advertising quality (applicable to Display line items only).
+              "videoViewability": "A String", # Video Viewability Section (applicable to video line items only).
+            },
+          },
+          "urlDetails": { # Details for assigned URL targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_URL`. # URL details. This field will be populated when the targeting_type is `TARGETING_TYPE_URL`.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+            "url": "A String", # Required. The URL, for example `example.com`. DV360 supports two levels of subdirectory targeting, for example `www.example.com/one-subdirectory-level/second-level`, and five levels of subdomain targeting, for example `five.four.three.two.one.example.com`.
+          },
+          "userRewardedContentDetails": { # User rewarded content targeting option details. This will be populated in the user_rewarded_content_details field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. # User rewarded content details. This field will be populated when the targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
+            "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
+            "userRewardedContent": "A String", # Output only. User rewarded content status for video ads.
+          },
+          "videoPlayerSizeDetails": { # Video player size targeting option details. This will be populated in the video_player_size_details field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. Explicitly targeting all options is not supported. Remove all video player size targeting options to achieve this effect. # Video player size details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.
+            "videoPlayerSize": "A String", # Required. The video player size.
+          },
+          "viewabilityDetails": { # Assigned viewability targeting option details. This will be populated in the viewability_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`. # Viewability details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIEWABILITY`. You can only target one viewability option per resource.
+            "viewability": "A String", # Required. The predicted viewability percentage.
+          },
+          "youtubeChannelDetails": { # Details for YouTube channel assigned targeting option. This will be populated in the youtube_channel_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`. # YouTube channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`.
+            "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+          },
+          "youtubeVideoDetails": { # Details for YouTube video assigned targeting option. This will be populated in the youtube_video_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`. # YouTube video details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+            "videoId": "A String", # YouTube video id as it appears on the YouTube watch page.
+          },
+        },
+      ],
+      "targetingType": "A String", # Required. Identifies the type of this assigned targeting option.
+    },
+  ],
+  "deleteRequests": [ # The assigned targeting options to delete in batch, specified as a list of `DeleteAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL`
+    { # A request listing which assigned targeting options of a given targeting type should be deleted.
+      "assignedTargetingOptionIds": [ # Required. The assigned targeting option IDs to delete.
+        "A String",
+      ],
+      "targetingType": "A String", # Required. Identifies the type of this assigned targeting option.
+    },
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "createdAssignedTargetingOptions": [ # The list of assigned targeting options that have been successfully created. This list will be absent if empty.
+    { # A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings.
+      "ageRangeDetails": { # Represents a targetable age range. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AGE_RANGE`. # Age range details. This field will be populated when the targeting_type is `TARGETING_TYPE_AGE_RANGE`.
+        "ageRange": "A String", # Required. The age range of an audience. We only support targeting a continuous age range of an audience. Thus, the age range represented in this field can be 1) targeted solely, or, 2) part of a larger continuous age range. The reach of a continuous age range targeting can be expanded by also targeting an audience of an unknown age.
+      },
+      "appCategoryDetails": { # Details for assigned app category targeting option. This will be populated in the app_category_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. # App category details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
+        "displayName": "A String", # Output only. The display name of the app category.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
+      },
+      "appDetails": { # Details for assigned app targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP`. # App details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP`.
+        "appId": "A String", # Required. The ID of the app. Android's Play store app uses bundle ID, for example `com.google.android.gm`. Apple's App store app ID uses 9 digit string, for example `422689480`.
+        "appPlatform": "A String", # Indicates the platform of the targeted app. If this field is not specified, the app platform will be assumed to be mobile (i.e., Android or iOS), and we will derive the appropriate mobile platform from the app ID.
+        "displayName": "A String", # Output only. The display name of the app.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+      },
+      "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts.
+      "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`
+      "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource.
+        "excludedFirstPartyAndPartnerAudienceGroup": { # Details of first party and partner audience group. All first party and partner audience targeting settings are logically ‘OR’ of each other. # Optional. The first party and partner audience ids and recencies of the excluded first party and partner audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other.
+          "settings": [ # Required. All first party and partner audience targeting settings in first party and partner audience group. Repeated settings with the same id are not allowed.
+            { # Details of first party and partner audience targeting setting.
+              "firstPartyAndPartnerAudienceId": "A String", # Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.
+              "recency": "A String", # Required. The recency of the first party and partner audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
+            },
+          ],
+        },
+        "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other.
+          "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
+            { # Details of Google audience targeting setting.
+              "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
+            },
+          ],
+        },
+        "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only.
+          "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise.
+            { # Details of combined audience targeting setting.
+              "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id.
+            },
+          ],
+        },
+        "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only.
+          "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored.
+            { # Details of custom list targeting setting.
+              "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id.
+            },
+          ],
+        },
+        "includedFirstPartyAndPartnerAudienceGroups": [ # Optional. The first party and partner audience ids and recencies of included first party and partner audience groups. Each first party and partner audience group contains first party and partner audience ids only. The relation between each first party and partner audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored.
+          { # Details of first party and partner audience group. All first party and partner audience targeting settings are logically ‘OR’ of each other.
+            "settings": [ # Required. All first party and partner audience targeting settings in first party and partner audience group. Repeated settings with the same id are not allowed.
+              { # Details of first party and partner audience targeting setting.
+                "firstPartyAndPartnerAudienceId": "A String", # Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.
+                "recency": "A String", # Required. The recency of the first party and partner audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
+              },
+            ],
+          },
+        ],
+        "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only.
+          "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
+            { # Details of Google audience targeting setting.
+              "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
+            },
+          ],
+        },
+      },
+      "audioContentTypeDetails": { # Details for audio content type assigned targeting option. This will be populated in the audio_content_type_details field when targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`. Explicitly targeting all options is not supported. Remove all audio content type targeting options to achieve this effect. # Audio content type details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`.
+        "audioContentType": "A String", # Required. The audio content type.
+      },
+      "authorizedSellerStatusDetails": { # Represents an assigned authorized seller status. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. If a resource does not have an `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` assigned targeting option, it is using the "Authorized Direct Sellers and Resellers" option. # Authorized seller status details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. You can only target one authorized seller status option per resource. If a resource doesn't have an authorized seller status option, all authorized sellers indicated as DIRECT or RESELLER in the ads.txt file are targeted by default.
+        "authorizedSellerStatus": "A String", # Output only. The authorized seller status to target.
+        "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.
+      },
+      "browserDetails": { # Details for assigned browser targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BROWSER`. # Browser details. This field will be populated when the targeting_type is `TARGETING_TYPE_BROWSER`.
+        "displayName": "A String", # Output only. The display name of the browser.
+        "negative": True or False, # Indicates if this option is being negatively targeted. All assigned browser targeting options on the same resource must have the same value for this field.
+        "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BROWSER`.
+      },
+      "businessChainDetails": { # Details for assigned Business chain targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`. # Business chain details. This field will be populated when the targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`.
+        "displayName": "A String", # Output only. The display name of a business chain, e.g. "KFC", "Chase Bank".
+        "proximityRadiusAmount": 3.14, # Required. The radius of the area around the business chain that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`. The minimum increment for both cases is 0.1. Inputs will be rounded to the nearest acceptable value if it is too granular, e.g. 15.57 will become 15.6.
+        "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
+        "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BUSINESS_CHAIN`. Accepted business chain targeting option IDs can be retrieved using SearchTargetingOptions.
+      },
+      "carrierAndIspDetails": { # Details for assigned carrier and ISP targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`. # Carrier and ISP details. This field will be populated when the targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`.
+        "displayName": "A String", # Output only. The display name of the carrier or ISP.
+        "negative": True or False, # Indicates if this option is being negatively targeted. All assigned carrier and ISP targeting options on the same resource must have the same value for this field.
+        "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`.
+      },
+      "categoryDetails": { # Assigned category targeting option details. This will be populated in the category_details field when targeting_type is `TARGETING_TYPE_CATEGORY`. # Category details. This field will be populated when the targeting_type is `TARGETING_TYPE_CATEGORY`. Targeting a category will also target its subcategories. If a category is excluded from targeting and a subcategory is included, the exclusion will take precedence.
+        "displayName": "A String", # Output only. The display name of the category.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CATEGORY`.
+      },
+      "channelDetails": { # Details for assigned channel targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CHANNEL`. # Channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_CHANNEL`.
+        "channelId": "A String", # Required. ID of the channel. Should refer to the channel ID field on a [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id) resource.
+        "negative": True or False, # Indicates if this option is being negatively targeted. For advertiser level assigned targeting option, this field must be true.
+      },
+      "contentDurationDetails": { # Details for content duration assigned targeting option. This will be populated in the content_duration_details field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`. Explicitly targeting all options is not supported. Remove all content duration targeting options to achieve this effect. # Content duration details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
+        "contentDuration": "A String", # Output only. The content duration.
+        "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
+      },
+      "contentGenreDetails": { # Details for content genre assigned targeting option. This will be populated in the content_genre_details field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`. Explicitly targeting all options is not supported. Remove all content genre targeting options to achieve this effect. # Content genre details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
+        "displayName": "A String", # Output only. The display name of the content genre.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
+      },
+      "contentInstreamPositionDetails": { # Assigned content instream position targeting option details. This will be populated in the content_instream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. # Content instream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.
+        "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`. * `AD_TYPE_AUDIO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_AUDIO_DEFAULT`.
+        "contentInstreamPosition": "A String", # Required. The content instream position for video or audio ads.
+      },
+      "contentOutstreamPositionDetails": { # Assigned content outstream position targeting option details. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. # Content outstream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.
+        "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+        "contentOutstreamPosition": "A String", # Required. The content outstream position.
+      },
+      "contentStreamTypeDetails": { # Details for content stream type assigned targeting option. This will be populated in the content_stream_type_details field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`. Explicitly targeting all options is not supported. Remove all content stream type targeting options to achieve this effect. # Content duration details. This field will be populated when the TargetingType is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
+        "contentStreamType": "A String", # Output only. The content stream type.
+        "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
+      },
+      "dayAndTimeDetails": { # Representation of a segment of time defined on a specific day of the week and with a start and end time. The time represented by `start_hour` must be before the time represented by `end_hour`. # Day and time details. This field will be populated when the targeting_type is `TARGETING_TYPE_DAY_AND_TIME`.
+        "dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting.
+        "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day).
+        "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day).
+        "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting.
+      },
+      "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
+        "displayName": "A String", # Output only. The display name of the device make and model.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
+      },
+      "deviceTypeDetails": { # Targeting details for device type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`. # Device Type details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_TYPE`.
+        "deviceType": "A String", # Required. The display name of the device type.
+        "youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items.
+      },
+      "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded.
+        "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED.
+      },
+      "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`.
+        "environment": "A String", # Required. The serving environment.
+      },
+      "exchangeDetails": { # Details for assigned exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`. # Exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_EXCHANGE`.
+        "exchange": "A String", # Required. The enum value for the exchange.
+      },
+      "genderDetails": { # Details for assigned gender targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GENDER`. # Gender details. This field will be populated when the targeting_type is `TARGETING_TYPE_GENDER`.
+        "gender": "A String", # Required. The gender of the audience.
+      },
+      "geoRegionDetails": { # Details for assigned geographic region targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GEO_REGION`. # Geographic region details. This field will be populated when the targeting_type is `TARGETING_TYPE_GEO_REGION`.
+        "displayName": "A String", # Output only. The display name of the geographic region (e.g., "Ontario, Canada").
+        "geoRegionType": "A String", # Output only. The type of geographic region targeting.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GEO_REGION`.
+      },
+      "householdIncomeDetails": { # Details for assigned household income targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`. # Household income details. This field will be populated when the targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`.
+        "householdIncome": "A String", # Required. The household income of the audience.
+      },
+      "inheritance": "A String", # Output only. The inheritance status of the assigned targeting option.
+      "inventorySourceDetails": { # Targeting details for inventory source. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`. # Inventory source details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`.
+        "inventorySourceId": "A String", # Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource.
+      },
+      "inventorySourceGroupDetails": { # Targeting details for inventory source group. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`. # Inventory source group details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`.
+        "inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource.
+      },
+      "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned.
+        "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+      },
+      "languageDetails": { # Details for assigned language targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_LANGUAGE`. # Language details. This field will be populated when the targeting_type is `TARGETING_TYPE_LANGUAGE`.
+        "displayName": "A String", # Output only. The display name of the language (e.g., "French").
+        "negative": True or False, # Indicates if this option is being negatively targeted. All assigned language targeting options on the same resource must have the same value for this field.
+        "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_LANGUAGE`.
+      },
+      "name": "A String", # Output only. The resource name for this assigned targeting option.
+      "nativeContentPositionDetails": { # Details for native content position assigned targeting option. This will be populated in the native_content_position_details field when targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`. Explicitly targeting all options is not supported. Remove all native content position targeting options to achieve this effect. # Native content position details. This field will be populated when the targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`.
+        "contentPosition": "A String", # Required. The content position.
+      },
+      "negativeKeywordListDetails": { # Targeting details for negative keyword list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. A maximum of 4 negative keyword lists can be assigned to a resource.
+        "negativeKeywordListId": "A String", # Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource.
+      },
+      "omidDetails": { # Represents a targetable Open Measurement enabled inventory type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_OMID`. # Open Measurement enabled inventory details. This field will be populated when the targeting_type is `TARGETING_TYPE_OMID`.
+        "omid": "A String", # Required. The type of Open Measurement enabled inventory.
+      },
+      "onScreenPositionDetails": { # On screen position targeting option details. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. # On screen position details. This field will be populated when the targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
+        "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+        "onScreenPosition": "A String", # Output only. The on screen position.
+        "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
+      },
+      "operatingSystemDetails": { # Assigned operating system targeting option details. This will be populated in the operating_system_details field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. # Operating system details. This field will be populated when the targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
+        "displayName": "A String", # Output only. The display name of the operating system.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "targetingOptionId": "A String", # Required. The targeting option ID populated in targeting_option_id field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
+      },
+      "parentalStatusDetails": { # Details for assigned parental status targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`. # Parental status details. This field will be populated when the targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`.
+        "parentalStatus": "A String", # Required. The parental status of the audience.
+      },
+      "poiDetails": { # Details for assigned POI targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_POI`. # POI details. This field will be populated when the targeting_type is `TARGETING_TYPE_POI`.
+        "displayName": "A String", # Output only. The display name of a POI, e.g. "Times Square", "Space Needle", followed by its full address if available.
+        "latitude": 3.14, # Output only. Latitude of the POI rounding to 6th decimal place.
+        "longitude": 3.14, # Output only. Longitude of the POI rounding to 6th decimal place.
+        "proximityRadiusAmount": 3.14, # Required. The radius of the area around the POI that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`.
+        "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
+        "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_POI`. Accepted POI targeting option IDs can be retrieved using `targetingTypes.targetingOptions.search`. If targeting a specific latitude/longitude coordinate removed from an address or POI name, you can generate the necessary targeting option ID by rounding the desired coordinate values to the 6th decimal place, removing the decimals, and concatenating the string values separated by a semicolon. For example, you can target the latitude/longitude pair of 40.7414691, -74.003387 using the targeting option ID "40741469;-74003387". **Upon** **creation, this field value will be updated to append a semicolon and** **alphanumerical hash value if only latitude/longitude coordinates are** **provided.**
+      },
+      "proximityLocationListDetails": { # Targeting details for proximity location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`. # Proximity location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`.
+        "proximityLocationListId": "A String", # Required. ID of the proximity location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_PROXIMITY`.
+        "proximityRadius": 3.14, # Required. Radius expressed in the distance units set in proximity_radius_unit. This represents the size of the area around a chosen location that will be targeted. Radius should be between 1 and 500 miles or 800 kilometers.
+        "proximityRadiusUnit": "A String", # Required. Radius distance units.
+      },
+      "regionalLocationListDetails": { # Targeting details for regional location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`. # Regional location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`.
+      },
+      "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them.
+        "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED.
+      },
+      "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`.
+        "sessionPosition": "A String", # The position where the ad will show in a session.
+      },
+      "subExchangeDetails": { # Details for assigned sub-exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`. # Sub-exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`.
+        "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`.
+      },
+      "targetingType": "A String", # Output only. Identifies the type of this assigned targeting option.
+      "thirdPartyVerifierDetails": { # Assigned third party verifier targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`. # Third party verification details. This field will be populated when the targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`.
+        "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox.
+          "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads.
+          "excludedAdlooxCategories": [ # Adloox categories to exclude.
+            "A String",
+          ],
+          "excludedFraudIvtMfaCategories": [ # Optional. Adloox's fraud IVT MFA categories to exclude.
+            "A String",
+          ],
+          "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads.
+        },
+        "doubleVerify": { # Details of DoubleVerify settings. # Third party brand verifier -- DoubleVerify.
+          "appStarRating": { # Details of DoubleVerify star ratings settings. # Avoid bidding on apps with the star ratings.
+            "avoidInsufficientStarRating": True or False, # Avoid bidding on apps with insufficient star ratings.
+            "avoidedStarRating": "A String", # Avoid bidding on apps with the star ratings.
+          },
+          "avoidedAgeRatings": [ # Avoid bidding on apps with the age rating.
+            "A String",
+          ],
+          "brandSafetyCategories": { # Settings for brand safety controls. # DV Brand Safety Controls.
+            "avoidUnknownBrandSafetyCategory": True or False, # Unknown or unrateable.
+            "avoidedHighSeverityCategories": [ # Brand safety high severity avoidance categories.
+              "A String",
+            ],
+            "avoidedMediumSeverityCategories": [ # Brand safety medium severity avoidance categories.
+              "A String",
+            ],
+          },
+          "customSegmentId": "A String", # The custom segment ID provided by DoubleVerify. The ID must start with "51" and consist of eight digits. Custom segment ID cannot be specified along with any of the following fields: * brand_safety_categories * avoided_age_ratings * app_star_rating * fraud_invalid_traffic
+          "displayViewability": { # Details of DoubleVerify display viewability settings. # Display viewability settings (applicable to display line items only).
+            "iab": "A String", # Target web and app inventory to maximize IAB viewable rate.
+            "viewableDuring": "A String", # Target web and app inventory to maximize 100% viewable duration.
+          },
+          "fraudInvalidTraffic": { # DoubleVerify Fraud & Invalid Traffic settings. # Avoid Sites and Apps with historical Fraud & IVT Rates.
+            "avoidInsufficientOption": True or False, # Insufficient Historical Fraud & IVT Stats.
+            "avoidedFraudOption": "A String", # Avoid Sites and Apps with historical Fraud & IVT.
+          },
+          "videoViewability": { # Details of DoubleVerify video viewability settings. # Video viewability settings (applicable to video line items only).
+            "playerImpressionRate": "A String", # Target inventory to maximize impressions with 400x300 or greater player size.
+            "videoIab": "A String", # Target web inventory to maximize IAB viewable rate.
+            "videoViewableRate": "A String", # Target web inventory to maximize fully viewable rate.
+          },
+        },
+        "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science.
+          "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive.
+            "A String",
+          ],
+          "displayViewability": "A String", # Display Viewability section (applicable to display line items only).
+          "excludeUnrateable": True or False, # Brand Safety - **Unrateable**.
+          "excludedAdFraudRisk": "A String", # Ad Fraud settings.
+          "excludedAdultRisk": "A String", # Brand Safety - **Adult content**.
+          "excludedAlcoholRisk": "A String", # Brand Safety - **Alcohol**.
+          "excludedDrugsRisk": "A String", # Brand Safety - **Drugs**.
+          "excludedGamblingRisk": "A String", # Brand Safety - **Gambling**.
+          "excludedHateSpeechRisk": "A String", # Brand Safety - **Hate speech**.
+          "excludedIllegalDownloadsRisk": "A String", # Brand Safety - **Illegal downloads**.
+          "excludedOffensiveLanguageRisk": "A String", # Brand Safety - **Offensive language**.
+          "excludedViolenceRisk": "A String", # Brand Safety - **Violence**.
+          "qualitySyncCustomSegmentId": [ # Optional. The quality sync custom segment ID provided by Integral Ad Science. The ID must be between `3000000` and `4999999`, inclusive.
+            "A String",
+          ],
+          "traqScoreOption": "A String", # True advertising quality (applicable to Display line items only).
+          "videoViewability": "A String", # Video Viewability Section (applicable to video line items only).
+        },
+      },
+      "urlDetails": { # Details for assigned URL targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_URL`. # URL details. This field will be populated when the targeting_type is `TARGETING_TYPE_URL`.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "url": "A String", # Required. The URL, for example `example.com`. DV360 supports two levels of subdirectory targeting, for example `www.example.com/one-subdirectory-level/second-level`, and five levels of subdomain targeting, for example `five.four.three.two.one.example.com`.
+      },
+      "userRewardedContentDetails": { # User rewarded content targeting option details. This will be populated in the user_rewarded_content_details field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. # User rewarded content details. This field will be populated when the targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
+        "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
+        "userRewardedContent": "A String", # Output only. User rewarded content status for video ads.
+      },
+      "videoPlayerSizeDetails": { # Video player size targeting option details. This will be populated in the video_player_size_details field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. Explicitly targeting all options is not supported. Remove all video player size targeting options to achieve this effect. # Video player size details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.
+        "videoPlayerSize": "A String", # Required. The video player size.
+      },
+      "viewabilityDetails": { # Assigned viewability targeting option details. This will be populated in the viewability_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`. # Viewability details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIEWABILITY`. You can only target one viewability option per resource.
+        "viewability": "A String", # Required. The predicted viewability percentage.
+      },
+      "youtubeChannelDetails": { # Details for YouTube channel assigned targeting option. This will be populated in the youtube_channel_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`. # YouTube channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`.
+        "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+      },
+      "youtubeVideoDetails": { # Details for YouTube video assigned targeting option. This will be populated in the youtube_video_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`. # YouTube video details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "videoId": "A String", # YouTube video id as it appears on the YouTube watch page.
+      },
+    },
+  ],
+}
+
+ +
+ get(partnerId, x__xgafv=None) +
Gets a partner.
+
+Args:
+  partnerId: string, Required. The ID of the partner to fetch. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single partner in Display & Video 360 (DV360).
+  "adServerConfig": { # Ad server related settings of a partner. # Ad server related settings of the partner.
+    "measurementConfig": { # Measurement settings of a partner. # Measurement settings of a partner.
+      "dv360ToCmCostReportingEnabled": True or False, # Whether or not to report DV360 cost to CM360.
+      "dv360ToCmDataSharingEnabled": True or False, # Whether or not to include DV360 data in CM360 data transfer reports.
+    },
+  },
+  "billingConfig": { # Billing related settings of a partner. # Billing related settings of the partner.
+    "billingProfileId": "A String", # The ID of a partner default billing profile.
+  },
+  "dataAccessConfig": { # Settings that control how partner related data may be accessed. # Settings that control how partner data may be accessed.
+    "sdfConfig": { # Structured Data File (SDF) related settings. # Structured Data Files (SDF) settings for the partner. The SDF configuration for the partner.
+      "adminEmail": "A String", # An administrator email address to which the SDF processing status reports will be sent.
+      "version": "A String", # Required. The version of SDF being used.
+    },
+  },
+  "displayName": "A String", # The display name of the partner. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "entityStatus": "A String", # Output only. The status of the partner.
+  "exchangeConfig": { # Settings that control which exchanges are enabled for a partner. # Settings that control which exchanges are enabled for the partner.
+    "enabledExchanges": [ # All enabled exchanges in the partner. Duplicate enabled exchanges will be ignored.
+      { # An enabled exchange in the partner.
+        "exchange": "A String", # The enabled exchange.
+        "googleAdManagerAgencyId": "A String", # Output only. Agency ID of Google Ad Manager. The field is only relevant when Google Ad Manager is the enabled exchange.
+        "googleAdManagerBuyerNetworkId": "A String", # Output only. Network ID of Google Ad Manager. The field is only relevant when Google Ad Manager is the enabled exchange.
+        "seatId": "A String", # Output only. Seat ID of the enabled exchange.
+      },
+    ],
+  },
+  "generalConfig": { # General settings of a partner. # General settings of the partner.
+    "currencyCode": "A String", # Immutable. Partner's currency in ISO 4217 format.
+    "timeZone": "A String", # Immutable. The standard TZ database name of the partner's time zone. For example, `America/New_York`. See more at: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
+  },
+  "name": "A String", # Output only. The resource name of the partner.
+  "partnerId": "A String", # Output only. The unique ID of the partner. Assigned by the system.
+  "updateTime": "A String", # Output only. The timestamp when the partner was last updated. Assigned by the system.
+}
+
+ +
+ list(filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists partners that are accessible to the current user. The order is defined by the order_by parameter.
+
+Args:
+  filter: string, Allows filtering by partner fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `entityStatus` Examples: * All active partners: `entityStatus="ENTITY_STATUS_ACTIVE"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
+  orderBy: string, Field by which to sort the list. Acceptable values are: * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`.
+  pageSize: integer, Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
+  pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListPartners` method. If not specified, the first page of results 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:
+
+    {
+  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListPartners` method to retrieve the next page of results.
+  "partners": [ # The list of partners. This list will be absent if empty.
+    { # A single partner in Display & Video 360 (DV360).
+      "adServerConfig": { # Ad server related settings of a partner. # Ad server related settings of the partner.
+        "measurementConfig": { # Measurement settings of a partner. # Measurement settings of a partner.
+          "dv360ToCmCostReportingEnabled": True or False, # Whether or not to report DV360 cost to CM360.
+          "dv360ToCmDataSharingEnabled": True or False, # Whether or not to include DV360 data in CM360 data transfer reports.
+        },
+      },
+      "billingConfig": { # Billing related settings of a partner. # Billing related settings of the partner.
+        "billingProfileId": "A String", # The ID of a partner default billing profile.
+      },
+      "dataAccessConfig": { # Settings that control how partner related data may be accessed. # Settings that control how partner data may be accessed.
+        "sdfConfig": { # Structured Data File (SDF) related settings. # Structured Data Files (SDF) settings for the partner. The SDF configuration for the partner.
+          "adminEmail": "A String", # An administrator email address to which the SDF processing status reports will be sent.
+          "version": "A String", # Required. The version of SDF being used.
+        },
+      },
+      "displayName": "A String", # The display name of the partner. Must be UTF-8 encoded with a maximum size of 240 bytes.
+      "entityStatus": "A String", # Output only. The status of the partner.
+      "exchangeConfig": { # Settings that control which exchanges are enabled for a partner. # Settings that control which exchanges are enabled for the partner.
+        "enabledExchanges": [ # All enabled exchanges in the partner. Duplicate enabled exchanges will be ignored.
+          { # An enabled exchange in the partner.
+            "exchange": "A String", # The enabled exchange.
+            "googleAdManagerAgencyId": "A String", # Output only. Agency ID of Google Ad Manager. The field is only relevant when Google Ad Manager is the enabled exchange.
+            "googleAdManagerBuyerNetworkId": "A String", # Output only. Network ID of Google Ad Manager. The field is only relevant when Google Ad Manager is the enabled exchange.
+            "seatId": "A String", # Output only. Seat ID of the enabled exchange.
+          },
+        ],
+      },
+      "generalConfig": { # General settings of a partner. # General settings of the partner.
+        "currencyCode": "A String", # Immutable. Partner's currency in ISO 4217 format.
+        "timeZone": "A String", # Immutable. The standard TZ database name of the partner's time zone. For example, `America/New_York`. See more at: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
+      },
+      "name": "A String", # Output only. The resource name of the partner.
+      "partnerId": "A String", # Output only. The unique ID of the partner. Assigned by the system.
+      "updateTime": "A String", # Output only. The timestamp when the partner was last updated. Assigned by the system.
+    },
+  ],
+}
+
+ +
+ 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/displayvideo_v4.partners.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v4.partners.targetingTypes.assignedTargetingOptions.html new file mode 100644 index 00000000000..3ade582d71a --- /dev/null +++ b/docs/dyn/displayvideo_v4.partners.targetingTypes.assignedTargetingOptions.html @@ -0,0 +1,1680 @@ + + + +

Display & Video 360 API . partners . targetingTypes . assignedTargetingOptions

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(partnerId, targetingType, body=None, x__xgafv=None)

+

Assigns a targeting option to a partner. Returns the assigned targeting option if successful.

+

+ delete(partnerId, targetingType, assignedTargetingOptionId, x__xgafv=None)

+

Deletes an assigned targeting option from a partner.

+

+ get(partnerId, targetingType, assignedTargetingOptionId, x__xgafv=None)

+

Gets a single targeting option assigned to a partner.

+

+ list(partnerId, targetingType, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists the targeting options assigned to a partner.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(partnerId, targetingType, body=None, x__xgafv=None) +
Assigns a targeting option to a partner. Returns the assigned targeting option if successful.
+
+Args:
+  partnerId: string, Required. The ID of the partner. (required)
+  targetingType: string, Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` (required)
+    Allowed values
+      TARGETING_TYPE_UNSPECIFIED - Default value when type is not specified or is unknown in this version.
+      TARGETING_TYPE_CHANNEL - Target a channel (a custom group of related websites or apps).
+      TARGETING_TYPE_APP_CATEGORY - Target an app category (for example, education or puzzle games).
+      TARGETING_TYPE_APP - Target a specific app (for example, Angry Birds).
+      TARGETING_TYPE_URL - Target a specific url (for example, quora.com).
+      TARGETING_TYPE_DAY_AND_TIME - Target ads during a chosen time period on a specific day.
+      TARGETING_TYPE_AGE_RANGE - Target ads to a specific age range (for example, 18-24).
+      TARGETING_TYPE_REGIONAL_LOCATION_LIST - Target ads to the specified regions on a regional location list.
+      TARGETING_TYPE_PROXIMITY_LOCATION_LIST - Target ads to the specified points of interest on a proximity location list.
+      TARGETING_TYPE_GENDER - Target ads to a specific gender (for example, female or male).
+      TARGETING_TYPE_VIDEO_PLAYER_SIZE - Target a specific video player size for video ads.
+      TARGETING_TYPE_USER_REWARDED_CONTENT - Target user rewarded content for video ads.
+      TARGETING_TYPE_PARENTAL_STATUS - Target ads to a specific parental status (for example, parent or not a parent).
+      TARGETING_TYPE_CONTENT_INSTREAM_POSITION - Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).
+      TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION - Target ads in a specific content outstream position.
+      TARGETING_TYPE_DEVICE_TYPE - Target ads to a specific device type (for example, tablet or connected TV).
+      TARGETING_TYPE_AUDIENCE_GROUP - Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.
+      TARGETING_TYPE_BROWSER - Target ads to specific web browsers (for example, Chrome).
+      TARGETING_TYPE_HOUSEHOLD_INCOME - Target ads to a specific household income range (for example, top 10%).
+      TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position.
+      TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify).
+      TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).
+      TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult).
+      TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app).
+      TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).
+      TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS).
+      TARGETING_TYPE_DEVICE_MAKE_MODEL - Target ads to a specific device make or model (for example, Roku or Samsung).
+      TARGETING_TYPE_KEYWORD - Target ads to a specific keyword (for example, dog or retriever).
+      TARGETING_TYPE_NEGATIVE_KEYWORD_LIST - Target ads to a specific negative keyword list.
+      TARGETING_TYPE_VIEWABILITY - Target ads to a specific viewability (for example, 80% viewable).
+      TARGETING_TYPE_CATEGORY - Target ads to a specific content category (for example, arts & entertainment).
+      TARGETING_TYPE_INVENTORY_SOURCE - Purchase impressions from specific deals and auction packages.
+      TARGETING_TYPE_LANGUAGE - Target ads to a specific language (for example, English or Japanese).
+      TARGETING_TYPE_AUTHORIZED_SELLER_STATUS - Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.
+      TARGETING_TYPE_GEO_REGION - Target ads to a specific regional location (for example, a city or state).
+      TARGETING_TYPE_INVENTORY_SOURCE_GROUP - Purchase impressions from a group of deals and auction packages.
+      TARGETING_TYPE_EXCHANGE - Purchase impressions from specific exchanges.
+      TARGETING_TYPE_SUB_EXCHANGE - Purchase impressions from specific sub-exchanges.
+      TARGETING_TYPE_POI - Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.
+      TARGETING_TYPE_BUSINESS_CHAIN - Target ads around locations of a business chain within a specific geo region.
+      TARGETING_TYPE_CONTENT_DURATION - Target ads to a specific video content duration.
+      TARGETING_TYPE_CONTENT_STREAM_TYPE - Target ads to a specific video content stream type.
+      TARGETING_TYPE_NATIVE_CONTENT_POSITION - Target ads to a specific native content position.
+      TARGETING_TYPE_OMID - Target ads in an Open Measurement enabled inventory.
+      TARGETING_TYPE_AUDIO_CONTENT_TYPE - Target ads to a specific audio content type.
+      TARGETING_TYPE_CONTENT_GENRE - Target ads to a specific content genre.
+      TARGETING_TYPE_YOUTUBE_VIDEO - Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
+      TARGETING_TYPE_YOUTUBE_CHANNEL - Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
+      TARGETING_TYPE_SESSION_POSITION - Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings.
+  "ageRangeDetails": { # Represents a targetable age range. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AGE_RANGE`. # Age range details. This field will be populated when the targeting_type is `TARGETING_TYPE_AGE_RANGE`.
+    "ageRange": "A String", # Required. The age range of an audience. We only support targeting a continuous age range of an audience. Thus, the age range represented in this field can be 1) targeted solely, or, 2) part of a larger continuous age range. The reach of a continuous age range targeting can be expanded by also targeting an audience of an unknown age.
+  },
+  "appCategoryDetails": { # Details for assigned app category targeting option. This will be populated in the app_category_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. # App category details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
+    "displayName": "A String", # Output only. The display name of the app category.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
+  },
+  "appDetails": { # Details for assigned app targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP`. # App details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP`.
+    "appId": "A String", # Required. The ID of the app. Android's Play store app uses bundle ID, for example `com.google.android.gm`. Apple's App store app ID uses 9 digit string, for example `422689480`.
+    "appPlatform": "A String", # Indicates the platform of the targeted app. If this field is not specified, the app platform will be assumed to be mobile (i.e., Android or iOS), and we will derive the appropriate mobile platform from the app ID.
+    "displayName": "A String", # Output only. The display name of the app.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+  },
+  "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts.
+  "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`
+  "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource.
+    "excludedFirstPartyAndPartnerAudienceGroup": { # Details of first party and partner audience group. All first party and partner audience targeting settings are logically ‘OR’ of each other. # Optional. The first party and partner audience ids and recencies of the excluded first party and partner audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other.
+      "settings": [ # Required. All first party and partner audience targeting settings in first party and partner audience group. Repeated settings with the same id are not allowed.
+        { # Details of first party and partner audience targeting setting.
+          "firstPartyAndPartnerAudienceId": "A String", # Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.
+          "recency": "A String", # Required. The recency of the first party and partner audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
+        },
+      ],
+    },
+    "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other.
+      "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
+        { # Details of Google audience targeting setting.
+          "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
+        },
+      ],
+    },
+    "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only.
+      "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise.
+        { # Details of combined audience targeting setting.
+          "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id.
+        },
+      ],
+    },
+    "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only.
+      "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored.
+        { # Details of custom list targeting setting.
+          "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id.
+        },
+      ],
+    },
+    "includedFirstPartyAndPartnerAudienceGroups": [ # Optional. The first party and partner audience ids and recencies of included first party and partner audience groups. Each first party and partner audience group contains first party and partner audience ids only. The relation between each first party and partner audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored.
+      { # Details of first party and partner audience group. All first party and partner audience targeting settings are logically ‘OR’ of each other.
+        "settings": [ # Required. All first party and partner audience targeting settings in first party and partner audience group. Repeated settings with the same id are not allowed.
+          { # Details of first party and partner audience targeting setting.
+            "firstPartyAndPartnerAudienceId": "A String", # Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.
+            "recency": "A String", # Required. The recency of the first party and partner audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
+          },
+        ],
+      },
+    ],
+    "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only.
+      "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
+        { # Details of Google audience targeting setting.
+          "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
+        },
+      ],
+    },
+  },
+  "audioContentTypeDetails": { # Details for audio content type assigned targeting option. This will be populated in the audio_content_type_details field when targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`. Explicitly targeting all options is not supported. Remove all audio content type targeting options to achieve this effect. # Audio content type details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`.
+    "audioContentType": "A String", # Required. The audio content type.
+  },
+  "authorizedSellerStatusDetails": { # Represents an assigned authorized seller status. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. If a resource does not have an `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` assigned targeting option, it is using the "Authorized Direct Sellers and Resellers" option. # Authorized seller status details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. You can only target one authorized seller status option per resource. If a resource doesn't have an authorized seller status option, all authorized sellers indicated as DIRECT or RESELLER in the ads.txt file are targeted by default.
+    "authorizedSellerStatus": "A String", # Output only. The authorized seller status to target.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.
+  },
+  "browserDetails": { # Details for assigned browser targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BROWSER`. # Browser details. This field will be populated when the targeting_type is `TARGETING_TYPE_BROWSER`.
+    "displayName": "A String", # Output only. The display name of the browser.
+    "negative": True or False, # Indicates if this option is being negatively targeted. All assigned browser targeting options on the same resource must have the same value for this field.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BROWSER`.
+  },
+  "businessChainDetails": { # Details for assigned Business chain targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`. # Business chain details. This field will be populated when the targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`.
+    "displayName": "A String", # Output only. The display name of a business chain, e.g. "KFC", "Chase Bank".
+    "proximityRadiusAmount": 3.14, # Required. The radius of the area around the business chain that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`. The minimum increment for both cases is 0.1. Inputs will be rounded to the nearest acceptable value if it is too granular, e.g. 15.57 will become 15.6.
+    "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BUSINESS_CHAIN`. Accepted business chain targeting option IDs can be retrieved using SearchTargetingOptions.
+  },
+  "carrierAndIspDetails": { # Details for assigned carrier and ISP targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`. # Carrier and ISP details. This field will be populated when the targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`.
+    "displayName": "A String", # Output only. The display name of the carrier or ISP.
+    "negative": True or False, # Indicates if this option is being negatively targeted. All assigned carrier and ISP targeting options on the same resource must have the same value for this field.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`.
+  },
+  "categoryDetails": { # Assigned category targeting option details. This will be populated in the category_details field when targeting_type is `TARGETING_TYPE_CATEGORY`. # Category details. This field will be populated when the targeting_type is `TARGETING_TYPE_CATEGORY`. Targeting a category will also target its subcategories. If a category is excluded from targeting and a subcategory is included, the exclusion will take precedence.
+    "displayName": "A String", # Output only. The display name of the category.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CATEGORY`.
+  },
+  "channelDetails": { # Details for assigned channel targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CHANNEL`. # Channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_CHANNEL`.
+    "channelId": "A String", # Required. ID of the channel. Should refer to the channel ID field on a [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id) resource.
+    "negative": True or False, # Indicates if this option is being negatively targeted. For advertiser level assigned targeting option, this field must be true.
+  },
+  "contentDurationDetails": { # Details for content duration assigned targeting option. This will be populated in the content_duration_details field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`. Explicitly targeting all options is not supported. Remove all content duration targeting options to achieve this effect. # Content duration details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
+    "contentDuration": "A String", # Output only. The content duration.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
+  },
+  "contentGenreDetails": { # Details for content genre assigned targeting option. This will be populated in the content_genre_details field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`. Explicitly targeting all options is not supported. Remove all content genre targeting options to achieve this effect. # Content genre details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
+    "displayName": "A String", # Output only. The display name of the content genre.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
+  },
+  "contentInstreamPositionDetails": { # Assigned content instream position targeting option details. This will be populated in the content_instream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. # Content instream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.
+    "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`. * `AD_TYPE_AUDIO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_AUDIO_DEFAULT`.
+    "contentInstreamPosition": "A String", # Required. The content instream position for video or audio ads.
+  },
+  "contentOutstreamPositionDetails": { # Assigned content outstream position targeting option details. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. # Content outstream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.
+    "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+    "contentOutstreamPosition": "A String", # Required. The content outstream position.
+  },
+  "contentStreamTypeDetails": { # Details for content stream type assigned targeting option. This will be populated in the content_stream_type_details field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`. Explicitly targeting all options is not supported. Remove all content stream type targeting options to achieve this effect. # Content duration details. This field will be populated when the TargetingType is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
+    "contentStreamType": "A String", # Output only. The content stream type.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
+  },
+  "dayAndTimeDetails": { # Representation of a segment of time defined on a specific day of the week and with a start and end time. The time represented by `start_hour` must be before the time represented by `end_hour`. # Day and time details. This field will be populated when the targeting_type is `TARGETING_TYPE_DAY_AND_TIME`.
+    "dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting.
+    "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day).
+    "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day).
+    "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting.
+  },
+  "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
+    "displayName": "A String", # Output only. The display name of the device make and model.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
+  },
+  "deviceTypeDetails": { # Targeting details for device type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`. # Device Type details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_TYPE`.
+    "deviceType": "A String", # Required. The display name of the device type.
+    "youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items.
+  },
+  "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded.
+    "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED.
+  },
+  "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`.
+    "environment": "A String", # Required. The serving environment.
+  },
+  "exchangeDetails": { # Details for assigned exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`. # Exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_EXCHANGE`.
+    "exchange": "A String", # Required. The enum value for the exchange.
+  },
+  "genderDetails": { # Details for assigned gender targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GENDER`. # Gender details. This field will be populated when the targeting_type is `TARGETING_TYPE_GENDER`.
+    "gender": "A String", # Required. The gender of the audience.
+  },
+  "geoRegionDetails": { # Details for assigned geographic region targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GEO_REGION`. # Geographic region details. This field will be populated when the targeting_type is `TARGETING_TYPE_GEO_REGION`.
+    "displayName": "A String", # Output only. The display name of the geographic region (e.g., "Ontario, Canada").
+    "geoRegionType": "A String", # Output only. The type of geographic region targeting.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GEO_REGION`.
+  },
+  "householdIncomeDetails": { # Details for assigned household income targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`. # Household income details. This field will be populated when the targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`.
+    "householdIncome": "A String", # Required. The household income of the audience.
+  },
+  "inheritance": "A String", # Output only. The inheritance status of the assigned targeting option.
+  "inventorySourceDetails": { # Targeting details for inventory source. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`. # Inventory source details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`.
+    "inventorySourceId": "A String", # Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource.
+  },
+  "inventorySourceGroupDetails": { # Targeting details for inventory source group. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`. # Inventory source group details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`.
+    "inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource.
+  },
+  "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned.
+    "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+  },
+  "languageDetails": { # Details for assigned language targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_LANGUAGE`. # Language details. This field will be populated when the targeting_type is `TARGETING_TYPE_LANGUAGE`.
+    "displayName": "A String", # Output only. The display name of the language (e.g., "French").
+    "negative": True or False, # Indicates if this option is being negatively targeted. All assigned language targeting options on the same resource must have the same value for this field.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_LANGUAGE`.
+  },
+  "name": "A String", # Output only. The resource name for this assigned targeting option.
+  "nativeContentPositionDetails": { # Details for native content position assigned targeting option. This will be populated in the native_content_position_details field when targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`. Explicitly targeting all options is not supported. Remove all native content position targeting options to achieve this effect. # Native content position details. This field will be populated when the targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`.
+    "contentPosition": "A String", # Required. The content position.
+  },
+  "negativeKeywordListDetails": { # Targeting details for negative keyword list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. A maximum of 4 negative keyword lists can be assigned to a resource.
+    "negativeKeywordListId": "A String", # Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource.
+  },
+  "omidDetails": { # Represents a targetable Open Measurement enabled inventory type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_OMID`. # Open Measurement enabled inventory details. This field will be populated when the targeting_type is `TARGETING_TYPE_OMID`.
+    "omid": "A String", # Required. The type of Open Measurement enabled inventory.
+  },
+  "onScreenPositionDetails": { # On screen position targeting option details. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. # On screen position details. This field will be populated when the targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
+    "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+    "onScreenPosition": "A String", # Output only. The on screen position.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
+  },
+  "operatingSystemDetails": { # Assigned operating system targeting option details. This will be populated in the operating_system_details field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. # Operating system details. This field will be populated when the targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
+    "displayName": "A String", # Output only. The display name of the operating system.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting option ID populated in targeting_option_id field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
+  },
+  "parentalStatusDetails": { # Details for assigned parental status targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`. # Parental status details. This field will be populated when the targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`.
+    "parentalStatus": "A String", # Required. The parental status of the audience.
+  },
+  "poiDetails": { # Details for assigned POI targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_POI`. # POI details. This field will be populated when the targeting_type is `TARGETING_TYPE_POI`.
+    "displayName": "A String", # Output only. The display name of a POI, e.g. "Times Square", "Space Needle", followed by its full address if available.
+    "latitude": 3.14, # Output only. Latitude of the POI rounding to 6th decimal place.
+    "longitude": 3.14, # Output only. Longitude of the POI rounding to 6th decimal place.
+    "proximityRadiusAmount": 3.14, # Required. The radius of the area around the POI that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`.
+    "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_POI`. Accepted POI targeting option IDs can be retrieved using `targetingTypes.targetingOptions.search`. If targeting a specific latitude/longitude coordinate removed from an address or POI name, you can generate the necessary targeting option ID by rounding the desired coordinate values to the 6th decimal place, removing the decimals, and concatenating the string values separated by a semicolon. For example, you can target the latitude/longitude pair of 40.7414691, -74.003387 using the targeting option ID "40741469;-74003387". **Upon** **creation, this field value will be updated to append a semicolon and** **alphanumerical hash value if only latitude/longitude coordinates are** **provided.**
+  },
+  "proximityLocationListDetails": { # Targeting details for proximity location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`. # Proximity location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`.
+    "proximityLocationListId": "A String", # Required. ID of the proximity location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_PROXIMITY`.
+    "proximityRadius": 3.14, # Required. Radius expressed in the distance units set in proximity_radius_unit. This represents the size of the area around a chosen location that will be targeted. Radius should be between 1 and 500 miles or 800 kilometers.
+    "proximityRadiusUnit": "A String", # Required. Radius distance units.
+  },
+  "regionalLocationListDetails": { # Targeting details for regional location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`. # Regional location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`.
+  },
+  "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them.
+    "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED.
+  },
+  "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`.
+    "sessionPosition": "A String", # The position where the ad will show in a session.
+  },
+  "subExchangeDetails": { # Details for assigned sub-exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`. # Sub-exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`.
+  },
+  "targetingType": "A String", # Output only. Identifies the type of this assigned targeting option.
+  "thirdPartyVerifierDetails": { # Assigned third party verifier targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`. # Third party verification details. This field will be populated when the targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`.
+    "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox.
+      "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads.
+      "excludedAdlooxCategories": [ # Adloox categories to exclude.
+        "A String",
+      ],
+      "excludedFraudIvtMfaCategories": [ # Optional. Adloox's fraud IVT MFA categories to exclude.
+        "A String",
+      ],
+      "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads.
+    },
+    "doubleVerify": { # Details of DoubleVerify settings. # Third party brand verifier -- DoubleVerify.
+      "appStarRating": { # Details of DoubleVerify star ratings settings. # Avoid bidding on apps with the star ratings.
+        "avoidInsufficientStarRating": True or False, # Avoid bidding on apps with insufficient star ratings.
+        "avoidedStarRating": "A String", # Avoid bidding on apps with the star ratings.
+      },
+      "avoidedAgeRatings": [ # Avoid bidding on apps with the age rating.
+        "A String",
+      ],
+      "brandSafetyCategories": { # Settings for brand safety controls. # DV Brand Safety Controls.
+        "avoidUnknownBrandSafetyCategory": True or False, # Unknown or unrateable.
+        "avoidedHighSeverityCategories": [ # Brand safety high severity avoidance categories.
+          "A String",
+        ],
+        "avoidedMediumSeverityCategories": [ # Brand safety medium severity avoidance categories.
+          "A String",
+        ],
+      },
+      "customSegmentId": "A String", # The custom segment ID provided by DoubleVerify. The ID must start with "51" and consist of eight digits. Custom segment ID cannot be specified along with any of the following fields: * brand_safety_categories * avoided_age_ratings * app_star_rating * fraud_invalid_traffic
+      "displayViewability": { # Details of DoubleVerify display viewability settings. # Display viewability settings (applicable to display line items only).
+        "iab": "A String", # Target web and app inventory to maximize IAB viewable rate.
+        "viewableDuring": "A String", # Target web and app inventory to maximize 100% viewable duration.
+      },
+      "fraudInvalidTraffic": { # DoubleVerify Fraud & Invalid Traffic settings. # Avoid Sites and Apps with historical Fraud & IVT Rates.
+        "avoidInsufficientOption": True or False, # Insufficient Historical Fraud & IVT Stats.
+        "avoidedFraudOption": "A String", # Avoid Sites and Apps with historical Fraud & IVT.
+      },
+      "videoViewability": { # Details of DoubleVerify video viewability settings. # Video viewability settings (applicable to video line items only).
+        "playerImpressionRate": "A String", # Target inventory to maximize impressions with 400x300 or greater player size.
+        "videoIab": "A String", # Target web inventory to maximize IAB viewable rate.
+        "videoViewableRate": "A String", # Target web inventory to maximize fully viewable rate.
+      },
+    },
+    "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science.
+      "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive.
+        "A String",
+      ],
+      "displayViewability": "A String", # Display Viewability section (applicable to display line items only).
+      "excludeUnrateable": True or False, # Brand Safety - **Unrateable**.
+      "excludedAdFraudRisk": "A String", # Ad Fraud settings.
+      "excludedAdultRisk": "A String", # Brand Safety - **Adult content**.
+      "excludedAlcoholRisk": "A String", # Brand Safety - **Alcohol**.
+      "excludedDrugsRisk": "A String", # Brand Safety - **Drugs**.
+      "excludedGamblingRisk": "A String", # Brand Safety - **Gambling**.
+      "excludedHateSpeechRisk": "A String", # Brand Safety - **Hate speech**.
+      "excludedIllegalDownloadsRisk": "A String", # Brand Safety - **Illegal downloads**.
+      "excludedOffensiveLanguageRisk": "A String", # Brand Safety - **Offensive language**.
+      "excludedViolenceRisk": "A String", # Brand Safety - **Violence**.
+      "qualitySyncCustomSegmentId": [ # Optional. The quality sync custom segment ID provided by Integral Ad Science. The ID must be between `3000000` and `4999999`, inclusive.
+        "A String",
+      ],
+      "traqScoreOption": "A String", # True advertising quality (applicable to Display line items only).
+      "videoViewability": "A String", # Video Viewability Section (applicable to video line items only).
+    },
+  },
+  "urlDetails": { # Details for assigned URL targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_URL`. # URL details. This field will be populated when the targeting_type is `TARGETING_TYPE_URL`.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "url": "A String", # Required. The URL, for example `example.com`. DV360 supports two levels of subdirectory targeting, for example `www.example.com/one-subdirectory-level/second-level`, and five levels of subdomain targeting, for example `five.four.three.two.one.example.com`.
+  },
+  "userRewardedContentDetails": { # User rewarded content targeting option details. This will be populated in the user_rewarded_content_details field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. # User rewarded content details. This field will be populated when the targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
+    "userRewardedContent": "A String", # Output only. User rewarded content status for video ads.
+  },
+  "videoPlayerSizeDetails": { # Video player size targeting option details. This will be populated in the video_player_size_details field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. Explicitly targeting all options is not supported. Remove all video player size targeting options to achieve this effect. # Video player size details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.
+    "videoPlayerSize": "A String", # Required. The video player size.
+  },
+  "viewabilityDetails": { # Assigned viewability targeting option details. This will be populated in the viewability_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`. # Viewability details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIEWABILITY`. You can only target one viewability option per resource.
+    "viewability": "A String", # Required. The predicted viewability percentage.
+  },
+  "youtubeChannelDetails": { # Details for YouTube channel assigned targeting option. This will be populated in the youtube_channel_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`. # YouTube channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`.
+    "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+  },
+  "youtubeVideoDetails": { # Details for YouTube video assigned targeting option. This will be populated in the youtube_video_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`. # YouTube video details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "videoId": "A String", # YouTube video id as it appears on the YouTube watch page.
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings.
+  "ageRangeDetails": { # Represents a targetable age range. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AGE_RANGE`. # Age range details. This field will be populated when the targeting_type is `TARGETING_TYPE_AGE_RANGE`.
+    "ageRange": "A String", # Required. The age range of an audience. We only support targeting a continuous age range of an audience. Thus, the age range represented in this field can be 1) targeted solely, or, 2) part of a larger continuous age range. The reach of a continuous age range targeting can be expanded by also targeting an audience of an unknown age.
+  },
+  "appCategoryDetails": { # Details for assigned app category targeting option. This will be populated in the app_category_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. # App category details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
+    "displayName": "A String", # Output only. The display name of the app category.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
+  },
+  "appDetails": { # Details for assigned app targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP`. # App details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP`.
+    "appId": "A String", # Required. The ID of the app. Android's Play store app uses bundle ID, for example `com.google.android.gm`. Apple's App store app ID uses 9 digit string, for example `422689480`.
+    "appPlatform": "A String", # Indicates the platform of the targeted app. If this field is not specified, the app platform will be assumed to be mobile (i.e., Android or iOS), and we will derive the appropriate mobile platform from the app ID.
+    "displayName": "A String", # Output only. The display name of the app.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+  },
+  "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts.
+  "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`
+  "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource.
+    "excludedFirstPartyAndPartnerAudienceGroup": { # Details of first party and partner audience group. All first party and partner audience targeting settings are logically ‘OR’ of each other. # Optional. The first party and partner audience ids and recencies of the excluded first party and partner audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other.
+      "settings": [ # Required. All first party and partner audience targeting settings in first party and partner audience group. Repeated settings with the same id are not allowed.
+        { # Details of first party and partner audience targeting setting.
+          "firstPartyAndPartnerAudienceId": "A String", # Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.
+          "recency": "A String", # Required. The recency of the first party and partner audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
+        },
+      ],
+    },
+    "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other.
+      "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
+        { # Details of Google audience targeting setting.
+          "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
+        },
+      ],
+    },
+    "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only.
+      "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise.
+        { # Details of combined audience targeting setting.
+          "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id.
+        },
+      ],
+    },
+    "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only.
+      "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored.
+        { # Details of custom list targeting setting.
+          "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id.
+        },
+      ],
+    },
+    "includedFirstPartyAndPartnerAudienceGroups": [ # Optional. The first party and partner audience ids and recencies of included first party and partner audience groups. Each first party and partner audience group contains first party and partner audience ids only. The relation between each first party and partner audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored.
+      { # Details of first party and partner audience group. All first party and partner audience targeting settings are logically ‘OR’ of each other.
+        "settings": [ # Required. All first party and partner audience targeting settings in first party and partner audience group. Repeated settings with the same id are not allowed.
+          { # Details of first party and partner audience targeting setting.
+            "firstPartyAndPartnerAudienceId": "A String", # Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.
+            "recency": "A String", # Required. The recency of the first party and partner audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
+          },
+        ],
+      },
+    ],
+    "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only.
+      "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
+        { # Details of Google audience targeting setting.
+          "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
+        },
+      ],
+    },
+  },
+  "audioContentTypeDetails": { # Details for audio content type assigned targeting option. This will be populated in the audio_content_type_details field when targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`. Explicitly targeting all options is not supported. Remove all audio content type targeting options to achieve this effect. # Audio content type details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`.
+    "audioContentType": "A String", # Required. The audio content type.
+  },
+  "authorizedSellerStatusDetails": { # Represents an assigned authorized seller status. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. If a resource does not have an `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` assigned targeting option, it is using the "Authorized Direct Sellers and Resellers" option. # Authorized seller status details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. You can only target one authorized seller status option per resource. If a resource doesn't have an authorized seller status option, all authorized sellers indicated as DIRECT or RESELLER in the ads.txt file are targeted by default.
+    "authorizedSellerStatus": "A String", # Output only. The authorized seller status to target.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.
+  },
+  "browserDetails": { # Details for assigned browser targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BROWSER`. # Browser details. This field will be populated when the targeting_type is `TARGETING_TYPE_BROWSER`.
+    "displayName": "A String", # Output only. The display name of the browser.
+    "negative": True or False, # Indicates if this option is being negatively targeted. All assigned browser targeting options on the same resource must have the same value for this field.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BROWSER`.
+  },
+  "businessChainDetails": { # Details for assigned Business chain targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`. # Business chain details. This field will be populated when the targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`.
+    "displayName": "A String", # Output only. The display name of a business chain, e.g. "KFC", "Chase Bank".
+    "proximityRadiusAmount": 3.14, # Required. The radius of the area around the business chain that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`. The minimum increment for both cases is 0.1. Inputs will be rounded to the nearest acceptable value if it is too granular, e.g. 15.57 will become 15.6.
+    "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BUSINESS_CHAIN`. Accepted business chain targeting option IDs can be retrieved using SearchTargetingOptions.
+  },
+  "carrierAndIspDetails": { # Details for assigned carrier and ISP targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`. # Carrier and ISP details. This field will be populated when the targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`.
+    "displayName": "A String", # Output only. The display name of the carrier or ISP.
+    "negative": True or False, # Indicates if this option is being negatively targeted. All assigned carrier and ISP targeting options on the same resource must have the same value for this field.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`.
+  },
+  "categoryDetails": { # Assigned category targeting option details. This will be populated in the category_details field when targeting_type is `TARGETING_TYPE_CATEGORY`. # Category details. This field will be populated when the targeting_type is `TARGETING_TYPE_CATEGORY`. Targeting a category will also target its subcategories. If a category is excluded from targeting and a subcategory is included, the exclusion will take precedence.
+    "displayName": "A String", # Output only. The display name of the category.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CATEGORY`.
+  },
+  "channelDetails": { # Details for assigned channel targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CHANNEL`. # Channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_CHANNEL`.
+    "channelId": "A String", # Required. ID of the channel. Should refer to the channel ID field on a [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id) resource.
+    "negative": True or False, # Indicates if this option is being negatively targeted. For advertiser level assigned targeting option, this field must be true.
+  },
+  "contentDurationDetails": { # Details for content duration assigned targeting option. This will be populated in the content_duration_details field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`. Explicitly targeting all options is not supported. Remove all content duration targeting options to achieve this effect. # Content duration details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
+    "contentDuration": "A String", # Output only. The content duration.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
+  },
+  "contentGenreDetails": { # Details for content genre assigned targeting option. This will be populated in the content_genre_details field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`. Explicitly targeting all options is not supported. Remove all content genre targeting options to achieve this effect. # Content genre details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
+    "displayName": "A String", # Output only. The display name of the content genre.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
+  },
+  "contentInstreamPositionDetails": { # Assigned content instream position targeting option details. This will be populated in the content_instream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. # Content instream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.
+    "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`. * `AD_TYPE_AUDIO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_AUDIO_DEFAULT`.
+    "contentInstreamPosition": "A String", # Required. The content instream position for video or audio ads.
+  },
+  "contentOutstreamPositionDetails": { # Assigned content outstream position targeting option details. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. # Content outstream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.
+    "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+    "contentOutstreamPosition": "A String", # Required. The content outstream position.
+  },
+  "contentStreamTypeDetails": { # Details for content stream type assigned targeting option. This will be populated in the content_stream_type_details field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`. Explicitly targeting all options is not supported. Remove all content stream type targeting options to achieve this effect. # Content duration details. This field will be populated when the TargetingType is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
+    "contentStreamType": "A String", # Output only. The content stream type.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
+  },
+  "dayAndTimeDetails": { # Representation of a segment of time defined on a specific day of the week and with a start and end time. The time represented by `start_hour` must be before the time represented by `end_hour`. # Day and time details. This field will be populated when the targeting_type is `TARGETING_TYPE_DAY_AND_TIME`.
+    "dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting.
+    "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day).
+    "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day).
+    "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting.
+  },
+  "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
+    "displayName": "A String", # Output only. The display name of the device make and model.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
+  },
+  "deviceTypeDetails": { # Targeting details for device type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`. # Device Type details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_TYPE`.
+    "deviceType": "A String", # Required. The display name of the device type.
+    "youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items.
+  },
+  "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded.
+    "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED.
+  },
+  "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`.
+    "environment": "A String", # Required. The serving environment.
+  },
+  "exchangeDetails": { # Details for assigned exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`. # Exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_EXCHANGE`.
+    "exchange": "A String", # Required. The enum value for the exchange.
+  },
+  "genderDetails": { # Details for assigned gender targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GENDER`. # Gender details. This field will be populated when the targeting_type is `TARGETING_TYPE_GENDER`.
+    "gender": "A String", # Required. The gender of the audience.
+  },
+  "geoRegionDetails": { # Details for assigned geographic region targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GEO_REGION`. # Geographic region details. This field will be populated when the targeting_type is `TARGETING_TYPE_GEO_REGION`.
+    "displayName": "A String", # Output only. The display name of the geographic region (e.g., "Ontario, Canada").
+    "geoRegionType": "A String", # Output only. The type of geographic region targeting.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GEO_REGION`.
+  },
+  "householdIncomeDetails": { # Details for assigned household income targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`. # Household income details. This field will be populated when the targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`.
+    "householdIncome": "A String", # Required. The household income of the audience.
+  },
+  "inheritance": "A String", # Output only. The inheritance status of the assigned targeting option.
+  "inventorySourceDetails": { # Targeting details for inventory source. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`. # Inventory source details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`.
+    "inventorySourceId": "A String", # Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource.
+  },
+  "inventorySourceGroupDetails": { # Targeting details for inventory source group. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`. # Inventory source group details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`.
+    "inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource.
+  },
+  "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned.
+    "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+  },
+  "languageDetails": { # Details for assigned language targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_LANGUAGE`. # Language details. This field will be populated when the targeting_type is `TARGETING_TYPE_LANGUAGE`.
+    "displayName": "A String", # Output only. The display name of the language (e.g., "French").
+    "negative": True or False, # Indicates if this option is being negatively targeted. All assigned language targeting options on the same resource must have the same value for this field.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_LANGUAGE`.
+  },
+  "name": "A String", # Output only. The resource name for this assigned targeting option.
+  "nativeContentPositionDetails": { # Details for native content position assigned targeting option. This will be populated in the native_content_position_details field when targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`. Explicitly targeting all options is not supported. Remove all native content position targeting options to achieve this effect. # Native content position details. This field will be populated when the targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`.
+    "contentPosition": "A String", # Required. The content position.
+  },
+  "negativeKeywordListDetails": { # Targeting details for negative keyword list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. A maximum of 4 negative keyword lists can be assigned to a resource.
+    "negativeKeywordListId": "A String", # Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource.
+  },
+  "omidDetails": { # Represents a targetable Open Measurement enabled inventory type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_OMID`. # Open Measurement enabled inventory details. This field will be populated when the targeting_type is `TARGETING_TYPE_OMID`.
+    "omid": "A String", # Required. The type of Open Measurement enabled inventory.
+  },
+  "onScreenPositionDetails": { # On screen position targeting option details. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. # On screen position details. This field will be populated when the targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
+    "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+    "onScreenPosition": "A String", # Output only. The on screen position.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
+  },
+  "operatingSystemDetails": { # Assigned operating system targeting option details. This will be populated in the operating_system_details field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. # Operating system details. This field will be populated when the targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
+    "displayName": "A String", # Output only. The display name of the operating system.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting option ID populated in targeting_option_id field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
+  },
+  "parentalStatusDetails": { # Details for assigned parental status targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`. # Parental status details. This field will be populated when the targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`.
+    "parentalStatus": "A String", # Required. The parental status of the audience.
+  },
+  "poiDetails": { # Details for assigned POI targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_POI`. # POI details. This field will be populated when the targeting_type is `TARGETING_TYPE_POI`.
+    "displayName": "A String", # Output only. The display name of a POI, e.g. "Times Square", "Space Needle", followed by its full address if available.
+    "latitude": 3.14, # Output only. Latitude of the POI rounding to 6th decimal place.
+    "longitude": 3.14, # Output only. Longitude of the POI rounding to 6th decimal place.
+    "proximityRadiusAmount": 3.14, # Required. The radius of the area around the POI that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`.
+    "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_POI`. Accepted POI targeting option IDs can be retrieved using `targetingTypes.targetingOptions.search`. If targeting a specific latitude/longitude coordinate removed from an address or POI name, you can generate the necessary targeting option ID by rounding the desired coordinate values to the 6th decimal place, removing the decimals, and concatenating the string values separated by a semicolon. For example, you can target the latitude/longitude pair of 40.7414691, -74.003387 using the targeting option ID "40741469;-74003387". **Upon** **creation, this field value will be updated to append a semicolon and** **alphanumerical hash value if only latitude/longitude coordinates are** **provided.**
+  },
+  "proximityLocationListDetails": { # Targeting details for proximity location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`. # Proximity location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`.
+    "proximityLocationListId": "A String", # Required. ID of the proximity location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_PROXIMITY`.
+    "proximityRadius": 3.14, # Required. Radius expressed in the distance units set in proximity_radius_unit. This represents the size of the area around a chosen location that will be targeted. Radius should be between 1 and 500 miles or 800 kilometers.
+    "proximityRadiusUnit": "A String", # Required. Radius distance units.
+  },
+  "regionalLocationListDetails": { # Targeting details for regional location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`. # Regional location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`.
+  },
+  "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them.
+    "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED.
+  },
+  "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`.
+    "sessionPosition": "A String", # The position where the ad will show in a session.
+  },
+  "subExchangeDetails": { # Details for assigned sub-exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`. # Sub-exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`.
+  },
+  "targetingType": "A String", # Output only. Identifies the type of this assigned targeting option.
+  "thirdPartyVerifierDetails": { # Assigned third party verifier targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`. # Third party verification details. This field will be populated when the targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`.
+    "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox.
+      "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads.
+      "excludedAdlooxCategories": [ # Adloox categories to exclude.
+        "A String",
+      ],
+      "excludedFraudIvtMfaCategories": [ # Optional. Adloox's fraud IVT MFA categories to exclude.
+        "A String",
+      ],
+      "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads.
+    },
+    "doubleVerify": { # Details of DoubleVerify settings. # Third party brand verifier -- DoubleVerify.
+      "appStarRating": { # Details of DoubleVerify star ratings settings. # Avoid bidding on apps with the star ratings.
+        "avoidInsufficientStarRating": True or False, # Avoid bidding on apps with insufficient star ratings.
+        "avoidedStarRating": "A String", # Avoid bidding on apps with the star ratings.
+      },
+      "avoidedAgeRatings": [ # Avoid bidding on apps with the age rating.
+        "A String",
+      ],
+      "brandSafetyCategories": { # Settings for brand safety controls. # DV Brand Safety Controls.
+        "avoidUnknownBrandSafetyCategory": True or False, # Unknown or unrateable.
+        "avoidedHighSeverityCategories": [ # Brand safety high severity avoidance categories.
+          "A String",
+        ],
+        "avoidedMediumSeverityCategories": [ # Brand safety medium severity avoidance categories.
+          "A String",
+        ],
+      },
+      "customSegmentId": "A String", # The custom segment ID provided by DoubleVerify. The ID must start with "51" and consist of eight digits. Custom segment ID cannot be specified along with any of the following fields: * brand_safety_categories * avoided_age_ratings * app_star_rating * fraud_invalid_traffic
+      "displayViewability": { # Details of DoubleVerify display viewability settings. # Display viewability settings (applicable to display line items only).
+        "iab": "A String", # Target web and app inventory to maximize IAB viewable rate.
+        "viewableDuring": "A String", # Target web and app inventory to maximize 100% viewable duration.
+      },
+      "fraudInvalidTraffic": { # DoubleVerify Fraud & Invalid Traffic settings. # Avoid Sites and Apps with historical Fraud & IVT Rates.
+        "avoidInsufficientOption": True or False, # Insufficient Historical Fraud & IVT Stats.
+        "avoidedFraudOption": "A String", # Avoid Sites and Apps with historical Fraud & IVT.
+      },
+      "videoViewability": { # Details of DoubleVerify video viewability settings. # Video viewability settings (applicable to video line items only).
+        "playerImpressionRate": "A String", # Target inventory to maximize impressions with 400x300 or greater player size.
+        "videoIab": "A String", # Target web inventory to maximize IAB viewable rate.
+        "videoViewableRate": "A String", # Target web inventory to maximize fully viewable rate.
+      },
+    },
+    "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science.
+      "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive.
+        "A String",
+      ],
+      "displayViewability": "A String", # Display Viewability section (applicable to display line items only).
+      "excludeUnrateable": True or False, # Brand Safety - **Unrateable**.
+      "excludedAdFraudRisk": "A String", # Ad Fraud settings.
+      "excludedAdultRisk": "A String", # Brand Safety - **Adult content**.
+      "excludedAlcoholRisk": "A String", # Brand Safety - **Alcohol**.
+      "excludedDrugsRisk": "A String", # Brand Safety - **Drugs**.
+      "excludedGamblingRisk": "A String", # Brand Safety - **Gambling**.
+      "excludedHateSpeechRisk": "A String", # Brand Safety - **Hate speech**.
+      "excludedIllegalDownloadsRisk": "A String", # Brand Safety - **Illegal downloads**.
+      "excludedOffensiveLanguageRisk": "A String", # Brand Safety - **Offensive language**.
+      "excludedViolenceRisk": "A String", # Brand Safety - **Violence**.
+      "qualitySyncCustomSegmentId": [ # Optional. The quality sync custom segment ID provided by Integral Ad Science. The ID must be between `3000000` and `4999999`, inclusive.
+        "A String",
+      ],
+      "traqScoreOption": "A String", # True advertising quality (applicable to Display line items only).
+      "videoViewability": "A String", # Video Viewability Section (applicable to video line items only).
+    },
+  },
+  "urlDetails": { # Details for assigned URL targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_URL`. # URL details. This field will be populated when the targeting_type is `TARGETING_TYPE_URL`.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "url": "A String", # Required. The URL, for example `example.com`. DV360 supports two levels of subdirectory targeting, for example `www.example.com/one-subdirectory-level/second-level`, and five levels of subdomain targeting, for example `five.four.three.two.one.example.com`.
+  },
+  "userRewardedContentDetails": { # User rewarded content targeting option details. This will be populated in the user_rewarded_content_details field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. # User rewarded content details. This field will be populated when the targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
+    "userRewardedContent": "A String", # Output only. User rewarded content status for video ads.
+  },
+  "videoPlayerSizeDetails": { # Video player size targeting option details. This will be populated in the video_player_size_details field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. Explicitly targeting all options is not supported. Remove all video player size targeting options to achieve this effect. # Video player size details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.
+    "videoPlayerSize": "A String", # Required. The video player size.
+  },
+  "viewabilityDetails": { # Assigned viewability targeting option details. This will be populated in the viewability_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`. # Viewability details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIEWABILITY`. You can only target one viewability option per resource.
+    "viewability": "A String", # Required. The predicted viewability percentage.
+  },
+  "youtubeChannelDetails": { # Details for YouTube channel assigned targeting option. This will be populated in the youtube_channel_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`. # YouTube channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`.
+    "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+  },
+  "youtubeVideoDetails": { # Details for YouTube video assigned targeting option. This will be populated in the youtube_video_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`. # YouTube video details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "videoId": "A String", # YouTube video id as it appears on the YouTube watch page.
+  },
+}
+
+ +
+ delete(partnerId, targetingType, assignedTargetingOptionId, x__xgafv=None) +
Deletes an assigned targeting option from a partner.
+
+Args:
+  partnerId: string, Required. The ID of the partner. (required)
+  targetingType: string, Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` (required)
+    Allowed values
+      TARGETING_TYPE_UNSPECIFIED - Default value when type is not specified or is unknown in this version.
+      TARGETING_TYPE_CHANNEL - Target a channel (a custom group of related websites or apps).
+      TARGETING_TYPE_APP_CATEGORY - Target an app category (for example, education or puzzle games).
+      TARGETING_TYPE_APP - Target a specific app (for example, Angry Birds).
+      TARGETING_TYPE_URL - Target a specific url (for example, quora.com).
+      TARGETING_TYPE_DAY_AND_TIME - Target ads during a chosen time period on a specific day.
+      TARGETING_TYPE_AGE_RANGE - Target ads to a specific age range (for example, 18-24).
+      TARGETING_TYPE_REGIONAL_LOCATION_LIST - Target ads to the specified regions on a regional location list.
+      TARGETING_TYPE_PROXIMITY_LOCATION_LIST - Target ads to the specified points of interest on a proximity location list.
+      TARGETING_TYPE_GENDER - Target ads to a specific gender (for example, female or male).
+      TARGETING_TYPE_VIDEO_PLAYER_SIZE - Target a specific video player size for video ads.
+      TARGETING_TYPE_USER_REWARDED_CONTENT - Target user rewarded content for video ads.
+      TARGETING_TYPE_PARENTAL_STATUS - Target ads to a specific parental status (for example, parent or not a parent).
+      TARGETING_TYPE_CONTENT_INSTREAM_POSITION - Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).
+      TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION - Target ads in a specific content outstream position.
+      TARGETING_TYPE_DEVICE_TYPE - Target ads to a specific device type (for example, tablet or connected TV).
+      TARGETING_TYPE_AUDIENCE_GROUP - Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.
+      TARGETING_TYPE_BROWSER - Target ads to specific web browsers (for example, Chrome).
+      TARGETING_TYPE_HOUSEHOLD_INCOME - Target ads to a specific household income range (for example, top 10%).
+      TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position.
+      TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify).
+      TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).
+      TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult).
+      TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app).
+      TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).
+      TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS).
+      TARGETING_TYPE_DEVICE_MAKE_MODEL - Target ads to a specific device make or model (for example, Roku or Samsung).
+      TARGETING_TYPE_KEYWORD - Target ads to a specific keyword (for example, dog or retriever).
+      TARGETING_TYPE_NEGATIVE_KEYWORD_LIST - Target ads to a specific negative keyword list.
+      TARGETING_TYPE_VIEWABILITY - Target ads to a specific viewability (for example, 80% viewable).
+      TARGETING_TYPE_CATEGORY - Target ads to a specific content category (for example, arts & entertainment).
+      TARGETING_TYPE_INVENTORY_SOURCE - Purchase impressions from specific deals and auction packages.
+      TARGETING_TYPE_LANGUAGE - Target ads to a specific language (for example, English or Japanese).
+      TARGETING_TYPE_AUTHORIZED_SELLER_STATUS - Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.
+      TARGETING_TYPE_GEO_REGION - Target ads to a specific regional location (for example, a city or state).
+      TARGETING_TYPE_INVENTORY_SOURCE_GROUP - Purchase impressions from a group of deals and auction packages.
+      TARGETING_TYPE_EXCHANGE - Purchase impressions from specific exchanges.
+      TARGETING_TYPE_SUB_EXCHANGE - Purchase impressions from specific sub-exchanges.
+      TARGETING_TYPE_POI - Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.
+      TARGETING_TYPE_BUSINESS_CHAIN - Target ads around locations of a business chain within a specific geo region.
+      TARGETING_TYPE_CONTENT_DURATION - Target ads to a specific video content duration.
+      TARGETING_TYPE_CONTENT_STREAM_TYPE - Target ads to a specific video content stream type.
+      TARGETING_TYPE_NATIVE_CONTENT_POSITION - Target ads to a specific native content position.
+      TARGETING_TYPE_OMID - Target ads in an Open Measurement enabled inventory.
+      TARGETING_TYPE_AUDIO_CONTENT_TYPE - Target ads to a specific audio content type.
+      TARGETING_TYPE_CONTENT_GENRE - Target ads to a specific content genre.
+      TARGETING_TYPE_YOUTUBE_VIDEO - Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
+      TARGETING_TYPE_YOUTUBE_CHANNEL - Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
+      TARGETING_TYPE_SESSION_POSITION - Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.
+  assignedTargetingOptionId: string, Required. The ID of the assigned targeting option 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(partnerId, targetingType, assignedTargetingOptionId, x__xgafv=None) +
Gets a single targeting option assigned to a partner.
+
+Args:
+  partnerId: string, Required. The ID of the partner. (required)
+  targetingType: string, Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` (required)
+    Allowed values
+      TARGETING_TYPE_UNSPECIFIED - Default value when type is not specified or is unknown in this version.
+      TARGETING_TYPE_CHANNEL - Target a channel (a custom group of related websites or apps).
+      TARGETING_TYPE_APP_CATEGORY - Target an app category (for example, education or puzzle games).
+      TARGETING_TYPE_APP - Target a specific app (for example, Angry Birds).
+      TARGETING_TYPE_URL - Target a specific url (for example, quora.com).
+      TARGETING_TYPE_DAY_AND_TIME - Target ads during a chosen time period on a specific day.
+      TARGETING_TYPE_AGE_RANGE - Target ads to a specific age range (for example, 18-24).
+      TARGETING_TYPE_REGIONAL_LOCATION_LIST - Target ads to the specified regions on a regional location list.
+      TARGETING_TYPE_PROXIMITY_LOCATION_LIST - Target ads to the specified points of interest on a proximity location list.
+      TARGETING_TYPE_GENDER - Target ads to a specific gender (for example, female or male).
+      TARGETING_TYPE_VIDEO_PLAYER_SIZE - Target a specific video player size for video ads.
+      TARGETING_TYPE_USER_REWARDED_CONTENT - Target user rewarded content for video ads.
+      TARGETING_TYPE_PARENTAL_STATUS - Target ads to a specific parental status (for example, parent or not a parent).
+      TARGETING_TYPE_CONTENT_INSTREAM_POSITION - Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).
+      TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION - Target ads in a specific content outstream position.
+      TARGETING_TYPE_DEVICE_TYPE - Target ads to a specific device type (for example, tablet or connected TV).
+      TARGETING_TYPE_AUDIENCE_GROUP - Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.
+      TARGETING_TYPE_BROWSER - Target ads to specific web browsers (for example, Chrome).
+      TARGETING_TYPE_HOUSEHOLD_INCOME - Target ads to a specific household income range (for example, top 10%).
+      TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position.
+      TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify).
+      TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).
+      TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult).
+      TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app).
+      TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).
+      TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS).
+      TARGETING_TYPE_DEVICE_MAKE_MODEL - Target ads to a specific device make or model (for example, Roku or Samsung).
+      TARGETING_TYPE_KEYWORD - Target ads to a specific keyword (for example, dog or retriever).
+      TARGETING_TYPE_NEGATIVE_KEYWORD_LIST - Target ads to a specific negative keyword list.
+      TARGETING_TYPE_VIEWABILITY - Target ads to a specific viewability (for example, 80% viewable).
+      TARGETING_TYPE_CATEGORY - Target ads to a specific content category (for example, arts & entertainment).
+      TARGETING_TYPE_INVENTORY_SOURCE - Purchase impressions from specific deals and auction packages.
+      TARGETING_TYPE_LANGUAGE - Target ads to a specific language (for example, English or Japanese).
+      TARGETING_TYPE_AUTHORIZED_SELLER_STATUS - Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.
+      TARGETING_TYPE_GEO_REGION - Target ads to a specific regional location (for example, a city or state).
+      TARGETING_TYPE_INVENTORY_SOURCE_GROUP - Purchase impressions from a group of deals and auction packages.
+      TARGETING_TYPE_EXCHANGE - Purchase impressions from specific exchanges.
+      TARGETING_TYPE_SUB_EXCHANGE - Purchase impressions from specific sub-exchanges.
+      TARGETING_TYPE_POI - Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.
+      TARGETING_TYPE_BUSINESS_CHAIN - Target ads around locations of a business chain within a specific geo region.
+      TARGETING_TYPE_CONTENT_DURATION - Target ads to a specific video content duration.
+      TARGETING_TYPE_CONTENT_STREAM_TYPE - Target ads to a specific video content stream type.
+      TARGETING_TYPE_NATIVE_CONTENT_POSITION - Target ads to a specific native content position.
+      TARGETING_TYPE_OMID - Target ads in an Open Measurement enabled inventory.
+      TARGETING_TYPE_AUDIO_CONTENT_TYPE - Target ads to a specific audio content type.
+      TARGETING_TYPE_CONTENT_GENRE - Target ads to a specific content genre.
+      TARGETING_TYPE_YOUTUBE_VIDEO - Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
+      TARGETING_TYPE_YOUTUBE_CHANNEL - Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
+      TARGETING_TYPE_SESSION_POSITION - Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.
+  assignedTargetingOptionId: string, Required. An identifier unique to the targeting type in this partner that identifies the assigned targeting option being requested. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings.
+  "ageRangeDetails": { # Represents a targetable age range. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AGE_RANGE`. # Age range details. This field will be populated when the targeting_type is `TARGETING_TYPE_AGE_RANGE`.
+    "ageRange": "A String", # Required. The age range of an audience. We only support targeting a continuous age range of an audience. Thus, the age range represented in this field can be 1) targeted solely, or, 2) part of a larger continuous age range. The reach of a continuous age range targeting can be expanded by also targeting an audience of an unknown age.
+  },
+  "appCategoryDetails": { # Details for assigned app category targeting option. This will be populated in the app_category_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. # App category details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
+    "displayName": "A String", # Output only. The display name of the app category.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
+  },
+  "appDetails": { # Details for assigned app targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP`. # App details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP`.
+    "appId": "A String", # Required. The ID of the app. Android's Play store app uses bundle ID, for example `com.google.android.gm`. Apple's App store app ID uses 9 digit string, for example `422689480`.
+    "appPlatform": "A String", # Indicates the platform of the targeted app. If this field is not specified, the app platform will be assumed to be mobile (i.e., Android or iOS), and we will derive the appropriate mobile platform from the app ID.
+    "displayName": "A String", # Output only. The display name of the app.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+  },
+  "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts.
+  "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`
+  "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource.
+    "excludedFirstPartyAndPartnerAudienceGroup": { # Details of first party and partner audience group. All first party and partner audience targeting settings are logically ‘OR’ of each other. # Optional. The first party and partner audience ids and recencies of the excluded first party and partner audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other.
+      "settings": [ # Required. All first party and partner audience targeting settings in first party and partner audience group. Repeated settings with the same id are not allowed.
+        { # Details of first party and partner audience targeting setting.
+          "firstPartyAndPartnerAudienceId": "A String", # Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.
+          "recency": "A String", # Required. The recency of the first party and partner audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
+        },
+      ],
+    },
+    "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other.
+      "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
+        { # Details of Google audience targeting setting.
+          "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
+        },
+      ],
+    },
+    "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only.
+      "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise.
+        { # Details of combined audience targeting setting.
+          "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id.
+        },
+      ],
+    },
+    "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only.
+      "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored.
+        { # Details of custom list targeting setting.
+          "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id.
+        },
+      ],
+    },
+    "includedFirstPartyAndPartnerAudienceGroups": [ # Optional. The first party and partner audience ids and recencies of included first party and partner audience groups. Each first party and partner audience group contains first party and partner audience ids only. The relation between each first party and partner audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored.
+      { # Details of first party and partner audience group. All first party and partner audience targeting settings are logically ‘OR’ of each other.
+        "settings": [ # Required. All first party and partner audience targeting settings in first party and partner audience group. Repeated settings with the same id are not allowed.
+          { # Details of first party and partner audience targeting setting.
+            "firstPartyAndPartnerAudienceId": "A String", # Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.
+            "recency": "A String", # Required. The recency of the first party and partner audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
+          },
+        ],
+      },
+    ],
+    "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only.
+      "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
+        { # Details of Google audience targeting setting.
+          "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
+        },
+      ],
+    },
+  },
+  "audioContentTypeDetails": { # Details for audio content type assigned targeting option. This will be populated in the audio_content_type_details field when targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`. Explicitly targeting all options is not supported. Remove all audio content type targeting options to achieve this effect. # Audio content type details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`.
+    "audioContentType": "A String", # Required. The audio content type.
+  },
+  "authorizedSellerStatusDetails": { # Represents an assigned authorized seller status. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. If a resource does not have an `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` assigned targeting option, it is using the "Authorized Direct Sellers and Resellers" option. # Authorized seller status details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. You can only target one authorized seller status option per resource. If a resource doesn't have an authorized seller status option, all authorized sellers indicated as DIRECT or RESELLER in the ads.txt file are targeted by default.
+    "authorizedSellerStatus": "A String", # Output only. The authorized seller status to target.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.
+  },
+  "browserDetails": { # Details for assigned browser targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BROWSER`. # Browser details. This field will be populated when the targeting_type is `TARGETING_TYPE_BROWSER`.
+    "displayName": "A String", # Output only. The display name of the browser.
+    "negative": True or False, # Indicates if this option is being negatively targeted. All assigned browser targeting options on the same resource must have the same value for this field.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BROWSER`.
+  },
+  "businessChainDetails": { # Details for assigned Business chain targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`. # Business chain details. This field will be populated when the targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`.
+    "displayName": "A String", # Output only. The display name of a business chain, e.g. "KFC", "Chase Bank".
+    "proximityRadiusAmount": 3.14, # Required. The radius of the area around the business chain that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`. The minimum increment for both cases is 0.1. Inputs will be rounded to the nearest acceptable value if it is too granular, e.g. 15.57 will become 15.6.
+    "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BUSINESS_CHAIN`. Accepted business chain targeting option IDs can be retrieved using SearchTargetingOptions.
+  },
+  "carrierAndIspDetails": { # Details for assigned carrier and ISP targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`. # Carrier and ISP details. This field will be populated when the targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`.
+    "displayName": "A String", # Output only. The display name of the carrier or ISP.
+    "negative": True or False, # Indicates if this option is being negatively targeted. All assigned carrier and ISP targeting options on the same resource must have the same value for this field.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`.
+  },
+  "categoryDetails": { # Assigned category targeting option details. This will be populated in the category_details field when targeting_type is `TARGETING_TYPE_CATEGORY`. # Category details. This field will be populated when the targeting_type is `TARGETING_TYPE_CATEGORY`. Targeting a category will also target its subcategories. If a category is excluded from targeting and a subcategory is included, the exclusion will take precedence.
+    "displayName": "A String", # Output only. The display name of the category.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CATEGORY`.
+  },
+  "channelDetails": { # Details for assigned channel targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CHANNEL`. # Channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_CHANNEL`.
+    "channelId": "A String", # Required. ID of the channel. Should refer to the channel ID field on a [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id) resource.
+    "negative": True or False, # Indicates if this option is being negatively targeted. For advertiser level assigned targeting option, this field must be true.
+  },
+  "contentDurationDetails": { # Details for content duration assigned targeting option. This will be populated in the content_duration_details field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`. Explicitly targeting all options is not supported. Remove all content duration targeting options to achieve this effect. # Content duration details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
+    "contentDuration": "A String", # Output only. The content duration.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
+  },
+  "contentGenreDetails": { # Details for content genre assigned targeting option. This will be populated in the content_genre_details field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`. Explicitly targeting all options is not supported. Remove all content genre targeting options to achieve this effect. # Content genre details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
+    "displayName": "A String", # Output only. The display name of the content genre.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
+  },
+  "contentInstreamPositionDetails": { # Assigned content instream position targeting option details. This will be populated in the content_instream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. # Content instream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.
+    "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`. * `AD_TYPE_AUDIO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_AUDIO_DEFAULT`.
+    "contentInstreamPosition": "A String", # Required. The content instream position for video or audio ads.
+  },
+  "contentOutstreamPositionDetails": { # Assigned content outstream position targeting option details. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. # Content outstream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.
+    "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+    "contentOutstreamPosition": "A String", # Required. The content outstream position.
+  },
+  "contentStreamTypeDetails": { # Details for content stream type assigned targeting option. This will be populated in the content_stream_type_details field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`. Explicitly targeting all options is not supported. Remove all content stream type targeting options to achieve this effect. # Content duration details. This field will be populated when the TargetingType is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
+    "contentStreamType": "A String", # Output only. The content stream type.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
+  },
+  "dayAndTimeDetails": { # Representation of a segment of time defined on a specific day of the week and with a start and end time. The time represented by `start_hour` must be before the time represented by `end_hour`. # Day and time details. This field will be populated when the targeting_type is `TARGETING_TYPE_DAY_AND_TIME`.
+    "dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting.
+    "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day).
+    "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day).
+    "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting.
+  },
+  "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
+    "displayName": "A String", # Output only. The display name of the device make and model.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
+  },
+  "deviceTypeDetails": { # Targeting details for device type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`. # Device Type details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_TYPE`.
+    "deviceType": "A String", # Required. The display name of the device type.
+    "youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items.
+  },
+  "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded.
+    "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED.
+  },
+  "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`.
+    "environment": "A String", # Required. The serving environment.
+  },
+  "exchangeDetails": { # Details for assigned exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`. # Exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_EXCHANGE`.
+    "exchange": "A String", # Required. The enum value for the exchange.
+  },
+  "genderDetails": { # Details for assigned gender targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GENDER`. # Gender details. This field will be populated when the targeting_type is `TARGETING_TYPE_GENDER`.
+    "gender": "A String", # Required. The gender of the audience.
+  },
+  "geoRegionDetails": { # Details for assigned geographic region targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GEO_REGION`. # Geographic region details. This field will be populated when the targeting_type is `TARGETING_TYPE_GEO_REGION`.
+    "displayName": "A String", # Output only. The display name of the geographic region (e.g., "Ontario, Canada").
+    "geoRegionType": "A String", # Output only. The type of geographic region targeting.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GEO_REGION`.
+  },
+  "householdIncomeDetails": { # Details for assigned household income targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`. # Household income details. This field will be populated when the targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`.
+    "householdIncome": "A String", # Required. The household income of the audience.
+  },
+  "inheritance": "A String", # Output only. The inheritance status of the assigned targeting option.
+  "inventorySourceDetails": { # Targeting details for inventory source. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`. # Inventory source details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`.
+    "inventorySourceId": "A String", # Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource.
+  },
+  "inventorySourceGroupDetails": { # Targeting details for inventory source group. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`. # Inventory source group details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`.
+    "inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource.
+  },
+  "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned.
+    "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+  },
+  "languageDetails": { # Details for assigned language targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_LANGUAGE`. # Language details. This field will be populated when the targeting_type is `TARGETING_TYPE_LANGUAGE`.
+    "displayName": "A String", # Output only. The display name of the language (e.g., "French").
+    "negative": True or False, # Indicates if this option is being negatively targeted. All assigned language targeting options on the same resource must have the same value for this field.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_LANGUAGE`.
+  },
+  "name": "A String", # Output only. The resource name for this assigned targeting option.
+  "nativeContentPositionDetails": { # Details for native content position assigned targeting option. This will be populated in the native_content_position_details field when targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`. Explicitly targeting all options is not supported. Remove all native content position targeting options to achieve this effect. # Native content position details. This field will be populated when the targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`.
+    "contentPosition": "A String", # Required. The content position.
+  },
+  "negativeKeywordListDetails": { # Targeting details for negative keyword list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. A maximum of 4 negative keyword lists can be assigned to a resource.
+    "negativeKeywordListId": "A String", # Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource.
+  },
+  "omidDetails": { # Represents a targetable Open Measurement enabled inventory type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_OMID`. # Open Measurement enabled inventory details. This field will be populated when the targeting_type is `TARGETING_TYPE_OMID`.
+    "omid": "A String", # Required. The type of Open Measurement enabled inventory.
+  },
+  "onScreenPositionDetails": { # On screen position targeting option details. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. # On screen position details. This field will be populated when the targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
+    "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+    "onScreenPosition": "A String", # Output only. The on screen position.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
+  },
+  "operatingSystemDetails": { # Assigned operating system targeting option details. This will be populated in the operating_system_details field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. # Operating system details. This field will be populated when the targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
+    "displayName": "A String", # Output only. The display name of the operating system.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting option ID populated in targeting_option_id field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
+  },
+  "parentalStatusDetails": { # Details for assigned parental status targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`. # Parental status details. This field will be populated when the targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`.
+    "parentalStatus": "A String", # Required. The parental status of the audience.
+  },
+  "poiDetails": { # Details for assigned POI targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_POI`. # POI details. This field will be populated when the targeting_type is `TARGETING_TYPE_POI`.
+    "displayName": "A String", # Output only. The display name of a POI, e.g. "Times Square", "Space Needle", followed by its full address if available.
+    "latitude": 3.14, # Output only. Latitude of the POI rounding to 6th decimal place.
+    "longitude": 3.14, # Output only. Longitude of the POI rounding to 6th decimal place.
+    "proximityRadiusAmount": 3.14, # Required. The radius of the area around the POI that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`.
+    "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_POI`. Accepted POI targeting option IDs can be retrieved using `targetingTypes.targetingOptions.search`. If targeting a specific latitude/longitude coordinate removed from an address or POI name, you can generate the necessary targeting option ID by rounding the desired coordinate values to the 6th decimal place, removing the decimals, and concatenating the string values separated by a semicolon. For example, you can target the latitude/longitude pair of 40.7414691, -74.003387 using the targeting option ID "40741469;-74003387". **Upon** **creation, this field value will be updated to append a semicolon and** **alphanumerical hash value if only latitude/longitude coordinates are** **provided.**
+  },
+  "proximityLocationListDetails": { # Targeting details for proximity location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`. # Proximity location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`.
+    "proximityLocationListId": "A String", # Required. ID of the proximity location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_PROXIMITY`.
+    "proximityRadius": 3.14, # Required. Radius expressed in the distance units set in proximity_radius_unit. This represents the size of the area around a chosen location that will be targeted. Radius should be between 1 and 500 miles or 800 kilometers.
+    "proximityRadiusUnit": "A String", # Required. Radius distance units.
+  },
+  "regionalLocationListDetails": { # Targeting details for regional location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`. # Regional location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`.
+  },
+  "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them.
+    "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED.
+  },
+  "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`.
+    "sessionPosition": "A String", # The position where the ad will show in a session.
+  },
+  "subExchangeDetails": { # Details for assigned sub-exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`. # Sub-exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`.
+  },
+  "targetingType": "A String", # Output only. Identifies the type of this assigned targeting option.
+  "thirdPartyVerifierDetails": { # Assigned third party verifier targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`. # Third party verification details. This field will be populated when the targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`.
+    "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox.
+      "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads.
+      "excludedAdlooxCategories": [ # Adloox categories to exclude.
+        "A String",
+      ],
+      "excludedFraudIvtMfaCategories": [ # Optional. Adloox's fraud IVT MFA categories to exclude.
+        "A String",
+      ],
+      "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads.
+    },
+    "doubleVerify": { # Details of DoubleVerify settings. # Third party brand verifier -- DoubleVerify.
+      "appStarRating": { # Details of DoubleVerify star ratings settings. # Avoid bidding on apps with the star ratings.
+        "avoidInsufficientStarRating": True or False, # Avoid bidding on apps with insufficient star ratings.
+        "avoidedStarRating": "A String", # Avoid bidding on apps with the star ratings.
+      },
+      "avoidedAgeRatings": [ # Avoid bidding on apps with the age rating.
+        "A String",
+      ],
+      "brandSafetyCategories": { # Settings for brand safety controls. # DV Brand Safety Controls.
+        "avoidUnknownBrandSafetyCategory": True or False, # Unknown or unrateable.
+        "avoidedHighSeverityCategories": [ # Brand safety high severity avoidance categories.
+          "A String",
+        ],
+        "avoidedMediumSeverityCategories": [ # Brand safety medium severity avoidance categories.
+          "A String",
+        ],
+      },
+      "customSegmentId": "A String", # The custom segment ID provided by DoubleVerify. The ID must start with "51" and consist of eight digits. Custom segment ID cannot be specified along with any of the following fields: * brand_safety_categories * avoided_age_ratings * app_star_rating * fraud_invalid_traffic
+      "displayViewability": { # Details of DoubleVerify display viewability settings. # Display viewability settings (applicable to display line items only).
+        "iab": "A String", # Target web and app inventory to maximize IAB viewable rate.
+        "viewableDuring": "A String", # Target web and app inventory to maximize 100% viewable duration.
+      },
+      "fraudInvalidTraffic": { # DoubleVerify Fraud & Invalid Traffic settings. # Avoid Sites and Apps with historical Fraud & IVT Rates.
+        "avoidInsufficientOption": True or False, # Insufficient Historical Fraud & IVT Stats.
+        "avoidedFraudOption": "A String", # Avoid Sites and Apps with historical Fraud & IVT.
+      },
+      "videoViewability": { # Details of DoubleVerify video viewability settings. # Video viewability settings (applicable to video line items only).
+        "playerImpressionRate": "A String", # Target inventory to maximize impressions with 400x300 or greater player size.
+        "videoIab": "A String", # Target web inventory to maximize IAB viewable rate.
+        "videoViewableRate": "A String", # Target web inventory to maximize fully viewable rate.
+      },
+    },
+    "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science.
+      "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive.
+        "A String",
+      ],
+      "displayViewability": "A String", # Display Viewability section (applicable to display line items only).
+      "excludeUnrateable": True or False, # Brand Safety - **Unrateable**.
+      "excludedAdFraudRisk": "A String", # Ad Fraud settings.
+      "excludedAdultRisk": "A String", # Brand Safety - **Adult content**.
+      "excludedAlcoholRisk": "A String", # Brand Safety - **Alcohol**.
+      "excludedDrugsRisk": "A String", # Brand Safety - **Drugs**.
+      "excludedGamblingRisk": "A String", # Brand Safety - **Gambling**.
+      "excludedHateSpeechRisk": "A String", # Brand Safety - **Hate speech**.
+      "excludedIllegalDownloadsRisk": "A String", # Brand Safety - **Illegal downloads**.
+      "excludedOffensiveLanguageRisk": "A String", # Brand Safety - **Offensive language**.
+      "excludedViolenceRisk": "A String", # Brand Safety - **Violence**.
+      "qualitySyncCustomSegmentId": [ # Optional. The quality sync custom segment ID provided by Integral Ad Science. The ID must be between `3000000` and `4999999`, inclusive.
+        "A String",
+      ],
+      "traqScoreOption": "A String", # True advertising quality (applicable to Display line items only).
+      "videoViewability": "A String", # Video Viewability Section (applicable to video line items only).
+    },
+  },
+  "urlDetails": { # Details for assigned URL targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_URL`. # URL details. This field will be populated when the targeting_type is `TARGETING_TYPE_URL`.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "url": "A String", # Required. The URL, for example `example.com`. DV360 supports two levels of subdirectory targeting, for example `www.example.com/one-subdirectory-level/second-level`, and five levels of subdomain targeting, for example `five.four.three.two.one.example.com`.
+  },
+  "userRewardedContentDetails": { # User rewarded content targeting option details. This will be populated in the user_rewarded_content_details field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. # User rewarded content details. This field will be populated when the targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
+    "userRewardedContent": "A String", # Output only. User rewarded content status for video ads.
+  },
+  "videoPlayerSizeDetails": { # Video player size targeting option details. This will be populated in the video_player_size_details field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. Explicitly targeting all options is not supported. Remove all video player size targeting options to achieve this effect. # Video player size details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.
+    "videoPlayerSize": "A String", # Required. The video player size.
+  },
+  "viewabilityDetails": { # Assigned viewability targeting option details. This will be populated in the viewability_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`. # Viewability details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIEWABILITY`. You can only target one viewability option per resource.
+    "viewability": "A String", # Required. The predicted viewability percentage.
+  },
+  "youtubeChannelDetails": { # Details for YouTube channel assigned targeting option. This will be populated in the youtube_channel_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`. # YouTube channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`.
+    "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+  },
+  "youtubeVideoDetails": { # Details for YouTube video assigned targeting option. This will be populated in the youtube_video_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`. # YouTube video details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "videoId": "A String", # YouTube video id as it appears on the YouTube watch page.
+  },
+}
+
+ +
+ list(partnerId, targetingType, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists the targeting options assigned to a partner.
+
+Args:
+  partnerId: string, Required. The ID of the partner. (required)
+  targetingType: string, Required. Identifies the type of assigned targeting options to list. Supported targeting types: * `TARGETING_TYPE_CHANNEL` (required)
+    Allowed values
+      TARGETING_TYPE_UNSPECIFIED - Default value when type is not specified or is unknown in this version.
+      TARGETING_TYPE_CHANNEL - Target a channel (a custom group of related websites or apps).
+      TARGETING_TYPE_APP_CATEGORY - Target an app category (for example, education or puzzle games).
+      TARGETING_TYPE_APP - Target a specific app (for example, Angry Birds).
+      TARGETING_TYPE_URL - Target a specific url (for example, quora.com).
+      TARGETING_TYPE_DAY_AND_TIME - Target ads during a chosen time period on a specific day.
+      TARGETING_TYPE_AGE_RANGE - Target ads to a specific age range (for example, 18-24).
+      TARGETING_TYPE_REGIONAL_LOCATION_LIST - Target ads to the specified regions on a regional location list.
+      TARGETING_TYPE_PROXIMITY_LOCATION_LIST - Target ads to the specified points of interest on a proximity location list.
+      TARGETING_TYPE_GENDER - Target ads to a specific gender (for example, female or male).
+      TARGETING_TYPE_VIDEO_PLAYER_SIZE - Target a specific video player size for video ads.
+      TARGETING_TYPE_USER_REWARDED_CONTENT - Target user rewarded content for video ads.
+      TARGETING_TYPE_PARENTAL_STATUS - Target ads to a specific parental status (for example, parent or not a parent).
+      TARGETING_TYPE_CONTENT_INSTREAM_POSITION - Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).
+      TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION - Target ads in a specific content outstream position.
+      TARGETING_TYPE_DEVICE_TYPE - Target ads to a specific device type (for example, tablet or connected TV).
+      TARGETING_TYPE_AUDIENCE_GROUP - Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.
+      TARGETING_TYPE_BROWSER - Target ads to specific web browsers (for example, Chrome).
+      TARGETING_TYPE_HOUSEHOLD_INCOME - Target ads to a specific household income range (for example, top 10%).
+      TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position.
+      TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify).
+      TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).
+      TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult).
+      TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app).
+      TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).
+      TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS).
+      TARGETING_TYPE_DEVICE_MAKE_MODEL - Target ads to a specific device make or model (for example, Roku or Samsung).
+      TARGETING_TYPE_KEYWORD - Target ads to a specific keyword (for example, dog or retriever).
+      TARGETING_TYPE_NEGATIVE_KEYWORD_LIST - Target ads to a specific negative keyword list.
+      TARGETING_TYPE_VIEWABILITY - Target ads to a specific viewability (for example, 80% viewable).
+      TARGETING_TYPE_CATEGORY - Target ads to a specific content category (for example, arts & entertainment).
+      TARGETING_TYPE_INVENTORY_SOURCE - Purchase impressions from specific deals and auction packages.
+      TARGETING_TYPE_LANGUAGE - Target ads to a specific language (for example, English or Japanese).
+      TARGETING_TYPE_AUTHORIZED_SELLER_STATUS - Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.
+      TARGETING_TYPE_GEO_REGION - Target ads to a specific regional location (for example, a city or state).
+      TARGETING_TYPE_INVENTORY_SOURCE_GROUP - Purchase impressions from a group of deals and auction packages.
+      TARGETING_TYPE_EXCHANGE - Purchase impressions from specific exchanges.
+      TARGETING_TYPE_SUB_EXCHANGE - Purchase impressions from specific sub-exchanges.
+      TARGETING_TYPE_POI - Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.
+      TARGETING_TYPE_BUSINESS_CHAIN - Target ads around locations of a business chain within a specific geo region.
+      TARGETING_TYPE_CONTENT_DURATION - Target ads to a specific video content duration.
+      TARGETING_TYPE_CONTENT_STREAM_TYPE - Target ads to a specific video content stream type.
+      TARGETING_TYPE_NATIVE_CONTENT_POSITION - Target ads to a specific native content position.
+      TARGETING_TYPE_OMID - Target ads in an Open Measurement enabled inventory.
+      TARGETING_TYPE_AUDIO_CONTENT_TYPE - Target ads to a specific audio content type.
+      TARGETING_TYPE_CONTENT_GENRE - Target ads to a specific content genre.
+      TARGETING_TYPE_YOUTUBE_VIDEO - Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
+      TARGETING_TYPE_YOUTUBE_CHANNEL - Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
+      TARGETING_TYPE_SESSION_POSITION - Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.
+  filter: string, Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` Examples: * `AssignedTargetingOption` resource with ID 123456: `assignedTargetingOptionId="123456"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
+  orderBy: string, Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`.
+  pageSize: integer, Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
+  pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListPartnerAssignedTargetingOptions` method. If not specified, the first page of results 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:
+
+    {
+  "assignedTargetingOptions": [ # The list of assigned targeting options. This list will be absent if empty.
+    { # A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings.
+      "ageRangeDetails": { # Represents a targetable age range. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AGE_RANGE`. # Age range details. This field will be populated when the targeting_type is `TARGETING_TYPE_AGE_RANGE`.
+        "ageRange": "A String", # Required. The age range of an audience. We only support targeting a continuous age range of an audience. Thus, the age range represented in this field can be 1) targeted solely, or, 2) part of a larger continuous age range. The reach of a continuous age range targeting can be expanded by also targeting an audience of an unknown age.
+      },
+      "appCategoryDetails": { # Details for assigned app category targeting option. This will be populated in the app_category_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. # App category details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
+        "displayName": "A String", # Output only. The display name of the app category.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
+      },
+      "appDetails": { # Details for assigned app targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP`. # App details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP`.
+        "appId": "A String", # Required. The ID of the app. Android's Play store app uses bundle ID, for example `com.google.android.gm`. Apple's App store app ID uses 9 digit string, for example `422689480`.
+        "appPlatform": "A String", # Indicates the platform of the targeted app. If this field is not specified, the app platform will be assumed to be mobile (i.e., Android or iOS), and we will derive the appropriate mobile platform from the app ID.
+        "displayName": "A String", # Output only. The display name of the app.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+      },
+      "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts.
+      "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`
+      "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource.
+        "excludedFirstPartyAndPartnerAudienceGroup": { # Details of first party and partner audience group. All first party and partner audience targeting settings are logically ‘OR’ of each other. # Optional. The first party and partner audience ids and recencies of the excluded first party and partner audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other.
+          "settings": [ # Required. All first party and partner audience targeting settings in first party and partner audience group. Repeated settings with the same id are not allowed.
+            { # Details of first party and partner audience targeting setting.
+              "firstPartyAndPartnerAudienceId": "A String", # Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.
+              "recency": "A String", # Required. The recency of the first party and partner audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
+            },
+          ],
+        },
+        "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other.
+          "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
+            { # Details of Google audience targeting setting.
+              "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
+            },
+          ],
+        },
+        "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only.
+          "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise.
+            { # Details of combined audience targeting setting.
+              "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id.
+            },
+          ],
+        },
+        "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only.
+          "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored.
+            { # Details of custom list targeting setting.
+              "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id.
+            },
+          ],
+        },
+        "includedFirstPartyAndPartnerAudienceGroups": [ # Optional. The first party and partner audience ids and recencies of included first party and partner audience groups. Each first party and partner audience group contains first party and partner audience ids only. The relation between each first party and partner audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored.
+          { # Details of first party and partner audience group. All first party and partner audience targeting settings are logically ‘OR’ of each other.
+            "settings": [ # Required. All first party and partner audience targeting settings in first party and partner audience group. Repeated settings with the same id are not allowed.
+              { # Details of first party and partner audience targeting setting.
+                "firstPartyAndPartnerAudienceId": "A String", # Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.
+                "recency": "A String", # Required. The recency of the first party and partner audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
+              },
+            ],
+          },
+        ],
+        "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only.
+          "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
+            { # Details of Google audience targeting setting.
+              "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
+            },
+          ],
+        },
+      },
+      "audioContentTypeDetails": { # Details for audio content type assigned targeting option. This will be populated in the audio_content_type_details field when targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`. Explicitly targeting all options is not supported. Remove all audio content type targeting options to achieve this effect. # Audio content type details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`.
+        "audioContentType": "A String", # Required. The audio content type.
+      },
+      "authorizedSellerStatusDetails": { # Represents an assigned authorized seller status. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. If a resource does not have an `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` assigned targeting option, it is using the "Authorized Direct Sellers and Resellers" option. # Authorized seller status details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. You can only target one authorized seller status option per resource. If a resource doesn't have an authorized seller status option, all authorized sellers indicated as DIRECT or RESELLER in the ads.txt file are targeted by default.
+        "authorizedSellerStatus": "A String", # Output only. The authorized seller status to target.
+        "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.
+      },
+      "browserDetails": { # Details for assigned browser targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BROWSER`. # Browser details. This field will be populated when the targeting_type is `TARGETING_TYPE_BROWSER`.
+        "displayName": "A String", # Output only. The display name of the browser.
+        "negative": True or False, # Indicates if this option is being negatively targeted. All assigned browser targeting options on the same resource must have the same value for this field.
+        "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BROWSER`.
+      },
+      "businessChainDetails": { # Details for assigned Business chain targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`. # Business chain details. This field will be populated when the targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`.
+        "displayName": "A String", # Output only. The display name of a business chain, e.g. "KFC", "Chase Bank".
+        "proximityRadiusAmount": 3.14, # Required. The radius of the area around the business chain that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`. The minimum increment for both cases is 0.1. Inputs will be rounded to the nearest acceptable value if it is too granular, e.g. 15.57 will become 15.6.
+        "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
+        "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BUSINESS_CHAIN`. Accepted business chain targeting option IDs can be retrieved using SearchTargetingOptions.
+      },
+      "carrierAndIspDetails": { # Details for assigned carrier and ISP targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`. # Carrier and ISP details. This field will be populated when the targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`.
+        "displayName": "A String", # Output only. The display name of the carrier or ISP.
+        "negative": True or False, # Indicates if this option is being negatively targeted. All assigned carrier and ISP targeting options on the same resource must have the same value for this field.
+        "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`.
+      },
+      "categoryDetails": { # Assigned category targeting option details. This will be populated in the category_details field when targeting_type is `TARGETING_TYPE_CATEGORY`. # Category details. This field will be populated when the targeting_type is `TARGETING_TYPE_CATEGORY`. Targeting a category will also target its subcategories. If a category is excluded from targeting and a subcategory is included, the exclusion will take precedence.
+        "displayName": "A String", # Output only. The display name of the category.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CATEGORY`.
+      },
+      "channelDetails": { # Details for assigned channel targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CHANNEL`. # Channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_CHANNEL`.
+        "channelId": "A String", # Required. ID of the channel. Should refer to the channel ID field on a [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id) resource.
+        "negative": True or False, # Indicates if this option is being negatively targeted. For advertiser level assigned targeting option, this field must be true.
+      },
+      "contentDurationDetails": { # Details for content duration assigned targeting option. This will be populated in the content_duration_details field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`. Explicitly targeting all options is not supported. Remove all content duration targeting options to achieve this effect. # Content duration details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
+        "contentDuration": "A String", # Output only. The content duration.
+        "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
+      },
+      "contentGenreDetails": { # Details for content genre assigned targeting option. This will be populated in the content_genre_details field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`. Explicitly targeting all options is not supported. Remove all content genre targeting options to achieve this effect. # Content genre details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
+        "displayName": "A String", # Output only. The display name of the content genre.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
+      },
+      "contentInstreamPositionDetails": { # Assigned content instream position targeting option details. This will be populated in the content_instream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. # Content instream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.
+        "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`. * `AD_TYPE_AUDIO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_AUDIO_DEFAULT`.
+        "contentInstreamPosition": "A String", # Required. The content instream position for video or audio ads.
+      },
+      "contentOutstreamPositionDetails": { # Assigned content outstream position targeting option details. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. # Content outstream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.
+        "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+        "contentOutstreamPosition": "A String", # Required. The content outstream position.
+      },
+      "contentStreamTypeDetails": { # Details for content stream type assigned targeting option. This will be populated in the content_stream_type_details field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`. Explicitly targeting all options is not supported. Remove all content stream type targeting options to achieve this effect. # Content duration details. This field will be populated when the TargetingType is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
+        "contentStreamType": "A String", # Output only. The content stream type.
+        "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
+      },
+      "dayAndTimeDetails": { # Representation of a segment of time defined on a specific day of the week and with a start and end time. The time represented by `start_hour` must be before the time represented by `end_hour`. # Day and time details. This field will be populated when the targeting_type is `TARGETING_TYPE_DAY_AND_TIME`.
+        "dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting.
+        "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day).
+        "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day).
+        "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting.
+      },
+      "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
+        "displayName": "A String", # Output only. The display name of the device make and model.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
+      },
+      "deviceTypeDetails": { # Targeting details for device type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`. # Device Type details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_TYPE`.
+        "deviceType": "A String", # Required. The display name of the device type.
+        "youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items.
+      },
+      "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded.
+        "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED.
+      },
+      "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`.
+        "environment": "A String", # Required. The serving environment.
+      },
+      "exchangeDetails": { # Details for assigned exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`. # Exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_EXCHANGE`.
+        "exchange": "A String", # Required. The enum value for the exchange.
+      },
+      "genderDetails": { # Details for assigned gender targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GENDER`. # Gender details. This field will be populated when the targeting_type is `TARGETING_TYPE_GENDER`.
+        "gender": "A String", # Required. The gender of the audience.
+      },
+      "geoRegionDetails": { # Details for assigned geographic region targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GEO_REGION`. # Geographic region details. This field will be populated when the targeting_type is `TARGETING_TYPE_GEO_REGION`.
+        "displayName": "A String", # Output only. The display name of the geographic region (e.g., "Ontario, Canada").
+        "geoRegionType": "A String", # Output only. The type of geographic region targeting.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GEO_REGION`.
+      },
+      "householdIncomeDetails": { # Details for assigned household income targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`. # Household income details. This field will be populated when the targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`.
+        "householdIncome": "A String", # Required. The household income of the audience.
+      },
+      "inheritance": "A String", # Output only. The inheritance status of the assigned targeting option.
+      "inventorySourceDetails": { # Targeting details for inventory source. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`. # Inventory source details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`.
+        "inventorySourceId": "A String", # Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource.
+      },
+      "inventorySourceGroupDetails": { # Targeting details for inventory source group. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`. # Inventory source group details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`.
+        "inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource.
+      },
+      "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned.
+        "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+      },
+      "languageDetails": { # Details for assigned language targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_LANGUAGE`. # Language details. This field will be populated when the targeting_type is `TARGETING_TYPE_LANGUAGE`.
+        "displayName": "A String", # Output only. The display name of the language (e.g., "French").
+        "negative": True or False, # Indicates if this option is being negatively targeted. All assigned language targeting options on the same resource must have the same value for this field.
+        "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_LANGUAGE`.
+      },
+      "name": "A String", # Output only. The resource name for this assigned targeting option.
+      "nativeContentPositionDetails": { # Details for native content position assigned targeting option. This will be populated in the native_content_position_details field when targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`. Explicitly targeting all options is not supported. Remove all native content position targeting options to achieve this effect. # Native content position details. This field will be populated when the targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`.
+        "contentPosition": "A String", # Required. The content position.
+      },
+      "negativeKeywordListDetails": { # Targeting details for negative keyword list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. A maximum of 4 negative keyword lists can be assigned to a resource.
+        "negativeKeywordListId": "A String", # Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource.
+      },
+      "omidDetails": { # Represents a targetable Open Measurement enabled inventory type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_OMID`. # Open Measurement enabled inventory details. This field will be populated when the targeting_type is `TARGETING_TYPE_OMID`.
+        "omid": "A String", # Required. The type of Open Measurement enabled inventory.
+      },
+      "onScreenPositionDetails": { # On screen position targeting option details. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. # On screen position details. This field will be populated when the targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
+        "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+        "onScreenPosition": "A String", # Output only. The on screen position.
+        "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
+      },
+      "operatingSystemDetails": { # Assigned operating system targeting option details. This will be populated in the operating_system_details field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. # Operating system details. This field will be populated when the targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
+        "displayName": "A String", # Output only. The display name of the operating system.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "targetingOptionId": "A String", # Required. The targeting option ID populated in targeting_option_id field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
+      },
+      "parentalStatusDetails": { # Details for assigned parental status targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`. # Parental status details. This field will be populated when the targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`.
+        "parentalStatus": "A String", # Required. The parental status of the audience.
+      },
+      "poiDetails": { # Details for assigned POI targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_POI`. # POI details. This field will be populated when the targeting_type is `TARGETING_TYPE_POI`.
+        "displayName": "A String", # Output only. The display name of a POI, e.g. "Times Square", "Space Needle", followed by its full address if available.
+        "latitude": 3.14, # Output only. Latitude of the POI rounding to 6th decimal place.
+        "longitude": 3.14, # Output only. Longitude of the POI rounding to 6th decimal place.
+        "proximityRadiusAmount": 3.14, # Required. The radius of the area around the POI that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`.
+        "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
+        "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_POI`. Accepted POI targeting option IDs can be retrieved using `targetingTypes.targetingOptions.search`. If targeting a specific latitude/longitude coordinate removed from an address or POI name, you can generate the necessary targeting option ID by rounding the desired coordinate values to the 6th decimal place, removing the decimals, and concatenating the string values separated by a semicolon. For example, you can target the latitude/longitude pair of 40.7414691, -74.003387 using the targeting option ID "40741469;-74003387". **Upon** **creation, this field value will be updated to append a semicolon and** **alphanumerical hash value if only latitude/longitude coordinates are** **provided.**
+      },
+      "proximityLocationListDetails": { # Targeting details for proximity location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`. # Proximity location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`.
+        "proximityLocationListId": "A String", # Required. ID of the proximity location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_PROXIMITY`.
+        "proximityRadius": 3.14, # Required. Radius expressed in the distance units set in proximity_radius_unit. This represents the size of the area around a chosen location that will be targeted. Radius should be between 1 and 500 miles or 800 kilometers.
+        "proximityRadiusUnit": "A String", # Required. Radius distance units.
+      },
+      "regionalLocationListDetails": { # Targeting details for regional location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`. # Regional location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`.
+      },
+      "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them.
+        "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED.
+      },
+      "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`.
+        "sessionPosition": "A String", # The position where the ad will show in a session.
+      },
+      "subExchangeDetails": { # Details for assigned sub-exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`. # Sub-exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`.
+        "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`.
+      },
+      "targetingType": "A String", # Output only. Identifies the type of this assigned targeting option.
+      "thirdPartyVerifierDetails": { # Assigned third party verifier targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`. # Third party verification details. This field will be populated when the targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`.
+        "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox.
+          "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads.
+          "excludedAdlooxCategories": [ # Adloox categories to exclude.
+            "A String",
+          ],
+          "excludedFraudIvtMfaCategories": [ # Optional. Adloox's fraud IVT MFA categories to exclude.
+            "A String",
+          ],
+          "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+          "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads.
+        },
+        "doubleVerify": { # Details of DoubleVerify settings. # Third party brand verifier -- DoubleVerify.
+          "appStarRating": { # Details of DoubleVerify star ratings settings. # Avoid bidding on apps with the star ratings.
+            "avoidInsufficientStarRating": True or False, # Avoid bidding on apps with insufficient star ratings.
+            "avoidedStarRating": "A String", # Avoid bidding on apps with the star ratings.
+          },
+          "avoidedAgeRatings": [ # Avoid bidding on apps with the age rating.
+            "A String",
+          ],
+          "brandSafetyCategories": { # Settings for brand safety controls. # DV Brand Safety Controls.
+            "avoidUnknownBrandSafetyCategory": True or False, # Unknown or unrateable.
+            "avoidedHighSeverityCategories": [ # Brand safety high severity avoidance categories.
+              "A String",
+            ],
+            "avoidedMediumSeverityCategories": [ # Brand safety medium severity avoidance categories.
+              "A String",
+            ],
+          },
+          "customSegmentId": "A String", # The custom segment ID provided by DoubleVerify. The ID must start with "51" and consist of eight digits. Custom segment ID cannot be specified along with any of the following fields: * brand_safety_categories * avoided_age_ratings * app_star_rating * fraud_invalid_traffic
+          "displayViewability": { # Details of DoubleVerify display viewability settings. # Display viewability settings (applicable to display line items only).
+            "iab": "A String", # Target web and app inventory to maximize IAB viewable rate.
+            "viewableDuring": "A String", # Target web and app inventory to maximize 100% viewable duration.
+          },
+          "fraudInvalidTraffic": { # DoubleVerify Fraud & Invalid Traffic settings. # Avoid Sites and Apps with historical Fraud & IVT Rates.
+            "avoidInsufficientOption": True or False, # Insufficient Historical Fraud & IVT Stats.
+            "avoidedFraudOption": "A String", # Avoid Sites and Apps with historical Fraud & IVT.
+          },
+          "videoViewability": { # Details of DoubleVerify video viewability settings. # Video viewability settings (applicable to video line items only).
+            "playerImpressionRate": "A String", # Target inventory to maximize impressions with 400x300 or greater player size.
+            "videoIab": "A String", # Target web inventory to maximize IAB viewable rate.
+            "videoViewableRate": "A String", # Target web inventory to maximize fully viewable rate.
+          },
+        },
+        "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science.
+          "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive.
+            "A String",
+          ],
+          "displayViewability": "A String", # Display Viewability section (applicable to display line items only).
+          "excludeUnrateable": True or False, # Brand Safety - **Unrateable**.
+          "excludedAdFraudRisk": "A String", # Ad Fraud settings.
+          "excludedAdultRisk": "A String", # Brand Safety - **Adult content**.
+          "excludedAlcoholRisk": "A String", # Brand Safety - **Alcohol**.
+          "excludedDrugsRisk": "A String", # Brand Safety - **Drugs**.
+          "excludedGamblingRisk": "A String", # Brand Safety - **Gambling**.
+          "excludedHateSpeechRisk": "A String", # Brand Safety - **Hate speech**.
+          "excludedIllegalDownloadsRisk": "A String", # Brand Safety - **Illegal downloads**.
+          "excludedOffensiveLanguageRisk": "A String", # Brand Safety - **Offensive language**.
+          "excludedViolenceRisk": "A String", # Brand Safety - **Violence**.
+          "qualitySyncCustomSegmentId": [ # Optional. The quality sync custom segment ID provided by Integral Ad Science. The ID must be between `3000000` and `4999999`, inclusive.
+            "A String",
+          ],
+          "traqScoreOption": "A String", # True advertising quality (applicable to Display line items only).
+          "videoViewability": "A String", # Video Viewability Section (applicable to video line items only).
+        },
+      },
+      "urlDetails": { # Details for assigned URL targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_URL`. # URL details. This field will be populated when the targeting_type is `TARGETING_TYPE_URL`.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "url": "A String", # Required. The URL, for example `example.com`. DV360 supports two levels of subdirectory targeting, for example `www.example.com/one-subdirectory-level/second-level`, and five levels of subdomain targeting, for example `five.four.three.two.one.example.com`.
+      },
+      "userRewardedContentDetails": { # User rewarded content targeting option details. This will be populated in the user_rewarded_content_details field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. # User rewarded content details. This field will be populated when the targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
+        "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
+        "userRewardedContent": "A String", # Output only. User rewarded content status for video ads.
+      },
+      "videoPlayerSizeDetails": { # Video player size targeting option details. This will be populated in the video_player_size_details field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. Explicitly targeting all options is not supported. Remove all video player size targeting options to achieve this effect. # Video player size details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.
+        "videoPlayerSize": "A String", # Required. The video player size.
+      },
+      "viewabilityDetails": { # Assigned viewability targeting option details. This will be populated in the viewability_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`. # Viewability details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIEWABILITY`. You can only target one viewability option per resource.
+        "viewability": "A String", # Required. The predicted viewability percentage.
+      },
+      "youtubeChannelDetails": { # Details for YouTube channel assigned targeting option. This will be populated in the youtube_channel_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`. # YouTube channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`.
+        "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+      },
+      "youtubeVideoDetails": { # Details for YouTube video assigned targeting option. This will be populated in the youtube_video_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`. # YouTube video details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`.
+        "negative": True or False, # Indicates if this option is being negatively targeted.
+        "videoId": "A String", # YouTube video id as it appears on the YouTube watch page.
+      },
+    },
+  ],
+  "nextPageToken": "A String", # A token identifying the next page of results. This value should be specified as the pageToken in a subsequent ListPartnerAssignedTargetingOptionsRequest to fetch the next page of results. This token will be absent if there are no more assigned_targeting_options to return.
+}
+
+ +
+ 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/displayvideo_v4.partners.targetingTypes.html b/docs/dyn/displayvideo_v4.partners.targetingTypes.html new file mode 100644 index 00000000000..b23d888baa9 --- /dev/null +++ b/docs/dyn/displayvideo_v4.partners.targetingTypes.html @@ -0,0 +1,91 @@ + + + +

Display & Video 360 API . partners . targetingTypes

+

Instance Methods

+

+ assignedTargetingOptions() +

+

Returns the assignedTargetingOptions Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/displayvideo_v4.sdfdownloadtasks.html b/docs/dyn/displayvideo_v4.sdfdownloadtasks.html index c692f72d776..a0c09bc0780 100644 --- a/docs/dyn/displayvideo_v4.sdfdownloadtasks.html +++ b/docs/dyn/displayvideo_v4.sdfdownloadtasks.html @@ -82,10 +82,96 @@

Instance Methods

close()

Close httplib2 connections.

+

+ create(body=None, x__xgafv=None)

+

Creates an SDF Download Task. Returns an Operation. An SDF Download Task is a long-running, asynchronous operation. The metadata type of this operation is SdfDownloadTaskMetadata. If the request is successful, the response type of the operation is SdfDownloadTask. The response will not include the download files, which must be retrieved with media.download. The state of operation can be retrieved with sdfdownloadtask.operations.get. Any errors can be found in the error.message. Note that error.details is expected to be empty.

Method Details

close()
Close httplib2 connections.
+
+ create(body=None, x__xgafv=None) +
Creates an SDF Download Task. Returns an Operation. An SDF Download Task is a long-running, asynchronous operation. The metadata type of this operation is SdfDownloadTaskMetadata. If the request is successful, the response type of the operation is SdfDownloadTask. The response will not include the download files, which must be retrieved with media.download. The state of operation can be retrieved with sdfdownloadtask.operations.get. Any errors can be found in the error.message. Note that error.details is expected to be empty.
+
+Args:
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for [SdfDownloadTaskService.CreateSdfDownloadTask].
+  "advertiserId": "A String", # The ID of the advertiser to download SDF for.
+  "idFilter": { # A filtering option that filters entities by their entity IDs. # Filters on entities by their entity IDs.
+    "adGroupAdIds": [ # YouTube Ads to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest.
+      "A String",
+    ],
+    "adGroupIds": [ # YouTube Ad Groups to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest.
+      "A String",
+    ],
+    "adGroupQaIds": [ # Optional. YouTube Ad Groups, by ID, to download in QA format. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest.
+      "A String",
+    ],
+    "campaignIds": [ # Campaigns to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest.
+      "A String",
+    ],
+    "insertionOrderIds": [ # Insertion Orders to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest.
+      "A String",
+    ],
+    "lineItemIds": [ # Line Items to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest.
+      "A String",
+    ],
+    "lineItemQaIds": [ # Optional. Line Items, by ID, to download in QA format. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest.
+      "A String",
+    ],
+    "mediaProductIds": [ # Media Products to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest.
+      "A String",
+    ],
+  },
+  "inventorySourceFilter": { # A filtering option for filtering on Inventory Source entities. # Filters on Inventory Sources by their IDs.
+    "inventorySourceIds": [ # Inventory Sources to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. Leave empty to download all Inventory Sources for the selected Advertiser or Partner.
+      "A String",
+    ],
+  },
+  "parentEntityFilter": { # A filtering option that filters on selected file types belonging to a chosen set of filter entities. # Filters on selected file types. The entities in each file are filtered by a chosen set of filter entities. The filter entities must be the same type as, or a parent type of, the selected file types.
+    "fileType": [ # Required. File types that will be returned.
+      "A String",
+    ],
+    "filterIds": [ # The IDs of the specified filter type. This is used to filter entities to fetch. If filter type is not `FILTER_TYPE_NONE`, at least one ID must be specified.
+      "A String",
+    ],
+    "filterType": "A String", # Required. Filter type used to filter fetched entities.
+  },
+  "partnerId": "A String", # The ID of the partner to download SDF for.
+  "version": "A String", # Required. The SDF version of the downloaded file. If set to `SDF_VERSION_UNSPECIFIED`, this will default to the version specified by the advertiser or partner identified by `root_id`. An advertiser inherits its SDF version from its partner unless configured otherwise.
+}
+
+  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.
+  },
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/displayvideo_v4.targetingTypes.html b/docs/dyn/displayvideo_v4.targetingTypes.html new file mode 100644 index 00000000000..a61d47f366a --- /dev/null +++ b/docs/dyn/displayvideo_v4.targetingTypes.html @@ -0,0 +1,91 @@ + + + +

Display & Video 360 API . targetingTypes

+

Instance Methods

+

+ targetingOptions() +

+

Returns the targetingOptions Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/displayvideo_v4.targetingTypes.targetingOptions.html b/docs/dyn/displayvideo_v4.targetingTypes.targetingOptions.html new file mode 100644 index 00000000000..9b7d043ac6c --- /dev/null +++ b/docs/dyn/displayvideo_v4.targetingTypes.targetingOptions.html @@ -0,0 +1,693 @@ + + + +

Display & Video 360 API . targetingTypes . targetingOptions

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(targetingType, targetingOptionId, advertiserId=None, x__xgafv=None)

+

Gets a single targeting option.

+

+ list(targetingType, advertiserId=None, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists targeting options of a given type.

+

+ list_next()

+

Retrieves the next page of results.

+

+ search(targetingType, body=None, x__xgafv=None)

+

Searches for targeting options of a given type based on the given search terms.

+

+ search_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(targetingType, targetingOptionId, advertiserId=None, x__xgafv=None) +
Gets a single targeting option.
+
+Args:
+  targetingType: string, Required. The type of targeting option to retrieve. Accepted values are: * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` (required)
+    Allowed values
+      TARGETING_TYPE_UNSPECIFIED - Default value when type is not specified or is unknown in this version.
+      TARGETING_TYPE_CHANNEL - Target a channel (a custom group of related websites or apps).
+      TARGETING_TYPE_APP_CATEGORY - Target an app category (for example, education or puzzle games).
+      TARGETING_TYPE_APP - Target a specific app (for example, Angry Birds).
+      TARGETING_TYPE_URL - Target a specific url (for example, quora.com).
+      TARGETING_TYPE_DAY_AND_TIME - Target ads during a chosen time period on a specific day.
+      TARGETING_TYPE_AGE_RANGE - Target ads to a specific age range (for example, 18-24).
+      TARGETING_TYPE_REGIONAL_LOCATION_LIST - Target ads to the specified regions on a regional location list.
+      TARGETING_TYPE_PROXIMITY_LOCATION_LIST - Target ads to the specified points of interest on a proximity location list.
+      TARGETING_TYPE_GENDER - Target ads to a specific gender (for example, female or male).
+      TARGETING_TYPE_VIDEO_PLAYER_SIZE - Target a specific video player size for video ads.
+      TARGETING_TYPE_USER_REWARDED_CONTENT - Target user rewarded content for video ads.
+      TARGETING_TYPE_PARENTAL_STATUS - Target ads to a specific parental status (for example, parent or not a parent).
+      TARGETING_TYPE_CONTENT_INSTREAM_POSITION - Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).
+      TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION - Target ads in a specific content outstream position.
+      TARGETING_TYPE_DEVICE_TYPE - Target ads to a specific device type (for example, tablet or connected TV).
+      TARGETING_TYPE_AUDIENCE_GROUP - Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.
+      TARGETING_TYPE_BROWSER - Target ads to specific web browsers (for example, Chrome).
+      TARGETING_TYPE_HOUSEHOLD_INCOME - Target ads to a specific household income range (for example, top 10%).
+      TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position.
+      TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify).
+      TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).
+      TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult).
+      TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app).
+      TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).
+      TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS).
+      TARGETING_TYPE_DEVICE_MAKE_MODEL - Target ads to a specific device make or model (for example, Roku or Samsung).
+      TARGETING_TYPE_KEYWORD - Target ads to a specific keyword (for example, dog or retriever).
+      TARGETING_TYPE_NEGATIVE_KEYWORD_LIST - Target ads to a specific negative keyword list.
+      TARGETING_TYPE_VIEWABILITY - Target ads to a specific viewability (for example, 80% viewable).
+      TARGETING_TYPE_CATEGORY - Target ads to a specific content category (for example, arts & entertainment).
+      TARGETING_TYPE_INVENTORY_SOURCE - Purchase impressions from specific deals and auction packages.
+      TARGETING_TYPE_LANGUAGE - Target ads to a specific language (for example, English or Japanese).
+      TARGETING_TYPE_AUTHORIZED_SELLER_STATUS - Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.
+      TARGETING_TYPE_GEO_REGION - Target ads to a specific regional location (for example, a city or state).
+      TARGETING_TYPE_INVENTORY_SOURCE_GROUP - Purchase impressions from a group of deals and auction packages.
+      TARGETING_TYPE_EXCHANGE - Purchase impressions from specific exchanges.
+      TARGETING_TYPE_SUB_EXCHANGE - Purchase impressions from specific sub-exchanges.
+      TARGETING_TYPE_POI - Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.
+      TARGETING_TYPE_BUSINESS_CHAIN - Target ads around locations of a business chain within a specific geo region.
+      TARGETING_TYPE_CONTENT_DURATION - Target ads to a specific video content duration.
+      TARGETING_TYPE_CONTENT_STREAM_TYPE - Target ads to a specific video content stream type.
+      TARGETING_TYPE_NATIVE_CONTENT_POSITION - Target ads to a specific native content position.
+      TARGETING_TYPE_OMID - Target ads in an Open Measurement enabled inventory.
+      TARGETING_TYPE_AUDIO_CONTENT_TYPE - Target ads to a specific audio content type.
+      TARGETING_TYPE_CONTENT_GENRE - Target ads to a specific content genre.
+      TARGETING_TYPE_YOUTUBE_VIDEO - Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
+      TARGETING_TYPE_YOUTUBE_CHANNEL - Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
+      TARGETING_TYPE_SESSION_POSITION - Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.
+  targetingOptionId: string, Required. The ID of the of targeting option to retrieve. (required)
+  advertiserId: string, Required. The Advertiser this request is being made in the context of.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a single targeting option, which is a targetable concept in DV360.
+  "ageRangeDetails": { # Represents a targetable age range. This will be populated in the age_range_details field when targeting_type is `TARGETING_TYPE_AGE_RANGE`. # Age range details.
+    "ageRange": "A String", # Output only. The age range of an audience.
+  },
+  "appCategoryDetails": { # Represents a targetable collection of apps. A collection lets you target dynamic groups of related apps that are maintained by the platform, for example `All Apps/Google Play/Games`. This will be populated in the app_category_details field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. # App category details.
+    "displayName": "A String", # Output only. The name of the app collection.
+  },
+  "audioContentTypeDetails": { # Represents a targetable audio content type. This will be populated in the audio_content_type_details field when targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`. # Audio content type details.
+    "audioContentType": "A String", # Output only. The audio content type.
+  },
+  "authorizedSellerStatusDetails": { # Represents a targetable authorized seller status. This will be populated in the authorized_seller_status_details field when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. # Authorized seller status resource details.
+    "authorizedSellerStatus": "A String", # Output only. The authorized seller status.
+  },
+  "browserDetails": { # Represents a targetable browser. This will be populated in the browser_details field when targeting_type is `TARGETING_TYPE_BROWSER`. # Browser details.
+    "displayName": "A String", # Output only. The display name of the browser.
+  },
+  "businessChainDetails": { # Represents a targetable business chain within a geo region. This will be populated in the business_chain_details field when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`. # Business chain resource details.
+    "businessChain": "A String", # Output only. The display name of the business chain, e.g. "KFC", "Chase Bank".
+    "geoRegion": "A String", # Output only. The display name of the geographic region, e.g. "Ontario, Canada".
+    "geoRegionType": "A String", # Output only. The type of the geographic region.
+  },
+  "carrierAndIspDetails": { # Represents a targetable carrier or ISP. This will be populated in the carrier_and_isp_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`. # Carrier and ISP details.
+    "displayName": "A String", # Output only. The display name of the carrier or ISP.
+    "type": "A String", # Output only. The type indicating if it's carrier or ISP.
+  },
+  "categoryDetails": { # Represents a targetable category. This will be populated in the category_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_CATEGORY`. # Category resource details.
+    "displayName": "A String", # Output only. The display name of the category.
+  },
+  "contentDurationDetails": { # Represents a targetable content duration. This will be populated in the content_duration_details field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`. # Content duration resource details.
+    "contentDuration": "A String", # Output only. The content duration.
+  },
+  "contentGenreDetails": { # Represents a targetable content genre. This will be populated in the content_genre_details field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`. # Content genre resource details.
+    "displayName": "A String", # Output only. The display name of the content genre
+  },
+  "contentInstreamPositionDetails": { # Represents a targetable content instream position, which could be used by video and audio ads. This will be populated in the content_instream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. # Content instream position details.
+    "contentInstreamPosition": "A String", # Output only. The content instream position.
+  },
+  "contentOutstreamPositionDetails": { # Represents a targetable content outstream position, which could be used by display and video ads. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. # Content outstream position details.
+    "contentOutstreamPosition": "A String", # Output only. The content outstream position.
+  },
+  "contentStreamTypeDetails": { # Represents a targetable content stream type. This will be populated in the content_stream_type_details field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`. # Content stream type resource details.
+    "contentStreamType": "A String", # Output only. The content stream type.
+  },
+  "deviceMakeModelDetails": { # Represents a targetable device make and model. This will be populated in the device_make_model_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model resource details.
+    "displayName": "A String", # Output only. The display name of the device make and model.
+  },
+  "deviceTypeDetails": { # Represents a targetable device type. This will be populated in the device_type_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`. # Device type details.
+    "deviceType": "A String", # Output only. The device type that is used to be targeted.
+  },
+  "digitalContentLabelDetails": { # Represents a targetable digital content label rating tier. This will be populated in the digital_content_label_details field of the TargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details.
+    "contentRatingTier": "A String", # Output only. An enum for the content label brand safety tiers.
+  },
+  "environmentDetails": { # Represents a targetable environment. This will be populated in the environment_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details.
+    "environment": "A String", # Output only. The serving environment.
+  },
+  "exchangeDetails": { # Represents a targetable exchange. This will be populated in the exchange_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`. # Exchange details.
+    "exchange": "A String", # Output only. The type of exchange.
+  },
+  "genderDetails": { # Represents a targetable gender. This will be populated in the gender_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_GENDER`. # Gender details.
+    "gender": "A String", # Output only. The gender of an audience.
+  },
+  "geoRegionDetails": { # Represents a targetable geographic region. This will be populated in the geo_region_details field when targeting_type is `TARGETING_TYPE_GEO_REGION`. # Geographic region resource details.
+    "displayName": "A String", # Output only. The display name of the geographic region (e.g., "Ontario, Canada").
+    "geoRegionType": "A String", # Output only. The type of geographic region targeting.
+  },
+  "householdIncomeDetails": { # Represents a targetable household income. This will be populated in the household_income_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`. # Household income details.
+    "householdIncome": "A String", # Output only. The household income of an audience.
+  },
+  "languageDetails": { # Represents a targetable language. This will be populated in the language_details field when targeting_type is `TARGETING_TYPE_LANGUAGE`. # Language resource details.
+    "displayName": "A String", # Output only. The display name of the language (e.g., "French").
+  },
+  "name": "A String", # Output only. The resource name for this targeting option.
+  "nativeContentPositionDetails": { # Represents a targetable native content position. This will be populated in the native_content_position_details field when targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`. # Native content position details.
+    "contentPosition": "A String", # Output only. The content position.
+  },
+  "omidDetails": { # Represents a targetable Open Measurement enabled inventory type. This will be populated in the omid_details field when targeting_type is `TARGETING_TYPE_OMID`. # Open Measurement enabled inventory details.
+    "omid": "A String", # Output only. The type of Open Measurement enabled inventory.
+  },
+  "onScreenPositionDetails": { # Represents a targetable on screen position, which could be used by display and video ads. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. # On screen position details.
+    "onScreenPosition": "A String", # Output only. The on screen position.
+  },
+  "operatingSystemDetails": { # Represents a targetable operating system. This will be populated in the operating_system_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. # Operating system resources details.
+    "displayName": "A String", # Output only. The display name of the operating system.
+  },
+  "parentalStatusDetails": { # Represents a targetable parental status. This will be populated in the parental_status_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`. # Parental status details.
+    "parentalStatus": "A String", # Output only. The parental status of an audience.
+  },
+  "poiDetails": { # Represents a targetable point of interest(POI). This will be populated in the poi_details field when targeting_type is `TARGETING_TYPE_POI`. # POI resource details.
+    "displayName": "A String", # Output only. The display name of a POI(e.g. "Times Square", "Space Needle"), followed by its full address if available.
+    "latitude": 3.14, # Output only. Latitude of the POI rounding to 6th decimal place.
+    "longitude": 3.14, # Output only. Longitude of the POI rounding to 6th decimal place.
+  },
+  "sensitiveCategoryDetails": { # Represents a targetable sensitive category. This will be populated in the sensitive_category_details field of the TargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive Category details.
+    "sensitiveCategory": "A String", # Output only. An enum for the DV360 Sensitive category content classifier.
+  },
+  "subExchangeDetails": { # Represents a targetable sub-exchange. This will be populated in the sub_exchange_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`. # Sub-exchange details.
+    "displayName": "A String", # Output only. The display name of the sub-exchange.
+  },
+  "targetingOptionId": "A String", # Output only. A unique identifier for this targeting option. The tuple {`targeting_type`, `targeting_option_id`} will be unique.
+  "targetingType": "A String", # Output only. The type of this targeting option.
+  "userRewardedContentDetails": { # Represents a targetable user rewarded content status for video ads only. This will be populated in the user_rewarded_content_details field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. # User rewarded content details.
+    "userRewardedContent": "A String", # Output only. User rewarded content status for video ads.
+  },
+  "videoPlayerSizeDetails": { # Represents a targetable video player size. This will be populated in the video_player_size_details field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. # Video player size details.
+    "videoPlayerSize": "A String", # Output only. The video player size.
+  },
+  "viewabilityDetails": { # Represents a targetable viewability. This will be populated in the viewability_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`. # Viewability resource details.
+    "viewability": "A String", # Output only. The predicted viewability percentage.
+  },
+}
+
+ +
+ list(targetingType, advertiserId=None, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists targeting options of a given type.
+
+Args:
+  targetingType: string, Required. The type of targeting option to be listed. Accepted values are: * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` (required)
+    Allowed values
+      TARGETING_TYPE_UNSPECIFIED - Default value when type is not specified or is unknown in this version.
+      TARGETING_TYPE_CHANNEL - Target a channel (a custom group of related websites or apps).
+      TARGETING_TYPE_APP_CATEGORY - Target an app category (for example, education or puzzle games).
+      TARGETING_TYPE_APP - Target a specific app (for example, Angry Birds).
+      TARGETING_TYPE_URL - Target a specific url (for example, quora.com).
+      TARGETING_TYPE_DAY_AND_TIME - Target ads during a chosen time period on a specific day.
+      TARGETING_TYPE_AGE_RANGE - Target ads to a specific age range (for example, 18-24).
+      TARGETING_TYPE_REGIONAL_LOCATION_LIST - Target ads to the specified regions on a regional location list.
+      TARGETING_TYPE_PROXIMITY_LOCATION_LIST - Target ads to the specified points of interest on a proximity location list.
+      TARGETING_TYPE_GENDER - Target ads to a specific gender (for example, female or male).
+      TARGETING_TYPE_VIDEO_PLAYER_SIZE - Target a specific video player size for video ads.
+      TARGETING_TYPE_USER_REWARDED_CONTENT - Target user rewarded content for video ads.
+      TARGETING_TYPE_PARENTAL_STATUS - Target ads to a specific parental status (for example, parent or not a parent).
+      TARGETING_TYPE_CONTENT_INSTREAM_POSITION - Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).
+      TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION - Target ads in a specific content outstream position.
+      TARGETING_TYPE_DEVICE_TYPE - Target ads to a specific device type (for example, tablet or connected TV).
+      TARGETING_TYPE_AUDIENCE_GROUP - Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.
+      TARGETING_TYPE_BROWSER - Target ads to specific web browsers (for example, Chrome).
+      TARGETING_TYPE_HOUSEHOLD_INCOME - Target ads to a specific household income range (for example, top 10%).
+      TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position.
+      TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify).
+      TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).
+      TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult).
+      TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app).
+      TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).
+      TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS).
+      TARGETING_TYPE_DEVICE_MAKE_MODEL - Target ads to a specific device make or model (for example, Roku or Samsung).
+      TARGETING_TYPE_KEYWORD - Target ads to a specific keyword (for example, dog or retriever).
+      TARGETING_TYPE_NEGATIVE_KEYWORD_LIST - Target ads to a specific negative keyword list.
+      TARGETING_TYPE_VIEWABILITY - Target ads to a specific viewability (for example, 80% viewable).
+      TARGETING_TYPE_CATEGORY - Target ads to a specific content category (for example, arts & entertainment).
+      TARGETING_TYPE_INVENTORY_SOURCE - Purchase impressions from specific deals and auction packages.
+      TARGETING_TYPE_LANGUAGE - Target ads to a specific language (for example, English or Japanese).
+      TARGETING_TYPE_AUTHORIZED_SELLER_STATUS - Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.
+      TARGETING_TYPE_GEO_REGION - Target ads to a specific regional location (for example, a city or state).
+      TARGETING_TYPE_INVENTORY_SOURCE_GROUP - Purchase impressions from a group of deals and auction packages.
+      TARGETING_TYPE_EXCHANGE - Purchase impressions from specific exchanges.
+      TARGETING_TYPE_SUB_EXCHANGE - Purchase impressions from specific sub-exchanges.
+      TARGETING_TYPE_POI - Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.
+      TARGETING_TYPE_BUSINESS_CHAIN - Target ads around locations of a business chain within a specific geo region.
+      TARGETING_TYPE_CONTENT_DURATION - Target ads to a specific video content duration.
+      TARGETING_TYPE_CONTENT_STREAM_TYPE - Target ads to a specific video content stream type.
+      TARGETING_TYPE_NATIVE_CONTENT_POSITION - Target ads to a specific native content position.
+      TARGETING_TYPE_OMID - Target ads in an Open Measurement enabled inventory.
+      TARGETING_TYPE_AUDIO_CONTENT_TYPE - Target ads to a specific audio content type.
+      TARGETING_TYPE_CONTENT_GENRE - Target ads to a specific content genre.
+      TARGETING_TYPE_YOUTUBE_VIDEO - Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
+      TARGETING_TYPE_YOUTUBE_CHANNEL - Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
+      TARGETING_TYPE_SESSION_POSITION - Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.
+  advertiserId: string, Required. The Advertiser this request is being made in the context of.
+  filter: string, Allows filtering by targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `OR` logical operators. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `carrierAndIspDetails.type` * `geoRegionDetails.geoRegionType` * `targetingOptionId` Examples: * All `GEO REGION` targeting options that belong to sub type `GEO_REGION_TYPE_COUNTRY` or `GEO_REGION_TYPE_STATE`: `geoRegionDetails.geoRegionType="GEO_REGION_TYPE_COUNTRY" OR geoRegionDetails.geoRegionType="GEO_REGION_TYPE_STATE"` * All `CARRIER AND ISP` targeting options that belong to sub type `CARRIER_AND_ISP_TYPE_CARRIER`: `carrierAndIspDetails.type="CARRIER_AND_ISP_TYPE_CARRIER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
+  orderBy: string, Field by which to sort the list. Acceptable values are: * `targetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `targetingOptionId desc`.
+  pageSize: integer, Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
+  pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListTargetingOptions` method. If not specified, the first page of results 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:
+
+    { # Response message for ListTargetingOptions.
+  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListTargetingOptions` method to retrieve the next page of results.
+  "targetingOptions": [ # The list of targeting options. This list will be absent if empty.
+    { # Represents a single targeting option, which is a targetable concept in DV360.
+      "ageRangeDetails": { # Represents a targetable age range. This will be populated in the age_range_details field when targeting_type is `TARGETING_TYPE_AGE_RANGE`. # Age range details.
+        "ageRange": "A String", # Output only. The age range of an audience.
+      },
+      "appCategoryDetails": { # Represents a targetable collection of apps. A collection lets you target dynamic groups of related apps that are maintained by the platform, for example `All Apps/Google Play/Games`. This will be populated in the app_category_details field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. # App category details.
+        "displayName": "A String", # Output only. The name of the app collection.
+      },
+      "audioContentTypeDetails": { # Represents a targetable audio content type. This will be populated in the audio_content_type_details field when targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`. # Audio content type details.
+        "audioContentType": "A String", # Output only. The audio content type.
+      },
+      "authorizedSellerStatusDetails": { # Represents a targetable authorized seller status. This will be populated in the authorized_seller_status_details field when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. # Authorized seller status resource details.
+        "authorizedSellerStatus": "A String", # Output only. The authorized seller status.
+      },
+      "browserDetails": { # Represents a targetable browser. This will be populated in the browser_details field when targeting_type is `TARGETING_TYPE_BROWSER`. # Browser details.
+        "displayName": "A String", # Output only. The display name of the browser.
+      },
+      "businessChainDetails": { # Represents a targetable business chain within a geo region. This will be populated in the business_chain_details field when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`. # Business chain resource details.
+        "businessChain": "A String", # Output only. The display name of the business chain, e.g. "KFC", "Chase Bank".
+        "geoRegion": "A String", # Output only. The display name of the geographic region, e.g. "Ontario, Canada".
+        "geoRegionType": "A String", # Output only. The type of the geographic region.
+      },
+      "carrierAndIspDetails": { # Represents a targetable carrier or ISP. This will be populated in the carrier_and_isp_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`. # Carrier and ISP details.
+        "displayName": "A String", # Output only. The display name of the carrier or ISP.
+        "type": "A String", # Output only. The type indicating if it's carrier or ISP.
+      },
+      "categoryDetails": { # Represents a targetable category. This will be populated in the category_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_CATEGORY`. # Category resource details.
+        "displayName": "A String", # Output only. The display name of the category.
+      },
+      "contentDurationDetails": { # Represents a targetable content duration. This will be populated in the content_duration_details field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`. # Content duration resource details.
+        "contentDuration": "A String", # Output only. The content duration.
+      },
+      "contentGenreDetails": { # Represents a targetable content genre. This will be populated in the content_genre_details field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`. # Content genre resource details.
+        "displayName": "A String", # Output only. The display name of the content genre
+      },
+      "contentInstreamPositionDetails": { # Represents a targetable content instream position, which could be used by video and audio ads. This will be populated in the content_instream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. # Content instream position details.
+        "contentInstreamPosition": "A String", # Output only. The content instream position.
+      },
+      "contentOutstreamPositionDetails": { # Represents a targetable content outstream position, which could be used by display and video ads. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. # Content outstream position details.
+        "contentOutstreamPosition": "A String", # Output only. The content outstream position.
+      },
+      "contentStreamTypeDetails": { # Represents a targetable content stream type. This will be populated in the content_stream_type_details field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`. # Content stream type resource details.
+        "contentStreamType": "A String", # Output only. The content stream type.
+      },
+      "deviceMakeModelDetails": { # Represents a targetable device make and model. This will be populated in the device_make_model_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model resource details.
+        "displayName": "A String", # Output only. The display name of the device make and model.
+      },
+      "deviceTypeDetails": { # Represents a targetable device type. This will be populated in the device_type_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`. # Device type details.
+        "deviceType": "A String", # Output only. The device type that is used to be targeted.
+      },
+      "digitalContentLabelDetails": { # Represents a targetable digital content label rating tier. This will be populated in the digital_content_label_details field of the TargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details.
+        "contentRatingTier": "A String", # Output only. An enum for the content label brand safety tiers.
+      },
+      "environmentDetails": { # Represents a targetable environment. This will be populated in the environment_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details.
+        "environment": "A String", # Output only. The serving environment.
+      },
+      "exchangeDetails": { # Represents a targetable exchange. This will be populated in the exchange_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`. # Exchange details.
+        "exchange": "A String", # Output only. The type of exchange.
+      },
+      "genderDetails": { # Represents a targetable gender. This will be populated in the gender_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_GENDER`. # Gender details.
+        "gender": "A String", # Output only. The gender of an audience.
+      },
+      "geoRegionDetails": { # Represents a targetable geographic region. This will be populated in the geo_region_details field when targeting_type is `TARGETING_TYPE_GEO_REGION`. # Geographic region resource details.
+        "displayName": "A String", # Output only. The display name of the geographic region (e.g., "Ontario, Canada").
+        "geoRegionType": "A String", # Output only. The type of geographic region targeting.
+      },
+      "householdIncomeDetails": { # Represents a targetable household income. This will be populated in the household_income_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`. # Household income details.
+        "householdIncome": "A String", # Output only. The household income of an audience.
+      },
+      "languageDetails": { # Represents a targetable language. This will be populated in the language_details field when targeting_type is `TARGETING_TYPE_LANGUAGE`. # Language resource details.
+        "displayName": "A String", # Output only. The display name of the language (e.g., "French").
+      },
+      "name": "A String", # Output only. The resource name for this targeting option.
+      "nativeContentPositionDetails": { # Represents a targetable native content position. This will be populated in the native_content_position_details field when targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`. # Native content position details.
+        "contentPosition": "A String", # Output only. The content position.
+      },
+      "omidDetails": { # Represents a targetable Open Measurement enabled inventory type. This will be populated in the omid_details field when targeting_type is `TARGETING_TYPE_OMID`. # Open Measurement enabled inventory details.
+        "omid": "A String", # Output only. The type of Open Measurement enabled inventory.
+      },
+      "onScreenPositionDetails": { # Represents a targetable on screen position, which could be used by display and video ads. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. # On screen position details.
+        "onScreenPosition": "A String", # Output only. The on screen position.
+      },
+      "operatingSystemDetails": { # Represents a targetable operating system. This will be populated in the operating_system_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. # Operating system resources details.
+        "displayName": "A String", # Output only. The display name of the operating system.
+      },
+      "parentalStatusDetails": { # Represents a targetable parental status. This will be populated in the parental_status_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`. # Parental status details.
+        "parentalStatus": "A String", # Output only. The parental status of an audience.
+      },
+      "poiDetails": { # Represents a targetable point of interest(POI). This will be populated in the poi_details field when targeting_type is `TARGETING_TYPE_POI`. # POI resource details.
+        "displayName": "A String", # Output only. The display name of a POI(e.g. "Times Square", "Space Needle"), followed by its full address if available.
+        "latitude": 3.14, # Output only. Latitude of the POI rounding to 6th decimal place.
+        "longitude": 3.14, # Output only. Longitude of the POI rounding to 6th decimal place.
+      },
+      "sensitiveCategoryDetails": { # Represents a targetable sensitive category. This will be populated in the sensitive_category_details field of the TargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive Category details.
+        "sensitiveCategory": "A String", # Output only. An enum for the DV360 Sensitive category content classifier.
+      },
+      "subExchangeDetails": { # Represents a targetable sub-exchange. This will be populated in the sub_exchange_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`. # Sub-exchange details.
+        "displayName": "A String", # Output only. The display name of the sub-exchange.
+      },
+      "targetingOptionId": "A String", # Output only. A unique identifier for this targeting option. The tuple {`targeting_type`, `targeting_option_id`} will be unique.
+      "targetingType": "A String", # Output only. The type of this targeting option.
+      "userRewardedContentDetails": { # Represents a targetable user rewarded content status for video ads only. This will be populated in the user_rewarded_content_details field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. # User rewarded content details.
+        "userRewardedContent": "A String", # Output only. User rewarded content status for video ads.
+      },
+      "videoPlayerSizeDetails": { # Represents a targetable video player size. This will be populated in the video_player_size_details field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. # Video player size details.
+        "videoPlayerSize": "A String", # Output only. The video player size.
+      },
+      "viewabilityDetails": { # Represents a targetable viewability. This will be populated in the viewability_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`. # Viewability resource details.
+        "viewability": "A String", # Output only. The predicted viewability percentage.
+      },
+    },
+  ],
+}
+
+ +
+ 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.
+        
+
+ +
+ search(targetingType, body=None, x__xgafv=None) +
Searches for targeting options of a given type based on the given search terms.
+
+Args:
+  targetingType: string, Required. The type of targeting options to retrieve. Accepted values are: * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_BUSINESS_CHAIN` (required)
+    Allowed values
+      TARGETING_TYPE_UNSPECIFIED - Default value when type is not specified or is unknown in this version.
+      TARGETING_TYPE_CHANNEL - Target a channel (a custom group of related websites or apps).
+      TARGETING_TYPE_APP_CATEGORY - Target an app category (for example, education or puzzle games).
+      TARGETING_TYPE_APP - Target a specific app (for example, Angry Birds).
+      TARGETING_TYPE_URL - Target a specific url (for example, quora.com).
+      TARGETING_TYPE_DAY_AND_TIME - Target ads during a chosen time period on a specific day.
+      TARGETING_TYPE_AGE_RANGE - Target ads to a specific age range (for example, 18-24).
+      TARGETING_TYPE_REGIONAL_LOCATION_LIST - Target ads to the specified regions on a regional location list.
+      TARGETING_TYPE_PROXIMITY_LOCATION_LIST - Target ads to the specified points of interest on a proximity location list.
+      TARGETING_TYPE_GENDER - Target ads to a specific gender (for example, female or male).
+      TARGETING_TYPE_VIDEO_PLAYER_SIZE - Target a specific video player size for video ads.
+      TARGETING_TYPE_USER_REWARDED_CONTENT - Target user rewarded content for video ads.
+      TARGETING_TYPE_PARENTAL_STATUS - Target ads to a specific parental status (for example, parent or not a parent).
+      TARGETING_TYPE_CONTENT_INSTREAM_POSITION - Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).
+      TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION - Target ads in a specific content outstream position.
+      TARGETING_TYPE_DEVICE_TYPE - Target ads to a specific device type (for example, tablet or connected TV).
+      TARGETING_TYPE_AUDIENCE_GROUP - Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.
+      TARGETING_TYPE_BROWSER - Target ads to specific web browsers (for example, Chrome).
+      TARGETING_TYPE_HOUSEHOLD_INCOME - Target ads to a specific household income range (for example, top 10%).
+      TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position.
+      TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify).
+      TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).
+      TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult).
+      TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app).
+      TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).
+      TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS).
+      TARGETING_TYPE_DEVICE_MAKE_MODEL - Target ads to a specific device make or model (for example, Roku or Samsung).
+      TARGETING_TYPE_KEYWORD - Target ads to a specific keyword (for example, dog or retriever).
+      TARGETING_TYPE_NEGATIVE_KEYWORD_LIST - Target ads to a specific negative keyword list.
+      TARGETING_TYPE_VIEWABILITY - Target ads to a specific viewability (for example, 80% viewable).
+      TARGETING_TYPE_CATEGORY - Target ads to a specific content category (for example, arts & entertainment).
+      TARGETING_TYPE_INVENTORY_SOURCE - Purchase impressions from specific deals and auction packages.
+      TARGETING_TYPE_LANGUAGE - Target ads to a specific language (for example, English or Japanese).
+      TARGETING_TYPE_AUTHORIZED_SELLER_STATUS - Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.
+      TARGETING_TYPE_GEO_REGION - Target ads to a specific regional location (for example, a city or state).
+      TARGETING_TYPE_INVENTORY_SOURCE_GROUP - Purchase impressions from a group of deals and auction packages.
+      TARGETING_TYPE_EXCHANGE - Purchase impressions from specific exchanges.
+      TARGETING_TYPE_SUB_EXCHANGE - Purchase impressions from specific sub-exchanges.
+      TARGETING_TYPE_POI - Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.
+      TARGETING_TYPE_BUSINESS_CHAIN - Target ads around locations of a business chain within a specific geo region.
+      TARGETING_TYPE_CONTENT_DURATION - Target ads to a specific video content duration.
+      TARGETING_TYPE_CONTENT_STREAM_TYPE - Target ads to a specific video content stream type.
+      TARGETING_TYPE_NATIVE_CONTENT_POSITION - Target ads to a specific native content position.
+      TARGETING_TYPE_OMID - Target ads in an Open Measurement enabled inventory.
+      TARGETING_TYPE_AUDIO_CONTENT_TYPE - Target ads to a specific audio content type.
+      TARGETING_TYPE_CONTENT_GENRE - Target ads to a specific content genre.
+      TARGETING_TYPE_YOUTUBE_VIDEO - Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
+      TARGETING_TYPE_YOUTUBE_CHANNEL - Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
+      TARGETING_TYPE_SESSION_POSITION - Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for SearchTargetingOptions.
+  "advertiserId": "A String", # Required. The Advertiser this request is being made in the context of.
+  "businessChainSearchTerms": { # Search terms for Business Chain targeting options. At least one of the field should be populated. # Search terms for Business Chain targeting options. Can only be used when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`.
+    "businessChainQuery": "A String", # The search query for the desired business chain. The query must be the full name of the business, e.g. "KFC", "mercedes-benz".
+    "regionQuery": "A String", # The search query for the desired geo region, e.g. "Seattle", "United State".
+  },
+  "geoRegionSearchTerms": { # Search terms for geo region targeting options. # Search terms for geo region targeting options. Can only be used when targeting_type is `TARGETING_TYPE_GEO_REGION`.
+    "geoRegionQuery": "A String", # The search query for the desired geo region. The query can be a prefix, e.g. "New Yor", "Seattle", "USA", etc.
+  },
+  "pageSize": 42, # Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
+  "pageToken": "A String", # A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `SearchTargetingOptions` method. If not specified, the first page of results will be returned.
+  "poiSearchTerms": { # Search terms for POI targeting options. # Search terms for POI targeting options. Can only be used when targeting_type is `TARGETING_TYPE_POI`.
+    "poiQuery": "A String", # The search query for the desired POI name, street address, or coordinate of the desired POI. The query can be a prefix, e.g. "Times squar", "40.7505045,-73.99562", "315 W 44th St", etc.
+  },
+}
+
+  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 SearchTargetingOptions.
+  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `SearchTargetingOptions` method to retrieve the next page of results.
+  "targetingOptions": [ # The list of targeting options that match the search criteria. This list will be absent if empty.
+    { # Represents a single targeting option, which is a targetable concept in DV360.
+      "ageRangeDetails": { # Represents a targetable age range. This will be populated in the age_range_details field when targeting_type is `TARGETING_TYPE_AGE_RANGE`. # Age range details.
+        "ageRange": "A String", # Output only. The age range of an audience.
+      },
+      "appCategoryDetails": { # Represents a targetable collection of apps. A collection lets you target dynamic groups of related apps that are maintained by the platform, for example `All Apps/Google Play/Games`. This will be populated in the app_category_details field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. # App category details.
+        "displayName": "A String", # Output only. The name of the app collection.
+      },
+      "audioContentTypeDetails": { # Represents a targetable audio content type. This will be populated in the audio_content_type_details field when targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`. # Audio content type details.
+        "audioContentType": "A String", # Output only. The audio content type.
+      },
+      "authorizedSellerStatusDetails": { # Represents a targetable authorized seller status. This will be populated in the authorized_seller_status_details field when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. # Authorized seller status resource details.
+        "authorizedSellerStatus": "A String", # Output only. The authorized seller status.
+      },
+      "browserDetails": { # Represents a targetable browser. This will be populated in the browser_details field when targeting_type is `TARGETING_TYPE_BROWSER`. # Browser details.
+        "displayName": "A String", # Output only. The display name of the browser.
+      },
+      "businessChainDetails": { # Represents a targetable business chain within a geo region. This will be populated in the business_chain_details field when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`. # Business chain resource details.
+        "businessChain": "A String", # Output only. The display name of the business chain, e.g. "KFC", "Chase Bank".
+        "geoRegion": "A String", # Output only. The display name of the geographic region, e.g. "Ontario, Canada".
+        "geoRegionType": "A String", # Output only. The type of the geographic region.
+      },
+      "carrierAndIspDetails": { # Represents a targetable carrier or ISP. This will be populated in the carrier_and_isp_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`. # Carrier and ISP details.
+        "displayName": "A String", # Output only. The display name of the carrier or ISP.
+        "type": "A String", # Output only. The type indicating if it's carrier or ISP.
+      },
+      "categoryDetails": { # Represents a targetable category. This will be populated in the category_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_CATEGORY`. # Category resource details.
+        "displayName": "A String", # Output only. The display name of the category.
+      },
+      "contentDurationDetails": { # Represents a targetable content duration. This will be populated in the content_duration_details field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`. # Content duration resource details.
+        "contentDuration": "A String", # Output only. The content duration.
+      },
+      "contentGenreDetails": { # Represents a targetable content genre. This will be populated in the content_genre_details field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`. # Content genre resource details.
+        "displayName": "A String", # Output only. The display name of the content genre
+      },
+      "contentInstreamPositionDetails": { # Represents a targetable content instream position, which could be used by video and audio ads. This will be populated in the content_instream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. # Content instream position details.
+        "contentInstreamPosition": "A String", # Output only. The content instream position.
+      },
+      "contentOutstreamPositionDetails": { # Represents a targetable content outstream position, which could be used by display and video ads. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. # Content outstream position details.
+        "contentOutstreamPosition": "A String", # Output only. The content outstream position.
+      },
+      "contentStreamTypeDetails": { # Represents a targetable content stream type. This will be populated in the content_stream_type_details field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`. # Content stream type resource details.
+        "contentStreamType": "A String", # Output only. The content stream type.
+      },
+      "deviceMakeModelDetails": { # Represents a targetable device make and model. This will be populated in the device_make_model_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model resource details.
+        "displayName": "A String", # Output only. The display name of the device make and model.
+      },
+      "deviceTypeDetails": { # Represents a targetable device type. This will be populated in the device_type_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`. # Device type details.
+        "deviceType": "A String", # Output only. The device type that is used to be targeted.
+      },
+      "digitalContentLabelDetails": { # Represents a targetable digital content label rating tier. This will be populated in the digital_content_label_details field of the TargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details.
+        "contentRatingTier": "A String", # Output only. An enum for the content label brand safety tiers.
+      },
+      "environmentDetails": { # Represents a targetable environment. This will be populated in the environment_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details.
+        "environment": "A String", # Output only. The serving environment.
+      },
+      "exchangeDetails": { # Represents a targetable exchange. This will be populated in the exchange_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`. # Exchange details.
+        "exchange": "A String", # Output only. The type of exchange.
+      },
+      "genderDetails": { # Represents a targetable gender. This will be populated in the gender_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_GENDER`. # Gender details.
+        "gender": "A String", # Output only. The gender of an audience.
+      },
+      "geoRegionDetails": { # Represents a targetable geographic region. This will be populated in the geo_region_details field when targeting_type is `TARGETING_TYPE_GEO_REGION`. # Geographic region resource details.
+        "displayName": "A String", # Output only. The display name of the geographic region (e.g., "Ontario, Canada").
+        "geoRegionType": "A String", # Output only. The type of geographic region targeting.
+      },
+      "householdIncomeDetails": { # Represents a targetable household income. This will be populated in the household_income_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`. # Household income details.
+        "householdIncome": "A String", # Output only. The household income of an audience.
+      },
+      "languageDetails": { # Represents a targetable language. This will be populated in the language_details field when targeting_type is `TARGETING_TYPE_LANGUAGE`. # Language resource details.
+        "displayName": "A String", # Output only. The display name of the language (e.g., "French").
+      },
+      "name": "A String", # Output only. The resource name for this targeting option.
+      "nativeContentPositionDetails": { # Represents a targetable native content position. This will be populated in the native_content_position_details field when targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`. # Native content position details.
+        "contentPosition": "A String", # Output only. The content position.
+      },
+      "omidDetails": { # Represents a targetable Open Measurement enabled inventory type. This will be populated in the omid_details field when targeting_type is `TARGETING_TYPE_OMID`. # Open Measurement enabled inventory details.
+        "omid": "A String", # Output only. The type of Open Measurement enabled inventory.
+      },
+      "onScreenPositionDetails": { # Represents a targetable on screen position, which could be used by display and video ads. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. # On screen position details.
+        "onScreenPosition": "A String", # Output only. The on screen position.
+      },
+      "operatingSystemDetails": { # Represents a targetable operating system. This will be populated in the operating_system_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. # Operating system resources details.
+        "displayName": "A String", # Output only. The display name of the operating system.
+      },
+      "parentalStatusDetails": { # Represents a targetable parental status. This will be populated in the parental_status_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`. # Parental status details.
+        "parentalStatus": "A String", # Output only. The parental status of an audience.
+      },
+      "poiDetails": { # Represents a targetable point of interest(POI). This will be populated in the poi_details field when targeting_type is `TARGETING_TYPE_POI`. # POI resource details.
+        "displayName": "A String", # Output only. The display name of a POI(e.g. "Times Square", "Space Needle"), followed by its full address if available.
+        "latitude": 3.14, # Output only. Latitude of the POI rounding to 6th decimal place.
+        "longitude": 3.14, # Output only. Longitude of the POI rounding to 6th decimal place.
+      },
+      "sensitiveCategoryDetails": { # Represents a targetable sensitive category. This will be populated in the sensitive_category_details field of the TargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive Category details.
+        "sensitiveCategory": "A String", # Output only. An enum for the DV360 Sensitive category content classifier.
+      },
+      "subExchangeDetails": { # Represents a targetable sub-exchange. This will be populated in the sub_exchange_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`. # Sub-exchange details.
+        "displayName": "A String", # Output only. The display name of the sub-exchange.
+      },
+      "targetingOptionId": "A String", # Output only. A unique identifier for this targeting option. The tuple {`targeting_type`, `targeting_option_id`} will be unique.
+      "targetingType": "A String", # Output only. The type of this targeting option.
+      "userRewardedContentDetails": { # Represents a targetable user rewarded content status for video ads only. This will be populated in the user_rewarded_content_details field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. # User rewarded content details.
+        "userRewardedContent": "A String", # Output only. User rewarded content status for video ads.
+      },
+      "videoPlayerSizeDetails": { # Represents a targetable video player size. This will be populated in the video_player_size_details field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. # Video player size details.
+        "videoPlayerSize": "A String", # Output only. The video player size.
+      },
+      "viewabilityDetails": { # Represents a targetable viewability. This will be populated in the viewability_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`. # Viewability resource details.
+        "viewability": "A String", # Output only. The predicted viewability percentage.
+      },
+    },
+  ],
+}
+
+ +
+ search_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/displayvideo_v4.users.html b/docs/dyn/displayvideo_v4.users.html new file mode 100644 index 00000000000..6f8093e22c9 --- /dev/null +++ b/docs/dyn/displayvideo_v4.users.html @@ -0,0 +1,352 @@ + + + +

Display & Video 360 API . users

+

Instance Methods

+

+ bulkEditAssignedUserRoles(userId, body=None, x__xgafv=None)

+

Bulk edits user roles for a user. The operation will delete the assigned user roles provided in BulkEditAssignedUserRolesRequest.deletedAssignedUserRoles and then assign the user roles provided in BulkEditAssignedUserRolesRequest.createdAssignedUserRoles. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this method.

+

+ close()

+

Close httplib2 connections.

+

+ create(body=None, x__xgafv=None)

+

Creates a new user. Returns the newly created user if successful. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this method.

+

+ delete(userId, x__xgafv=None)

+

Deletes a user. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this method.

+

+ get(userId, x__xgafv=None)

+

Gets a user. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this method.

+

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

+

Lists users that are accessible to the current user. If two users have user roles on the same partner or advertiser, they can access each other. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this method.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(userId, body=None, updateMask=None, x__xgafv=None)

+

Updates an existing user. Returns the updated user if successful. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this method.

+

Method Details

+
+ bulkEditAssignedUserRoles(userId, body=None, x__xgafv=None) +
Bulk edits user roles for a user. The operation will delete the assigned user roles provided in BulkEditAssignedUserRolesRequest.deletedAssignedUserRoles and then assign the user roles provided in BulkEditAssignedUserRolesRequest.createdAssignedUserRoles. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this method.
+
+Args:
+  userId: string, Required. The ID of the user to which the assigned user roles belong. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for BulkEditAssignedUserRoles.
+  "createdAssignedUserRoles": [ # The assigned user roles to create in batch, specified as a list of AssignedUserRoles.
+    { # A single assigned user role, which defines a user's authorized interaction with a specified partner or advertiser.
+      "advertiserId": "A String", # The ID of the advertiser that the assigend user role applies to.
+      "assignedUserRoleId": "A String", # Output only. The ID of the assigned user role.
+      "partnerId": "A String", # The ID of the partner that the assigned user role applies to.
+      "userRole": "A String", # Required. The user role to assign to a user for the entity.
+    },
+  ],
+  "deletedAssignedUserRoles": [ # The assigned user roles to delete in batch, specified as a list of assigned_user_role_ids. The format of assigned_user_role_id is `entityType-entityid`, for example `partner-123`.
+    "A String",
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "createdAssignedUserRoles": [ # The list of assigned user roles that have been successfully created. This list will be absent if empty.
+    { # A single assigned user role, which defines a user's authorized interaction with a specified partner or advertiser.
+      "advertiserId": "A String", # The ID of the advertiser that the assigend user role applies to.
+      "assignedUserRoleId": "A String", # Output only. The ID of the assigned user role.
+      "partnerId": "A String", # The ID of the partner that the assigned user role applies to.
+      "userRole": "A String", # Required. The user role to assign to a user for the entity.
+    },
+  ],
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ create(body=None, x__xgafv=None) +
Creates a new user. Returns the newly created user if successful. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this method.
+
+Args:
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A single user in Display & Video 360.
+  "assignedUserRoles": [ # The assigned user roles. Required in CreateUser. Output only in UpdateUser. Can only be updated through BulkEditAssignedUserRoles.
+    { # A single assigned user role, which defines a user's authorized interaction with a specified partner or advertiser.
+      "advertiserId": "A String", # The ID of the advertiser that the assigend user role applies to.
+      "assignedUserRoleId": "A String", # Output only. The ID of the assigned user role.
+      "partnerId": "A String", # The ID of the partner that the assigned user role applies to.
+      "userRole": "A String", # Required. The user role to assign to a user for the entity.
+    },
+  ],
+  "displayName": "A String", # Required. The display name of the user. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "email": "A String", # Required. Immutable. The email address used to identify the user.
+  "lastLoginTime": "A String", # Output only. The timestamp when the user last logged in DV360 UI.
+  "name": "A String", # Output only. The resource name of the user.
+  "userId": "A String", # Output only. The unique ID of the user. Assigned by the system.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single user in Display & Video 360.
+  "assignedUserRoles": [ # The assigned user roles. Required in CreateUser. Output only in UpdateUser. Can only be updated through BulkEditAssignedUserRoles.
+    { # A single assigned user role, which defines a user's authorized interaction with a specified partner or advertiser.
+      "advertiserId": "A String", # The ID of the advertiser that the assigend user role applies to.
+      "assignedUserRoleId": "A String", # Output only. The ID of the assigned user role.
+      "partnerId": "A String", # The ID of the partner that the assigned user role applies to.
+      "userRole": "A String", # Required. The user role to assign to a user for the entity.
+    },
+  ],
+  "displayName": "A String", # Required. The display name of the user. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "email": "A String", # Required. Immutable. The email address used to identify the user.
+  "lastLoginTime": "A String", # Output only. The timestamp when the user last logged in DV360 UI.
+  "name": "A String", # Output only. The resource name of the user.
+  "userId": "A String", # Output only. The unique ID of the user. Assigned by the system.
+}
+
+ +
+ delete(userId, x__xgafv=None) +
Deletes a user. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this method.
+
+Args:
+  userId: string, Required. The ID of the user 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(userId, x__xgafv=None) +
Gets a user. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this method.
+
+Args:
+  userId: string, Required. The ID of the user to fetch. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single user in Display & Video 360.
+  "assignedUserRoles": [ # The assigned user roles. Required in CreateUser. Output only in UpdateUser. Can only be updated through BulkEditAssignedUserRoles.
+    { # A single assigned user role, which defines a user's authorized interaction with a specified partner or advertiser.
+      "advertiserId": "A String", # The ID of the advertiser that the assigend user role applies to.
+      "assignedUserRoleId": "A String", # Output only. The ID of the assigned user role.
+      "partnerId": "A String", # The ID of the partner that the assigned user role applies to.
+      "userRole": "A String", # Required. The user role to assign to a user for the entity.
+    },
+  ],
+  "displayName": "A String", # Required. The display name of the user. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "email": "A String", # Required. Immutable. The email address used to identify the user.
+  "lastLoginTime": "A String", # Output only. The timestamp when the user last logged in DV360 UI.
+  "name": "A String", # Output only. The resource name of the user.
+  "userId": "A String", # Output only. The unique ID of the user. Assigned by the system.
+}
+
+ +
+ list(filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists users that are accessible to the current user. If two users have user roles on the same partner or advertiser, they can access each other. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this method.
+
+Args:
+  filter: string, Allows filtering by user fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `displayName` and `email` fields must use the `HAS (:)` operator. * The `lastLoginTime` field must use either the `LESS THAN OR EQUAL TO (<=)` or `GREATER THAN OR EQUAL TO (>=)` operator. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `assignedUserRole.advertiserId` * `assignedUserRole.entityType`: This is synthetic field of `AssignedUserRole` used for filtering. Identifies the type of entity to which the user role is assigned. Valid values are `Partner` and `Advertiser`. * `assignedUserRole.parentPartnerId`: This is a synthetic field of `AssignedUserRole` used for filtering. Identifies the parent partner of the entity to which the user role is assigned. * `assignedUserRole.partnerId` * `assignedUserRole.userRole` * `displayName` * `email` * `lastLoginTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * The user with `displayName` containing "foo": `displayName:"foo"` * The user with `email` containing "bar": `email:"bar"` * All users with standard user roles: `assignedUserRole.userRole="STANDARD"` * All users with user roles for partner 123: `assignedUserRole.partnerId="123"` * All users with user roles for advertiser 123: `assignedUserRole.advertiserId="123"` * All users with partner level user roles: `entityType="PARTNER"` * All users with user roles for partner 123 and advertisers under partner 123: `parentPartnerId="123"` * All users that last logged in on or after 2023-01-01T00:00:00Z (format of ISO 8601): `lastLoginTime>="2023-01-01T00:00:00Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
+  orderBy: string, Field by which to sort the list. Acceptable values are: * `displayName` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`.
+  pageSize: integer, Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
+  pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListUsers` method. If not specified, the first page of results 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:
+
+    {
+  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListUsers` method to retrieve the next page of results. This token will be absent if there are no more results to return.
+  "users": [ # The list of users. This list will be absent if empty.
+    { # A single user in Display & Video 360.
+      "assignedUserRoles": [ # The assigned user roles. Required in CreateUser. Output only in UpdateUser. Can only be updated through BulkEditAssignedUserRoles.
+        { # A single assigned user role, which defines a user's authorized interaction with a specified partner or advertiser.
+          "advertiserId": "A String", # The ID of the advertiser that the assigend user role applies to.
+          "assignedUserRoleId": "A String", # Output only. The ID of the assigned user role.
+          "partnerId": "A String", # The ID of the partner that the assigned user role applies to.
+          "userRole": "A String", # Required. The user role to assign to a user for the entity.
+        },
+      ],
+      "displayName": "A String", # Required. The display name of the user. Must be UTF-8 encoded with a maximum size of 240 bytes.
+      "email": "A String", # Required. Immutable. The email address used to identify the user.
+      "lastLoginTime": "A String", # Output only. The timestamp when the user last logged in DV360 UI.
+      "name": "A String", # Output only. The resource name of the user.
+      "userId": "A String", # Output only. The unique ID of the user. Assigned by the system.
+    },
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(userId, body=None, updateMask=None, x__xgafv=None) +
Updates an existing user. Returns the updated user if successful. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this method.
+
+Args:
+  userId: string, Output only. The unique ID of the user. Assigned by the system. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A single user in Display & Video 360.
+  "assignedUserRoles": [ # The assigned user roles. Required in CreateUser. Output only in UpdateUser. Can only be updated through BulkEditAssignedUserRoles.
+    { # A single assigned user role, which defines a user's authorized interaction with a specified partner or advertiser.
+      "advertiserId": "A String", # The ID of the advertiser that the assigend user role applies to.
+      "assignedUserRoleId": "A String", # Output only. The ID of the assigned user role.
+      "partnerId": "A String", # The ID of the partner that the assigned user role applies to.
+      "userRole": "A String", # Required. The user role to assign to a user for the entity.
+    },
+  ],
+  "displayName": "A String", # Required. The display name of the user. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "email": "A String", # Required. Immutable. The email address used to identify the user.
+  "lastLoginTime": "A String", # Output only. The timestamp when the user last logged in DV360 UI.
+  "name": "A String", # Output only. The resource name of the user.
+  "userId": "A String", # Output only. The unique ID of the user. Assigned by the system.
+}
+
+  updateMask: string, Required. The mask to control which fields to update.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single user in Display & Video 360.
+  "assignedUserRoles": [ # The assigned user roles. Required in CreateUser. Output only in UpdateUser. Can only be updated through BulkEditAssignedUserRoles.
+    { # A single assigned user role, which defines a user's authorized interaction with a specified partner or advertiser.
+      "advertiserId": "A String", # The ID of the advertiser that the assigend user role applies to.
+      "assignedUserRoleId": "A String", # Output only. The ID of the assigned user role.
+      "partnerId": "A String", # The ID of the partner that the assigned user role applies to.
+      "userRole": "A String", # Required. The user role to assign to a user for the entity.
+    },
+  ],
+  "displayName": "A String", # Required. The display name of the user. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "email": "A String", # Required. Immutable. The email address used to identify the user.
+  "lastLoginTime": "A String", # Output only. The timestamp when the user last logged in DV360 UI.
+  "name": "A String", # Output only. The resource name of the user.
+  "userId": "A String", # Output only. The unique ID of the user. Assigned by the system.
+}
+
+ + \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/displayvideo.v2.json b/googleapiclient/discovery_cache/documents/displayvideo.v2.json index d4d79632de5..65bc0e91dcd 100644 --- a/googleapiclient/discovery_cache/documents/displayvideo.v2.json +++ b/googleapiclient/discovery_cache/documents/displayvideo.v2.json @@ -4832,7 +4832,7 @@ ] }, "patch": { -"description": "Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful.", +"description": "Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful. *Warning*: Starting **April 1, 2025**, requests updating custom bidding algorithms that are assigned to line items will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).", "flatPath": "v2/customBiddingAlgorithms/{customBiddingAlgorithmsId}", "httpMethod": "PATCH", "id": "displayvideo.customBiddingAlgorithms.patch", @@ -4909,7 +4909,7 @@ "scripts": { "methods": { "create": { -"description": "Creates a new custom bidding script. Returns the newly created script if successful.", +"description": "Creates a new custom bidding script. Returns the newly created script if successful. *Warning*: Starting **April 1, 2025**, requests updating custom bidding algorithms that are assigned to line items will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).", "flatPath": "v2/customBiddingAlgorithms/{customBiddingAlgorithmsId}/scripts", "httpMethod": "POST", "id": "displayvideo.customBiddingAlgorithms.scripts.create", @@ -8010,7 +8010,7 @@ } } }, -"revision": "20250211", +"revision": "20250220", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActivateManualTriggerRequest": { @@ -8587,10 +8587,10 @@ "properties": { "asset": { "$ref": "Asset", -"description": "The associated asset." +"description": "Optional. The associated asset." }, "role": { -"description": "The role of this asset for the creative.", +"description": "Optional. The role of this asset for the creative.", "enum": [ "ASSET_ROLE_UNSPECIFIED", "ASSET_ROLE_MAIN", @@ -8620,24 +8620,24 @@ "The asset is the main asset of the creative.", "The asset is a backup asset of the creative.", "The asset is a polite load asset of the creative.", -"Headline of a native creative. The content must be UTF-8 encoded with a length of no more than 25 characters. This role is only supported in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", -"Long headline of a native creative. The content must be UTF-8 encoded with a length of no more than 50 characters. This role is only supported in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", -"Body text of a native creative. The content must be UTF-8 encoded with a length of no more than 90 characters. This role is only supported in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", -"Long body text of a native creative. The content must be UTF-8 encoded with a length of no more than 150 characters. This role is only supported in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", -"A short, friendly version of the landing page URL to show in the creative. This URL gives people an idea of where they'll arrive after they click on the creative. The content must be UTF-8 encoded with a length of no more than 30 characters. For example, if the landing page URL is 'http://www.example.com/page', the caption URL can be 'example.com'. The protocol (http://) is optional, but the URL can't contain spaces or special characters. This role is only supported in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", -"The text to use on the call-to-action button of a native creative. The content must be UTF-8 encoded with a length of no more than 15 characters. This role is only supported in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", -"The text that identifies the advertiser or brand name. The content must be UTF-8 encoded with a length of no more than 25 characters. This role is only supported in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", +"Headline of a native creative. The content must be UTF-8 encoded with a length of no more than 25 characters. This role is only supported in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", +"Long headline of a native creative. The content must be UTF-8 encoded with a length of no more than 50 characters. This role is only supported in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", +"Body text of a native creative. The content must be UTF-8 encoded with a length of no more than 90 characters. This role is only supported in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", +"Long body text of a native creative. The content must be UTF-8 encoded with a length of no more than 150 characters. This role is only supported in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", +"A short, friendly version of the landing page URL to show in the creative. This URL gives people an idea of where they'll arrive after they click on the creative. The content must be UTF-8 encoded with a length of no more than 30 characters. For example, if the landing page URL is 'http://www.example.com/page', the caption URL can be 'example.com'. The protocol (http://) is optional, but the URL can't contain spaces or special characters. This role is only supported in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", +"The text to use on the call-to-action button of a native creative. The content must be UTF-8 encoded with a length of no more than 15 characters. This role is only supported in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", +"The text that identifies the advertiser or brand name. The content must be UTF-8 encoded with a length of no more than 25 characters. This role is only supported in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", "The purchase price of your app in the Google play store or iOS app store (for example, $5.99). Note that this value is not automatically synced with the actual value listed in the store. It will always be the one provided when save the creative. The content must be UTF-8 encoded with a length of no more than 15 characters. Assets of this role are read-only.", -"The ID of an Android app in the Google play store. You can find this ID in the App\u2019s Google Play Store URL after \u2018id\u2019. For example, in https://play.google.com/store/apps/details?id=com.company.appname the identifier is com.company.appname. Assets of this role are read-only.", -"The ID of an iOS app in the Apple app store. This ID number can be found in the Apple App Store URL as the string of numbers directly after \"id\". For example, in https://apps.apple.com/us/app/gmail-email-by-google/id422689480 the ID is 422689480. Assets of this role are read-only.", +"The ID of an Android app in the Google play store. You can find this ID in the App\u2019s Google Play Store URL after \u2018id\u2019. For example, in `https://play.google.com/store/apps/details?id=com.company.appname` the identifier is com.company.appname. Assets of this role are read-only.", +"The ID of an iOS app in the Apple app store. This ID number can be found in the Apple App Store URL as the string of numbers directly after \"id\". For example, in `https://apps.apple.com/us/app/gmail-email-by-google/id422689480` the ID is 422689480. Assets of this role are read-only.", "The rating of an app in the Google play store or iOS app store. Note that this value is not automatically synced with the actual rating in the store. It will always be the one provided when save the creative. Assets of this role are read-only.", -"The icon of a creative. This role is only supported and required in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`", -"The cover image of a native video creative. This role is only supported and required in following creative_type: * `CREATIVE_TYPE_VIDEO`", -"The main color to use in a creative. This role is only supported and required in following creative_type: * `CREATIVE_TYPE_ASSET_BASED_CREATIVE`", -"The accent color to use in a creative. This role is only supported and required in following creative_type: * `CREATIVE_TYPE_ASSET_BASED_CREATIVE`", -"Whether the creative must use a logo asset. This role is only supported and required in following creative_type: * `CREATIVE_TYPE_ASSET_BASED_CREATIVE`", -"Whether the creative must use an image asset. This role is only supported and required in following creative_type: * `CREATIVE_TYPE_ASSET_BASED_CREATIVE`", -"Whether asset enhancements can be applied to the creative. This role is only supported and required in following creative_type: * `CREATIVE_TYPE_ASSET_BASED_CREATIVE`" +"The icon of a creative. This role is only supported and required in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`", +"The cover image of a native video creative. This role is only supported and required in the following creative_type: * `CREATIVE_TYPE_VIDEO`", +"The main color to use in a creative. This role is only supported and required in the following creative_type: * `CREATIVE_TYPE_ASSET_BASED_CREATIVE`", +"The accent color to use in a creative. This role is only supported and required in the following creative_type: * `CREATIVE_TYPE_ASSET_BASED_CREATIVE`", +"Whether the creative must use a logo asset. This role is only supported and required in the following creative_type: * `CREATIVE_TYPE_ASSET_BASED_CREATIVE`", +"Whether the creative must use an image asset. This role is only supported and required in the following creative_type: * `CREATIVE_TYPE_ASSET_BASED_CREATIVE`", +"Whether asset enhancements can be applied to the creative. This role is only supported and required in the following creative_type: * `CREATIVE_TYPE_ASSET_BASED_CREATIVE`" ], "type": "string" } @@ -9081,24 +9081,24 @@ "type": "object" }, "AudienceGroupAssignedTargetingOptionDetails": { -"description": "Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. NEXT_ID: 9", +"description": "Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups.", "id": "AudienceGroupAssignedTargetingOptionDetails", "properties": { "excludedGoogleAudienceGroup": { "$ref": "GoogleAudienceGroup", -"description": "The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically \u2018OR\u2019 of each other." +"description": "Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically \u2018OR\u2019 of each other." }, "includedCombinedAudienceGroup": { "$ref": "CombinedAudienceGroup", -"description": "The combined audience ids of the included combined audience group. Contains combined audience ids only." +"description": "Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only." }, "includedCustomListGroup": { "$ref": "CustomListGroup", -"description": "The custom list ids of the included custom list group. Contains custom list ids only." +"description": "Optional. The custom list ids of the included custom list group. Contains custom list ids only." }, "includedGoogleAudienceGroup": { "$ref": "GoogleAudienceGroup", -"description": "The Google audience ids of the included Google audience group. Contains Google audience ids only." +"description": "Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only." } }, "type": "object" @@ -9182,12 +9182,12 @@ "id": "AudioVideoOffset", "properties": { "percentage": { -"description": "The offset in percentage of the audio or video duration.", +"description": "Optional. The offset in percentage of the audio or video duration.", "format": "int64", "type": "string" }, "seconds": { -"description": "The offset in seconds from the start of the audio or video.", +"description": "Optional. The offset in seconds from the start of the audio or video.", "format": "int64", "type": "string" } @@ -10026,7 +10026,7 @@ }, "frequencyCap": { "$ref": "FrequencyCap", -"description": "Required. The frequency cap setting of the campaign." +"description": "Required. The frequency cap setting of the campaign. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap)" }, "name": { "description": "Output only. The resource name of the campaign.", @@ -10342,17 +10342,17 @@ "id": "CmTrackingAd", "properties": { "cmAdId": { -"description": "The ad ID of the campaign manager 360 tracking Ad.", +"description": "Optional. The ad ID of the campaign manager 360 tracking Ad.", "format": "int64", "type": "string" }, "cmCreativeId": { -"description": "The creative ID of the campaign manager 360 tracking Ad.", +"description": "Optional. The creative ID of the campaign manager 360 tracking Ad.", "format": "int64", "type": "string" }, "cmPlacementId": { -"description": "The placement ID of the campaign manager 360 tracking Ad.", +"description": "Optional. The placement ID of the campaign manager 360 tracking Ad.", "format": "int64", "type": "string" } @@ -10387,7 +10387,7 @@ "id": "CombinedAudienceGroup", "properties": { "settings": { -"description": "Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise.", +"description": "Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise.", "items": { "$ref": "CombinedAudienceTargetingSetting" }, @@ -10736,7 +10736,7 @@ "id": "ConversionCountingConfig", "properties": { "floodlightActivityConfigs": { -"description": "The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field.", +"description": "The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. *Warning*: Starting **April 1, 2025**, this field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).", "items": { "$ref": "TrackingFloodlightActivityConfig" }, @@ -10996,7 +10996,7 @@ false "id": "Creative", "properties": { "additionalDimensions": { -"description": "Additional dimensions. Applicable when creative_type is one of: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_LIGHTBOX` * `CREATIVE_TYPE_PUBLISHER_HOSTED` If this field is specified, width_pixels and height_pixels are both required and must be greater than or equal to 0.", +"description": "Optional. Additional dimensions. Applicable when creative_type is one of: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_LIGHTBOX` * `CREATIVE_TYPE_PUBLISHER_HOSTED` If this field is specified, width_pixels and height_pixels are both required and must be greater than or equal to 0.", "items": { "$ref": "Dimensions" }, @@ -11009,7 +11009,7 @@ false "type": "string" }, "appendedTag": { -"description": "Third-party HTML tracking tag to be appended to the creative tag.", +"description": "Optional. Third-party HTML tracking tag to be appended to the creative tag.", "type": "string" }, "assets": { @@ -11027,10 +11027,10 @@ false }, "cmTrackingAd": { "$ref": "CmTrackingAd", -"description": "The Campaign Manager 360 tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager 360 and third-party ad serving: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` Output only for other cases." +"description": "Optional. The Campaign Manager 360 tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager 360 and third-party ad serving: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` Output only for other cases." }, "companionCreativeIds": { -"description": "The IDs of companion creatives for a video creative. You can assign existing display creatives (with image or HTML5 assets) to serve surrounding the publisher's video player. Companions display around the video player while the video is playing and remain after the video has completed. Creatives contain additional dimensions can not be companion creatives. This field is only supported for following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO`", +"description": "Optional. The IDs of companion creatives for a video creative. You can assign existing display creatives (with image or HTML5 assets) to serve surrounding the publisher's video player. Companions display around the video player while the video is playing and remain after the video has completed. Creatives contain additional dimensions can not be companion creatives. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO`", "items": { "format": "int64", "type": "string" @@ -11038,7 +11038,7 @@ false "type": "array" }, "counterEvents": { -"description": "Counter events for a rich media creative. Counters track the number of times that a user interacts with any part of a rich media creative in a specified way (mouse-overs, mouse-outs, clicks, taps, data loading, keyboard entries, etc.). Any event that can be captured in the creative can be recorded as a counter. Leave it empty or unset for creatives containing image assets only.", +"description": "Optional. Counter events for a rich media creative. Counters track the number of times that a user interacts with any part of a rich media creative in a specified way (mouse-overs, mouse-outs, clicks, taps, data loading, keyboard entries, etc.). Any event that can be captured in the creative can be recorded as a counter. Leave it empty or unset for creatives containing image assets only.", "items": { "$ref": "CounterEvent" }, @@ -11112,7 +11112,7 @@ false "Publisher hosted creative. Create and update methods are **not** supported for this creative type.", "Native video creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`", "Templated app install mobile video creative. Create and update methods are **not** supported for this creative type.", -"Asset based creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`." +"Asset-based creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`." ], "type": "string" }, @@ -11218,15 +11218,15 @@ false "type": "boolean" }, "iasCampaignMonitoring": { -"description": "Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. To enable this for the creative, make sure the Advertiser.creative_config.ias_client_id has been set to your IAS client ID.", +"description": "Optional. Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. To enable this for the creative, make sure the Advertiser.creative_config.ias_client_id has been set to your IAS client ID.", "type": "boolean" }, "integrationCode": { -"description": "ID information used to link this creative to an external system. Must be UTF-8 encoded with a length of no more than 10,000 characters.", +"description": "Optional. ID information used to link this creative to an external system. Must be UTF-8 encoded with a length of no more than 10,000 characters.", "type": "string" }, "jsTrackerUrl": { -"description": "JavaScript measurement URL from supported third-party verification providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not supported. This field is only writeable in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", +"description": "Optional. JavaScript measurement URL from supported third-party verification providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not supported. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", "type": "string" }, "lineItemIds": { @@ -11255,12 +11255,12 @@ false "type": "string" }, "notes": { -"description": "User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters.", +"description": "Optional. User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters.", "type": "string" }, "obaIcon": { "$ref": "ObaIcon", -"description": "Specifies the OBA icon for a video creative. This field is only supported in following creative_type: * `CREATIVE_TYPE_VIDEO`" +"description": "Optional. Specifies the OBA icon for a video creative. This field is only supported in the following creative_type: * `CREATIVE_TYPE_VIDEO`" }, "oggAudio": { "description": "Output only. Indicates the third-party audio creative supports OGG. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO`", @@ -11269,7 +11269,7 @@ false }, "progressOffset": { "$ref": "AudioVideoOffset", -"description": "Amount of time to play the video before counting a view. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`" +"description": "Optional. Amount of time to play the video before counting a view. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`" }, "requireHtml5": { "description": "Optional. Indicates that the creative relies on HTML5 to render properly. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE`", @@ -11290,10 +11290,10 @@ false }, "skipOffset": { "$ref": "AudioVideoOffset", -"description": "Amount of time to play the video before the skip button appears. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`" +"description": "Optional. Amount of time to play the video before the skip button appears. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`" }, "skippable": { -"description": "Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`", +"description": "Optional. Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`", "type": "boolean" }, "thirdPartyTag": { @@ -11301,28 +11301,28 @@ false "type": "string" }, "thirdPartyUrls": { -"description": "Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO`", +"description": "Optional. Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO`", "items": { "$ref": "ThirdPartyUrl" }, "type": "array" }, "timerEvents": { -"description": "Timer custom events for a rich media creative. Timers track the time during which a user views and interacts with a specified part of a rich media creative. A creative can have multiple timer events, each timed independently. Leave it empty or unset for creatives containing image assets only.", +"description": "Optional. Timer custom events for a rich media creative. Timers track the time during which a user views and interacts with a specified part of a rich media creative. A creative can have multiple timer events, each timed independently. Leave it empty or unset for creatives containing image assets only.", "items": { "$ref": "TimerEvent" }, "type": "array" }, "trackerUrls": { -"description": "Tracking URLs for analytics providers or third-party ad technology vendors. The URLs must start with https (except on inventory that doesn't require SSL compliance). If using macros in your URL, use only macros supported by Display & Video 360. Standard URLs only, no IMG or SCRIPT tags. This field is only writeable in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", +"description": "Optional. Tracking URLs for analytics providers or third-party ad technology vendors. The URLs must start with `https:` (except on inventory that doesn't require SSL compliance). If using macros in your URL, use only macros supported by Display & Video 360. Standard URLs only, no IMG or SCRIPT tags. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", "items": { "type": "string" }, "type": "array" }, "transcodes": { -"description": "Output only. Audio/Video transcodes. Display & Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher's system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer\u2019s connection and screen size. This field is only supported in following creative_type: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_AUDIO`", +"description": "Output only. Audio/Video transcodes. Display & Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher's system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer\u2019s connection and screen size. This field is only supported in the following creative_type: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_AUDIO`", "items": { "$ref": "Transcode" }, @@ -11391,7 +11391,7 @@ false "Publisher hosted creative. Create and update methods are **not** supported for this creative type.", "Native video creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`", "Templated app install mobile video creative. Create and update methods are **not** supported for this creative type.", -"Asset based creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`." +"Asset-based creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`." ], "type": "string" }, @@ -11667,7 +11667,7 @@ false "id": "CustomListGroup", "properties": { "settings": { -"description": "Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored.", +"description": "Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored.", "items": { "$ref": "CustomListTargetingSetting" }, @@ -13392,11 +13392,11 @@ false "id": "ExitEvent", "properties": { "name": { -"description": "The name of the click tag of the exit event. The name must be unique within one creative. Leave it empty or unset for creatives containing image assets only.", +"description": "Optional. The name of the click tag of the exit event. The name must be unique within one creative. Leave it empty or unset for creatives containing image assets only.", "type": "string" }, "reportingName": { -"description": "The name used to identify this event in reports. Leave it empty or unset for creatives containing image assets only.", +"description": "Optional. The name used to identify this event in reports. Leave it empty or unset for creatives containing image assets only.", "type": "string" }, "type": { @@ -13564,7 +13564,7 @@ false "type": "integer" }, "timeUnit": { -"description": "The time unit in which the frequency cap will be applied. Required when unlimited is `false`.", +"description": "The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).", "enum": [ "TIME_UNIT_UNSPECIFIED", "TIME_UNIT_LIFETIME", @@ -13586,7 +13586,7 @@ false "type": "string" }, "timeUnitCount": { -"description": "The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59", +"description": "The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).", "format": "int32", "type": "integer" }, @@ -13989,7 +13989,7 @@ false "id": "GoogleAudienceGroup", "properties": { "settings": { -"description": "Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored.", +"description": "Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.", "items": { "$ref": "GoogleAudienceTargetingSetting" }, @@ -14486,7 +14486,7 @@ false }, "bidStrategy": { "$ref": "BiddingStrategy", -"description": "The bidding strategy of the insertion order. By default, fixed_bid is set." +"description": "Optional. The bidding strategy of the insertion order. By default, fixed_bid is set." }, "billableOutcome": { "description": "Immutable. The billable outcome of the insertion order. Outcome based buying is deprecated. `BILLABLE_OUTCOME_PAY_PER_IMPRESSION` is the only valid value.", @@ -14545,7 +14545,7 @@ true }, "frequencyCap": { "$ref": "FrequencyCap", -"description": "Required. The frequency capping setting of the insertion order." +"description": "Required. The frequency capping setting of the insertion order. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap)" }, "insertionOrderId": { "description": "Output only. The unique ID of the insertion order. Assigned by the system.", @@ -14554,7 +14554,7 @@ true "type": "string" }, "insertionOrderType": { -"description": "The type of insertion order. If this field is unspecified in creation, the value defaults to `RTB`.", +"description": "Optional. The type of insertion order. If this field is unspecified in creation, the value defaults to `RTB`.", "enum": [ "INSERTION_ORDER_TYPE_UNSPECIFIED", "RTB", @@ -14569,7 +14569,7 @@ true }, "integrationDetails": { "$ref": "IntegrationDetails", -"description": "Additional integration details of the insertion order." +"description": "Optional. Additional integration details of the insertion order." }, "name": { "description": "Output only. The resource name of the insertion order.", @@ -14581,7 +14581,7 @@ true "description": "Required. The budget spending speed setting of the insertion order. pacing_type `PACING_TYPE_ASAP` is not compatible with pacing_period `PACING_PERIOD_FLIGHT`." }, "partnerCosts": { -"description": "The partner costs associated with the insertion order. If absent or empty in CreateInsertionOrder method, the newly created insertion order will inherit partner costs from the partner settings.", +"description": "Optional. The partner costs associated with the insertion order. If absent or empty in CreateInsertionOrder method, the newly created insertion order will inherit partner costs from the partner settings.", "items": { "$ref": "PartnerCost" }, @@ -14626,7 +14626,7 @@ true "id": "InsertionOrderBudget", "properties": { "automationType": { -"description": "The type of automation used to manage bid and budget for the insertion order. If this field is unspecified in creation, the value defaults to `INSERTION_ORDER_AUTOMATION_TYPE_NONE`.", +"description": "Optional. The type of automation used to manage bid and budget for the insertion order. If this field is unspecified in creation, the value defaults to `INSERTION_ORDER_AUTOMATION_TYPE_NONE`.", "enum": [ "INSERTION_ORDER_AUTOMATION_TYPE_UNSPECIFIED", "INSERTION_ORDER_AUTOMATION_TYPE_BUDGET", @@ -14675,7 +14675,7 @@ true "type": "string" }, "campaignBudgetId": { -"description": "The budget_id of the campaign budget that this insertion order budget segment is a part of.", +"description": "Optional. The budget_id of the campaign budget that this insertion order budget segment is a part of.", "format": "int64", "type": "string" }, @@ -14684,7 +14684,7 @@ true "description": "Required. The start and end date settings of the budget segment. They are resolved relative to the parent advertiser's time zone. * When creating a new budget segment, both `start_date` and `end_date` must be in the future. * An existing budget segment with a `start_date` in the past has a mutable `end_date` but an immutable `start_date`. * `end_date` must be the `start_date` or later, both before the year 2037." }, "description": { -"description": "The budget segment description. It can be used to enter Purchase Order information for each budget segment and have that information printed on the invoices. Must be UTF-8 encoded.", +"description": "Optional. The budget segment description. It can be used to enter Purchase Order information for each budget segment and have that information printed on the invoices. Must be UTF-8 encoded.", "type": "string" } }, @@ -15618,7 +15618,7 @@ true }, "conversionCounting": { "$ref": "ConversionCountingConfig", -"description": "The conversion tracking setting of the line item." +"description": "The conversion tracking setting of the line item. *Warning*: Starting **April 1, 2025**, the floodlight_activity_configs field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight)." }, "creativeIds": { "description": "The IDs of the creatives associated with the line item.", @@ -15662,7 +15662,7 @@ true }, "frequencyCap": { "$ref": "FrequencyCap", -"description": "Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap." +"description": "Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap)" }, "insertionOrderId": { "description": "Required. Immutable. The unique ID of the insertion order that the line item belongs to.", @@ -16660,7 +16660,7 @@ true "id": "MaximizeSpendBidStrategy", "properties": { "customBiddingAlgorithmId": { -"description": "The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`.", +"description": "The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).", "format": "int64", "type": "string" }, @@ -16912,19 +16912,19 @@ true "id": "ObaIcon", "properties": { "clickTrackingUrl": { -"description": "Required. The click tracking URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com", +"description": "Required. The click tracking URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com`", "type": "string" }, "dimensions": { "$ref": "Dimensions", -"description": "The dimensions of the OBA icon." +"description": "Optional. The dimensions of the OBA icon." }, "landingPageUrl": { -"description": "Required. The landing page URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com", +"description": "Required. The landing page URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com`", "type": "string" }, "position": { -"description": "The position of the OBA icon on the creative.", +"description": "Optional. The position of the OBA icon on the creative.", "enum": [ "OBA_ICON_POSITION_UNSPECIFIED", "OBA_ICON_POSITION_UPPER_RIGHT", @@ -16942,19 +16942,19 @@ true "type": "string" }, "program": { -"description": "The program of the OBA icon. For example: \u201cAdChoices\u201d.", +"description": "Optional. The program of the OBA icon. For example: \u201cAdChoices\u201d.", "type": "string" }, "resourceMimeType": { -"description": "The MIME type of the OBA icon resource.", +"description": "Optional. The MIME type of the OBA icon resource.", "type": "string" }, "resourceUrl": { -"description": "The URL of the OBA icon resource.", +"description": "Optional. The URL of the OBA icon resource.", "type": "string" }, "viewTrackingUrl": { -"description": "Required. The view tracking URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com", +"description": "Required. The view tracking URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com`", "type": "string" } }, @@ -17608,7 +17608,7 @@ false "id": "PerformanceGoalBidStrategy", "properties": { "customBiddingAlgorithmId": { -"description": "The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`.", +"description": "The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).", "format": "int64", "type": "string" }, @@ -18892,7 +18892,7 @@ true "id": "ThirdPartyUrl", "properties": { "type": { -"description": "The type of interaction needs to be tracked by the tracking URL", +"description": "Optional. The type of interaction needs to be tracked by the tracking URL", "enum": [ "THIRD_PARTY_URL_TYPE_UNSPECIFIED", "THIRD_PARTY_URL_TYPE_IMPRESSION", @@ -18932,7 +18932,7 @@ true "type": "string" }, "url": { -"description": "Tracking URL used to track the interaction. Provide a URL with optional path or query string, beginning with `https:`. For example, https://www.example.com/path", +"description": "Optional. Tracking URL used to track the interaction. Provide a URL with optional path or query string, beginning with `https:`. For example, `https://www.example.com/path`", "type": "string" } }, @@ -19057,44 +19057,44 @@ true "id": "Transcode", "properties": { "audioBitRateKbps": { -"description": "The bit rate for the audio stream of the transcoded video, or the bit rate for the transcoded audio, in kilobits per second.", +"description": "Optional. The bit rate for the audio stream of the transcoded video, or the bit rate for the transcoded audio, in kilobits per second.", "format": "int64", "type": "string" }, "audioSampleRateHz": { -"description": "The sample rate for the audio stream of the transcoded video, or the sample rate for the transcoded audio, in hertz.", +"description": "Optional. The sample rate for the audio stream of the transcoded video, or the sample rate for the transcoded audio, in hertz.", "format": "int64", "type": "string" }, "bitRateKbps": { -"description": "The transcoding bit rate of the transcoded video, in kilobits per second.", +"description": "Optional. The transcoding bit rate of the transcoded video, in kilobits per second.", "format": "int64", "type": "string" }, "dimensions": { "$ref": "Dimensions", -"description": "The dimensions of the transcoded video." +"description": "Optional. The dimensions of the transcoded video." }, "fileSizeBytes": { -"description": "The size of the transcoded file, in bytes.", +"description": "Optional. The size of the transcoded file, in bytes.", "format": "int64", "type": "string" }, "frameRate": { -"description": "The frame rate of the transcoded video, in frames per second.", +"description": "Optional. The frame rate of the transcoded video, in frames per second.", "format": "float", "type": "number" }, "mimeType": { -"description": "The MIME type of the transcoded file.", +"description": "Optional. The MIME type of the transcoded file.", "type": "string" }, "name": { -"description": "The name of the transcoded file.", +"description": "Optional. The name of the transcoded file.", "type": "string" }, "transcoded": { -"description": "Indicates if the transcoding was successful.", +"description": "Optional. Indicates if the transcoding was successful.", "type": "boolean" } }, @@ -19105,11 +19105,11 @@ true "id": "UniversalAdId", "properties": { "id": { -"description": "The unique creative identifier.", +"description": "Optional. The unique creative identifier.", "type": "string" }, "registry": { -"description": "The registry provides unique creative identifiers.", +"description": "Optional. The registry provides unique creative identifiers.", "enum": [ "UNIVERSAL_AD_REGISTRY_UNSPECIFIED", "UNIVERSAL_AD_REGISTRY_OTHER", @@ -19903,7 +19903,7 @@ true }, "viewFrequencyCap": { "$ref": "FrequencyCap", -"description": "The view frequency cap settings of the line item. The max_views field in this settings object must be used if assigning a limited cap." +"description": "The view frequency cap settings of the line item. The max_views field in this settings object must be used if assigning a limited cap. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap)" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/displayvideo.v3.json b/googleapiclient/discovery_cache/documents/displayvideo.v3.json index 0f3344f31a9..f1393086ac8 100644 --- a/googleapiclient/discovery_cache/documents/displayvideo.v3.json +++ b/googleapiclient/discovery_cache/documents/displayvideo.v3.json @@ -5668,7 +5668,7 @@ ] }, "patch": { -"description": "Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful.", +"description": "Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful. *Warning*: Starting **April 1, 2025**, requests updating custom bidding algorithms that are assigned to line items will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).", "flatPath": "v3/customBiddingAlgorithms/{customBiddingAlgorithmsId}", "httpMethod": "PATCH", "id": "displayvideo.customBiddingAlgorithms.patch", @@ -5783,7 +5783,7 @@ "rules": { "methods": { "create": { -"description": "Creates a new rules resource. Returns the newly created rules resource if successful.", +"description": "Creates a new rules resource. Returns the newly created rules resource if successful. *Warning*: Starting **April 1, 2025**, requests updating custom bidding algorithms that are assigned to line items will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).", "flatPath": "v3/customBiddingAlgorithms/{customBiddingAlgorithmsId}/rules", "httpMethod": "POST", "id": "displayvideo.customBiddingAlgorithms.rules.create", @@ -5929,7 +5929,7 @@ "scripts": { "methods": { "create": { -"description": "Creates a new custom bidding script. Returns the newly created script if successful.", +"description": "Creates a new custom bidding script. Returns the newly created script if successful. *Warning*: Starting **April 1, 2025**, requests updating custom bidding algorithms that are assigned to line items will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).", "flatPath": "v3/customBiddingAlgorithms/{customBiddingAlgorithmsId}/scripts", "httpMethod": "POST", "id": "displayvideo.customBiddingAlgorithms.scripts.create", @@ -6271,7 +6271,7 @@ "type": "string" }, "pageSize": { -"description": "Requested page size. Must be between `1` and `5000`. If unspecified, this value defaults to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", +"description": "Requested page size. Must be between `1` and `5000`. If unspecified, this value defaults to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. *Warning*: Starting **March 6, 2025**, this value will default to `5000` if not set.", "format": "int32", "location": "query", "type": "integer" @@ -9256,7 +9256,7 @@ } } }, -"revision": "20250211", +"revision": "20250220", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActiveViewVideoViewabilityMetricConfig": { @@ -10605,7 +10605,7 @@ "Signal value is greater than the comparison value.", "Signal value is less than the second.", "Signal value is greater than or equal to the second.", -"Signal value is less or equals to the comparison value." +"Signal value is less than or equal to the comparison value." ], "type": "string" }, @@ -10740,10 +10740,10 @@ "properties": { "asset": { "$ref": "Asset", -"description": "The associated asset." +"description": "Optional. The associated asset." }, "role": { -"description": "The role of this asset for the creative.", +"description": "Optional. The role of this asset for the creative.", "enum": [ "ASSET_ROLE_UNSPECIFIED", "ASSET_ROLE_MAIN", @@ -10773,24 +10773,24 @@ "The asset is the main asset of the creative.", "The asset is a backup asset of the creative.", "The asset is a polite load asset of the creative.", -"Headline of a native creative. The content must be UTF-8 encoded with a length of no more than 25 characters. This role is only supported in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", -"Long headline of a native creative. The content must be UTF-8 encoded with a length of no more than 50 characters. This role is only supported in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", -"Body text of a native creative. The content must be UTF-8 encoded with a length of no more than 90 characters. This role is only supported in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", -"Long body text of a native creative. The content must be UTF-8 encoded with a length of no more than 150 characters. This role is only supported in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", -"A short, friendly version of the landing page URL to show in the creative. This URL gives people an idea of where they'll arrive after they click on the creative. The content must be UTF-8 encoded with a length of no more than 30 characters. For example, if the landing page URL is 'http://www.example.com/page', the caption URL can be 'example.com'. The protocol (http://) is optional, but the URL can't contain spaces or special characters. This role is only supported in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", -"The text to use on the call-to-action button of a native creative. The content must be UTF-8 encoded with a length of no more than 15 characters. This role is only supported in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", -"The text that identifies the advertiser or brand name. The content must be UTF-8 encoded with a length of no more than 25 characters. This role is only supported in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", +"Headline of a native creative. The content must be UTF-8 encoded with a length of no more than 25 characters. This role is only supported in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", +"Long headline of a native creative. The content must be UTF-8 encoded with a length of no more than 50 characters. This role is only supported in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", +"Body text of a native creative. The content must be UTF-8 encoded with a length of no more than 90 characters. This role is only supported in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", +"Long body text of a native creative. The content must be UTF-8 encoded with a length of no more than 150 characters. This role is only supported in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", +"A short, friendly version of the landing page URL to show in the creative. This URL gives people an idea of where they'll arrive after they click on the creative. The content must be UTF-8 encoded with a length of no more than 30 characters. For example, if the landing page URL is 'http://www.example.com/page', the caption URL can be 'example.com'. The protocol (http://) is optional, but the URL can't contain spaces or special characters. This role is only supported in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", +"The text to use on the call-to-action button of a native creative. The content must be UTF-8 encoded with a length of no more than 15 characters. This role is only supported in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", +"The text that identifies the advertiser or brand name. The content must be UTF-8 encoded with a length of no more than 25 characters. This role is only supported in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", "The purchase price of your app in the Google play store or iOS app store (for example, $5.99). Note that this value is not automatically synced with the actual value listed in the store. It will always be the one provided when save the creative. The content must be UTF-8 encoded with a length of no more than 15 characters. Assets of this role are read-only.", -"The ID of an Android app in the Google play store. You can find this ID in the App\u2019s Google Play Store URL after \u2018id\u2019. For example, in https://play.google.com/store/apps/details?id=com.company.appname the identifier is com.company.appname. Assets of this role are read-only.", -"The ID of an iOS app in the Apple app store. This ID number can be found in the Apple App Store URL as the string of numbers directly after \"id\". For example, in https://apps.apple.com/us/app/gmail-email-by-google/id422689480 the ID is 422689480. Assets of this role are read-only.", +"The ID of an Android app in the Google play store. You can find this ID in the App\u2019s Google Play Store URL after \u2018id\u2019. For example, in `https://play.google.com/store/apps/details?id=com.company.appname` the identifier is com.company.appname. Assets of this role are read-only.", +"The ID of an iOS app in the Apple app store. This ID number can be found in the Apple App Store URL as the string of numbers directly after \"id\". For example, in `https://apps.apple.com/us/app/gmail-email-by-google/id422689480` the ID is 422689480. Assets of this role are read-only.", "The rating of an app in the Google play store or iOS app store. Note that this value is not automatically synced with the actual rating in the store. It will always be the one provided when save the creative. Assets of this role are read-only.", -"The icon of a creative. This role is only supported and required in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`", -"The cover image of a native video creative. This role is only supported and required in following creative_type: * `CREATIVE_TYPE_VIDEO`", -"The main color to use in a creative. This role is only supported and required in following creative_type: * `CREATIVE_TYPE_ASSET_BASED_CREATIVE`", -"The accent color to use in a creative. This role is only supported and required in following creative_type: * `CREATIVE_TYPE_ASSET_BASED_CREATIVE`", -"Whether the creative must use a logo asset. This role is only supported and required in following creative_type: * `CREATIVE_TYPE_ASSET_BASED_CREATIVE`", -"Whether the creative must use an image asset. This role is only supported and required in following creative_type: * `CREATIVE_TYPE_ASSET_BASED_CREATIVE`", -"Whether asset enhancements can be applied to the creative. This role is only supported and required in following creative_type: * `CREATIVE_TYPE_ASSET_BASED_CREATIVE`" +"The icon of a creative. This role is only supported and required in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`", +"The cover image of a native video creative. This role is only supported and required in the following creative_type: * `CREATIVE_TYPE_VIDEO`", +"The main color to use in a creative. This role is only supported and required in the following creative_type: * `CREATIVE_TYPE_ASSET_BASED_CREATIVE`", +"The accent color to use in a creative. This role is only supported and required in the following creative_type: * `CREATIVE_TYPE_ASSET_BASED_CREATIVE`", +"Whether the creative must use a logo asset. This role is only supported and required in the following creative_type: * `CREATIVE_TYPE_ASSET_BASED_CREATIVE`", +"Whether the creative must use an image asset. This role is only supported and required in the following creative_type: * `CREATIVE_TYPE_ASSET_BASED_CREATIVE`", +"Whether asset enhancements can be applied to the creative. This role is only supported and required in the following creative_type: * `CREATIVE_TYPE_ASSET_BASED_CREATIVE`" ], "type": "string" } @@ -11234,27 +11234,27 @@ "type": "object" }, "AudienceGroupAssignedTargetingOptionDetails": { -"description": "Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. NEXT_ID: 9", +"description": "Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups.", "id": "AudienceGroupAssignedTargetingOptionDetails", "properties": { "excludedFirstAndThirdPartyAudienceGroup": { "$ref": "FirstAndThirdPartyAudienceGroup", -"description": "The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically \u2018OR\u2019 of each other." +"description": "Optional. The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically \u2018OR\u2019 of each other." }, "excludedGoogleAudienceGroup": { "$ref": "GoogleAudienceGroup", -"description": "The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically \u2018OR\u2019 of each other." +"description": "Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically \u2018OR\u2019 of each other." }, "includedCombinedAudienceGroup": { "$ref": "CombinedAudienceGroup", -"description": "The combined audience ids of the included combined audience group. Contains combined audience ids only." +"description": "Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only." }, "includedCustomListGroup": { "$ref": "CustomListGroup", -"description": "The custom list ids of the included custom list group. Contains custom list ids only." +"description": "Optional. The custom list ids of the included custom list group. Contains custom list ids only." }, "includedFirstAndThirdPartyAudienceGroups": { -"description": "The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with same settings will be ignored.", +"description": "Optional. The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored.", "items": { "$ref": "FirstAndThirdPartyAudienceGroup" }, @@ -11262,7 +11262,7 @@ }, "includedGoogleAudienceGroup": { "$ref": "GoogleAudienceGroup", -"description": "The Google audience ids of the included Google audience group. Contains Google audience ids only." +"description": "Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only." } }, "type": "object" @@ -11346,12 +11346,12 @@ "id": "AudioVideoOffset", "properties": { "percentage": { -"description": "The offset in percentage of the audio or video duration.", +"description": "Optional. The offset in percentage of the audio or video duration.", "format": "int64", "type": "string" }, "seconds": { -"description": "The offset in seconds from the start of the audio or video.", +"description": "Optional. The offset in seconds from the start of the audio or video.", "format": "int64", "type": "string" } @@ -12228,7 +12228,7 @@ }, "frequencyCap": { "$ref": "FrequencyCap", -"description": "Required. The frequency cap setting of the campaign." +"description": "Required. The frequency cap setting of the campaign. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap)" }, "name": { "description": "Output only. The resource name of the campaign.", @@ -12544,17 +12544,17 @@ "id": "CmTrackingAd", "properties": { "cmAdId": { -"description": "The ad ID of the campaign manager 360 tracking Ad.", +"description": "Optional. The ad ID of the campaign manager 360 tracking Ad.", "format": "int64", "type": "string" }, "cmCreativeId": { -"description": "The creative ID of the campaign manager 360 tracking Ad.", +"description": "Optional. The creative ID of the campaign manager 360 tracking Ad.", "format": "int64", "type": "string" }, "cmPlacementId": { -"description": "The placement ID of the campaign manager 360 tracking Ad.", +"description": "Optional. The placement ID of the campaign manager 360 tracking Ad.", "format": "int64", "type": "string" } @@ -12589,7 +12589,7 @@ "id": "CombinedAudienceGroup", "properties": { "settings": { -"description": "Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise.", +"description": "Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise.", "items": { "$ref": "CombinedAudienceTargetingSetting" }, @@ -13031,7 +13031,7 @@ "id": "ConversionCountingConfig", "properties": { "floodlightActivityConfigs": { -"description": "The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field.", +"description": "The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. *Warning*: Starting **April 1, 2025**, this field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).", "items": { "$ref": "TrackingFloodlightActivityConfig" }, @@ -13291,7 +13291,7 @@ false "id": "Creative", "properties": { "additionalDimensions": { -"description": "Additional dimensions. Applicable when creative_type is one of: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_LIGHTBOX` * `CREATIVE_TYPE_PUBLISHER_HOSTED` If this field is specified, width_pixels and height_pixels are both required and must be greater than or equal to 0.", +"description": "Optional. Additional dimensions. Applicable when creative_type is one of: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_LIGHTBOX` * `CREATIVE_TYPE_PUBLISHER_HOSTED` If this field is specified, width_pixels and height_pixels are both required and must be greater than or equal to 0.", "items": { "$ref": "Dimensions" }, @@ -13304,7 +13304,7 @@ false "type": "string" }, "appendedTag": { -"description": "Third-party HTML tracking tag to be appended to the creative tag.", +"description": "Optional. Third-party HTML tracking tag to be appended to the creative tag.", "type": "string" }, "assets": { @@ -13322,10 +13322,10 @@ false }, "cmTrackingAd": { "$ref": "CmTrackingAd", -"description": "The Campaign Manager 360 tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager 360 and third-party ad serving: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` Output only for other cases." +"description": "Optional. The Campaign Manager 360 tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager 360 and third-party ad serving: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` Output only for other cases." }, "companionCreativeIds": { -"description": "The IDs of companion creatives for a video creative. You can assign existing display creatives (with image or HTML5 assets) to serve surrounding the publisher's video player. Companions display around the video player while the video is playing and remain after the video has completed. Creatives contain additional dimensions can not be companion creatives. This field is only supported for following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO`", +"description": "Optional. The IDs of companion creatives for a video creative. You can assign existing display creatives (with image or HTML5 assets) to serve surrounding the publisher's video player. Companions display around the video player while the video is playing and remain after the video has completed. Creatives contain additional dimensions can not be companion creatives. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO`", "items": { "format": "int64", "type": "string" @@ -13333,7 +13333,7 @@ false "type": "array" }, "counterEvents": { -"description": "Counter events for a rich media creative. Counters track the number of times that a user interacts with any part of a rich media creative in a specified way (mouse-overs, mouse-outs, clicks, taps, data loading, keyboard entries, etc.). Any event that can be captured in the creative can be recorded as a counter. Leave it empty or unset for creatives containing image assets only.", +"description": "Optional. Counter events for a rich media creative. Counters track the number of times that a user interacts with any part of a rich media creative in a specified way (mouse-overs, mouse-outs, clicks, taps, data loading, keyboard entries, etc.). Any event that can be captured in the creative can be recorded as a counter. Leave it empty or unset for creatives containing image assets only.", "items": { "$ref": "CounterEvent" }, @@ -13407,7 +13407,7 @@ false "Publisher hosted creative. Create and update methods are **not** supported for this creative type.", "Native video creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`", "Templated app install mobile video creative. Create and update methods are **not** supported for this creative type.", -"Asset based creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`." +"Asset-based creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`." ], "type": "string" }, @@ -13513,15 +13513,15 @@ false "type": "boolean" }, "iasCampaignMonitoring": { -"description": "Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. To enable this for the creative, make sure the Advertiser.creative_config.ias_client_id has been set to your IAS client ID.", +"description": "Optional. Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. To enable this for the creative, make sure the Advertiser.creative_config.ias_client_id has been set to your IAS client ID.", "type": "boolean" }, "integrationCode": { -"description": "ID information used to link this creative to an external system. Must be UTF-8 encoded with a length of no more than 10,000 characters.", +"description": "Optional. ID information used to link this creative to an external system. Must be UTF-8 encoded with a length of no more than 10,000 characters.", "type": "string" }, "jsTrackerUrl": { -"description": "JavaScript measurement URL from supported third-party verification providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not supported. This field is only writeable in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", +"description": "Optional. JavaScript measurement URL from supported third-party verification providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not supported. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", "type": "string" }, "lineItemIds": { @@ -13550,12 +13550,12 @@ false "type": "string" }, "notes": { -"description": "User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters.", +"description": "Optional. User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters.", "type": "string" }, "obaIcon": { "$ref": "ObaIcon", -"description": "Specifies the OBA icon for a video creative. This field is only supported in following creative_type: * `CREATIVE_TYPE_VIDEO`" +"description": "Optional. Specifies the OBA icon for a video creative. This field is only supported in the following creative_type: * `CREATIVE_TYPE_VIDEO`" }, "oggAudio": { "description": "Output only. Indicates the third-party audio creative supports OGG. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO`", @@ -13564,7 +13564,7 @@ false }, "progressOffset": { "$ref": "AudioVideoOffset", -"description": "Amount of time to play the video before counting a view. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`" +"description": "Optional. Amount of time to play the video before counting a view. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`" }, "requireHtml5": { "description": "Optional. Indicates that the creative relies on HTML5 to render properly. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE`", @@ -13585,10 +13585,10 @@ false }, "skipOffset": { "$ref": "AudioVideoOffset", -"description": "Amount of time to play the video before the skip button appears. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`" +"description": "Optional. Amount of time to play the video before the skip button appears. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`" }, "skippable": { -"description": "Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`", +"description": "Optional. Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`", "type": "boolean" }, "thirdPartyTag": { @@ -13596,28 +13596,28 @@ false "type": "string" }, "thirdPartyUrls": { -"description": "Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO`", +"description": "Optional. Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO`", "items": { "$ref": "ThirdPartyUrl" }, "type": "array" }, "timerEvents": { -"description": "Timer custom events for a rich media creative. Timers track the time during which a user views and interacts with a specified part of a rich media creative. A creative can have multiple timer events, each timed independently. Leave it empty or unset for creatives containing image assets only.", +"description": "Optional. Timer custom events for a rich media creative. Timers track the time during which a user views and interacts with a specified part of a rich media creative. A creative can have multiple timer events, each timed independently. Leave it empty or unset for creatives containing image assets only.", "items": { "$ref": "TimerEvent" }, "type": "array" }, "trackerUrls": { -"description": "Tracking URLs for analytics providers or third-party ad technology vendors. The URLs must start with https (except on inventory that doesn't require SSL compliance). If using macros in your URL, use only macros supported by Display & Video 360. Standard URLs only, no IMG or SCRIPT tags. This field is only writeable in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", +"description": "Optional. Tracking URLs for analytics providers or third-party ad technology vendors. The URLs must start with `https:` (except on inventory that doesn't require SSL compliance). If using macros in your URL, use only macros supported by Display & Video 360. Standard URLs only, no IMG or SCRIPT tags. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", "items": { "type": "string" }, "type": "array" }, "transcodes": { -"description": "Output only. Audio/Video transcodes. Display & Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher's system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer\u2019s connection and screen size. This field is only supported in following creative_type: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_AUDIO`", +"description": "Output only. Audio/Video transcodes. Display & Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher's system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer\u2019s connection and screen size. This field is only supported in the following creative_type: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_AUDIO`", "items": { "$ref": "Transcode" }, @@ -13686,7 +13686,7 @@ false "Publisher hosted creative. Create and update methods are **not** supported for this creative type.", "Native video creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`", "Templated app install mobile video creative. Create and update methods are **not** supported for this creative type.", -"Asset based creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`." +"Asset-based creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`." ], "type": "string" }, @@ -14070,7 +14070,7 @@ false "id": "CustomListGroup", "properties": { "settings": { -"description": "Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored.", +"description": "Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored.", "items": { "$ref": "CustomListTargetingSetting" }, @@ -15879,11 +15879,11 @@ false "id": "ExitEvent", "properties": { "name": { -"description": "The name of the click tag of the exit event. The name must be unique within one creative. Leave it empty or unset for creatives containing image assets only.", +"description": "Optional. The name of the click tag of the exit event. The name must be unique within one creative. Leave it empty or unset for creatives containing image assets only.", "type": "string" }, "reportingName": { -"description": "The name used to identify this event in reports. Leave it empty or unset for creatives containing image assets only.", +"description": "Optional. The name used to identify this event in reports. Leave it empty or unset for creatives containing image assets only.", "type": "string" }, "type": { @@ -16044,7 +16044,7 @@ false "type": "string" }, "membershipDurationDays": { -"description": "The duration in days that an entry remains in the audience after the qualifying event. If the audience has no expiration, set the value of this field to 10000. Otherwise, the set value must be greater than 0 and less than or equal to 540. Only applicable to first party audiences. This field is required if one of the following audience_type is used: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`", +"description": "The duration in days that an entry remains in the audience after the qualifying event. If the audience has no expiration, set the value of this field to 10000. Otherwise, the set value must be greater than 0 and less than or equal to 540. Only applicable to first party audiences. This field is required if one of the following audience_type is used: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID` *Warning*: Starting on **April 7, 2025**, audiences will no longer be able to have infinite membership duration. This field will no longer accept the value 10000 and all audiences with membership durations greater than 540 days will be updated to a membership duration of 540 days. [Read more about this announced change](/display-video/api/deprecations#features.audience_duration).", "format": "int64", "type": "string" }, @@ -16071,7 +16071,7 @@ false "id": "FirstAndThirdPartyAudienceGroup", "properties": { "settings": { -"description": "Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed.", +"description": "Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed.", "items": { "$ref": "FirstAndThirdPartyAudienceTargetingSetting" }, @@ -16090,7 +16090,7 @@ false "type": "string" }, "recency": { -"description": "The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.", +"description": "Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.", "enum": [ "RECENCY_NO_LIMIT", "RECENCY_1_MINUTE", @@ -16304,7 +16304,7 @@ false "type": "integer" }, "timeUnit": { -"description": "The time unit in which the frequency cap will be applied. Required when unlimited is `false`.", +"description": "The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).", "enum": [ "TIME_UNIT_UNSPECIFIED", "TIME_UNIT_LIFETIME", @@ -16326,7 +16326,7 @@ false "type": "string" }, "timeUnitCount": { -"description": "The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59", +"description": "The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).", "format": "int32", "type": "integer" }, @@ -16729,7 +16729,7 @@ false "id": "GoogleAudienceGroup", "properties": { "settings": { -"description": "Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored.", +"description": "Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.", "items": { "$ref": "GoogleAudienceTargetingSetting" }, @@ -17242,7 +17242,7 @@ false }, "bidStrategy": { "$ref": "BiddingStrategy", -"description": "The bidding strategy of the insertion order. By default, fixed_bid is set." +"description": "Optional. The bidding strategy of the insertion order. By default, fixed_bid is set." }, "budget": { "$ref": "InsertionOrderBudget", @@ -17279,7 +17279,7 @@ false }, "frequencyCap": { "$ref": "FrequencyCap", -"description": "Required. The frequency capping setting of the insertion order." +"description": "Required. The frequency capping setting of the insertion order. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap)" }, "insertionOrderId": { "description": "Output only. The unique ID of the insertion order. Assigned by the system.", @@ -17288,7 +17288,7 @@ false "type": "string" }, "insertionOrderType": { -"description": "The type of insertion order. If this field is unspecified in creation, the value defaults to `RTB`.", +"description": "Optional. The type of insertion order. If this field is unspecified in creation, the value defaults to `RTB`.", "enum": [ "INSERTION_ORDER_TYPE_UNSPECIFIED", "RTB", @@ -17303,7 +17303,7 @@ false }, "integrationDetails": { "$ref": "IntegrationDetails", -"description": "Additional integration details of the insertion order." +"description": "Optional. Additional integration details of the insertion order." }, "kpi": { "$ref": "Kpi", @@ -17315,7 +17315,7 @@ false "type": "string" }, "optimizationObjective": { -"description": "Optional. The optimization objective of the insertion order.", +"description": "Optional. Required. The optimization objective of the insertion order.", "enum": [ "OPTIMIZATION_OBJECTIVE_UNSPECIFIED", "CONVERSION", @@ -17339,7 +17339,7 @@ false "description": "Required. The budget spending speed setting of the insertion order. pacing_type `PACING_TYPE_ASAP` is not compatible with pacing_period `PACING_PERIOD_FLIGHT`." }, "partnerCosts": { -"description": "The partner costs associated with the insertion order. If absent or empty in CreateInsertionOrder method, the newly created insertion order will inherit partner costs from the partner settings.", +"description": "Optional. The partner costs associated with the insertion order. If absent or empty in CreateInsertionOrder method, the newly created insertion order will inherit partner costs from the partner settings.", "items": { "$ref": "PartnerCost" }, @@ -17380,7 +17380,7 @@ false "id": "InsertionOrderBudget", "properties": { "automationType": { -"description": "The type of automation used to manage bid and budget for the insertion order. If this field is unspecified in creation, the value defaults to `INSERTION_ORDER_AUTOMATION_TYPE_NONE`.", +"description": "Optional. The type of automation used to manage bid and budget for the insertion order. If this field is unspecified in creation, the value defaults to `INSERTION_ORDER_AUTOMATION_TYPE_NONE`.", "enum": [ "INSERTION_ORDER_AUTOMATION_TYPE_UNSPECIFIED", "INSERTION_ORDER_AUTOMATION_TYPE_BUDGET", @@ -17429,7 +17429,7 @@ false "type": "string" }, "campaignBudgetId": { -"description": "The budget_id of the campaign budget that this insertion order budget segment is a part of.", +"description": "Optional. The budget_id of the campaign budget that this insertion order budget segment is a part of.", "format": "int64", "type": "string" }, @@ -17438,7 +17438,7 @@ false "description": "Required. The start and end date settings of the budget segment. They are resolved relative to the parent advertiser's time zone. * When creating a new budget segment, both `start_date` and `end_date` must be in the future. * An existing budget segment with a `start_date` in the past has a mutable `end_date` but an immutable `start_date`. * `end_date` must be the `start_date` or later, both before the year 2037." }, "description": { -"description": "The budget segment description. It can be used to enter Purchase Order information for each budget segment and have that information printed on the invoices. Must be UTF-8 encoded.", +"description": "Optional. The budget segment description. It can be used to enter Purchase Order information for each budget segment and have that information printed on the invoices. Must be UTF-8 encoded.", "type": "string" } }, @@ -18456,7 +18456,7 @@ false }, "conversionCounting": { "$ref": "ConversionCountingConfig", -"description": "The conversion tracking setting of the line item." +"description": "The conversion tracking setting of the line item. *Warning*: Starting **April 1, 2025**, the floodlight_activity_configs field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight)." }, "creativeIds": { "description": "The IDs of the creatives associated with the line item.", @@ -18500,7 +18500,7 @@ false }, "frequencyCap": { "$ref": "FrequencyCap", -"description": "Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap." +"description": "Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap)" }, "insertionOrderId": { "description": "Required. Immutable. The unique ID of the insertion order that the line item belongs to.", @@ -19495,7 +19495,7 @@ false "id": "MaximizeSpendBidStrategy", "properties": { "customBiddingAlgorithmId": { -"description": "The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`.", +"description": "The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).", "format": "int64", "type": "string" }, @@ -19765,19 +19765,19 @@ false "id": "ObaIcon", "properties": { "clickTrackingUrl": { -"description": "Required. The click tracking URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com", +"description": "Required. The click tracking URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com`", "type": "string" }, "dimensions": { "$ref": "Dimensions", -"description": "The dimensions of the OBA icon." +"description": "Optional. The dimensions of the OBA icon." }, "landingPageUrl": { -"description": "Required. The landing page URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com", +"description": "Required. The landing page URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com`", "type": "string" }, "position": { -"description": "The position of the OBA icon on the creative.", +"description": "Optional. The position of the OBA icon on the creative.", "enum": [ "OBA_ICON_POSITION_UNSPECIFIED", "OBA_ICON_POSITION_UPPER_RIGHT", @@ -19795,19 +19795,19 @@ false "type": "string" }, "program": { -"description": "The program of the OBA icon. For example: \u201cAdChoices\u201d.", +"description": "Optional. The program of the OBA icon. For example: \u201cAdChoices\u201d.", "type": "string" }, "resourceMimeType": { -"description": "The MIME type of the OBA icon resource.", +"description": "Optional. The MIME type of the OBA icon resource.", "type": "string" }, "resourceUrl": { -"description": "The URL of the OBA icon resource.", +"description": "Optional. The URL of the OBA icon resource.", "type": "string" }, "viewTrackingUrl": { -"description": "Required. The view tracking URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com", +"description": "Required. The view tracking URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com`", "type": "string" } }, @@ -20481,7 +20481,7 @@ false "id": "PerformanceGoalBidStrategy", "properties": { "customBiddingAlgorithmId": { -"description": "The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`.", +"description": "The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).", "format": "int64", "type": "string" }, @@ -21164,89 +21164,6 @@ false }, "type": "object" }, -"SdfUploadTask": { -"description": "Type for the response returned by [SdfUploadTaskService.CreateSdfUploadTask].", -"id": "SdfUploadTask", -"properties": { -"resourceName": { -"description": "A resource name to be used in media.download to Download the script files. Or media.upload to Upload the script files. Resource names have the format `download/sdfuploadtasks/media/{media_id}`.", -"type": "string" -} -}, -"type": "object" -}, -"SdfUploadTaskMetadata": { -"description": "Type for the metadata returned by [SdfUploadTaskService.CreateSdfUploadTask].", -"id": "SdfUploadTaskMetadata", -"properties": { -"createTime": { -"description": "The time when the operation was created.", -"format": "google-datetime", -"type": "string" -}, -"endTime": { -"description": "The time when execution was completed.", -"format": "google-datetime", -"type": "string" -}, -"version": { -"description": "The SDF version used to execute this upload task.", -"enum": [ -"SDF_VERSION_UNSPECIFIED", -"SDF_VERSION_3_1", -"SDF_VERSION_4", -"SDF_VERSION_4_1", -"SDF_VERSION_4_2", -"SDF_VERSION_5", -"SDF_VERSION_5_1", -"SDF_VERSION_5_2", -"SDF_VERSION_5_3", -"SDF_VERSION_5_4", -"SDF_VERSION_5_5", -"SDF_VERSION_6", -"SDF_VERSION_7", -"SDF_VERSION_7_1", -"SDF_VERSION_8" -], -"enumDeprecated": [ -false, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -false, -false, -false, -false -], -"enumDescriptions": [ -"SDF version value is not specified or is unknown in this version.", -"SDF version 3.1", -"SDF version 4", -"SDF version 4.1", -"SDF version 4.2", -"SDF version 5.", -"SDF version 5.1", -"SDF version 5.2", -"SDF version 5.3", -"SDF version 5.4", -"SDF version 5.5", -"SDF version 6", -"SDF version 7. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version.", -"SDF version 7.1. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version.", -"SDF version 8. Read the [v8 migration guide](/display-video/api/structured-data-file/v8-migration-guide) before migrating to this version." -], -"type": "string" -} -}, -"type": "object" -}, "SearchTargetingOptionsRequest": { "description": "Request message for SearchTargetingOptions.", "id": "SearchTargetingOptionsRequest", @@ -21562,7 +21479,7 @@ false "type": "boolean" }, "enableOptimizedTargeting": { -"description": "Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`", +"description": "Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` *Warning*: Starting **March 6, 2025**, this field will stop being compatible when using the BiddingStrategy field fixed_bid. [Read more about this announced change](/display-video/api/deprecations#features.ot_fixed_bid)", "type": "boolean" } }, @@ -21875,7 +21792,7 @@ false "id": "ThirdPartyUrl", "properties": { "type": { -"description": "The type of interaction needs to be tracked by the tracking URL", +"description": "Optional. The type of interaction needs to be tracked by the tracking URL", "enum": [ "THIRD_PARTY_URL_TYPE_UNSPECIFIED", "THIRD_PARTY_URL_TYPE_IMPRESSION", @@ -21915,7 +21832,7 @@ false "type": "string" }, "url": { -"description": "Tracking URL used to track the interaction. Provide a URL with optional path or query string, beginning with `https:`. For example, https://www.example.com/path", +"description": "Optional. Tracking URL used to track the interaction. Provide a URL with optional path or query string, beginning with `https:`. For example, `https://www.example.com/path`", "type": "string" } }, @@ -22040,44 +21957,44 @@ false "id": "Transcode", "properties": { "audioBitRateKbps": { -"description": "The bit rate for the audio stream of the transcoded video, or the bit rate for the transcoded audio, in kilobits per second.", +"description": "Optional. The bit rate for the audio stream of the transcoded video, or the bit rate for the transcoded audio, in kilobits per second.", "format": "int64", "type": "string" }, "audioSampleRateHz": { -"description": "The sample rate for the audio stream of the transcoded video, or the sample rate for the transcoded audio, in hertz.", +"description": "Optional. The sample rate for the audio stream of the transcoded video, or the sample rate for the transcoded audio, in hertz.", "format": "int64", "type": "string" }, "bitRateKbps": { -"description": "The transcoding bit rate of the transcoded video, in kilobits per second.", +"description": "Optional. The transcoding bit rate of the transcoded video, in kilobits per second.", "format": "int64", "type": "string" }, "dimensions": { "$ref": "Dimensions", -"description": "The dimensions of the transcoded video." +"description": "Optional. The dimensions of the transcoded video." }, "fileSizeBytes": { -"description": "The size of the transcoded file, in bytes.", +"description": "Optional. The size of the transcoded file, in bytes.", "format": "int64", "type": "string" }, "frameRate": { -"description": "The frame rate of the transcoded video, in frames per second.", +"description": "Optional. The frame rate of the transcoded video, in frames per second.", "format": "float", "type": "number" }, "mimeType": { -"description": "The MIME type of the transcoded file.", +"description": "Optional. The MIME type of the transcoded file.", "type": "string" }, "name": { -"description": "The name of the transcoded file.", +"description": "Optional. The name of the transcoded file.", "type": "string" }, "transcoded": { -"description": "Indicates if the transcoding was successful.", +"description": "Optional. Indicates if the transcoding was successful.", "type": "boolean" } }, @@ -22088,11 +22005,11 @@ false "id": "UniversalAdId", "properties": { "id": { -"description": "The unique creative identifier.", +"description": "Optional. The unique creative identifier.", "type": "string" }, "registry": { -"description": "The registry provides unique creative identifiers.", +"description": "Optional. The registry provides unique creative identifiers.", "enum": [ "UNIVERSAL_AD_REGISTRY_UNSPECIFIED", "UNIVERSAL_AD_REGISTRY_OTHER", @@ -22677,7 +22594,7 @@ false }, "viewFrequencyCap": { "$ref": "FrequencyCap", -"description": "The view frequency cap settings of the line item. The max_views field in this settings object must be used if assigning a limited cap." +"description": "The view frequency cap settings of the line item. The max_views field in this settings object must be used if assigning a limited cap. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap)" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/displayvideo.v4.json b/googleapiclient/discovery_cache/documents/displayvideo.v4.json index 7255b4a1a33..b04115f7bd1 100644 --- a/googleapiclient/discovery_cache/documents/displayvideo.v4.json +++ b/googleapiclient/discovery_cache/documents/displayvideo.v4.json @@ -5,6 +5,12 @@ "https://www.googleapis.com/auth/display-video": { "description": "Create, see, edit, and permanently delete your Display & Video 360 entities and reports" }, +"https://www.googleapis.com/auth/display-video-mediaplanning": { +"description": "Create, see, and edit Display & Video 360 Campaign entities and see billing invoices" +}, +"https://www.googleapis.com/auth/display-video-user-management": { +"description": "Private Service: https://www.googleapis.com/auth/display-video-user-management" +}, "https://www.googleapis.com/auth/doubleclickbidmanager": { "description": "View and manage your reports in DoubleClick Bid Manager" } @@ -108,222 +114,21369 @@ }, "protocol": "rest", "resources": { -"media": { +"advertisers": { "methods": { -"download": { -"description": "Downloads media. Download is supported on the URI `/download/{resource_name=**}?alt=media.` **Note**: Download requests will not be successful without including `alt=media` query string.", -"flatPath": "download/{downloadId}", +"audit": { +"description": "Audits an advertiser. Returns the counts of used entities per resource type under the advertiser provided. Used entities count towards their respective resource limit. See https://support.google.com/displayvideo/answer/6071450.", +"flatPath": "v4/advertisers/{advertisersId}:audit", "httpMethod": "GET", -"id": "displayvideo.media.download", +"id": "displayvideo.advertisers.audit", "parameterOrder": [ -"resourceName" +"advertiserId" ], "parameters": { -"resourceName": { -"description": "Name of the media that is being downloaded. See ReadRequest.resource_name.", +"advertiserId": { +"description": "Required. The ID of the advertiser to audit.", +"format": "int64", "location": "path", -"pattern": "^.*$", +"pattern": "^[^/]+$", "required": true, "type": "string" +}, +"readMask": { +"description": "Optional. The specific fields to return. If no mask is specified, all fields in the response proto will be filled. Valid values are: * usedLineItemsCount * usedInsertionOrdersCount * usedCampaignsCount * channelsCount * negativelyTargetedChannelsCount * negativeKeywordListsCount * adGroupCriteriaCount * campaignCriteriaCount", +"format": "google-fieldmask", +"location": "query", +"type": "string" } }, -"path": "download/{+resourceName}", +"path": "v4/advertisers/{+advertiserId}:audit", "response": { -"$ref": "GoogleBytestreamMedia" +"$ref": "AuditAdvertiserResponse" }, "scopes": [ -"https://www.googleapis.com/auth/display-video", -"https://www.googleapis.com/auth/doubleclickbidmanager" -], -"supportsMediaDownload": true +"https://www.googleapis.com/auth/display-video" +] }, -"upload": { -"description": "Uploads media. Upload is supported on the URI `/upload/media/{resource_name=**}?upload_type=media.` **Note**: Upload requests will not be successful without including `upload_type=media` query string.", -"flatPath": "media/{mediaId}", +"create": { +"description": "Creates a new advertiser. Returns the newly created advertiser if successful. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.", +"flatPath": "v4/advertisers", "httpMethod": "POST", -"id": "displayvideo.media.upload", -"mediaUpload": { -"accept": [ -"*/*" +"id": "displayvideo.advertisers.create", +"parameterOrder": [], +"parameters": {}, +"path": "v4/advertisers", +"request": { +"$ref": "Advertiser" +}, +"response": { +"$ref": "Advertiser" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"delete": { +"description": "Deletes an advertiser. Deleting an advertiser will delete all of its child resources, for example, campaigns, insertion orders and line items. A deleted advertiser cannot be recovered.", +"flatPath": "v4/advertisers/{advertisersId}", +"httpMethod": "DELETE", +"id": "displayvideo.advertisers.delete", +"parameterOrder": [ +"advertiserId" ], -"protocols": { -"simple": { -"multipart": true, -"path": "/upload/media/{+resourceName}" -} +"parameters": { +"advertiserId": { +"description": "The ID of the advertiser we need to delete.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" } }, +"path": "v4/advertisers/{+advertiserId}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"editAssignedTargetingOptions": { +"description": "Edits targeting options under a single advertiser. The operation will delete the assigned targeting options provided in BulkEditAdvertiserAssignedTargetingOptionsRequest.delete_requests and then create the assigned targeting options provided in BulkEditAdvertiserAssignedTargetingOptionsRequest.create_requests .", +"flatPath": "v4/advertisers/{advertisersId}:editAssignedTargetingOptions", +"httpMethod": "POST", +"id": "displayvideo.advertisers.editAssignedTargetingOptions", "parameterOrder": [ -"resourceName" +"advertiserId" ], "parameters": { -"resourceName": { -"description": "Name of the media that is being downloaded. See ReadRequest.resource_name.", +"advertiserId": { +"description": "Required. The ID of the advertiser.", +"format": "int64", "location": "path", -"pattern": "^.*$", +"pattern": "^[^/]+$", "required": true, "type": "string" } }, -"path": "media/{+resourceName}", +"path": "v4/advertisers/{+advertiserId}:editAssignedTargetingOptions", "request": { -"$ref": "GoogleBytestreamMedia" +"$ref": "BulkEditAdvertiserAssignedTargetingOptionsRequest" }, "response": { -"$ref": "GoogleBytestreamMedia" +"$ref": "BulkEditAdvertiserAssignedTargetingOptionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/display-video", -"https://www.googleapis.com/auth/doubleclickbidmanager" -], -"supportsMediaUpload": true -} -} +"https://www.googleapis.com/auth/display-video" +] }, -"sdfdownloadtasks": { -"resources": { -"operations": { -"methods": { "get": { -"description": "Gets the latest state of an asynchronous SDF download task operation. Clients should poll this method at intervals of 30 seconds.", -"flatPath": "v4/sdfdownloadtasks/operations/{operationsId}", +"description": "Gets an advertiser.", +"flatPath": "v4/advertisers/{advertisersId}", "httpMethod": "GET", -"id": "displayvideo.sdfdownloadtasks.operations.get", +"id": "displayvideo.advertisers.get", "parameterOrder": [ -"name" +"advertiserId" ], "parameters": { -"name": { -"description": "The name of the operation resource.", +"advertiserId": { +"description": "Required. The ID of the advertiser to fetch.", +"format": "int64", "location": "path", -"pattern": "^sdfdownloadtasks/operations/[^/]+$", +"pattern": "^[^/]+$", "required": true, "type": "string" } }, -"path": "v4/{+name}", +"path": "v4/advertisers/{+advertiserId}", "response": { -"$ref": "Operation" +"$ref": "Advertiser" }, "scopes": [ -"https://www.googleapis.com/auth/display-video", -"https://www.googleapis.com/auth/doubleclickbidmanager" +"https://www.googleapis.com/auth/display-video" ] +}, +"list": { +"description": "Lists advertisers that are accessible to the current user. The order is defined by the order_by parameter. A single partner_id is required. Cross-partner listing is not supported.", +"flatPath": "v4/advertisers", +"httpMethod": "GET", +"id": "displayvideo.advertisers.list", +"parameterOrder": [], +"parameters": { +"filter": { +"description": "Allows filtering by advertiser fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. * A restriction has the form of `{field} {operator} {value}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `advertiserId` * `displayName` * `entityStatus` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All active advertisers under a partner: `entityStatus=\"ENTITY_STATUS_ACTIVE\"` * All advertisers with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<=\"2020-11-04T18:54:47Z\"` * All advertisers with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>=\"2020-11-04T18:54:47Z\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` * `updateTime` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. For example, `displayName desc`.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdvertisers` method. If not specified, the first page of results will be returned.", +"location": "query", +"type": "string" +}, +"partnerId": { +"description": "Required. The ID of the partner that the fetched advertisers should all belong to. The system only supports listing advertisers for one partner at a time.", +"format": "int64", +"location": "query", +"type": "string" } +}, +"path": "v4/advertisers", +"response": { +"$ref": "ListAdvertisersResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"listAssignedTargetingOptions": { +"description": "Lists assigned targeting options of an advertiser across targeting types.", +"flatPath": "v4/advertisers/{advertisersId}:listAssignedTargetingOptions", +"httpMethod": "GET", +"id": "displayvideo.advertisers.listAssignedTargetingOptions", +"parameterOrder": [ +"advertiserId" +], +"parameters": { +"advertiserId": { +"description": "Required. The ID of the advertiser the line item belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"filter": { +"description": "Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=) operator`. Supported fields: * `targetingType` Examples: * targetingType with value TARGETING_TYPE_CHANNEL `targetingType=\"TARGETING_TYPE_CHANNEL\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Field by which to sort the list. Acceptable values are: * `targetingType` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `targetingType desc`.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is '5000'. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to `BulkListAdvertiserAssignedTargetingOptions` method. If not specified, the first page of results will be returned.", +"location": "query", +"type": "string" } +}, +"path": "v4/advertisers/{+advertiserId}:listAssignedTargetingOptions", +"response": { +"$ref": "BulkListAdvertiserAssignedTargetingOptionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"patch": { +"description": "Updates an existing advertiser. Returns the updated advertiser if successful.", +"flatPath": "v4/advertisers/{advertisersId}", +"httpMethod": "PATCH", +"id": "displayvideo.advertisers.patch", +"parameterOrder": [ +"advertiserId" +], +"parameters": { +"advertiserId": { +"description": "Output only. The unique ID of the advertiser. Assigned by the system.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Required. The mask to control which fields to update.", +"format": "google-fieldmask", +"location": "query", +"type": "string" } +}, +"path": "v4/advertisers/{+advertiserId}", +"request": { +"$ref": "Advertiser" +}, +"response": { +"$ref": "Advertiser" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] } }, -"sdfuploadtasks": { "resources": { -"operations": { +"adGroupAds": { "methods": { "get": { -"description": "Gets the latest state of an asynchronous SDF download task operation. Clients should poll this method at intervals of 30 seconds.", -"flatPath": "v4/sdfuploadtasks/operations/{operationsId}", +"description": "Gets an ad group ad.", +"flatPath": "v4/advertisers/{advertisersId}/adGroupAds/{adGroupAdsId}", "httpMethod": "GET", -"id": "displayvideo.sdfuploadtasks.operations.get", +"id": "displayvideo.advertisers.adGroupAds.get", "parameterOrder": [ -"name" +"advertiserId", +"adGroupAdId" ], "parameters": { -"name": { -"description": "The name of the operation resource.", +"adGroupAdId": { +"description": "Required. The ID of the ad group ad to fetch.", +"format": "int64", "location": "path", -"pattern": "^sdfuploadtasks/operations/[^/]+$", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"advertiserId": { +"description": "Required. The ID of the advertiser this ad group ad belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", "required": true, "type": "string" } }, -"path": "v4/{+name}", +"path": "v4/advertisers/{+advertiserId}/adGroupAds/{+adGroupAdId}", "response": { -"$ref": "Operation" +"$ref": "AdGroupAd" }, "scopes": [ -"https://www.googleapis.com/auth/display-video", -"https://www.googleapis.com/auth/doubleclickbidmanager" +"https://www.googleapis.com/auth/display-video" ] -} -} -} -} -} }, -"revision": "20250210", -"rootUrl": "https://displayvideo.googleapis.com/", -"schemas": { -"GoogleBytestreamMedia": { -"description": "Media resource.", -"id": "GoogleBytestreamMedia", -"properties": { -"resourceName": { -"description": "Name of the media resource.", +"list": { +"description": "Lists ad group ads.", +"flatPath": "v4/advertisers/{advertisersId}/adGroupAds", +"httpMethod": "GET", +"id": "displayvideo.advertisers.adGroupAds.list", +"parameterOrder": [ +"advertiserId" +], +"parameters": { +"advertiserId": { +"description": "Required. The ID of the advertiser the ad groups belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, "type": "string" -} -}, -"type": "object" -}, -"Operation": { -"description": "This resource represents a long-running operation that is the result of a network API call.", -"id": "Operation", -"properties": { -"done": { -"description": "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.", -"type": "boolean" }, -"error": { -"$ref": "Status", -"description": "The error result of the operation in case of failure or cancellation." +"filter": { +"description": "Optional. Allows filtering by custom ad group ad fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` and `OR`. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `adGroupId` * `displayName` * `entityStatus` * `adGroupAdId` Examples: * All ad group ads under an ad group: `adGroupId=\"1234\"` * All ad group ads under an ad group with an entityStatus of `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED`: `(entityStatus=\"ENTITY_STATUS_ACTIVE\" OR entityStatus=\"ENTITY_STATUS_PAUSED\") AND adGroupId=\"12345\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", +"location": "query", +"type": "string" }, -"metadata": { -"additionalProperties": { -"description": "Properties of the object. Contains field @type with type URL.", -"type": "any" +"orderBy": { +"description": "Optional. Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`.", +"location": "query", +"type": "string" }, -"description": "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.", -"type": "object" +"pageSize": { +"description": "Optional. Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", +"format": "int32", +"location": "query", +"type": "integer" }, -"name": { -"description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", +"pageToken": { +"description": "Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdGroupAds` method. If not specified, the first page of results will be returned.", +"location": "query", "type": "string" +} }, +"path": "v4/advertisers/{+advertiserId}/adGroupAds", "response": { -"additionalProperties": { -"description": "Properties of the object. Contains field @type with type URL.", -"type": "any" +"$ref": "ListAdGroupAdsResponse" }, -"description": "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`.", -"type": "object" +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +} } }, -"type": "object" +"adGroups": { +"methods": { +"bulkListAssignedTargetingOptions": { +"description": "Lists assigned targeting options for multiple ad groups across targeting types. Inherited assigned targeting options are not included.", +"flatPath": "v4/advertisers/{advertisersId}/adGroups:bulkListAssignedTargetingOptions", +"httpMethod": "GET", +"id": "displayvideo.advertisers.adGroups.bulkListAssignedTargetingOptions", +"parameterOrder": [ +"advertiserId" +], +"parameters": { +"adGroupIds": { +"description": "Required. The IDs of the ad groups to list assigned targeting options for.", +"format": "int64", +"location": "query", +"repeated": true, +"type": "string" }, -"Status": { -"description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). 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).", -"id": "Status", -"properties": { -"code": { -"description": "The status code, which should be an enum value of google.rpc.Code.", -"format": "int32", -"type": "integer" +"advertiserId": { +"description": "Required. The ID of the advertiser the line items belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" }, -"details": { -"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", -"items": { -"additionalProperties": { -"description": "Properties of the object. Contains field @type with type URL.", -"type": "any" +"filter": { +"description": "Optional. Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `targetingType` Examples: * `AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_YOUTUBE_VIDEO` or `TARGETING_TYPE_YOUTUBE_CHANNEL`: `targetingType=\"TARGETING_TYPE_YOUTUBE_VIDEO\" OR targetingType=\"TARGETING_TYPE_YOUTUBE_CHANNEL\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", +"location": "query", +"type": "string" }, -"type": "object" +"orderBy": { +"description": "Optional. Field by which to sort the list. Acceptable values are: * `adGroupId` (default) * `assignedTargetingOption.targetingType` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `targetingType desc`.", +"location": "query", +"type": "string" }, -"type": "array" +"pageSize": { +"description": "Optional. Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", +"format": "int32", +"location": "query", +"type": "integer" }, -"message": { +"pageToken": { +"description": "Optional. A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to the `BulkListAdGroupAssignedTargetingOptions` method. If not specified, the first page of results will be returned.", +"location": "query", +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/adGroups:bulkListAssignedTargetingOptions", +"response": { +"$ref": "BulkListAdGroupAssignedTargetingOptionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"get": { +"description": "Gets an ad group.", +"flatPath": "v4/advertisers/{advertisersId}/adGroups/{adGroupsId}", +"httpMethod": "GET", +"id": "displayvideo.advertisers.adGroups.get", +"parameterOrder": [ +"advertiserId", +"adGroupId" +], +"parameters": { +"adGroupId": { +"description": "Required. The ID of the ad group to fetch.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"advertiserId": { +"description": "Required. The ID of the advertiser this ad group belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}", +"response": { +"$ref": "AdGroup" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"list": { +"description": "Lists ad groups.", +"flatPath": "v4/advertisers/{advertisersId}/adGroups", +"httpMethod": "GET", +"id": "displayvideo.advertisers.adGroups.list", +"parameterOrder": [ +"advertiserId" +], +"parameters": { +"advertiserId": { +"description": "Required. The ID of the advertiser the ad groups belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"filter": { +"description": "Optional. Allows filtering by custom ad group fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` and `OR`. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported properties: * `adGroupId` * `displayName` * `entityStatus` * `lineItemId` * `adGroupFormat` Examples: * All ad groups under an line item: `lineItemId=\"1234\"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` `AD_GROUP_FORMAT_IN_STREAM` ad groups under an advertiser: `(entityStatus=\"ENTITY_STATUS_ACTIVE\" OR entityStatus=\"ENTITY_STATUS_PAUSED\") AND adGroupFormat=\"AD_GROUP_FORMAT_IN_STREAM\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdGroups` method. If not specified, the first page of results will be returned.", +"location": "query", +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/adGroups", +"response": { +"$ref": "ListAdGroupsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +} +}, +"resources": { +"targetingTypes": { +"resources": { +"assignedTargetingOptions": { +"methods": { +"get": { +"description": "Gets a single targeting option assigned to an ad group. Inherited assigned targeting options are not included.", +"flatPath": "v4/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}", +"httpMethod": "GET", +"id": "displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.get", +"parameterOrder": [ +"advertiserId", +"adGroupId", +"targetingType", +"assignedTargetingOptionId" +], +"parameters": { +"adGroupId": { +"description": "Required. The ID of the ad group the assigned targeting option belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"advertiserId": { +"description": "Required. The ID of the advertiser the ad group belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"assignedTargetingOptionId": { +"description": "Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested.", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"targetingType": { +"description": "Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO`", +"enum": [ +"TARGETING_TYPE_UNSPECIFIED", +"TARGETING_TYPE_CHANNEL", +"TARGETING_TYPE_APP_CATEGORY", +"TARGETING_TYPE_APP", +"TARGETING_TYPE_URL", +"TARGETING_TYPE_DAY_AND_TIME", +"TARGETING_TYPE_AGE_RANGE", +"TARGETING_TYPE_REGIONAL_LOCATION_LIST", +"TARGETING_TYPE_PROXIMITY_LOCATION_LIST", +"TARGETING_TYPE_GENDER", +"TARGETING_TYPE_VIDEO_PLAYER_SIZE", +"TARGETING_TYPE_USER_REWARDED_CONTENT", +"TARGETING_TYPE_PARENTAL_STATUS", +"TARGETING_TYPE_CONTENT_INSTREAM_POSITION", +"TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", +"TARGETING_TYPE_DEVICE_TYPE", +"TARGETING_TYPE_AUDIENCE_GROUP", +"TARGETING_TYPE_BROWSER", +"TARGETING_TYPE_HOUSEHOLD_INCOME", +"TARGETING_TYPE_ON_SCREEN_POSITION", +"TARGETING_TYPE_THIRD_PARTY_VERIFIER", +"TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", +"TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", +"TARGETING_TYPE_ENVIRONMENT", +"TARGETING_TYPE_CARRIER_AND_ISP", +"TARGETING_TYPE_OPERATING_SYSTEM", +"TARGETING_TYPE_DEVICE_MAKE_MODEL", +"TARGETING_TYPE_KEYWORD", +"TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", +"TARGETING_TYPE_VIEWABILITY", +"TARGETING_TYPE_CATEGORY", +"TARGETING_TYPE_INVENTORY_SOURCE", +"TARGETING_TYPE_LANGUAGE", +"TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", +"TARGETING_TYPE_GEO_REGION", +"TARGETING_TYPE_INVENTORY_SOURCE_GROUP", +"TARGETING_TYPE_EXCHANGE", +"TARGETING_TYPE_SUB_EXCHANGE", +"TARGETING_TYPE_POI", +"TARGETING_TYPE_BUSINESS_CHAIN", +"TARGETING_TYPE_CONTENT_DURATION", +"TARGETING_TYPE_CONTENT_STREAM_TYPE", +"TARGETING_TYPE_NATIVE_CONTENT_POSITION", +"TARGETING_TYPE_OMID", +"TARGETING_TYPE_AUDIO_CONTENT_TYPE", +"TARGETING_TYPE_CONTENT_GENRE", +"TARGETING_TYPE_YOUTUBE_VIDEO", +"TARGETING_TYPE_YOUTUBE_CHANNEL", +"TARGETING_TYPE_SESSION_POSITION" +], +"enumDescriptions": [ +"Default value when type is not specified or is unknown in this version.", +"Target a channel (a custom group of related websites or apps).", +"Target an app category (for example, education or puzzle games).", +"Target a specific app (for example, Angry Birds).", +"Target a specific url (for example, quora.com).", +"Target ads during a chosen time period on a specific day.", +"Target ads to a specific age range (for example, 18-24).", +"Target ads to the specified regions on a regional location list.", +"Target ads to the specified points of interest on a proximity location list.", +"Target ads to a specific gender (for example, female or male).", +"Target a specific video player size for video ads.", +"Target user rewarded content for video ads.", +"Target ads to a specific parental status (for example, parent or not a parent).", +"Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", +"Target ads in a specific content outstream position.", +"Target ads to a specific device type (for example, tablet or connected TV).", +"Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", +"Target ads to specific web browsers (for example, Chrome).", +"Target ads to a specific household income range (for example, top 10%).", +"Target ads in a specific on screen position.", +"Filter web sites through third party verification (for example, IAS or DoubleVerify).", +"Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", +"Filter website content by sensitive categories (for example, adult).", +"Target ads to a specific environment (for example, web or app).", +"Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", +"Target ads to a specific operating system (for example, macOS).", +"Target ads to a specific device make or model (for example, Roku or Samsung).", +"Target ads to a specific keyword (for example, dog or retriever).", +"Target ads to a specific negative keyword list.", +"Target ads to a specific viewability (for example, 80% viewable).", +"Target ads to a specific content category (for example, arts & entertainment).", +"Purchase impressions from specific deals and auction packages.", +"Target ads to a specific language (for example, English or Japanese).", +"Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", +"Target ads to a specific regional location (for example, a city or state).", +"Purchase impressions from a group of deals and auction packages.", +"Purchase impressions from specific exchanges.", +"Purchase impressions from specific sub-exchanges.", +"Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", +"Target ads around locations of a business chain within a specific geo region.", +"Target ads to a specific video content duration.", +"Target ads to a specific video content stream type.", +"Target ads to a specific native content position.", +"Target ads in an Open Measurement enabled inventory.", +"Target ads to a specific audio content type.", +"Target ads to a specific content genre.", +"Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", +"Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", +"Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." +], +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}", +"response": { +"$ref": "AssignedTargetingOption" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"list": { +"description": "Lists the targeting options assigned to an ad group. Inherited assigned targeting options are not included.", +"flatPath": "v4/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions", +"httpMethod": "GET", +"id": "displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.list", +"parameterOrder": [ +"advertiserId", +"adGroupId", +"targetingType" +], +"parameters": { +"adGroupId": { +"description": "Required. The ID of the ad group to list assigned targeting options for.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"advertiserId": { +"description": "Required. The ID of the advertiser the ad group belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"filter": { +"description": "Optional. Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` Examples: * `AssignedTargetingOption` resources with ID 1 or 2: `assignedTargetingOptionId=\"1\" OR assignedTargetingOptionId=\"2\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `assignedTargetingOptionId desc`.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdGroupAssignedTargetingOptions` method. If not specified, the first page of results will be returned.", +"location": "query", +"type": "string" +}, +"targetingType": { +"description": "Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO`", +"enum": [ +"TARGETING_TYPE_UNSPECIFIED", +"TARGETING_TYPE_CHANNEL", +"TARGETING_TYPE_APP_CATEGORY", +"TARGETING_TYPE_APP", +"TARGETING_TYPE_URL", +"TARGETING_TYPE_DAY_AND_TIME", +"TARGETING_TYPE_AGE_RANGE", +"TARGETING_TYPE_REGIONAL_LOCATION_LIST", +"TARGETING_TYPE_PROXIMITY_LOCATION_LIST", +"TARGETING_TYPE_GENDER", +"TARGETING_TYPE_VIDEO_PLAYER_SIZE", +"TARGETING_TYPE_USER_REWARDED_CONTENT", +"TARGETING_TYPE_PARENTAL_STATUS", +"TARGETING_TYPE_CONTENT_INSTREAM_POSITION", +"TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", +"TARGETING_TYPE_DEVICE_TYPE", +"TARGETING_TYPE_AUDIENCE_GROUP", +"TARGETING_TYPE_BROWSER", +"TARGETING_TYPE_HOUSEHOLD_INCOME", +"TARGETING_TYPE_ON_SCREEN_POSITION", +"TARGETING_TYPE_THIRD_PARTY_VERIFIER", +"TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", +"TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", +"TARGETING_TYPE_ENVIRONMENT", +"TARGETING_TYPE_CARRIER_AND_ISP", +"TARGETING_TYPE_OPERATING_SYSTEM", +"TARGETING_TYPE_DEVICE_MAKE_MODEL", +"TARGETING_TYPE_KEYWORD", +"TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", +"TARGETING_TYPE_VIEWABILITY", +"TARGETING_TYPE_CATEGORY", +"TARGETING_TYPE_INVENTORY_SOURCE", +"TARGETING_TYPE_LANGUAGE", +"TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", +"TARGETING_TYPE_GEO_REGION", +"TARGETING_TYPE_INVENTORY_SOURCE_GROUP", +"TARGETING_TYPE_EXCHANGE", +"TARGETING_TYPE_SUB_EXCHANGE", +"TARGETING_TYPE_POI", +"TARGETING_TYPE_BUSINESS_CHAIN", +"TARGETING_TYPE_CONTENT_DURATION", +"TARGETING_TYPE_CONTENT_STREAM_TYPE", +"TARGETING_TYPE_NATIVE_CONTENT_POSITION", +"TARGETING_TYPE_OMID", +"TARGETING_TYPE_AUDIO_CONTENT_TYPE", +"TARGETING_TYPE_CONTENT_GENRE", +"TARGETING_TYPE_YOUTUBE_VIDEO", +"TARGETING_TYPE_YOUTUBE_CHANNEL", +"TARGETING_TYPE_SESSION_POSITION" +], +"enumDescriptions": [ +"Default value when type is not specified or is unknown in this version.", +"Target a channel (a custom group of related websites or apps).", +"Target an app category (for example, education or puzzle games).", +"Target a specific app (for example, Angry Birds).", +"Target a specific url (for example, quora.com).", +"Target ads during a chosen time period on a specific day.", +"Target ads to a specific age range (for example, 18-24).", +"Target ads to the specified regions on a regional location list.", +"Target ads to the specified points of interest on a proximity location list.", +"Target ads to a specific gender (for example, female or male).", +"Target a specific video player size for video ads.", +"Target user rewarded content for video ads.", +"Target ads to a specific parental status (for example, parent or not a parent).", +"Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", +"Target ads in a specific content outstream position.", +"Target ads to a specific device type (for example, tablet or connected TV).", +"Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", +"Target ads to specific web browsers (for example, Chrome).", +"Target ads to a specific household income range (for example, top 10%).", +"Target ads in a specific on screen position.", +"Filter web sites through third party verification (for example, IAS or DoubleVerify).", +"Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", +"Filter website content by sensitive categories (for example, adult).", +"Target ads to a specific environment (for example, web or app).", +"Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", +"Target ads to a specific operating system (for example, macOS).", +"Target ads to a specific device make or model (for example, Roku or Samsung).", +"Target ads to a specific keyword (for example, dog or retriever).", +"Target ads to a specific negative keyword list.", +"Target ads to a specific viewability (for example, 80% viewable).", +"Target ads to a specific content category (for example, arts & entertainment).", +"Purchase impressions from specific deals and auction packages.", +"Target ads to a specific language (for example, English or Japanese).", +"Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", +"Target ads to a specific regional location (for example, a city or state).", +"Purchase impressions from a group of deals and auction packages.", +"Purchase impressions from specific exchanges.", +"Purchase impressions from specific sub-exchanges.", +"Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", +"Target ads around locations of a business chain within a specific geo region.", +"Target ads to a specific video content duration.", +"Target ads to a specific video content stream type.", +"Target ads to a specific native content position.", +"Target ads in an Open Measurement enabled inventory.", +"Target ads to a specific audio content type.", +"Target ads to a specific content genre.", +"Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", +"Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", +"Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." +], +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions", +"response": { +"$ref": "ListAdGroupAssignedTargetingOptionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +} +} +} +} +} +} +}, +"assets": { +"methods": { +"upload": { +"description": "Uploads an asset. Returns the ID of the newly uploaded asset if successful. The asset file size should be no more than 10 MB for images, 200 MB for ZIP files, and 1 GB for videos. Must be used within the [multipart media upload process](/display-video/api/guides/how-tos/upload#multipart). Examples using provided client libraries can be found in our [Creating Creatives guide](/display-video/api/guides/creating-creatives/overview#upload_an_asset).", +"flatPath": "v4/advertisers/{advertisersId}/assets", +"httpMethod": "POST", +"id": "displayvideo.advertisers.assets.upload", +"mediaUpload": { +"accept": [ +"*/*" +], +"protocols": { +"simple": { +"multipart": true, +"path": "/upload/v4/advertisers/{+advertiserId}/assets" +} +} +}, +"parameterOrder": [ +"advertiserId" +], +"parameters": { +"advertiserId": { +"description": "Required. The ID of the advertiser this asset belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/assets", +"request": { +"$ref": "CreateAssetRequest" +}, +"response": { +"$ref": "CreateAssetResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +], +"supportsMediaUpload": true +} +} +}, +"campaigns": { +"methods": { +"create": { +"description": "Creates a new campaign. Returns the newly created campaign if successful.", +"flatPath": "v4/advertisers/{advertisersId}/campaigns", +"httpMethod": "POST", +"id": "displayvideo.advertisers.campaigns.create", +"parameterOrder": [ +"advertiserId" +], +"parameters": { +"advertiserId": { +"description": "Output only. The unique ID of the advertiser the campaign belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/campaigns", +"request": { +"$ref": "Campaign" +}, +"response": { +"$ref": "Campaign" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video", +"https://www.googleapis.com/auth/display-video-mediaplanning" +] +}, +"delete": { +"description": "Permanently deletes a campaign. A deleted campaign cannot be recovered. The campaign should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.", +"flatPath": "v4/advertisers/{advertisersId}/campaigns/{campaignsId}", +"httpMethod": "DELETE", +"id": "displayvideo.advertisers.campaigns.delete", +"parameterOrder": [ +"advertiserId", +"campaignId" +], +"parameters": { +"advertiserId": { +"description": "The ID of the advertiser this campaign belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"campaignId": { +"description": "The ID of the campaign we need to delete.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/campaigns/{+campaignId}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video", +"https://www.googleapis.com/auth/display-video-mediaplanning" +] +}, +"get": { +"description": "Gets a campaign.", +"flatPath": "v4/advertisers/{advertisersId}/campaigns/{campaignsId}", +"httpMethod": "GET", +"id": "displayvideo.advertisers.campaigns.get", +"parameterOrder": [ +"advertiserId", +"campaignId" +], +"parameters": { +"advertiserId": { +"description": "Required. The ID of the advertiser this campaign belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"campaignId": { +"description": "Required. The ID of the campaign to fetch.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/campaigns/{+campaignId}", +"response": { +"$ref": "Campaign" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video", +"https://www.googleapis.com/auth/display-video-mediaplanning" +] +}, +"list": { +"description": "Lists campaigns in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, campaigns with `ENTITY_STATUS_ARCHIVED` will not be included in the results.", +"flatPath": "v4/advertisers/{advertisersId}/campaigns", +"httpMethod": "GET", +"id": "displayvideo.advertisers.campaigns.list", +"parameterOrder": [ +"advertiserId" +], +"parameters": { +"advertiserId": { +"description": "The ID of the advertiser to list campaigns for.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"filter": { +"description": "Allows filtering by campaign fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` campaigns under an advertiser: `(entityStatus=\"ENTITY_STATUS_ACTIVE\" OR entityStatus=\"ENTITY_STATUS_PAUSED\")` * All campaigns with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<=\"2020-11-04T18:54:47Z\"` * All campaigns with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>=\"2020-11-04T18:54:47Z\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` * `updateTime` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCampaigns` method. If not specified, the first page of results will be returned.", +"location": "query", +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/campaigns", +"response": { +"$ref": "ListCampaignsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video", +"https://www.googleapis.com/auth/display-video-mediaplanning" +] +}, +"patch": { +"description": "Updates an existing campaign. Returns the updated campaign if successful.", +"flatPath": "v4/advertisers/{advertisersId}/campaigns/{campaignsId}", +"httpMethod": "PATCH", +"id": "displayvideo.advertisers.campaigns.patch", +"parameterOrder": [ +"advertiserId", +"campaignId" +], +"parameters": { +"advertiserId": { +"description": "Output only. The unique ID of the advertiser the campaign belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"campaignId": { +"description": "Output only. The unique ID of the campaign. Assigned by the system.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Required. The mask to control which fields to update.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/campaigns/{+campaignId}", +"request": { +"$ref": "Campaign" +}, +"response": { +"$ref": "Campaign" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video", +"https://www.googleapis.com/auth/display-video-mediaplanning" +] +} +} +}, +"channels": { +"methods": { +"create": { +"description": "Creates a new channel. Returns the newly created channel if successful.", +"flatPath": "v4/advertisers/{advertisersId}/channels", +"httpMethod": "POST", +"id": "displayvideo.advertisers.channels.create", +"parameterOrder": [ +"advertiserId" +], +"parameters": { +"advertiserId": { +"description": "The ID of the advertiser that owns the created channel.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"partnerId": { +"description": "The ID of the partner that owns the created channel.", +"format": "int64", +"location": "query", +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/channels", +"request": { +"$ref": "Channel" +}, +"response": { +"$ref": "Channel" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"get": { +"description": "Gets a channel for a partner or advertiser.", +"flatPath": "v4/advertisers/{advertisersId}/channels/{channelsId}", +"httpMethod": "GET", +"id": "displayvideo.advertisers.channels.get", +"parameterOrder": [ +"advertiserId", +"channelId" +], +"parameters": { +"advertiserId": { +"description": "The ID of the advertiser that owns the fetched channel.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"channelId": { +"description": "Required. The ID of the channel to fetch.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"partnerId": { +"description": "The ID of the partner that owns the fetched channel.", +"format": "int64", +"location": "query", +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/channels/{+channelId}", +"response": { +"$ref": "Channel" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"list": { +"description": "Lists channels for a partner or advertiser.", +"flatPath": "v4/advertisers/{advertisersId}/channels", +"httpMethod": "GET", +"id": "displayvideo.advertisers.channels.list", +"parameterOrder": [ +"advertiserId" +], +"parameters": { +"advertiserId": { +"description": "The ID of the advertiser that owns the channels.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"filter": { +"description": "Allows filtering by channel fields. Supported syntax: * Filter expressions for channel can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All channels for which the display name contains \"google\": `displayName : \"google\"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Field by which to sort the list. Acceptable values are: * `displayName` (default) * `channelId` The default sorting order is ascending. To specify descending order for a field, a suffix \" desc\" should be added to the field name. Example: `displayName desc`.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListChannels` method. If not specified, the first page of results will be returned.", +"location": "query", +"type": "string" +}, +"partnerId": { +"description": "The ID of the partner that owns the channels.", +"format": "int64", +"location": "query", +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/channels", +"response": { +"$ref": "ListChannelsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"patch": { +"description": "Updates a channel. Returns the updated channel if successful.", +"flatPath": "v4/advertisers/{advertisersId}/channels/{channelId}", +"httpMethod": "PATCH", +"id": "displayvideo.advertisers.channels.patch", +"parameterOrder": [ +"advertiserId", +"channelId" +], +"parameters": { +"advertiserId": { +"description": "The ID of the advertiser that owns the created channel.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"channelId": { +"description": "Output only. The unique ID of the channel. Assigned by the system.", +"format": "int64", +"location": "path", +"required": true, +"type": "string" +}, +"partnerId": { +"description": "The ID of the partner that owns the created channel.", +"format": "int64", +"location": "query", +"type": "string" +}, +"updateMask": { +"description": "Required. The mask to control which fields to update.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/channels/{channelId}", +"request": { +"$ref": "Channel" +}, +"response": { +"$ref": "Channel" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +} +}, +"resources": { +"sites": { +"methods": { +"bulkEdit": { +"description": "Bulk edits sites under a single channel. The operation will delete the sites provided in BulkEditSitesRequest.deleted_sites and then create the sites provided in BulkEditSitesRequest.created_sites.", +"flatPath": "v4/advertisers/{advertiserId}/channels/{channelsId}/sites:bulkEdit", +"httpMethod": "POST", +"id": "displayvideo.advertisers.channels.sites.bulkEdit", +"parameterOrder": [ +"advertiserId", +"channelId" +], +"parameters": { +"advertiserId": { +"description": "The ID of the advertiser that owns the parent channel.", +"format": "int64", +"location": "path", +"required": true, +"type": "string" +}, +"channelId": { +"description": "Required. The ID of the parent channel to which the sites belong.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{advertiserId}/channels/{+channelId}/sites:bulkEdit", +"request": { +"$ref": "BulkEditSitesRequest" +}, +"response": { +"$ref": "BulkEditSitesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"create": { +"description": "Creates a site in a channel.", +"flatPath": "v4/advertisers/{advertiserId}/channels/{channelsId}/sites", +"httpMethod": "POST", +"id": "displayvideo.advertisers.channels.sites.create", +"parameterOrder": [ +"advertiserId", +"channelId" +], +"parameters": { +"advertiserId": { +"description": "The ID of the advertiser that owns the parent channel.", +"format": "int64", +"location": "path", +"required": true, +"type": "string" +}, +"channelId": { +"description": "Required. The ID of the parent channel in which the site will be created.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"partnerId": { +"description": "The ID of the partner that owns the parent channel.", +"format": "int64", +"location": "query", +"type": "string" +} +}, +"path": "v4/advertisers/{advertiserId}/channels/{+channelId}/sites", +"request": { +"$ref": "Site" +}, +"response": { +"$ref": "Site" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"delete": { +"description": "Deletes a site from a channel.", +"flatPath": "v4/advertisers/{advertiserId}/channels/{channelsId}/sites/{sitesId}", +"httpMethod": "DELETE", +"id": "displayvideo.advertisers.channels.sites.delete", +"parameterOrder": [ +"advertiserId", +"channelId", +"urlOrAppId" +], +"parameters": { +"advertiserId": { +"description": "The ID of the advertiser that owns the parent channel.", +"format": "int64", +"location": "path", +"required": true, +"type": "string" +}, +"channelId": { +"description": "Required. The ID of the parent channel to which the site belongs.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"partnerId": { +"description": "The ID of the partner that owns the parent channel.", +"format": "int64", +"location": "query", +"type": "string" +}, +"urlOrAppId": { +"description": "Required. The URL or app ID of the site to delete.", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{advertiserId}/channels/{+channelId}/sites/{+urlOrAppId}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"list": { +"description": "Lists sites in a channel.", +"flatPath": "v4/advertisers/{advertisersId}/channels/{channelsId}/sites", +"httpMethod": "GET", +"id": "displayvideo.advertisers.channels.sites.list", +"parameterOrder": [ +"advertiserId", +"channelId" +], +"parameters": { +"advertiserId": { +"description": "The ID of the advertiser that owns the parent channel.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"channelId": { +"description": "Required. The ID of the parent channel to which the requested sites belong.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"filter": { +"description": "Allows filtering by site fields. Supported syntax: * Filter expressions for site retrieval can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `urlOrAppId` Examples: * All sites for which the URL or app ID contains \"google\": `urlOrAppId : \"google\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Field by which to sort the list. Acceptable values are: * `urlOrAppId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \" desc\" should be added to the field name. Example: `urlOrAppId desc`.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Requested page size. Must be between `1` and `10000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListSites` method. If not specified, the first page of results will be returned.", +"location": "query", +"type": "string" +}, +"partnerId": { +"description": "The ID of the partner that owns the parent channel.", +"format": "int64", +"location": "query", +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/channels/{+channelId}/sites", +"response": { +"$ref": "ListSitesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"replace": { +"description": "Replaces all of the sites under a single channel. The operation will replace the sites under a channel with the sites provided in ReplaceSitesRequest.new_sites. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.", +"flatPath": "v4/advertisers/{advertiserId}/channels/{channelsId}/sites:replace", +"httpMethod": "POST", +"id": "displayvideo.advertisers.channels.sites.replace", +"parameterOrder": [ +"advertiserId", +"channelId" +], +"parameters": { +"advertiserId": { +"description": "The ID of the advertiser that owns the parent channel.", +"format": "int64", +"location": "path", +"required": true, +"type": "string" +}, +"channelId": { +"description": "Required. The ID of the parent channel whose sites will be replaced.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{advertiserId}/channels/{+channelId}/sites:replace", +"request": { +"$ref": "ReplaceSitesRequest" +}, +"response": { +"$ref": "ReplaceSitesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +} +} +} +} +}, +"creatives": { +"methods": { +"create": { +"description": "Creates a new creative. Returns the newly created creative if successful. A [\"Standard\" user role](//support.google.com/displayvideo/answer/2723011) or greater for the parent advertiser or partner is required to make this request.", +"flatPath": "v4/advertisers/{advertisersId}/creatives", +"httpMethod": "POST", +"id": "displayvideo.advertisers.creatives.create", +"parameterOrder": [ +"advertiserId" +], +"parameters": { +"advertiserId": { +"description": "Output only. The unique ID of the advertiser the creative belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/creatives", +"request": { +"$ref": "Creative" +}, +"response": { +"$ref": "Creative" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"delete": { +"description": "Deletes a creative. Returns error code `NOT_FOUND` if the creative does not exist. The creative should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, before it can be deleted. A [\"Standard\" user role](//support.google.com/displayvideo/answer/2723011) or greater for the parent advertiser or partner is required to make this request.", +"flatPath": "v4/advertisers/{advertisersId}/creatives/{creativesId}", +"httpMethod": "DELETE", +"id": "displayvideo.advertisers.creatives.delete", +"parameterOrder": [ +"advertiserId", +"creativeId" +], +"parameters": { +"advertiserId": { +"description": "The ID of the advertiser this creative belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"creativeId": { +"description": "The ID of the creative to be deleted.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/creatives/{+creativeId}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"get": { +"description": "Gets a creative.", +"flatPath": "v4/advertisers/{advertisersId}/creatives/{creativesId}", +"httpMethod": "GET", +"id": "displayvideo.advertisers.creatives.get", +"parameterOrder": [ +"advertiserId", +"creativeId" +], +"parameters": { +"advertiserId": { +"description": "Required. The ID of the advertiser this creative belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"creativeId": { +"description": "Required. The ID of the creative to fetch.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/creatives/{+creativeId}", +"response": { +"$ref": "Creative" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"list": { +"description": "Lists creatives in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, creatives with `ENTITY_STATUS_ARCHIVED` will not be included in the results.", +"flatPath": "v4/advertisers/{advertisersId}/creatives", +"httpMethod": "GET", +"id": "displayvideo.advertisers.creatives.list", +"parameterOrder": [ +"advertiserId" +], +"parameters": { +"advertiserId": { +"description": "Required. The ID of the advertiser to list creatives for.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"filter": { +"description": "Allows filtering by creative fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `lineItemIds` field must use the `HAS (:)` operator. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. * For `entityStatus`, `minDuration`, `maxDuration`, `updateTime`, and `dynamic` fields, there may be at most one restriction. Supported Fields: * `approvalStatus` * `creativeId` * `creativeType` * `dimensions` (input in the form of `{width}x{height}`) * `dynamic` * `entityStatus` * `exchangeReviewStatus` (input in the form of `{exchange}-{reviewStatus}`) * `lineItemIds` * `maxDuration` (input in the form of `{duration}s`. Only seconds are supported) * `minDuration` (input in the form of `{duration}s`. Only seconds are supported) * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Notes: * For `updateTime`, a creative resource's field value reflects the last time that a creative has been updated, which includes updates made by the system (e.g. creative review updates). Examples: * All native creatives: `creativeType=\"CREATIVE_TYPE_NATIVE\"` * All active creatives with 300x400 or 50x100 dimensions: `entityStatus=\"ENTITY_STATUS_ACTIVE\" AND (dimensions=\"300x400\" OR dimensions=\"50x100\")` * All dynamic creatives that are approved by AdX or AppNexus, with a minimum duration of 5 seconds and 200ms: `dynamic=\"true\" AND minDuration=\"5.2s\" AND (exchangeReviewStatus=\"EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED\" OR exchangeReviewStatus=\"EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED\")` * All video creatives that are associated with line item ID 1 or 2: `creativeType=\"CREATIVE_TYPE_VIDEO\" AND (lineItemIds:1 OR lineItemIds:2)` * Find creatives by multiple creative IDs: `creativeId=1 OR creativeId=2` * All creatives with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>=\"2020-11-04T18:54:47Z\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Field by which to sort the list. Acceptable values are: * `creativeId` (default) * `createTime` * `mediaDuration` * `dimensions` (sorts by width first, then by height) The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `createTime desc`.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCreatives` method. If not specified, the first page of results will be returned.", +"location": "query", +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/creatives", +"response": { +"$ref": "ListCreativesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"patch": { +"description": "Updates an existing creative. Returns the updated creative if successful. A [\"Standard\" user role](//support.google.com/displayvideo/answer/2723011) or greater for the parent advertiser or partner is required to make this request.", +"flatPath": "v4/advertisers/{advertisersId}/creatives/{creativesId}", +"httpMethod": "PATCH", +"id": "displayvideo.advertisers.creatives.patch", +"parameterOrder": [ +"advertiserId", +"creativeId" +], +"parameters": { +"advertiserId": { +"description": "Output only. The unique ID of the advertiser the creative belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"creativeId": { +"description": "Output only. The unique ID of the creative. Assigned by the system.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Required. The mask to control which fields to update.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/creatives/{+creativeId}", +"request": { +"$ref": "Creative" +}, +"response": { +"$ref": "Creative" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +} +} +}, +"insertionOrders": { +"methods": { +"create": { +"description": "Creates a new insertion order. Returns the newly created insertion order if successful.", +"flatPath": "v4/advertisers/{advertisersId}/insertionOrders", +"httpMethod": "POST", +"id": "displayvideo.advertisers.insertionOrders.create", +"parameterOrder": [ +"advertiserId" +], +"parameters": { +"advertiserId": { +"description": "Output only. The unique ID of the advertiser the insertion order belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/insertionOrders", +"request": { +"$ref": "InsertionOrder" +}, +"response": { +"$ref": "InsertionOrder" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"delete": { +"description": "Deletes an insertion order. Returns error code `NOT_FOUND` if the insertion order does not exist. The insertion order should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it.", +"flatPath": "v4/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}", +"httpMethod": "DELETE", +"id": "displayvideo.advertisers.insertionOrders.delete", +"parameterOrder": [ +"advertiserId", +"insertionOrderId" +], +"parameters": { +"advertiserId": { +"description": "The ID of the advertiser this insertion order belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"insertionOrderId": { +"description": "The ID of the insertion order to delete.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"get": { +"description": "Gets an insertion order. Returns error code `NOT_FOUND` if the insertion order does not exist.", +"flatPath": "v4/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}", +"httpMethod": "GET", +"id": "displayvideo.advertisers.insertionOrders.get", +"parameterOrder": [ +"advertiserId", +"insertionOrderId" +], +"parameters": { +"advertiserId": { +"description": "Required. The ID of the advertiser this insertion order belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"insertionOrderId": { +"description": "Required. The ID of the insertion order to fetch.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}", +"response": { +"$ref": "InsertionOrder" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"list": { +"description": "Lists insertion orders in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, insertion orders with `ENTITY_STATUS_ARCHIVED` will not be included in the results.", +"flatPath": "v4/advertisers/{advertisersId}/insertionOrders", +"httpMethod": "GET", +"id": "displayvideo.advertisers.insertionOrders.list", +"parameterOrder": [ +"advertiserId" +], +"parameters": { +"advertiserId": { +"description": "Required. The ID of the advertiser to list insertion orders for.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"filter": { +"description": "Allows filtering by insertion order fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All insertion orders under a campaign: `campaignId=\"1234\"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` insertion orders under an advertiser: `(entityStatus=\"ENTITY_STATUS_ACTIVE\" OR entityStatus=\"ENTITY_STATUS_PAUSED\")` * All insertion orders with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<=\"2020-11-04T18:54:47Z\"` * All insertion orders with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>=\"2020-11-04T18:54:47Z\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Field by which to sort the list. Acceptable values are: * \"displayName\" (default) * \"entityStatus\" * \"updateTime\" The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInsertionOrders` method. If not specified, the first page of results will be returned.", +"location": "query", +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/insertionOrders", +"response": { +"$ref": "ListInsertionOrdersResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"patch": { +"description": "Updates an existing insertion order. Returns the updated insertion order if successful.", +"flatPath": "v4/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}", +"httpMethod": "PATCH", +"id": "displayvideo.advertisers.insertionOrders.patch", +"parameterOrder": [ +"advertiserId", +"insertionOrderId" +], +"parameters": { +"advertiserId": { +"description": "Output only. The unique ID of the advertiser the insertion order belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"insertionOrderId": { +"description": "Output only. The unique ID of the insertion order. Assigned by the system.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Required. The mask to control which fields to update.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}", +"request": { +"$ref": "InsertionOrder" +}, +"response": { +"$ref": "InsertionOrder" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +} +} +}, +"invoices": { +"methods": { +"list": { +"description": "Lists invoices posted for an advertiser in a given month. Invoices generated by billing profiles with a \"Partner\" invoice level are not retrievable through this method.", +"flatPath": "v4/advertisers/{advertisersId}/invoices", +"httpMethod": "GET", +"id": "displayvideo.advertisers.invoices.list", +"parameterOrder": [ +"advertiserId" +], +"parameters": { +"advertiserId": { +"description": "Required. The ID of the advertiser to list invoices for.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"issueMonth": { +"description": "The month to list the invoices for. If not set, the request will retrieve invoices for the previous month. Must be in the format YYYYMM.", +"location": "query", +"type": "string" +}, +"loiSapinInvoiceType": { +"description": "Select type of invoice to retrieve for Loi Sapin advertisers. Only applicable to Loi Sapin advertisers. Will be ignored otherwise.", +"enum": [ +"LOI_SAPIN_INVOICE_TYPE_UNSPECIFIED", +"LOI_SAPIN_INVOICE_TYPE_MEDIA", +"LOI_SAPIN_INVOICE_TYPE_PLATFORM" +], +"enumDescriptions": [ +"Value is not specified.", +"Invoices with Media cost.", +"Invoices with Platform fee." +], +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInvoices` method. If not specified, the first page of results will be returned.", +"location": "query", +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/invoices", +"response": { +"$ref": "ListInvoicesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video", +"https://www.googleapis.com/auth/display-video-mediaplanning" +] +}, +"lookupInvoiceCurrency": { +"description": "Retrieves the invoice currency used by an advertiser in a given month.", +"flatPath": "v4/advertisers/{advertisersId}/invoices:lookupInvoiceCurrency", +"httpMethod": "GET", +"id": "displayvideo.advertisers.invoices.lookupInvoiceCurrency", +"parameterOrder": [ +"advertiserId" +], +"parameters": { +"advertiserId": { +"description": "Required. The ID of the advertiser to lookup currency for.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"invoiceMonth": { +"description": "Month for which the currency is needed. If not set, the request will return existing currency settings for the advertiser. Must be in the format YYYYMM.", +"location": "query", +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/invoices:lookupInvoiceCurrency", +"response": { +"$ref": "LookupInvoiceCurrencyResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video", +"https://www.googleapis.com/auth/display-video-mediaplanning" +] +} +} +}, +"lineItems": { +"methods": { +"bulkEditAssignedTargetingOptions": { +"description": "Bulk edits targeting options under multiple line items. The operation will delete the assigned targeting options provided in BulkEditAssignedTargetingOptionsRequest.delete_requests and then create the assigned targeting options provided in BulkEditAssignedTargetingOptionsRequest.create_requests. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * lineItems.bulkUpdate * lineItems.patch * assignedTargetingOptions.create * assignedTargetingOptions.delete YouTube & Partners line items cannot be created or updated using the API.", +"flatPath": "v4/advertisers/{advertisersId}/lineItems:bulkEditAssignedTargetingOptions", +"httpMethod": "POST", +"id": "displayvideo.advertisers.lineItems.bulkEditAssignedTargetingOptions", +"parameterOrder": [ +"advertiserId" +], +"parameters": { +"advertiserId": { +"description": "Required. The ID of the advertiser the line items belong to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/lineItems:bulkEditAssignedTargetingOptions", +"request": { +"$ref": "BulkEditAssignedTargetingOptionsRequest" +}, +"response": { +"$ref": "BulkEditAssignedTargetingOptionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"bulkListAssignedTargetingOptions": { +"description": "Lists assigned targeting options for multiple line items across targeting types.", +"flatPath": "v4/advertisers/{advertisersId}/lineItems:bulkListAssignedTargetingOptions", +"httpMethod": "GET", +"id": "displayvideo.advertisers.lineItems.bulkListAssignedTargetingOptions", +"parameterOrder": [ +"advertiserId" +], +"parameters": { +"advertiserId": { +"description": "Required. The ID of the advertiser the line items belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"filter": { +"description": "Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR` on the same field. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `targetingType` * `inheritance` Examples: * `AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` or `TARGETING_TYPE_CHANNEL`: `targetingType=\"TARGETING_TYPE_PROXIMITY_LOCATION_LIST\" OR targetingType=\"TARGETING_TYPE_CHANNEL\"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance=\"NOT_INHERITED\" OR inheritance=\"INHERITED_FROM_PARTNER\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", +"location": "query", +"type": "string" +}, +"lineItemIds": { +"description": "Required. The IDs of the line items to list assigned targeting options for.", +"format": "int64", +"location": "query", +"repeated": true, +"type": "string" +}, +"orderBy": { +"description": "Field by which to sort the list. Acceptable values are: * `lineItemId` (default) * `assignedTargetingOption.targetingType` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `targetingType desc`.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to the `BulkListAssignedTargetingOptions` method. If not specified, the first page of results will be returned.", +"location": "query", +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/lineItems:bulkListAssignedTargetingOptions", +"response": { +"$ref": "BulkListAssignedTargetingOptionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"bulkUpdate": { +"description": "Updates multiple line items. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * BulkEditAssignedTargetingOptions * UpdateLineItem * assignedTargetingOptions.create * assignedTargetingOptions.delete YouTube & Partners line items cannot be created or updated using the API.", +"flatPath": "v4/advertisers/{advertisersId}/lineItems:bulkUpdate", +"httpMethod": "POST", +"id": "displayvideo.advertisers.lineItems.bulkUpdate", +"parameterOrder": [ +"advertiserId" +], +"parameters": { +"advertiserId": { +"description": "Required. The ID of the advertiser this line item belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/lineItems:bulkUpdate", +"request": { +"$ref": "BulkUpdateLineItemsRequest" +}, +"response": { +"$ref": "BulkUpdateLineItemsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"create": { +"description": "Creates a new line item. Returns the newly created line item if successful. YouTube & Partners line items cannot be created or updated using the API.", +"flatPath": "v4/advertisers/{advertisersId}/lineItems", +"httpMethod": "POST", +"id": "displayvideo.advertisers.lineItems.create", +"parameterOrder": [ +"advertiserId" +], +"parameters": { +"advertiserId": { +"description": "Output only. The unique ID of the advertiser the line item belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/lineItems", +"request": { +"$ref": "LineItem" +}, +"response": { +"$ref": "LineItem" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"delete": { +"description": "Deletes a line item. Returns error code `NOT_FOUND` if the line item does not exist. The line item should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it. YouTube & Partners line items cannot be created or updated using the API.", +"flatPath": "v4/advertisers/{advertisersId}/lineItems/{lineItemsId}", +"httpMethod": "DELETE", +"id": "displayvideo.advertisers.lineItems.delete", +"parameterOrder": [ +"advertiserId", +"lineItemId" +], +"parameters": { +"advertiserId": { +"description": "The ID of the advertiser this line item belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"lineItemId": { +"description": "The ID of the line item to delete.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"duplicate": { +"description": "Duplicates a line item. Returns the ID of the created line item if successful. YouTube & Partners line items cannot be created or updated using the API. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.", +"flatPath": "v4/advertisers/{advertisersId}/lineItems/{lineItemsId}:duplicate", +"httpMethod": "POST", +"id": "displayvideo.advertisers.lineItems.duplicate", +"parameterOrder": [ +"advertiserId", +"lineItemId" +], +"parameters": { +"advertiserId": { +"description": "Required. The ID of the advertiser this line item belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"lineItemId": { +"description": "Required. The ID of the line item to duplicate.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}:duplicate", +"request": { +"$ref": "DuplicateLineItemRequest" +}, +"response": { +"$ref": "DuplicateLineItemResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"generateDefault": { +"description": "Creates a new line item with settings (including targeting) inherited from the insertion order and an `ENTITY_STATUS_DRAFT` entity_status. Returns the newly created line item if successful. There are default values based on the three fields: * The insertion order's insertion_order_type * The insertion order's automation_type * The given line_item_type YouTube & Partners line items cannot be created or updated using the API.", +"flatPath": "v4/advertisers/{advertisersId}/lineItems:generateDefault", +"httpMethod": "POST", +"id": "displayvideo.advertisers.lineItems.generateDefault", +"parameterOrder": [ +"advertiserId" +], +"parameters": { +"advertiserId": { +"description": "Required. The ID of the advertiser this line item belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/lineItems:generateDefault", +"request": { +"$ref": "GenerateDefaultLineItemRequest" +}, +"response": { +"$ref": "LineItem" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"get": { +"description": "Gets a line item.", +"flatPath": "v4/advertisers/{advertisersId}/lineItems/{lineItemsId}", +"httpMethod": "GET", +"id": "displayvideo.advertisers.lineItems.get", +"parameterOrder": [ +"advertiserId", +"lineItemId" +], +"parameters": { +"advertiserId": { +"description": "Required. The ID of the advertiser this line item belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"lineItemId": { +"description": "Required. The ID of the line item to fetch.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}", +"response": { +"$ref": "LineItem" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"list": { +"description": "Lists line items in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, line items with `ENTITY_STATUS_ARCHIVED` will not be included in the results.", +"flatPath": "v4/advertisers/{advertisersId}/lineItems", +"httpMethod": "GET", +"id": "displayvideo.advertisers.lineItems.list", +"parameterOrder": [ +"advertiserId" +], +"parameters": { +"advertiserId": { +"description": "Required. The ID of the advertiser to list line items for.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"filter": { +"description": "Allows filtering by line item fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `insertionOrderId` * `lineItemId` * `lineItemType` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All line items under an insertion order: `insertionOrderId=\"1234\"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` and `LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser: `(entityStatus=\"ENTITY_STATUS_ACTIVE\" OR entityStatus=\"ENTITY_STATUS_PAUSED\") AND lineItemType=\"LINE_ITEM_TYPE_DISPLAY_DEFAULT\"` * All line items with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<=\"2020-11-04T18:54:47Z\"` * All line items with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>=\"2020-11-04T18:54:47Z\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` * `updateTime` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListLineItems` method. If not specified, the first page of results will be returned.", +"location": "query", +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/lineItems", +"response": { +"$ref": "ListLineItemsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"patch": { +"description": "Updates an existing line item. Returns the updated line item if successful. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * BulkEditAssignedTargetingOptions * BulkUpdateLineItems * assignedTargetingOptions.create * assignedTargetingOptions.delete YouTube & Partners line items cannot be created or updated using the API. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.", +"flatPath": "v4/advertisers/{advertisersId}/lineItems/{lineItemsId}", +"httpMethod": "PATCH", +"id": "displayvideo.advertisers.lineItems.patch", +"parameterOrder": [ +"advertiserId", +"lineItemId" +], +"parameters": { +"advertiserId": { +"description": "Output only. The unique ID of the advertiser the line item belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"lineItemId": { +"description": "Output only. The unique ID of the line item. Assigned by the system.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Required. The mask to control which fields to update.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}", +"request": { +"$ref": "LineItem" +}, +"response": { +"$ref": "LineItem" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +} +}, +"resources": { +"targetingTypes": { +"resources": { +"assignedTargetingOptions": { +"methods": { +"create": { +"description": "Assigns a targeting option to a line item. Returns the assigned targeting option if successful. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * lineItems.bulkEditAssignedTargetingOptions * lineItems.bulkUpdate * lineItems.patch * DeleteLineItemAssignedTargetingOption YouTube & Partners line items cannot be created or updated using the API.", +"flatPath": "v4/advertisers/{advertisersId}/lineItems/{lineItemsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions", +"httpMethod": "POST", +"id": "displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.create", +"parameterOrder": [ +"advertiserId", +"lineItemId", +"targetingType" +], +"parameters": { +"advertiserId": { +"description": "Required. The ID of the advertiser the line item belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"lineItemId": { +"description": "Required. The ID of the line item the assigned targeting option will belong to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"targetingType": { +"description": "Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY`", +"enum": [ +"TARGETING_TYPE_UNSPECIFIED", +"TARGETING_TYPE_CHANNEL", +"TARGETING_TYPE_APP_CATEGORY", +"TARGETING_TYPE_APP", +"TARGETING_TYPE_URL", +"TARGETING_TYPE_DAY_AND_TIME", +"TARGETING_TYPE_AGE_RANGE", +"TARGETING_TYPE_REGIONAL_LOCATION_LIST", +"TARGETING_TYPE_PROXIMITY_LOCATION_LIST", +"TARGETING_TYPE_GENDER", +"TARGETING_TYPE_VIDEO_PLAYER_SIZE", +"TARGETING_TYPE_USER_REWARDED_CONTENT", +"TARGETING_TYPE_PARENTAL_STATUS", +"TARGETING_TYPE_CONTENT_INSTREAM_POSITION", +"TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", +"TARGETING_TYPE_DEVICE_TYPE", +"TARGETING_TYPE_AUDIENCE_GROUP", +"TARGETING_TYPE_BROWSER", +"TARGETING_TYPE_HOUSEHOLD_INCOME", +"TARGETING_TYPE_ON_SCREEN_POSITION", +"TARGETING_TYPE_THIRD_PARTY_VERIFIER", +"TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", +"TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", +"TARGETING_TYPE_ENVIRONMENT", +"TARGETING_TYPE_CARRIER_AND_ISP", +"TARGETING_TYPE_OPERATING_SYSTEM", +"TARGETING_TYPE_DEVICE_MAKE_MODEL", +"TARGETING_TYPE_KEYWORD", +"TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", +"TARGETING_TYPE_VIEWABILITY", +"TARGETING_TYPE_CATEGORY", +"TARGETING_TYPE_INVENTORY_SOURCE", +"TARGETING_TYPE_LANGUAGE", +"TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", +"TARGETING_TYPE_GEO_REGION", +"TARGETING_TYPE_INVENTORY_SOURCE_GROUP", +"TARGETING_TYPE_EXCHANGE", +"TARGETING_TYPE_SUB_EXCHANGE", +"TARGETING_TYPE_POI", +"TARGETING_TYPE_BUSINESS_CHAIN", +"TARGETING_TYPE_CONTENT_DURATION", +"TARGETING_TYPE_CONTENT_STREAM_TYPE", +"TARGETING_TYPE_NATIVE_CONTENT_POSITION", +"TARGETING_TYPE_OMID", +"TARGETING_TYPE_AUDIO_CONTENT_TYPE", +"TARGETING_TYPE_CONTENT_GENRE", +"TARGETING_TYPE_YOUTUBE_VIDEO", +"TARGETING_TYPE_YOUTUBE_CHANNEL", +"TARGETING_TYPE_SESSION_POSITION" +], +"enumDescriptions": [ +"Default value when type is not specified or is unknown in this version.", +"Target a channel (a custom group of related websites or apps).", +"Target an app category (for example, education or puzzle games).", +"Target a specific app (for example, Angry Birds).", +"Target a specific url (for example, quora.com).", +"Target ads during a chosen time period on a specific day.", +"Target ads to a specific age range (for example, 18-24).", +"Target ads to the specified regions on a regional location list.", +"Target ads to the specified points of interest on a proximity location list.", +"Target ads to a specific gender (for example, female or male).", +"Target a specific video player size for video ads.", +"Target user rewarded content for video ads.", +"Target ads to a specific parental status (for example, parent or not a parent).", +"Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", +"Target ads in a specific content outstream position.", +"Target ads to a specific device type (for example, tablet or connected TV).", +"Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", +"Target ads to specific web browsers (for example, Chrome).", +"Target ads to a specific household income range (for example, top 10%).", +"Target ads in a specific on screen position.", +"Filter web sites through third party verification (for example, IAS or DoubleVerify).", +"Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", +"Filter website content by sensitive categories (for example, adult).", +"Target ads to a specific environment (for example, web or app).", +"Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", +"Target ads to a specific operating system (for example, macOS).", +"Target ads to a specific device make or model (for example, Roku or Samsung).", +"Target ads to a specific keyword (for example, dog or retriever).", +"Target ads to a specific negative keyword list.", +"Target ads to a specific viewability (for example, 80% viewable).", +"Target ads to a specific content category (for example, arts & entertainment).", +"Purchase impressions from specific deals and auction packages.", +"Target ads to a specific language (for example, English or Japanese).", +"Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", +"Target ads to a specific regional location (for example, a city or state).", +"Purchase impressions from a group of deals and auction packages.", +"Purchase impressions from specific exchanges.", +"Purchase impressions from specific sub-exchanges.", +"Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", +"Target ads around locations of a business chain within a specific geo region.", +"Target ads to a specific video content duration.", +"Target ads to a specific video content stream type.", +"Target ads to a specific native content position.", +"Target ads in an Open Measurement enabled inventory.", +"Target ads to a specific audio content type.", +"Target ads to a specific content genre.", +"Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", +"Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", +"Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." +], +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions", +"request": { +"$ref": "AssignedTargetingOption" +}, +"response": { +"$ref": "AssignedTargetingOption" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"delete": { +"description": "Deletes an assigned targeting option from a line item. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * lineItems.bulkEditAssignedTargetingOptions * lineItems.bulkUpdate * lineItems.patch * CreateLineItemAssignedTargetingOption YouTube & Partners line items cannot be created or updated using the API.", +"flatPath": "v4/advertisers/{advertisersId}/lineItems/{lineItemsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}", +"httpMethod": "DELETE", +"id": "displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.delete", +"parameterOrder": [ +"advertiserId", +"lineItemId", +"targetingType", +"assignedTargetingOptionId" +], +"parameters": { +"advertiserId": { +"description": "Required. The ID of the advertiser the line item belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"assignedTargetingOptionId": { +"description": "Required. The ID of the assigned targeting option to delete.", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"lineItemId": { +"description": "Required. The ID of the line item the assigned targeting option belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"targetingType": { +"description": "Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY`", +"enum": [ +"TARGETING_TYPE_UNSPECIFIED", +"TARGETING_TYPE_CHANNEL", +"TARGETING_TYPE_APP_CATEGORY", +"TARGETING_TYPE_APP", +"TARGETING_TYPE_URL", +"TARGETING_TYPE_DAY_AND_TIME", +"TARGETING_TYPE_AGE_RANGE", +"TARGETING_TYPE_REGIONAL_LOCATION_LIST", +"TARGETING_TYPE_PROXIMITY_LOCATION_LIST", +"TARGETING_TYPE_GENDER", +"TARGETING_TYPE_VIDEO_PLAYER_SIZE", +"TARGETING_TYPE_USER_REWARDED_CONTENT", +"TARGETING_TYPE_PARENTAL_STATUS", +"TARGETING_TYPE_CONTENT_INSTREAM_POSITION", +"TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", +"TARGETING_TYPE_DEVICE_TYPE", +"TARGETING_TYPE_AUDIENCE_GROUP", +"TARGETING_TYPE_BROWSER", +"TARGETING_TYPE_HOUSEHOLD_INCOME", +"TARGETING_TYPE_ON_SCREEN_POSITION", +"TARGETING_TYPE_THIRD_PARTY_VERIFIER", +"TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", +"TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", +"TARGETING_TYPE_ENVIRONMENT", +"TARGETING_TYPE_CARRIER_AND_ISP", +"TARGETING_TYPE_OPERATING_SYSTEM", +"TARGETING_TYPE_DEVICE_MAKE_MODEL", +"TARGETING_TYPE_KEYWORD", +"TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", +"TARGETING_TYPE_VIEWABILITY", +"TARGETING_TYPE_CATEGORY", +"TARGETING_TYPE_INVENTORY_SOURCE", +"TARGETING_TYPE_LANGUAGE", +"TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", +"TARGETING_TYPE_GEO_REGION", +"TARGETING_TYPE_INVENTORY_SOURCE_GROUP", +"TARGETING_TYPE_EXCHANGE", +"TARGETING_TYPE_SUB_EXCHANGE", +"TARGETING_TYPE_POI", +"TARGETING_TYPE_BUSINESS_CHAIN", +"TARGETING_TYPE_CONTENT_DURATION", +"TARGETING_TYPE_CONTENT_STREAM_TYPE", +"TARGETING_TYPE_NATIVE_CONTENT_POSITION", +"TARGETING_TYPE_OMID", +"TARGETING_TYPE_AUDIO_CONTENT_TYPE", +"TARGETING_TYPE_CONTENT_GENRE", +"TARGETING_TYPE_YOUTUBE_VIDEO", +"TARGETING_TYPE_YOUTUBE_CHANNEL", +"TARGETING_TYPE_SESSION_POSITION" +], +"enumDescriptions": [ +"Default value when type is not specified or is unknown in this version.", +"Target a channel (a custom group of related websites or apps).", +"Target an app category (for example, education or puzzle games).", +"Target a specific app (for example, Angry Birds).", +"Target a specific url (for example, quora.com).", +"Target ads during a chosen time period on a specific day.", +"Target ads to a specific age range (for example, 18-24).", +"Target ads to the specified regions on a regional location list.", +"Target ads to the specified points of interest on a proximity location list.", +"Target ads to a specific gender (for example, female or male).", +"Target a specific video player size for video ads.", +"Target user rewarded content for video ads.", +"Target ads to a specific parental status (for example, parent or not a parent).", +"Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", +"Target ads in a specific content outstream position.", +"Target ads to a specific device type (for example, tablet or connected TV).", +"Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", +"Target ads to specific web browsers (for example, Chrome).", +"Target ads to a specific household income range (for example, top 10%).", +"Target ads in a specific on screen position.", +"Filter web sites through third party verification (for example, IAS or DoubleVerify).", +"Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", +"Filter website content by sensitive categories (for example, adult).", +"Target ads to a specific environment (for example, web or app).", +"Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", +"Target ads to a specific operating system (for example, macOS).", +"Target ads to a specific device make or model (for example, Roku or Samsung).", +"Target ads to a specific keyword (for example, dog or retriever).", +"Target ads to a specific negative keyword list.", +"Target ads to a specific viewability (for example, 80% viewable).", +"Target ads to a specific content category (for example, arts & entertainment).", +"Purchase impressions from specific deals and auction packages.", +"Target ads to a specific language (for example, English or Japanese).", +"Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", +"Target ads to a specific regional location (for example, a city or state).", +"Purchase impressions from a group of deals and auction packages.", +"Purchase impressions from specific exchanges.", +"Purchase impressions from specific sub-exchanges.", +"Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", +"Target ads around locations of a business chain within a specific geo region.", +"Target ads to a specific video content duration.", +"Target ads to a specific video content stream type.", +"Target ads to a specific native content position.", +"Target ads in an Open Measurement enabled inventory.", +"Target ads to a specific audio content type.", +"Target ads to a specific content genre.", +"Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", +"Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", +"Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." +], +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"get": { +"description": "Gets a single targeting option assigned to a line item.", +"flatPath": "v4/advertisers/{advertisersId}/lineItems/{lineItemsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}", +"httpMethod": "GET", +"id": "displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.get", +"parameterOrder": [ +"advertiserId", +"lineItemId", +"targetingType", +"assignedTargetingOptionId" +], +"parameters": { +"advertiserId": { +"description": "Required. The ID of the advertiser the line item belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"assignedTargetingOptionId": { +"description": "Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested.", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"lineItemId": { +"description": "Required. The ID of the line item the assigned targeting option belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"targetingType": { +"description": "Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_YOUTUBE_CHANNEL` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) * `TARGETING_TYPE_YOUTUBE_VIDEO` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items)", +"enum": [ +"TARGETING_TYPE_UNSPECIFIED", +"TARGETING_TYPE_CHANNEL", +"TARGETING_TYPE_APP_CATEGORY", +"TARGETING_TYPE_APP", +"TARGETING_TYPE_URL", +"TARGETING_TYPE_DAY_AND_TIME", +"TARGETING_TYPE_AGE_RANGE", +"TARGETING_TYPE_REGIONAL_LOCATION_LIST", +"TARGETING_TYPE_PROXIMITY_LOCATION_LIST", +"TARGETING_TYPE_GENDER", +"TARGETING_TYPE_VIDEO_PLAYER_SIZE", +"TARGETING_TYPE_USER_REWARDED_CONTENT", +"TARGETING_TYPE_PARENTAL_STATUS", +"TARGETING_TYPE_CONTENT_INSTREAM_POSITION", +"TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", +"TARGETING_TYPE_DEVICE_TYPE", +"TARGETING_TYPE_AUDIENCE_GROUP", +"TARGETING_TYPE_BROWSER", +"TARGETING_TYPE_HOUSEHOLD_INCOME", +"TARGETING_TYPE_ON_SCREEN_POSITION", +"TARGETING_TYPE_THIRD_PARTY_VERIFIER", +"TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", +"TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", +"TARGETING_TYPE_ENVIRONMENT", +"TARGETING_TYPE_CARRIER_AND_ISP", +"TARGETING_TYPE_OPERATING_SYSTEM", +"TARGETING_TYPE_DEVICE_MAKE_MODEL", +"TARGETING_TYPE_KEYWORD", +"TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", +"TARGETING_TYPE_VIEWABILITY", +"TARGETING_TYPE_CATEGORY", +"TARGETING_TYPE_INVENTORY_SOURCE", +"TARGETING_TYPE_LANGUAGE", +"TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", +"TARGETING_TYPE_GEO_REGION", +"TARGETING_TYPE_INVENTORY_SOURCE_GROUP", +"TARGETING_TYPE_EXCHANGE", +"TARGETING_TYPE_SUB_EXCHANGE", +"TARGETING_TYPE_POI", +"TARGETING_TYPE_BUSINESS_CHAIN", +"TARGETING_TYPE_CONTENT_DURATION", +"TARGETING_TYPE_CONTENT_STREAM_TYPE", +"TARGETING_TYPE_NATIVE_CONTENT_POSITION", +"TARGETING_TYPE_OMID", +"TARGETING_TYPE_AUDIO_CONTENT_TYPE", +"TARGETING_TYPE_CONTENT_GENRE", +"TARGETING_TYPE_YOUTUBE_VIDEO", +"TARGETING_TYPE_YOUTUBE_CHANNEL", +"TARGETING_TYPE_SESSION_POSITION" +], +"enumDescriptions": [ +"Default value when type is not specified or is unknown in this version.", +"Target a channel (a custom group of related websites or apps).", +"Target an app category (for example, education or puzzle games).", +"Target a specific app (for example, Angry Birds).", +"Target a specific url (for example, quora.com).", +"Target ads during a chosen time period on a specific day.", +"Target ads to a specific age range (for example, 18-24).", +"Target ads to the specified regions on a regional location list.", +"Target ads to the specified points of interest on a proximity location list.", +"Target ads to a specific gender (for example, female or male).", +"Target a specific video player size for video ads.", +"Target user rewarded content for video ads.", +"Target ads to a specific parental status (for example, parent or not a parent).", +"Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", +"Target ads in a specific content outstream position.", +"Target ads to a specific device type (for example, tablet or connected TV).", +"Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", +"Target ads to specific web browsers (for example, Chrome).", +"Target ads to a specific household income range (for example, top 10%).", +"Target ads in a specific on screen position.", +"Filter web sites through third party verification (for example, IAS or DoubleVerify).", +"Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", +"Filter website content by sensitive categories (for example, adult).", +"Target ads to a specific environment (for example, web or app).", +"Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", +"Target ads to a specific operating system (for example, macOS).", +"Target ads to a specific device make or model (for example, Roku or Samsung).", +"Target ads to a specific keyword (for example, dog or retriever).", +"Target ads to a specific negative keyword list.", +"Target ads to a specific viewability (for example, 80% viewable).", +"Target ads to a specific content category (for example, arts & entertainment).", +"Purchase impressions from specific deals and auction packages.", +"Target ads to a specific language (for example, English or Japanese).", +"Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", +"Target ads to a specific regional location (for example, a city or state).", +"Purchase impressions from a group of deals and auction packages.", +"Purchase impressions from specific exchanges.", +"Purchase impressions from specific sub-exchanges.", +"Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", +"Target ads around locations of a business chain within a specific geo region.", +"Target ads to a specific video content duration.", +"Target ads to a specific video content stream type.", +"Target ads to a specific native content position.", +"Target ads in an Open Measurement enabled inventory.", +"Target ads to a specific audio content type.", +"Target ads to a specific content genre.", +"Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", +"Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", +"Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." +], +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}", +"response": { +"$ref": "AssignedTargetingOption" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"list": { +"description": "Lists the targeting options assigned to a line item.", +"flatPath": "v4/advertisers/{advertisersId}/lineItems/{lineItemsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions", +"httpMethod": "GET", +"id": "displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.list", +"parameterOrder": [ +"advertiserId", +"lineItemId", +"targetingType" +], +"parameters": { +"advertiserId": { +"description": "Required. The ID of the advertiser the line item belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"filter": { +"description": "Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` * `inheritance` Examples: * `AssignedTargetingOption` resources with ID 1 or 2: `assignedTargetingOptionId=\"1\" OR assignedTargetingOptionId=\"2\"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance=\"NOT_INHERITED\" OR inheritance=\"INHERITED_FROM_PARTNER\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", +"location": "query", +"type": "string" +}, +"lineItemId": { +"description": "Required. The ID of the line item to list assigned targeting options for.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"orderBy": { +"description": "Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `assignedTargetingOptionId desc`.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListLineItemAssignedTargetingOptions` method. If not specified, the first page of results will be returned.", +"location": "query", +"type": "string" +}, +"targetingType": { +"description": "Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_YOUTUBE_CHANNEL` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) * `TARGETING_TYPE_YOUTUBE_VIDEO` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items)", +"enum": [ +"TARGETING_TYPE_UNSPECIFIED", +"TARGETING_TYPE_CHANNEL", +"TARGETING_TYPE_APP_CATEGORY", +"TARGETING_TYPE_APP", +"TARGETING_TYPE_URL", +"TARGETING_TYPE_DAY_AND_TIME", +"TARGETING_TYPE_AGE_RANGE", +"TARGETING_TYPE_REGIONAL_LOCATION_LIST", +"TARGETING_TYPE_PROXIMITY_LOCATION_LIST", +"TARGETING_TYPE_GENDER", +"TARGETING_TYPE_VIDEO_PLAYER_SIZE", +"TARGETING_TYPE_USER_REWARDED_CONTENT", +"TARGETING_TYPE_PARENTAL_STATUS", +"TARGETING_TYPE_CONTENT_INSTREAM_POSITION", +"TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", +"TARGETING_TYPE_DEVICE_TYPE", +"TARGETING_TYPE_AUDIENCE_GROUP", +"TARGETING_TYPE_BROWSER", +"TARGETING_TYPE_HOUSEHOLD_INCOME", +"TARGETING_TYPE_ON_SCREEN_POSITION", +"TARGETING_TYPE_THIRD_PARTY_VERIFIER", +"TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", +"TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", +"TARGETING_TYPE_ENVIRONMENT", +"TARGETING_TYPE_CARRIER_AND_ISP", +"TARGETING_TYPE_OPERATING_SYSTEM", +"TARGETING_TYPE_DEVICE_MAKE_MODEL", +"TARGETING_TYPE_KEYWORD", +"TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", +"TARGETING_TYPE_VIEWABILITY", +"TARGETING_TYPE_CATEGORY", +"TARGETING_TYPE_INVENTORY_SOURCE", +"TARGETING_TYPE_LANGUAGE", +"TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", +"TARGETING_TYPE_GEO_REGION", +"TARGETING_TYPE_INVENTORY_SOURCE_GROUP", +"TARGETING_TYPE_EXCHANGE", +"TARGETING_TYPE_SUB_EXCHANGE", +"TARGETING_TYPE_POI", +"TARGETING_TYPE_BUSINESS_CHAIN", +"TARGETING_TYPE_CONTENT_DURATION", +"TARGETING_TYPE_CONTENT_STREAM_TYPE", +"TARGETING_TYPE_NATIVE_CONTENT_POSITION", +"TARGETING_TYPE_OMID", +"TARGETING_TYPE_AUDIO_CONTENT_TYPE", +"TARGETING_TYPE_CONTENT_GENRE", +"TARGETING_TYPE_YOUTUBE_VIDEO", +"TARGETING_TYPE_YOUTUBE_CHANNEL", +"TARGETING_TYPE_SESSION_POSITION" +], +"enumDescriptions": [ +"Default value when type is not specified or is unknown in this version.", +"Target a channel (a custom group of related websites or apps).", +"Target an app category (for example, education or puzzle games).", +"Target a specific app (for example, Angry Birds).", +"Target a specific url (for example, quora.com).", +"Target ads during a chosen time period on a specific day.", +"Target ads to a specific age range (for example, 18-24).", +"Target ads to the specified regions on a regional location list.", +"Target ads to the specified points of interest on a proximity location list.", +"Target ads to a specific gender (for example, female or male).", +"Target a specific video player size for video ads.", +"Target user rewarded content for video ads.", +"Target ads to a specific parental status (for example, parent or not a parent).", +"Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", +"Target ads in a specific content outstream position.", +"Target ads to a specific device type (for example, tablet or connected TV).", +"Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", +"Target ads to specific web browsers (for example, Chrome).", +"Target ads to a specific household income range (for example, top 10%).", +"Target ads in a specific on screen position.", +"Filter web sites through third party verification (for example, IAS or DoubleVerify).", +"Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", +"Filter website content by sensitive categories (for example, adult).", +"Target ads to a specific environment (for example, web or app).", +"Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", +"Target ads to a specific operating system (for example, macOS).", +"Target ads to a specific device make or model (for example, Roku or Samsung).", +"Target ads to a specific keyword (for example, dog or retriever).", +"Target ads to a specific negative keyword list.", +"Target ads to a specific viewability (for example, 80% viewable).", +"Target ads to a specific content category (for example, arts & entertainment).", +"Purchase impressions from specific deals and auction packages.", +"Target ads to a specific language (for example, English or Japanese).", +"Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", +"Target ads to a specific regional location (for example, a city or state).", +"Purchase impressions from a group of deals and auction packages.", +"Purchase impressions from specific exchanges.", +"Purchase impressions from specific sub-exchanges.", +"Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", +"Target ads around locations of a business chain within a specific geo region.", +"Target ads to a specific video content duration.", +"Target ads to a specific video content stream type.", +"Target ads to a specific native content position.", +"Target ads in an Open Measurement enabled inventory.", +"Target ads to a specific audio content type.", +"Target ads to a specific content genre.", +"Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", +"Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", +"Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." +], +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions", +"response": { +"$ref": "ListLineItemAssignedTargetingOptionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +} +} +} +} +} +} +}, +"locationLists": { +"methods": { +"create": { +"description": "Creates a new location list. Returns the newly created location list if successful.", +"flatPath": "v4/advertisers/{advertisersId}/locationLists", +"httpMethod": "POST", +"id": "displayvideo.advertisers.locationLists.create", +"parameterOrder": [ +"advertiserId" +], +"parameters": { +"advertiserId": { +"description": "Required. The ID of the DV360 advertiser to which the location list belongs.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/locationLists", +"request": { +"$ref": "LocationList" +}, +"response": { +"$ref": "LocationList" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"get": { +"description": "Gets a location list.", +"flatPath": "v4/advertisers/{advertisersId}/locationLists/{locationListsId}", +"httpMethod": "GET", +"id": "displayvideo.advertisers.locationLists.get", +"parameterOrder": [ +"advertiserId", +"locationListId" +], +"parameters": { +"advertiserId": { +"description": "Required. The ID of the DV360 advertiser to which the fetched location list belongs.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"locationListId": { +"description": "Required. The ID of the location list to fetch.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/locationLists/{+locationListId}", +"response": { +"$ref": "LocationList" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"list": { +"description": "Lists location lists based on a given advertiser id.", +"flatPath": "v4/advertisers/{advertisersId}/locationLists", +"httpMethod": "GET", +"id": "displayvideo.advertisers.locationLists.list", +"parameterOrder": [ +"advertiserId" +], +"parameters": { +"advertiserId": { +"description": "Required. The ID of the DV360 advertiser to which the fetched location lists belong.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"filter": { +"description": "Allows filtering by location list fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `locationType` Examples: * All regional location list: `locationType=\"TARGETING_LOCATION_TYPE_REGIONAL\"` * All proximity location list: `locationType=\"TARGETING_LOCATION_TYPE_PROXIMITY\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Field by which to sort the list. Acceptable values are: * `locationListId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Requested page size. Must be between `1` and `200`. Defaults to `100` if not set. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListLocationLists` method. If not specified, the first page of results will be returned.", +"location": "query", +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/locationLists", +"response": { +"$ref": "ListLocationListsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"patch": { +"description": "Updates a location list. Returns the updated location list if successful.", +"flatPath": "v4/advertisers/{advertisersId}/locationLists/{locationListId}", +"httpMethod": "PATCH", +"id": "displayvideo.advertisers.locationLists.patch", +"parameterOrder": [ +"advertiserId", +"locationListId" +], +"parameters": { +"advertiserId": { +"description": "Required. The ID of the DV360 advertiser to which the location lists belongs.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"locationListId": { +"description": "Output only. The unique ID of the location list. Assigned by the system.", +"format": "int64", +"location": "path", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Required. The mask to control which fields to update.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/locationLists/{locationListId}", +"request": { +"$ref": "LocationList" +}, +"response": { +"$ref": "LocationList" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +} +}, +"resources": { +"assignedLocations": { +"methods": { +"bulkEdit": { +"description": "Bulk edits multiple assignments between locations and a single location list. The operation will delete the assigned locations provided in deletedAssignedLocations and then create the assigned locations provided in createdAssignedLocations.", +"flatPath": "v4/advertisers/{advertiserId}/locationLists/{locationListsId}/assignedLocations:bulkEdit", +"httpMethod": "POST", +"id": "displayvideo.advertisers.locationLists.assignedLocations.bulkEdit", +"parameterOrder": [ +"advertiserId", +"locationListId" +], +"parameters": { +"advertiserId": { +"description": "Required. The ID of the DV360 advertiser to which the location list belongs.", +"format": "int64", +"location": "path", +"required": true, +"type": "string" +}, +"locationListId": { +"description": "Required. The ID of the location list to which these assignments are assigned.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{advertiserId}/locationLists/{+locationListId}/assignedLocations:bulkEdit", +"request": { +"$ref": "BulkEditAssignedLocationsRequest" +}, +"response": { +"$ref": "BulkEditAssignedLocationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"create": { +"description": "Creates an assignment between a location and a location list.", +"flatPath": "v4/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations", +"httpMethod": "POST", +"id": "displayvideo.advertisers.locationLists.assignedLocations.create", +"parameterOrder": [ +"advertiserId", +"locationListId" +], +"parameters": { +"advertiserId": { +"description": "Required. The ID of the DV360 advertiser to which the location list belongs.", +"format": "int64", +"location": "path", +"required": true, +"type": "string" +}, +"locationListId": { +"description": "Required. The ID of the location list for which the assignment will be created.", +"format": "int64", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations", +"request": { +"$ref": "AssignedLocation" +}, +"response": { +"$ref": "AssignedLocation" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"delete": { +"description": "Deletes the assignment between a location and a location list.", +"flatPath": "v4/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations/{assignedLocationsId}", +"httpMethod": "DELETE", +"id": "displayvideo.advertisers.locationLists.assignedLocations.delete", +"parameterOrder": [ +"advertiserId", +"locationListId", +"assignedLocationId" +], +"parameters": { +"advertiserId": { +"description": "Required. The ID of the DV360 advertiser to which the location list belongs.", +"format": "int64", +"location": "path", +"required": true, +"type": "string" +}, +"assignedLocationId": { +"description": "Required. The ID of the assigned location to delete.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"locationListId": { +"description": "Required. The ID of the location list to which this assignment is assigned.", +"format": "int64", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations/{+assignedLocationId}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"list": { +"description": "Lists locations assigned to a location list.", +"flatPath": "v4/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations", +"httpMethod": "GET", +"id": "displayvideo.advertisers.locationLists.assignedLocations.list", +"parameterOrder": [ +"advertiserId", +"locationListId" +], +"parameters": { +"advertiserId": { +"description": "Required. The ID of the DV360 advertiser to which the location list belongs.", +"format": "int64", +"location": "path", +"required": true, +"type": "string" +}, +"filter": { +"description": "Allows filtering by location list assignment fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedLocationId` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", +"location": "query", +"type": "string" +}, +"locationListId": { +"description": "Required. The ID of the location list to which these assignments are assigned.", +"format": "int64", +"location": "path", +"required": true, +"type": "string" +}, +"orderBy": { +"description": "Field by which to sort the list. Acceptable values are: * `assignedLocationId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \" desc\" should be added to the field name. Example: `assignedLocationId desc`.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAssignedLocations` method. If not specified, the first page of results will be returned.", +"location": "query", +"type": "string" +} +}, +"path": "v4/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations", +"response": { +"$ref": "ListAssignedLocationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +} +} +} +} +}, +"negativeKeywordLists": { +"methods": { +"create": { +"description": "Creates a new negative keyword list. Returns the newly created negative keyword list if successful.", +"flatPath": "v4/advertisers/{advertisersId}/negativeKeywordLists", +"httpMethod": "POST", +"id": "displayvideo.advertisers.negativeKeywordLists.create", +"parameterOrder": [ +"advertiserId" +], +"parameters": { +"advertiserId": { +"description": "Required. The ID of the DV360 advertiser to which the negative keyword list will belong.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/negativeKeywordLists", +"request": { +"$ref": "NegativeKeywordList" +}, +"response": { +"$ref": "NegativeKeywordList" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"delete": { +"description": "Deletes a negative keyword list given an advertiser ID and a negative keyword list ID.", +"flatPath": "v4/advertisers/{advertisersId}/negativeKeywordLists/{negativeKeywordListsId}", +"httpMethod": "DELETE", +"id": "displayvideo.advertisers.negativeKeywordLists.delete", +"parameterOrder": [ +"advertiserId", +"negativeKeywordListId" +], +"parameters": { +"advertiserId": { +"description": "Required. The ID of the DV360 advertiser to which the negative keyword list belongs.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"negativeKeywordListId": { +"description": "Required. The ID of the negative keyword list to delete.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"get": { +"description": "Gets a negative keyword list given an advertiser ID and a negative keyword list ID.", +"flatPath": "v4/advertisers/{advertisersId}/negativeKeywordLists/{negativeKeywordListsId}", +"httpMethod": "GET", +"id": "displayvideo.advertisers.negativeKeywordLists.get", +"parameterOrder": [ +"advertiserId", +"negativeKeywordListId" +], +"parameters": { +"advertiserId": { +"description": "Required. The ID of the DV360 advertiser to which the fetched negative keyword list belongs.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"negativeKeywordListId": { +"description": "Required. The ID of the negative keyword list to fetch.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}", +"response": { +"$ref": "NegativeKeywordList" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"list": { +"description": "Lists negative keyword lists based on a given advertiser id.", +"flatPath": "v4/advertisers/{advertisersId}/negativeKeywordLists", +"httpMethod": "GET", +"id": "displayvideo.advertisers.negativeKeywordLists.list", +"parameterOrder": [ +"advertiserId" +], +"parameters": { +"advertiserId": { +"description": "Required. The ID of the DV360 advertiser to which the fetched negative keyword lists belong.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "Requested page size. Must be between `1` and `200`. Defaults to `100` if not set. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListNegativeKeywordLists` method. If not specified, the first page of results will be returned.", +"location": "query", +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/negativeKeywordLists", +"response": { +"$ref": "ListNegativeKeywordListsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"patch": { +"description": "Updates a negative keyword list. Returns the updated negative keyword list if successful.", +"flatPath": "v4/advertisers/{advertisersId}/negativeKeywordLists/{negativeKeywordListId}", +"httpMethod": "PATCH", +"id": "displayvideo.advertisers.negativeKeywordLists.patch", +"parameterOrder": [ +"advertiserId", +"negativeKeywordListId" +], +"parameters": { +"advertiserId": { +"description": "Required. The ID of the DV360 advertiser to which the negative keyword list belongs.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"negativeKeywordListId": { +"description": "Output only. The unique ID of the negative keyword list. Assigned by the system.", +"format": "int64", +"location": "path", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Required. The mask to control which fields to update.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/negativeKeywordLists/{negativeKeywordListId}", +"request": { +"$ref": "NegativeKeywordList" +}, +"response": { +"$ref": "NegativeKeywordList" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +} +}, +"resources": { +"negativeKeywords": { +"methods": { +"bulkEdit": { +"description": "Bulk edits negative keywords in a single negative keyword list. The operation will delete the negative keywords provided in BulkEditNegativeKeywordsRequest.deleted_negative_keywords and then create the negative keywords provided in BulkEditNegativeKeywordsRequest.created_negative_keywords. This operation is guaranteed to be atomic and will never result in a partial success or partial failure.", +"flatPath": "v4/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords:bulkEdit", +"httpMethod": "POST", +"id": "displayvideo.advertisers.negativeKeywordLists.negativeKeywords.bulkEdit", +"parameterOrder": [ +"advertiserId", +"negativeKeywordListId" +], +"parameters": { +"advertiserId": { +"description": "Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.", +"format": "int64", +"location": "path", +"required": true, +"type": "string" +}, +"negativeKeywordListId": { +"description": "Required. The ID of the parent negative keyword list to which the negative keywords belong.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords:bulkEdit", +"request": { +"$ref": "BulkEditNegativeKeywordsRequest" +}, +"response": { +"$ref": "BulkEditNegativeKeywordsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"create": { +"description": "Creates a negative keyword in a negative keyword list.", +"flatPath": "v4/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords", +"httpMethod": "POST", +"id": "displayvideo.advertisers.negativeKeywordLists.negativeKeywords.create", +"parameterOrder": [ +"advertiserId", +"negativeKeywordListId" +], +"parameters": { +"advertiserId": { +"description": "Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.", +"format": "int64", +"location": "path", +"required": true, +"type": "string" +}, +"negativeKeywordListId": { +"description": "Required. The ID of the parent negative keyword list in which the negative keyword will be created.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords", +"request": { +"$ref": "NegativeKeyword" +}, +"response": { +"$ref": "NegativeKeyword" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"delete": { +"description": "Deletes a negative keyword from a negative keyword list.", +"flatPath": "v4/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords/{negativeKeywordsId}", +"httpMethod": "DELETE", +"id": "displayvideo.advertisers.negativeKeywordLists.negativeKeywords.delete", +"parameterOrder": [ +"advertiserId", +"negativeKeywordListId", +"keywordValue" +], +"parameters": { +"advertiserId": { +"description": "Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.", +"format": "int64", +"location": "path", +"required": true, +"type": "string" +}, +"keywordValue": { +"description": "Required. The keyword value of the negative keyword to delete.", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"negativeKeywordListId": { +"description": "Required. The ID of the parent negative keyword list to which the negative keyword belongs.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords/{+keywordValue}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"list": { +"description": "Lists negative keywords in a negative keyword list.", +"flatPath": "v4/advertisers/{advertisersId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords", +"httpMethod": "GET", +"id": "displayvideo.advertisers.negativeKeywordLists.negativeKeywords.list", +"parameterOrder": [ +"advertiserId", +"negativeKeywordListId" +], +"parameters": { +"advertiserId": { +"description": "Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"filter": { +"description": "Allows filtering by negative keyword fields. Supported syntax: * Filter expressions for negative keywords can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `keywordValue` Examples: * All negative keywords for which the keyword value contains \"google\": `keywordValue : \"google\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", +"location": "query", +"type": "string" +}, +"negativeKeywordListId": { +"description": "Required. The ID of the parent negative keyword list to which the requested negative keywords belong.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"orderBy": { +"description": "Field by which to sort the list. Acceptable values are: * `keywordValue` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \" desc\" should be added to the field name. Example: `keywordValue desc`.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Requested page size. Must be between `1` and `1000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListNegativeKeywords` method. If not specified, the first page of results will be returned.", +"location": "query", +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords", +"response": { +"$ref": "ListNegativeKeywordsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"replace": { +"description": "Replaces all negative keywords in a single negative keyword list. The operation will replace the keywords in a negative keyword list with keywords provided in ReplaceNegativeKeywordsRequest.new_negative_keywords.", +"flatPath": "v4/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords:replace", +"httpMethod": "POST", +"id": "displayvideo.advertisers.negativeKeywordLists.negativeKeywords.replace", +"parameterOrder": [ +"advertiserId", +"negativeKeywordListId" +], +"parameters": { +"advertiserId": { +"description": "Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.", +"format": "int64", +"location": "path", +"required": true, +"type": "string" +}, +"negativeKeywordListId": { +"description": "Required. The ID of the parent negative keyword list to which the negative keywords belong.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords:replace", +"request": { +"$ref": "ReplaceNegativeKeywordsRequest" +}, +"response": { +"$ref": "ReplaceNegativeKeywordsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +} +} +} +} +}, +"targetingTypes": { +"resources": { +"assignedTargetingOptions": { +"methods": { +"create": { +"description": "Assigns a targeting option to an advertiser. Returns the assigned targeting option if successful.", +"flatPath": "v4/advertisers/{advertisersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions", +"httpMethod": "POST", +"id": "displayvideo.advertisers.targetingTypes.assignedTargetingOptions.create", +"parameterOrder": [ +"advertiserId", +"targetingType" +], +"parameters": { +"advertiserId": { +"description": "Required. The ID of the advertiser.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"targetingType": { +"description": "Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD`", +"enum": [ +"TARGETING_TYPE_UNSPECIFIED", +"TARGETING_TYPE_CHANNEL", +"TARGETING_TYPE_APP_CATEGORY", +"TARGETING_TYPE_APP", +"TARGETING_TYPE_URL", +"TARGETING_TYPE_DAY_AND_TIME", +"TARGETING_TYPE_AGE_RANGE", +"TARGETING_TYPE_REGIONAL_LOCATION_LIST", +"TARGETING_TYPE_PROXIMITY_LOCATION_LIST", +"TARGETING_TYPE_GENDER", +"TARGETING_TYPE_VIDEO_PLAYER_SIZE", +"TARGETING_TYPE_USER_REWARDED_CONTENT", +"TARGETING_TYPE_PARENTAL_STATUS", +"TARGETING_TYPE_CONTENT_INSTREAM_POSITION", +"TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", +"TARGETING_TYPE_DEVICE_TYPE", +"TARGETING_TYPE_AUDIENCE_GROUP", +"TARGETING_TYPE_BROWSER", +"TARGETING_TYPE_HOUSEHOLD_INCOME", +"TARGETING_TYPE_ON_SCREEN_POSITION", +"TARGETING_TYPE_THIRD_PARTY_VERIFIER", +"TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", +"TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", +"TARGETING_TYPE_ENVIRONMENT", +"TARGETING_TYPE_CARRIER_AND_ISP", +"TARGETING_TYPE_OPERATING_SYSTEM", +"TARGETING_TYPE_DEVICE_MAKE_MODEL", +"TARGETING_TYPE_KEYWORD", +"TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", +"TARGETING_TYPE_VIEWABILITY", +"TARGETING_TYPE_CATEGORY", +"TARGETING_TYPE_INVENTORY_SOURCE", +"TARGETING_TYPE_LANGUAGE", +"TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", +"TARGETING_TYPE_GEO_REGION", +"TARGETING_TYPE_INVENTORY_SOURCE_GROUP", +"TARGETING_TYPE_EXCHANGE", +"TARGETING_TYPE_SUB_EXCHANGE", +"TARGETING_TYPE_POI", +"TARGETING_TYPE_BUSINESS_CHAIN", +"TARGETING_TYPE_CONTENT_DURATION", +"TARGETING_TYPE_CONTENT_STREAM_TYPE", +"TARGETING_TYPE_NATIVE_CONTENT_POSITION", +"TARGETING_TYPE_OMID", +"TARGETING_TYPE_AUDIO_CONTENT_TYPE", +"TARGETING_TYPE_CONTENT_GENRE", +"TARGETING_TYPE_YOUTUBE_VIDEO", +"TARGETING_TYPE_YOUTUBE_CHANNEL", +"TARGETING_TYPE_SESSION_POSITION" +], +"enumDescriptions": [ +"Default value when type is not specified or is unknown in this version.", +"Target a channel (a custom group of related websites or apps).", +"Target an app category (for example, education or puzzle games).", +"Target a specific app (for example, Angry Birds).", +"Target a specific url (for example, quora.com).", +"Target ads during a chosen time period on a specific day.", +"Target ads to a specific age range (for example, 18-24).", +"Target ads to the specified regions on a regional location list.", +"Target ads to the specified points of interest on a proximity location list.", +"Target ads to a specific gender (for example, female or male).", +"Target a specific video player size for video ads.", +"Target user rewarded content for video ads.", +"Target ads to a specific parental status (for example, parent or not a parent).", +"Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", +"Target ads in a specific content outstream position.", +"Target ads to a specific device type (for example, tablet or connected TV).", +"Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", +"Target ads to specific web browsers (for example, Chrome).", +"Target ads to a specific household income range (for example, top 10%).", +"Target ads in a specific on screen position.", +"Filter web sites through third party verification (for example, IAS or DoubleVerify).", +"Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", +"Filter website content by sensitive categories (for example, adult).", +"Target ads to a specific environment (for example, web or app).", +"Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", +"Target ads to a specific operating system (for example, macOS).", +"Target ads to a specific device make or model (for example, Roku or Samsung).", +"Target ads to a specific keyword (for example, dog or retriever).", +"Target ads to a specific negative keyword list.", +"Target ads to a specific viewability (for example, 80% viewable).", +"Target ads to a specific content category (for example, arts & entertainment).", +"Purchase impressions from specific deals and auction packages.", +"Target ads to a specific language (for example, English or Japanese).", +"Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", +"Target ads to a specific regional location (for example, a city or state).", +"Purchase impressions from a group of deals and auction packages.", +"Purchase impressions from specific exchanges.", +"Purchase impressions from specific sub-exchanges.", +"Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", +"Target ads around locations of a business chain within a specific geo region.", +"Target ads to a specific video content duration.", +"Target ads to a specific video content stream type.", +"Target ads to a specific native content position.", +"Target ads in an Open Measurement enabled inventory.", +"Target ads to a specific audio content type.", +"Target ads to a specific content genre.", +"Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", +"Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", +"Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." +], +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions", +"request": { +"$ref": "AssignedTargetingOption" +}, +"response": { +"$ref": "AssignedTargetingOption" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"delete": { +"description": "Deletes an assigned targeting option from an advertiser.", +"flatPath": "v4/advertisers/{advertisersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}", +"httpMethod": "DELETE", +"id": "displayvideo.advertisers.targetingTypes.assignedTargetingOptions.delete", +"parameterOrder": [ +"advertiserId", +"targetingType", +"assignedTargetingOptionId" +], +"parameters": { +"advertiserId": { +"description": "Required. The ID of the advertiser.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"assignedTargetingOptionId": { +"description": "Required. The ID of the assigned targeting option to delete.", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"targetingType": { +"description": "Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD`", +"enum": [ +"TARGETING_TYPE_UNSPECIFIED", +"TARGETING_TYPE_CHANNEL", +"TARGETING_TYPE_APP_CATEGORY", +"TARGETING_TYPE_APP", +"TARGETING_TYPE_URL", +"TARGETING_TYPE_DAY_AND_TIME", +"TARGETING_TYPE_AGE_RANGE", +"TARGETING_TYPE_REGIONAL_LOCATION_LIST", +"TARGETING_TYPE_PROXIMITY_LOCATION_LIST", +"TARGETING_TYPE_GENDER", +"TARGETING_TYPE_VIDEO_PLAYER_SIZE", +"TARGETING_TYPE_USER_REWARDED_CONTENT", +"TARGETING_TYPE_PARENTAL_STATUS", +"TARGETING_TYPE_CONTENT_INSTREAM_POSITION", +"TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", +"TARGETING_TYPE_DEVICE_TYPE", +"TARGETING_TYPE_AUDIENCE_GROUP", +"TARGETING_TYPE_BROWSER", +"TARGETING_TYPE_HOUSEHOLD_INCOME", +"TARGETING_TYPE_ON_SCREEN_POSITION", +"TARGETING_TYPE_THIRD_PARTY_VERIFIER", +"TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", +"TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", +"TARGETING_TYPE_ENVIRONMENT", +"TARGETING_TYPE_CARRIER_AND_ISP", +"TARGETING_TYPE_OPERATING_SYSTEM", +"TARGETING_TYPE_DEVICE_MAKE_MODEL", +"TARGETING_TYPE_KEYWORD", +"TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", +"TARGETING_TYPE_VIEWABILITY", +"TARGETING_TYPE_CATEGORY", +"TARGETING_TYPE_INVENTORY_SOURCE", +"TARGETING_TYPE_LANGUAGE", +"TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", +"TARGETING_TYPE_GEO_REGION", +"TARGETING_TYPE_INVENTORY_SOURCE_GROUP", +"TARGETING_TYPE_EXCHANGE", +"TARGETING_TYPE_SUB_EXCHANGE", +"TARGETING_TYPE_POI", +"TARGETING_TYPE_BUSINESS_CHAIN", +"TARGETING_TYPE_CONTENT_DURATION", +"TARGETING_TYPE_CONTENT_STREAM_TYPE", +"TARGETING_TYPE_NATIVE_CONTENT_POSITION", +"TARGETING_TYPE_OMID", +"TARGETING_TYPE_AUDIO_CONTENT_TYPE", +"TARGETING_TYPE_CONTENT_GENRE", +"TARGETING_TYPE_YOUTUBE_VIDEO", +"TARGETING_TYPE_YOUTUBE_CHANNEL", +"TARGETING_TYPE_SESSION_POSITION" +], +"enumDescriptions": [ +"Default value when type is not specified or is unknown in this version.", +"Target a channel (a custom group of related websites or apps).", +"Target an app category (for example, education or puzzle games).", +"Target a specific app (for example, Angry Birds).", +"Target a specific url (for example, quora.com).", +"Target ads during a chosen time period on a specific day.", +"Target ads to a specific age range (for example, 18-24).", +"Target ads to the specified regions on a regional location list.", +"Target ads to the specified points of interest on a proximity location list.", +"Target ads to a specific gender (for example, female or male).", +"Target a specific video player size for video ads.", +"Target user rewarded content for video ads.", +"Target ads to a specific parental status (for example, parent or not a parent).", +"Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", +"Target ads in a specific content outstream position.", +"Target ads to a specific device type (for example, tablet or connected TV).", +"Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", +"Target ads to specific web browsers (for example, Chrome).", +"Target ads to a specific household income range (for example, top 10%).", +"Target ads in a specific on screen position.", +"Filter web sites through third party verification (for example, IAS or DoubleVerify).", +"Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", +"Filter website content by sensitive categories (for example, adult).", +"Target ads to a specific environment (for example, web or app).", +"Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", +"Target ads to a specific operating system (for example, macOS).", +"Target ads to a specific device make or model (for example, Roku or Samsung).", +"Target ads to a specific keyword (for example, dog or retriever).", +"Target ads to a specific negative keyword list.", +"Target ads to a specific viewability (for example, 80% viewable).", +"Target ads to a specific content category (for example, arts & entertainment).", +"Purchase impressions from specific deals and auction packages.", +"Target ads to a specific language (for example, English or Japanese).", +"Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", +"Target ads to a specific regional location (for example, a city or state).", +"Purchase impressions from a group of deals and auction packages.", +"Purchase impressions from specific exchanges.", +"Purchase impressions from specific sub-exchanges.", +"Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", +"Target ads around locations of a business chain within a specific geo region.", +"Target ads to a specific video content duration.", +"Target ads to a specific video content stream type.", +"Target ads to a specific native content position.", +"Target ads in an Open Measurement enabled inventory.", +"Target ads to a specific audio content type.", +"Target ads to a specific content genre.", +"Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", +"Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", +"Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." +], +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"get": { +"description": "Gets a single targeting option assigned to an advertiser.", +"flatPath": "v4/advertisers/{advertisersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}", +"httpMethod": "GET", +"id": "displayvideo.advertisers.targetingTypes.assignedTargetingOptions.get", +"parameterOrder": [ +"advertiserId", +"targetingType", +"assignedTargetingOptionId" +], +"parameters": { +"advertiserId": { +"description": "Required. The ID of the advertiser.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"assignedTargetingOptionId": { +"description": "Required. An identifier unique to the targeting type in this advertiser that identifies the assigned targeting option being requested.", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"targetingType": { +"description": "Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_YOUTUBE_VIDEO` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_KEYWORD`", +"enum": [ +"TARGETING_TYPE_UNSPECIFIED", +"TARGETING_TYPE_CHANNEL", +"TARGETING_TYPE_APP_CATEGORY", +"TARGETING_TYPE_APP", +"TARGETING_TYPE_URL", +"TARGETING_TYPE_DAY_AND_TIME", +"TARGETING_TYPE_AGE_RANGE", +"TARGETING_TYPE_REGIONAL_LOCATION_LIST", +"TARGETING_TYPE_PROXIMITY_LOCATION_LIST", +"TARGETING_TYPE_GENDER", +"TARGETING_TYPE_VIDEO_PLAYER_SIZE", +"TARGETING_TYPE_USER_REWARDED_CONTENT", +"TARGETING_TYPE_PARENTAL_STATUS", +"TARGETING_TYPE_CONTENT_INSTREAM_POSITION", +"TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", +"TARGETING_TYPE_DEVICE_TYPE", +"TARGETING_TYPE_AUDIENCE_GROUP", +"TARGETING_TYPE_BROWSER", +"TARGETING_TYPE_HOUSEHOLD_INCOME", +"TARGETING_TYPE_ON_SCREEN_POSITION", +"TARGETING_TYPE_THIRD_PARTY_VERIFIER", +"TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", +"TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", +"TARGETING_TYPE_ENVIRONMENT", +"TARGETING_TYPE_CARRIER_AND_ISP", +"TARGETING_TYPE_OPERATING_SYSTEM", +"TARGETING_TYPE_DEVICE_MAKE_MODEL", +"TARGETING_TYPE_KEYWORD", +"TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", +"TARGETING_TYPE_VIEWABILITY", +"TARGETING_TYPE_CATEGORY", +"TARGETING_TYPE_INVENTORY_SOURCE", +"TARGETING_TYPE_LANGUAGE", +"TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", +"TARGETING_TYPE_GEO_REGION", +"TARGETING_TYPE_INVENTORY_SOURCE_GROUP", +"TARGETING_TYPE_EXCHANGE", +"TARGETING_TYPE_SUB_EXCHANGE", +"TARGETING_TYPE_POI", +"TARGETING_TYPE_BUSINESS_CHAIN", +"TARGETING_TYPE_CONTENT_DURATION", +"TARGETING_TYPE_CONTENT_STREAM_TYPE", +"TARGETING_TYPE_NATIVE_CONTENT_POSITION", +"TARGETING_TYPE_OMID", +"TARGETING_TYPE_AUDIO_CONTENT_TYPE", +"TARGETING_TYPE_CONTENT_GENRE", +"TARGETING_TYPE_YOUTUBE_VIDEO", +"TARGETING_TYPE_YOUTUBE_CHANNEL", +"TARGETING_TYPE_SESSION_POSITION" +], +"enumDescriptions": [ +"Default value when type is not specified or is unknown in this version.", +"Target a channel (a custom group of related websites or apps).", +"Target an app category (for example, education or puzzle games).", +"Target a specific app (for example, Angry Birds).", +"Target a specific url (for example, quora.com).", +"Target ads during a chosen time period on a specific day.", +"Target ads to a specific age range (for example, 18-24).", +"Target ads to the specified regions on a regional location list.", +"Target ads to the specified points of interest on a proximity location list.", +"Target ads to a specific gender (for example, female or male).", +"Target a specific video player size for video ads.", +"Target user rewarded content for video ads.", +"Target ads to a specific parental status (for example, parent or not a parent).", +"Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", +"Target ads in a specific content outstream position.", +"Target ads to a specific device type (for example, tablet or connected TV).", +"Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", +"Target ads to specific web browsers (for example, Chrome).", +"Target ads to a specific household income range (for example, top 10%).", +"Target ads in a specific on screen position.", +"Filter web sites through third party verification (for example, IAS or DoubleVerify).", +"Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", +"Filter website content by sensitive categories (for example, adult).", +"Target ads to a specific environment (for example, web or app).", +"Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", +"Target ads to a specific operating system (for example, macOS).", +"Target ads to a specific device make or model (for example, Roku or Samsung).", +"Target ads to a specific keyword (for example, dog or retriever).", +"Target ads to a specific negative keyword list.", +"Target ads to a specific viewability (for example, 80% viewable).", +"Target ads to a specific content category (for example, arts & entertainment).", +"Purchase impressions from specific deals and auction packages.", +"Target ads to a specific language (for example, English or Japanese).", +"Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", +"Target ads to a specific regional location (for example, a city or state).", +"Purchase impressions from a group of deals and auction packages.", +"Purchase impressions from specific exchanges.", +"Purchase impressions from specific sub-exchanges.", +"Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", +"Target ads around locations of a business chain within a specific geo region.", +"Target ads to a specific video content duration.", +"Target ads to a specific video content stream type.", +"Target ads to a specific native content position.", +"Target ads in an Open Measurement enabled inventory.", +"Target ads to a specific audio content type.", +"Target ads to a specific content genre.", +"Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", +"Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", +"Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." +], +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}", +"response": { +"$ref": "AssignedTargetingOption" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"list": { +"description": "Lists the targeting options assigned to an advertiser.", +"flatPath": "v4/advertisers/{advertisersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions", +"httpMethod": "GET", +"id": "displayvideo.advertisers.targetingTypes.assignedTargetingOptions.list", +"parameterOrder": [ +"advertiserId", +"targetingType" +], +"parameters": { +"advertiserId": { +"description": "Required. The ID of the advertiser.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"filter": { +"description": "Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` Examples: * `AssignedTargetingOption` with ID 123456: `assignedTargetingOptionId=\"123456\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `assignedTargetingOptionId desc`.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdvertiserAssignedTargetingOptions` method. If not specified, the first page of results will be returned.", +"location": "query", +"type": "string" +}, +"targetingType": { +"description": "Required. Identifies the type of assigned targeting options to list. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_YOUTUBE_VIDEO` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_KEYWORD`", +"enum": [ +"TARGETING_TYPE_UNSPECIFIED", +"TARGETING_TYPE_CHANNEL", +"TARGETING_TYPE_APP_CATEGORY", +"TARGETING_TYPE_APP", +"TARGETING_TYPE_URL", +"TARGETING_TYPE_DAY_AND_TIME", +"TARGETING_TYPE_AGE_RANGE", +"TARGETING_TYPE_REGIONAL_LOCATION_LIST", +"TARGETING_TYPE_PROXIMITY_LOCATION_LIST", +"TARGETING_TYPE_GENDER", +"TARGETING_TYPE_VIDEO_PLAYER_SIZE", +"TARGETING_TYPE_USER_REWARDED_CONTENT", +"TARGETING_TYPE_PARENTAL_STATUS", +"TARGETING_TYPE_CONTENT_INSTREAM_POSITION", +"TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", +"TARGETING_TYPE_DEVICE_TYPE", +"TARGETING_TYPE_AUDIENCE_GROUP", +"TARGETING_TYPE_BROWSER", +"TARGETING_TYPE_HOUSEHOLD_INCOME", +"TARGETING_TYPE_ON_SCREEN_POSITION", +"TARGETING_TYPE_THIRD_PARTY_VERIFIER", +"TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", +"TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", +"TARGETING_TYPE_ENVIRONMENT", +"TARGETING_TYPE_CARRIER_AND_ISP", +"TARGETING_TYPE_OPERATING_SYSTEM", +"TARGETING_TYPE_DEVICE_MAKE_MODEL", +"TARGETING_TYPE_KEYWORD", +"TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", +"TARGETING_TYPE_VIEWABILITY", +"TARGETING_TYPE_CATEGORY", +"TARGETING_TYPE_INVENTORY_SOURCE", +"TARGETING_TYPE_LANGUAGE", +"TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", +"TARGETING_TYPE_GEO_REGION", +"TARGETING_TYPE_INVENTORY_SOURCE_GROUP", +"TARGETING_TYPE_EXCHANGE", +"TARGETING_TYPE_SUB_EXCHANGE", +"TARGETING_TYPE_POI", +"TARGETING_TYPE_BUSINESS_CHAIN", +"TARGETING_TYPE_CONTENT_DURATION", +"TARGETING_TYPE_CONTENT_STREAM_TYPE", +"TARGETING_TYPE_NATIVE_CONTENT_POSITION", +"TARGETING_TYPE_OMID", +"TARGETING_TYPE_AUDIO_CONTENT_TYPE", +"TARGETING_TYPE_CONTENT_GENRE", +"TARGETING_TYPE_YOUTUBE_VIDEO", +"TARGETING_TYPE_YOUTUBE_CHANNEL", +"TARGETING_TYPE_SESSION_POSITION" +], +"enumDescriptions": [ +"Default value when type is not specified or is unknown in this version.", +"Target a channel (a custom group of related websites or apps).", +"Target an app category (for example, education or puzzle games).", +"Target a specific app (for example, Angry Birds).", +"Target a specific url (for example, quora.com).", +"Target ads during a chosen time period on a specific day.", +"Target ads to a specific age range (for example, 18-24).", +"Target ads to the specified regions on a regional location list.", +"Target ads to the specified points of interest on a proximity location list.", +"Target ads to a specific gender (for example, female or male).", +"Target a specific video player size for video ads.", +"Target user rewarded content for video ads.", +"Target ads to a specific parental status (for example, parent or not a parent).", +"Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", +"Target ads in a specific content outstream position.", +"Target ads to a specific device type (for example, tablet or connected TV).", +"Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", +"Target ads to specific web browsers (for example, Chrome).", +"Target ads to a specific household income range (for example, top 10%).", +"Target ads in a specific on screen position.", +"Filter web sites through third party verification (for example, IAS or DoubleVerify).", +"Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", +"Filter website content by sensitive categories (for example, adult).", +"Target ads to a specific environment (for example, web or app).", +"Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", +"Target ads to a specific operating system (for example, macOS).", +"Target ads to a specific device make or model (for example, Roku or Samsung).", +"Target ads to a specific keyword (for example, dog or retriever).", +"Target ads to a specific negative keyword list.", +"Target ads to a specific viewability (for example, 80% viewable).", +"Target ads to a specific content category (for example, arts & entertainment).", +"Purchase impressions from specific deals and auction packages.", +"Target ads to a specific language (for example, English or Japanese).", +"Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", +"Target ads to a specific regional location (for example, a city or state).", +"Purchase impressions from a group of deals and auction packages.", +"Purchase impressions from specific exchanges.", +"Purchase impressions from specific sub-exchanges.", +"Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", +"Target ads around locations of a business chain within a specific geo region.", +"Target ads to a specific video content duration.", +"Target ads to a specific video content stream type.", +"Target ads to a specific native content position.", +"Target ads in an Open Measurement enabled inventory.", +"Target ads to a specific audio content type.", +"Target ads to a specific content genre.", +"Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", +"Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", +"Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." +], +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions", +"response": { +"$ref": "ListAdvertiserAssignedTargetingOptionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +} +} +} +} +} +} +}, +"combinedAudiences": { +"methods": { +"get": { +"description": "Gets a combined audience.", +"flatPath": "v4/combinedAudiences/{combinedAudiencesId}", +"httpMethod": "GET", +"id": "displayvideo.combinedAudiences.get", +"parameterOrder": [ +"combinedAudienceId" +], +"parameters": { +"advertiserId": { +"description": "The ID of the advertiser that has access to the fetched combined audience.", +"format": "int64", +"location": "query", +"type": "string" +}, +"combinedAudienceId": { +"description": "Required. The ID of the combined audience to fetch.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"partnerId": { +"description": "The ID of the partner that has access to the fetched combined audience.", +"format": "int64", +"location": "query", +"type": "string" +} +}, +"path": "v4/combinedAudiences/{+combinedAudienceId}", +"response": { +"$ref": "CombinedAudience" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"list": { +"description": "Lists combined audiences. The order is defined by the order_by parameter.", +"flatPath": "v4/combinedAudiences", +"httpMethod": "GET", +"id": "displayvideo.combinedAudiences.list", +"parameterOrder": [], +"parameters": { +"advertiserId": { +"description": "The ID of the advertiser that has access to the fetched combined audiences.", +"format": "int64", +"location": "query", +"type": "string" +}, +"filter": { +"description": "Allows filtering by combined audience fields. Supported syntax: * Filter expressions for combined audiences can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All combined audiences for which the display name contains \"Google\": `displayName : \"Google\"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Field by which to sort the list. Acceptable values are: * `combinedAudienceId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCombinedAudiences` method. If not specified, the first page of results will be returned.", +"location": "query", +"type": "string" +}, +"partnerId": { +"description": "The ID of the partner that has access to the fetched combined audiences.", +"format": "int64", +"location": "query", +"type": "string" +} +}, +"path": "v4/combinedAudiences", +"response": { +"$ref": "ListCombinedAudiencesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +} +} +}, +"customBiddingAlgorithms": { +"methods": { +"create": { +"description": "Creates a new custom bidding algorithm. Returns the newly created custom bidding algorithm if successful.", +"flatPath": "v4/customBiddingAlgorithms", +"httpMethod": "POST", +"id": "displayvideo.customBiddingAlgorithms.create", +"parameterOrder": [], +"parameters": {}, +"path": "v4/customBiddingAlgorithms", +"request": { +"$ref": "CustomBiddingAlgorithm" +}, +"response": { +"$ref": "CustomBiddingAlgorithm" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"get": { +"description": "Gets a custom bidding algorithm.", +"flatPath": "v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}", +"httpMethod": "GET", +"id": "displayvideo.customBiddingAlgorithms.get", +"parameterOrder": [ +"customBiddingAlgorithmId" +], +"parameters": { +"advertiserId": { +"description": "The ID of the DV360 partner that has access to the custom bidding algorithm.", +"format": "int64", +"location": "query", +"type": "string" +}, +"customBiddingAlgorithmId": { +"description": "Required. The ID of the custom bidding algorithm to fetch.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"partnerId": { +"description": "The ID of the DV360 partner that has access to the custom bidding algorithm.", +"format": "int64", +"location": "query", +"type": "string" +} +}, +"path": "v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}", +"response": { +"$ref": "CustomBiddingAlgorithm" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"list": { +"description": "Lists custom bidding algorithms that are accessible to the current user and can be used in bidding stratgies. The order is defined by the order_by parameter.", +"flatPath": "v4/customBiddingAlgorithms", +"httpMethod": "GET", +"id": "displayvideo.customBiddingAlgorithms.list", +"parameterOrder": [], +"parameters": { +"advertiserId": { +"description": "The ID of the DV360 advertiser that has access to the custom bidding algorithm.", +"format": "int64", +"location": "query", +"type": "string" +}, +"filter": { +"description": "Allows filtering by custom bidding algorithm fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND`. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `customBiddingAlgorithmType` field must use the `EQUALS (=)` operator. * The `displayName` field must use the `HAS (:)` operator. Supported fields: * `customBiddingAlgorithmType` * `displayName` Examples: * All custom bidding algorithms for which the display name contains \"politics\": `displayName:\"politics\"`. * All custom bidding algorithms for which the type is \"SCRIPT_BASED\": `customBiddingAlgorithmType=SCRIPT_BASED` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Field by which to sort the list. Acceptable values are: * `displayName` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCustomBiddingAlgorithms` method. If not specified, the first page of results will be returned.", +"location": "query", +"type": "string" +}, +"partnerId": { +"description": "The ID of the DV360 partner that has access to the custom bidding algorithm.", +"format": "int64", +"location": "query", +"type": "string" +} +}, +"path": "v4/customBiddingAlgorithms", +"response": { +"$ref": "ListCustomBiddingAlgorithmsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"patch": { +"description": "Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful. *Warning*: Starting **April 1, 2025**, requests updating custom bidding algorithms that are assigned to line items will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).", +"flatPath": "v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}", +"httpMethod": "PATCH", +"id": "displayvideo.customBiddingAlgorithms.patch", +"parameterOrder": [ +"customBiddingAlgorithmId" +], +"parameters": { +"customBiddingAlgorithmId": { +"description": "Output only. The unique ID of the custom bidding algorithm. Assigned by the system.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Required. The mask to control which fields to update.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}", +"request": { +"$ref": "CustomBiddingAlgorithm" +}, +"response": { +"$ref": "CustomBiddingAlgorithm" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"uploadRules": { +"description": "Creates a rules reference object for an AlgorithmRules file. The resulting reference object provides a resource path where the AlgorithmRules file should be uploaded. This reference object should be included when creating a new CustomBiddingAlgorithmRules resource.", +"flatPath": "v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}:uploadRules", +"httpMethod": "GET", +"id": "displayvideo.customBiddingAlgorithms.uploadRules", +"parameterOrder": [ +"customBiddingAlgorithmId" +], +"parameters": { +"advertiserId": { +"description": "The ID of the advertiser that owns the parent custom bidding algorithm.", +"format": "int64", +"location": "query", +"type": "string" +}, +"customBiddingAlgorithmId": { +"description": "Required. The ID of the custom bidding algorithm that owns the rules resource.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"partnerId": { +"description": "The ID of the partner that owns the parent custom bidding algorithm.", +"format": "int64", +"location": "query", +"type": "string" +} +}, +"path": "v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}:uploadRules", +"response": { +"$ref": "CustomBiddingAlgorithmRulesRef" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"uploadScript": { +"description": "Creates a custom bidding script reference object for a script file. The resulting reference object provides a resource path to which the script file should be uploaded. This reference object should be included in when creating a new custom bidding script object.", +"flatPath": "v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}:uploadScript", +"httpMethod": "GET", +"id": "displayvideo.customBiddingAlgorithms.uploadScript", +"parameterOrder": [ +"customBiddingAlgorithmId" +], +"parameters": { +"advertiserId": { +"description": "The ID of the advertiser that owns the parent custom bidding algorithm.", +"format": "int64", +"location": "query", +"type": "string" +}, +"customBiddingAlgorithmId": { +"description": "Required. The ID of the custom bidding algorithm owns the script.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"partnerId": { +"description": "The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script.", +"format": "int64", +"location": "query", +"type": "string" +} +}, +"path": "v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}:uploadScript", +"response": { +"$ref": "CustomBiddingScriptRef" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +} +}, +"resources": { +"rules": { +"methods": { +"create": { +"description": "Creates a new rules resource. Returns the newly created rules resource if successful. *Warning*: Starting **April 1, 2025**, requests updating custom bidding algorithms that are assigned to line items will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).", +"flatPath": "v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}/rules", +"httpMethod": "POST", +"id": "displayvideo.customBiddingAlgorithms.rules.create", +"parameterOrder": [ +"customBiddingAlgorithmId" +], +"parameters": { +"advertiserId": { +"description": "The ID of the advertiser that owns the parent custom bidding algorithm.", +"format": "int64", +"location": "query", +"type": "string" +}, +"customBiddingAlgorithmId": { +"description": "Required. The ID of the custom bidding algorithm that owns the rules resource.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"partnerId": { +"description": "The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this rules resource.", +"format": "int64", +"location": "query", +"type": "string" +} +}, +"path": "v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}/rules", +"request": { +"$ref": "CustomBiddingAlgorithmRules" +}, +"response": { +"$ref": "CustomBiddingAlgorithmRules" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"get": { +"description": "Retrieves a rules resource.", +"flatPath": "v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}/rules/{rulesId}", +"httpMethod": "GET", +"id": "displayvideo.customBiddingAlgorithms.rules.get", +"parameterOrder": [ +"customBiddingAlgorithmId", +"customBiddingAlgorithmRulesId" +], +"parameters": { +"advertiserId": { +"description": "The ID of the advertiser that owns the parent custom bidding algorithm.", +"format": "int64", +"location": "query", +"type": "string" +}, +"customBiddingAlgorithmId": { +"description": "Required. The ID of the custom bidding algorithm that owns the rules resource.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"customBiddingAlgorithmRulesId": { +"description": "Required. The ID of the rules resource to fetch.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"partnerId": { +"description": "The ID of the partner that owns the parent custom bidding algorithm.", +"format": "int64", +"location": "query", +"type": "string" +} +}, +"path": "v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}/rules/{+customBiddingAlgorithmRulesId}", +"response": { +"$ref": "CustomBiddingAlgorithmRules" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"list": { +"description": "Lists rules resources that belong to the given algorithm. The order is defined by the order_by parameter.", +"flatPath": "v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}/rules", +"httpMethod": "GET", +"id": "displayvideo.customBiddingAlgorithms.rules.list", +"parameterOrder": [ +"customBiddingAlgorithmId" +], +"parameters": { +"advertiserId": { +"description": "The ID of the advertiser that owns the parent custom bidding algorithm.", +"format": "int64", +"location": "query", +"type": "string" +}, +"customBiddingAlgorithmId": { +"description": "Required. The ID of the custom bidding algorithm that owns the rules resource.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"orderBy": { +"description": "Field by which to sort the list. Acceptable values are: * `createTime desc` (default) The default sorting order is descending. To specify ascending order for a field, the suffix \"desc\" should be removed. Example: `createTime`.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCustomBiddingAlgorithmRules` method. If not specified, the first page of results will be returned.", +"location": "query", +"type": "string" +}, +"partnerId": { +"description": "The ID of the partner that owns the parent custom bidding algorithm.", +"format": "int64", +"location": "query", +"type": "string" +} +}, +"path": "v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}/rules", +"response": { +"$ref": "ListCustomBiddingAlgorithmRulesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +} +} +}, +"scripts": { +"methods": { +"create": { +"description": "Creates a new custom bidding script. Returns the newly created script if successful. *Warning*: Starting **April 1, 2025**, requests updating custom bidding algorithms that are assigned to line items will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).", +"flatPath": "v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}/scripts", +"httpMethod": "POST", +"id": "displayvideo.customBiddingAlgorithms.scripts.create", +"parameterOrder": [ +"customBiddingAlgorithmId" +], +"parameters": { +"advertiserId": { +"description": "The ID of the advertiser that owns the parent custom bidding algorithm.", +"format": "int64", +"location": "query", +"type": "string" +}, +"customBiddingAlgorithmId": { +"description": "Required. The ID of the custom bidding algorithm that owns the script.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"partnerId": { +"description": "The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script.", +"format": "int64", +"location": "query", +"type": "string" +} +}, +"path": "v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}/scripts", +"request": { +"$ref": "CustomBiddingScript" +}, +"response": { +"$ref": "CustomBiddingScript" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"get": { +"description": "Gets a custom bidding script.", +"flatPath": "v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}/scripts/{scriptsId}", +"httpMethod": "GET", +"id": "displayvideo.customBiddingAlgorithms.scripts.get", +"parameterOrder": [ +"customBiddingAlgorithmId", +"customBiddingScriptId" +], +"parameters": { +"advertiserId": { +"description": "The ID of the advertiser that owns the parent custom bidding algorithm.", +"format": "int64", +"location": "query", +"type": "string" +}, +"customBiddingAlgorithmId": { +"description": "Required. The ID of the custom bidding algorithm owns the script.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"customBiddingScriptId": { +"description": "Required. The ID of the custom bidding script to fetch.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"partnerId": { +"description": "The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script.", +"format": "int64", +"location": "query", +"type": "string" +} +}, +"path": "v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}/scripts/{+customBiddingScriptId}", +"response": { +"$ref": "CustomBiddingScript" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"list": { +"description": "Lists custom bidding scripts that belong to the given algorithm. The order is defined by the order_by parameter.", +"flatPath": "v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}/scripts", +"httpMethod": "GET", +"id": "displayvideo.customBiddingAlgorithms.scripts.list", +"parameterOrder": [ +"customBiddingAlgorithmId" +], +"parameters": { +"advertiserId": { +"description": "The ID of the advertiser that owns the parent custom bidding algorithm.", +"format": "int64", +"location": "query", +"type": "string" +}, +"customBiddingAlgorithmId": { +"description": "Required. The ID of the custom bidding algorithm owns the script.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"orderBy": { +"description": "Field by which to sort the list. Acceptable values are: * `createTime desc` (default) The default sorting order is descending. To specify ascending order for a field, the suffix \"desc\" should be removed. Example: `createTime`.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCustomBiddingScripts` method. If not specified, the first page of results will be returned.", +"location": "query", +"type": "string" +}, +"partnerId": { +"description": "The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script.", +"format": "int64", +"location": "query", +"type": "string" +} +}, +"path": "v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}/scripts", +"response": { +"$ref": "ListCustomBiddingScriptsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +} +} +} +} +}, +"customLists": { +"methods": { +"get": { +"description": "Gets a custom list.", +"flatPath": "v4/customLists/{customListsId}", +"httpMethod": "GET", +"id": "displayvideo.customLists.get", +"parameterOrder": [ +"customListId" +], +"parameters": { +"advertiserId": { +"description": "The ID of the DV360 advertiser that has access to the fetched custom lists.", +"format": "int64", +"location": "query", +"type": "string" +}, +"customListId": { +"description": "Required. The ID of the custom list to fetch.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/customLists/{+customListId}", +"response": { +"$ref": "CustomList" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"list": { +"description": "Lists custom lists. The order is defined by the order_by parameter.", +"flatPath": "v4/customLists", +"httpMethod": "GET", +"id": "displayvideo.customLists.list", +"parameterOrder": [], +"parameters": { +"advertiserId": { +"description": "The ID of the DV360 advertiser that has access to the fetched custom lists.", +"format": "int64", +"location": "query", +"type": "string" +}, +"filter": { +"description": "Allows filtering by custom list fields. Supported syntax: * Filter expressions for custom lists can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All custom lists for which the display name contains \"Google\": `displayName:\"Google\"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Field by which to sort the list. Acceptable values are: * `customListId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCustomLists` method. If not specified, the first page of results will be returned.", +"location": "query", +"type": "string" +} +}, +"path": "v4/customLists", +"response": { +"$ref": "ListCustomListsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +} +} +}, +"firstPartyAndPartnerAudiences": { +"methods": { +"create": { +"description": "Creates a FirstPartyAndPartnerAudience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`", +"flatPath": "v4/firstPartyAndPartnerAudiences", +"httpMethod": "POST", +"id": "displayvideo.firstPartyAndPartnerAudiences.create", +"parameterOrder": [], +"parameters": { +"advertiserId": { +"description": "Required. The ID of the advertiser under whom the FirstPartyAndPartnerAudience will be created.", +"format": "int64", +"location": "query", +"type": "string" +} +}, +"path": "v4/firstPartyAndPartnerAudiences", +"request": { +"$ref": "FirstPartyAndPartnerAudience" +}, +"response": { +"$ref": "FirstPartyAndPartnerAudience" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"editCustomerMatchMembers": { +"description": "Updates the member list of a Customer Match audience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`", +"flatPath": "v4/firstPartyAndPartnerAudiences/{firstPartyAndPartnerAudiencesId}:editCustomerMatchMembers", +"httpMethod": "POST", +"id": "displayvideo.firstPartyAndPartnerAudiences.editCustomerMatchMembers", +"parameterOrder": [ +"firstPartyAndPartnerAudienceId" +], +"parameters": { +"firstPartyAndPartnerAudienceId": { +"description": "Required. The ID of the Customer Match FirstPartyAndPartnerAudience whose members will be edited.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/firstPartyAndPartnerAudiences/{+firstPartyAndPartnerAudienceId}:editCustomerMatchMembers", +"request": { +"$ref": "EditCustomerMatchMembersRequest" +}, +"response": { +"$ref": "EditCustomerMatchMembersResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"get": { +"description": "Gets a first party or partner audience.", +"flatPath": "v4/firstPartyAndPartnerAudiences/{firstPartyAndPartnerAudiencesId}", +"httpMethod": "GET", +"id": "displayvideo.firstPartyAndPartnerAudiences.get", +"parameterOrder": [ +"firstPartyAndPartnerAudienceId" +], +"parameters": { +"advertiserId": { +"description": "The ID of the advertiser that has access to the fetched first party and partner audience.", +"format": "int64", +"location": "query", +"type": "string" +}, +"firstPartyAndPartnerAudienceId": { +"description": "Required. The ID of the first party and partner audience to fetch.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"partnerId": { +"description": "The ID of the partner that has access to the fetched first party and partner audience.", +"format": "int64", +"location": "query", +"type": "string" +} +}, +"path": "v4/firstPartyAndPartnerAudiences/{+firstPartyAndPartnerAudienceId}", +"response": { +"$ref": "FirstPartyAndPartnerAudience" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"list": { +"description": "Lists first party and partner audiences. The order is defined by the order_by parameter.", +"flatPath": "v4/firstPartyAndPartnerAudiences", +"httpMethod": "GET", +"id": "displayvideo.firstPartyAndPartnerAudiences.list", +"parameterOrder": [], +"parameters": { +"advertiserId": { +"description": "The ID of the advertiser that has access to the fetched first party and partner audiences.", +"format": "int64", +"location": "query", +"type": "string" +}, +"filter": { +"description": "Optional. Allows filtering by first party and partner audience fields. Supported syntax: * Filter expressions for first party and partner audiences can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All first party and partner audiences for which the display name contains \"Google\": `displayName:\"Google\"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. Field by which to sort the list. Acceptable values are: * `FirstPartyAndPartnerAudienceId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. Requested page size. Must be between `1` and `5000`. If unspecified, this value defaults to `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListFirstPartyAndPartnerAudiences` method. If not specified, the first page of results will be returned.", +"location": "query", +"type": "string" +}, +"partnerId": { +"description": "The ID of the partner that has access to the fetched first party and partner audiences.", +"format": "int64", +"location": "query", +"type": "string" +} +}, +"path": "v4/firstPartyAndPartnerAudiences", +"response": { +"$ref": "ListFirstPartyAndPartnerAudiencesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"patch": { +"description": "Updates an existing FirstPartyAndPartnerAudience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`", +"flatPath": "v4/firstPartyAndPartnerAudiences/{firstPartyAndPartnerAudiencesId}", +"httpMethod": "PATCH", +"id": "displayvideo.firstPartyAndPartnerAudiences.patch", +"parameterOrder": [ +"firstPartyAndPartnerAudienceId" +], +"parameters": { +"advertiserId": { +"description": "Required. The ID of the owner advertiser of the updated FirstPartyAndPartnerAudience.", +"format": "int64", +"location": "query", +"type": "string" +}, +"firstPartyAndPartnerAudienceId": { +"description": "Identifier. The unique ID of the first party and partner audience. Assigned by the system.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Required. The mask to control which fields to update. Updates are only supported for the following fields: * `displayName` * `description` * `membershipDurationDays`", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v4/firstPartyAndPartnerAudiences/{+firstPartyAndPartnerAudienceId}", +"request": { +"$ref": "FirstPartyAndPartnerAudience" +}, +"response": { +"$ref": "FirstPartyAndPartnerAudience" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +} +} +}, +"floodlightGroups": { +"methods": { +"get": { +"description": "Gets a Floodlight group.", +"flatPath": "v4/floodlightGroups/{floodlightGroupsId}", +"httpMethod": "GET", +"id": "displayvideo.floodlightGroups.get", +"parameterOrder": [ +"floodlightGroupId" +], +"parameters": { +"floodlightGroupId": { +"description": "Required. The ID of the Floodlight group to fetch.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"partnerId": { +"description": "Required. The partner context by which the Floodlight group is being accessed.", +"format": "int64", +"location": "query", +"type": "string" +} +}, +"path": "v4/floodlightGroups/{+floodlightGroupId}", +"response": { +"$ref": "FloodlightGroup" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"patch": { +"description": "Updates an existing Floodlight group. Returns the updated Floodlight group if successful.", +"flatPath": "v4/floodlightGroups/{floodlightGroupId}", +"httpMethod": "PATCH", +"id": "displayvideo.floodlightGroups.patch", +"parameterOrder": [ +"floodlightGroupId" +], +"parameters": { +"floodlightGroupId": { +"description": "Output only. The unique ID of the Floodlight group. Assigned by the system.", +"format": "int64", +"location": "path", +"required": true, +"type": "string" +}, +"partnerId": { +"description": "Required. The partner context by which the Floodlight group is being accessed.", +"format": "int64", +"location": "query", +"type": "string" +}, +"updateMask": { +"description": "Required. The mask to control which fields to update.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v4/floodlightGroups/{floodlightGroupId}", +"request": { +"$ref": "FloodlightGroup" +}, +"response": { +"$ref": "FloodlightGroup" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +} +}, +"resources": { +"floodlightActivities": { +"methods": { +"get": { +"description": "Gets a Floodlight activity.", +"flatPath": "v4/floodlightGroups/{floodlightGroupsId}/floodlightActivities/{floodlightActivitiesId}", +"httpMethod": "GET", +"id": "displayvideo.floodlightGroups.floodlightActivities.get", +"parameterOrder": [ +"floodlightGroupId", +"floodlightActivityId" +], +"parameters": { +"floodlightActivityId": { +"description": "Required. The ID of the Floodlight activity to fetch.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"floodlightGroupId": { +"description": "Required. The ID of the parent Floodlight group to which the requested Floodlight activity belongs.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"partnerId": { +"description": "Required. The ID of the partner through which the Floodlight activity is being accessed.", +"format": "int64", +"location": "query", +"type": "string" +} +}, +"path": "v4/floodlightGroups/{+floodlightGroupId}/floodlightActivities/{+floodlightActivityId}", +"response": { +"$ref": "FloodlightActivity" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"list": { +"description": "Lists Floodlight activities in a Floodlight group.", +"flatPath": "v4/floodlightGroups/{floodlightGroupsId}/floodlightActivities", +"httpMethod": "GET", +"id": "displayvideo.floodlightGroups.floodlightActivities.list", +"parameterOrder": [ +"floodlightGroupId" +], +"parameters": { +"floodlightGroupId": { +"description": "Required. The ID of the parent Floodlight group to which the requested Floodlight activities belong.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"orderBy": { +"description": "Optional. Field by which to sort the list. Acceptable values are: * `displayName` (default) * `floodlightActivityId` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListFloodlightActivities` method. If not specified, the first page of results will be returned.", +"location": "query", +"type": "string" +}, +"partnerId": { +"description": "Required. The ID of the partner through which the Floodlight activities are being accessed.", +"format": "int64", +"location": "query", +"type": "string" +} +}, +"path": "v4/floodlightGroups/{+floodlightGroupId}/floodlightActivities", +"response": { +"$ref": "ListFloodlightActivitiesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +} +} +} +} +}, +"googleAudiences": { +"methods": { +"get": { +"description": "Gets a Google audience.", +"flatPath": "v4/googleAudiences/{googleAudiencesId}", +"httpMethod": "GET", +"id": "displayvideo.googleAudiences.get", +"parameterOrder": [ +"googleAudienceId" +], +"parameters": { +"advertiserId": { +"description": "The ID of the advertiser that has access to the fetched Google audience.", +"format": "int64", +"location": "query", +"type": "string" +}, +"googleAudienceId": { +"description": "Required. The ID of the Google audience to fetch.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"partnerId": { +"description": "The ID of the partner that has access to the fetched Google audience.", +"format": "int64", +"location": "query", +"type": "string" +} +}, +"path": "v4/googleAudiences/{+googleAudienceId}", +"response": { +"$ref": "GoogleAudience" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"list": { +"description": "Lists Google audiences. The order is defined by the order_by parameter.", +"flatPath": "v4/googleAudiences", +"httpMethod": "GET", +"id": "displayvideo.googleAudiences.list", +"parameterOrder": [], +"parameters": { +"advertiserId": { +"description": "The ID of the advertiser that has access to the fetched Google audiences.", +"format": "int64", +"location": "query", +"type": "string" +}, +"filter": { +"description": "Allows filtering by Google audience fields. Supported syntax: * Filter expressions for Google audiences can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All Google audiences for which the display name contains \"Google\": `displayName:\"Google\"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Field by which to sort the list. Acceptable values are: * `googleAudienceId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListGoogleAudiences` method. If not specified, the first page of results will be returned.", +"location": "query", +"type": "string" +}, +"partnerId": { +"description": "The ID of the partner that has access to the fetched Google audiences.", +"format": "int64", +"location": "query", +"type": "string" +} +}, +"path": "v4/googleAudiences", +"response": { +"$ref": "ListGoogleAudiencesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +} +} +}, +"guaranteedOrders": { +"methods": { +"create": { +"description": "Creates a new guaranteed order. Returns the newly created guaranteed order if successful.", +"flatPath": "v4/guaranteedOrders", +"httpMethod": "POST", +"id": "displayvideo.guaranteedOrders.create", +"parameterOrder": [], +"parameters": { +"advertiserId": { +"description": "The ID of the advertiser that the request is being made within.", +"format": "int64", +"location": "query", +"type": "string" +}, +"partnerId": { +"description": "The ID of the partner that the request is being made within.", +"format": "int64", +"location": "query", +"type": "string" +} +}, +"path": "v4/guaranteedOrders", +"request": { +"$ref": "GuaranteedOrder" +}, +"response": { +"$ref": "GuaranteedOrder" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"editGuaranteedOrderReadAccessors": { +"description": "Edits read advertisers of a guaranteed order.", +"flatPath": "v4/guaranteedOrders/{guaranteedOrdersId}:editGuaranteedOrderReadAccessors", +"httpMethod": "POST", +"id": "displayvideo.guaranteedOrders.editGuaranteedOrderReadAccessors", +"parameterOrder": [ +"guaranteedOrderId" +], +"parameters": { +"guaranteedOrderId": { +"description": "Required. The ID of the guaranteed order to edit. The ID is of the format `{exchange}-{legacy_guaranteed_order_id}`", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/guaranteedOrders/{+guaranteedOrderId}:editGuaranteedOrderReadAccessors", +"request": { +"$ref": "EditGuaranteedOrderReadAccessorsRequest" +}, +"response": { +"$ref": "EditGuaranteedOrderReadAccessorsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"get": { +"description": "Gets a guaranteed order.", +"flatPath": "v4/guaranteedOrders/{guaranteedOrdersId}", +"httpMethod": "GET", +"id": "displayvideo.guaranteedOrders.get", +"parameterOrder": [ +"guaranteedOrderId" +], +"parameters": { +"advertiserId": { +"description": "The ID of the advertiser that has access to the guaranteed order.", +"format": "int64", +"location": "query", +"type": "string" +}, +"guaranteedOrderId": { +"description": "Required. The ID of the guaranteed order to fetch. The ID is of the format `{exchange}-{legacy_guaranteed_order_id}`", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"partnerId": { +"description": "The ID of the partner that has access to the guaranteed order.", +"format": "int64", +"location": "query", +"type": "string" +} +}, +"path": "v4/guaranteedOrders/{+guaranteedOrderId}", +"response": { +"$ref": "GuaranteedOrder" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"list": { +"description": "Lists guaranteed orders that are accessible to the current user. The order is defined by the order_by parameter. If a filter by entity_status is not specified, guaranteed orders with entity status `ENTITY_STATUS_ARCHIVED` will not be included in the results.", +"flatPath": "v4/guaranteedOrders", +"httpMethod": "GET", +"id": "displayvideo.guaranteedOrders.list", +"parameterOrder": [], +"parameters": { +"advertiserId": { +"description": "The ID of the advertiser that has access to the guaranteed order.", +"format": "int64", +"location": "query", +"type": "string" +}, +"filter": { +"description": "Allows filtering by guaranteed order fields. * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `guaranteed_order_id` * `exchange` * `display_name` * `status.entityStatus` Examples: * All active guaranteed orders: `status.entityStatus=\"ENTITY_STATUS_ACTIVE\"` * Guaranteed orders belonging to Google Ad Manager or Rubicon exchanges: `exchange=\"EXCHANGE_GOOGLE_AD_MANAGER\" OR exchange=\"EXCHANGE_RUBICON\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Field by which to sort the list. Acceptable values are: * `displayName` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. For example, `displayName desc`.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListGuaranteedOrders` method. If not specified, the first page of results will be returned.", +"location": "query", +"type": "string" +}, +"partnerId": { +"description": "The ID of the partner that has access to the guaranteed order.", +"format": "int64", +"location": "query", +"type": "string" +} +}, +"path": "v4/guaranteedOrders", +"response": { +"$ref": "ListGuaranteedOrdersResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"patch": { +"description": "Updates an existing guaranteed order. Returns the updated guaranteed order if successful.", +"flatPath": "v4/guaranteedOrders/{guaranteedOrdersId}", +"httpMethod": "PATCH", +"id": "displayvideo.guaranteedOrders.patch", +"parameterOrder": [ +"guaranteedOrderId" +], +"parameters": { +"advertiserId": { +"description": "The ID of the advertiser that the request is being made within.", +"format": "int64", +"location": "query", +"type": "string" +}, +"guaranteedOrderId": { +"description": "Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format `{exchange}-{legacy_guaranteed_order_id}`.", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"partnerId": { +"description": "The ID of the partner that the request is being made within.", +"format": "int64", +"location": "query", +"type": "string" +}, +"updateMask": { +"description": "Required. The mask to control which fields to update.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v4/guaranteedOrders/{+guaranteedOrderId}", +"request": { +"$ref": "GuaranteedOrder" +}, +"response": { +"$ref": "GuaranteedOrder" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +} +} +}, +"inventorySourceGroups": { +"methods": { +"create": { +"description": "Creates a new inventory source group. Returns the newly created inventory source group if successful.", +"flatPath": "v4/inventorySourceGroups", +"httpMethod": "POST", +"id": "displayvideo.inventorySourceGroups.create", +"parameterOrder": [], +"parameters": { +"advertiserId": { +"description": "The ID of the advertiser that owns the inventory source group. The parent partner will not have access to this group.", +"format": "int64", +"location": "query", +"type": "string" +}, +"partnerId": { +"description": "The ID of the partner that owns the inventory source group. Only this partner will have write access to this group. Only advertisers to which this group is explicitly shared will have read access to this group.", +"format": "int64", +"location": "query", +"type": "string" +} +}, +"path": "v4/inventorySourceGroups", +"request": { +"$ref": "InventorySourceGroup" +}, +"response": { +"$ref": "InventorySourceGroup" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"delete": { +"description": "Deletes an inventory source group.", +"flatPath": "v4/inventorySourceGroups/{inventorySourceGroupsId}", +"httpMethod": "DELETE", +"id": "displayvideo.inventorySourceGroups.delete", +"parameterOrder": [ +"inventorySourceGroupId" +], +"parameters": { +"advertiserId": { +"description": "The ID of the advertiser that owns the inventory source group. The parent partner does not have access to this group.", +"format": "int64", +"location": "query", +"type": "string" +}, +"inventorySourceGroupId": { +"description": "Required. The ID of the inventory source group to delete.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"partnerId": { +"description": "The ID of the partner that owns the inventory source group. Only this partner has write access to this group.", +"format": "int64", +"location": "query", +"type": "string" +} +}, +"path": "v4/inventorySourceGroups/{+inventorySourceGroupId}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"get": { +"description": "Gets an inventory source group.", +"flatPath": "v4/inventorySourceGroups/{inventorySourceGroupsId}", +"httpMethod": "GET", +"id": "displayvideo.inventorySourceGroups.get", +"parameterOrder": [ +"inventorySourceGroupId" +], +"parameters": { +"advertiserId": { +"description": "The ID of the advertiser that has access to the inventory source group. If an inventory source group is partner-owned, only advertisers to which the group is explicitly shared can access the group.", +"format": "int64", +"location": "query", +"type": "string" +}, +"inventorySourceGroupId": { +"description": "Required. The ID of the inventory source group to fetch.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"partnerId": { +"description": "The ID of the partner that has access to the inventory source group. A partner cannot access an advertiser-owned inventory source group.", +"format": "int64", +"location": "query", +"type": "string" +} +}, +"path": "v4/inventorySourceGroups/{+inventorySourceGroupId}", +"response": { +"$ref": "InventorySourceGroup" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"list": { +"description": "Lists inventory source groups that are accessible to the current user. The order is defined by the order_by parameter.", +"flatPath": "v4/inventorySourceGroups", +"httpMethod": "GET", +"id": "displayvideo.inventorySourceGroups.list", +"parameterOrder": [], +"parameters": { +"advertiserId": { +"description": "The ID of the advertiser that has access to the inventory source group. If an inventory source group is partner-owned, only advertisers to which the group is explicitly shared can access the group.", +"format": "int64", +"location": "query", +"type": "string" +}, +"filter": { +"description": "Allows filtering by inventory source group fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `inventorySourceGroupId` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Field by which to sort the list. Acceptable values are: * `displayName` (default) * `inventorySourceGroupId` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. For example, `displayName desc`.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInventorySources` method. If not specified, the first page of results will be returned.", +"location": "query", +"type": "string" +}, +"partnerId": { +"description": "The ID of the partner that has access to the inventory source group. A partner cannot access advertiser-owned inventory source groups.", +"format": "int64", +"location": "query", +"type": "string" +} +}, +"path": "v4/inventorySourceGroups", +"response": { +"$ref": "ListInventorySourceGroupsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"patch": { +"description": "Updates an inventory source group. Returns the updated inventory source group if successful.", +"flatPath": "v4/inventorySourceGroups/{inventorySourceGroupId}", +"httpMethod": "PATCH", +"id": "displayvideo.inventorySourceGroups.patch", +"parameterOrder": [ +"inventorySourceGroupId" +], +"parameters": { +"advertiserId": { +"description": "The ID of the advertiser that owns the inventory source group. The parent partner does not have access to this group.", +"format": "int64", +"location": "query", +"type": "string" +}, +"inventorySourceGroupId": { +"description": "Output only. The unique ID of the inventory source group. Assigned by the system.", +"format": "int64", +"location": "path", +"required": true, +"type": "string" +}, +"partnerId": { +"description": "The ID of the partner that owns the inventory source group. Only this partner has write access to this group.", +"format": "int64", +"location": "query", +"type": "string" +}, +"updateMask": { +"description": "Required. The mask to control which fields to update.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v4/inventorySourceGroups/{inventorySourceGroupId}", +"request": { +"$ref": "InventorySourceGroup" +}, +"response": { +"$ref": "InventorySourceGroup" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +} +}, +"resources": { +"assignedInventorySources": { +"methods": { +"bulkEdit": { +"description": "Bulk edits multiple assignments between inventory sources and a single inventory source group. The operation will delete the assigned inventory sources provided in BulkEditAssignedInventorySourcesRequest.deleted_assigned_inventory_sources and then create the assigned inventory sources provided in BulkEditAssignedInventorySourcesRequest.created_assigned_inventory_sources.", +"flatPath": "v4/inventorySourceGroups/{inventorySourceGroupsId}/assignedInventorySources:bulkEdit", +"httpMethod": "POST", +"id": "displayvideo.inventorySourceGroups.assignedInventorySources.bulkEdit", +"parameterOrder": [ +"inventorySourceGroupId" +], +"parameters": { +"inventorySourceGroupId": { +"description": "Required. The ID of the inventory source group to which the assignments are assigned.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources:bulkEdit", +"request": { +"$ref": "BulkEditAssignedInventorySourcesRequest" +}, +"response": { +"$ref": "BulkEditAssignedInventorySourcesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"create": { +"description": "Creates an assignment between an inventory source and an inventory source group.", +"flatPath": "v4/inventorySourceGroups/{inventorySourceGroupsId}/assignedInventorySources", +"httpMethod": "POST", +"id": "displayvideo.inventorySourceGroups.assignedInventorySources.create", +"parameterOrder": [ +"inventorySourceGroupId" +], +"parameters": { +"advertiserId": { +"description": "The ID of the advertiser that owns the parent inventory source group. The parent partner will not have access to this assigned inventory source.", +"format": "int64", +"location": "query", +"type": "string" +}, +"inventorySourceGroupId": { +"description": "Required. The ID of the inventory source group to which the assignment will be assigned.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"partnerId": { +"description": "The ID of the partner that owns the parent inventory source group. Only this partner will have write access to this assigned inventory source.", +"format": "int64", +"location": "query", +"type": "string" +} +}, +"path": "v4/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources", +"request": { +"$ref": "AssignedInventorySource" +}, +"response": { +"$ref": "AssignedInventorySource" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"delete": { +"description": "Deletes the assignment between an inventory source and an inventory source group.", +"flatPath": "v4/inventorySourceGroups/{inventorySourceGroupsId}/assignedInventorySources/{assignedInventorySourcesId}", +"httpMethod": "DELETE", +"id": "displayvideo.inventorySourceGroups.assignedInventorySources.delete", +"parameterOrder": [ +"inventorySourceGroupId", +"assignedInventorySourceId" +], +"parameters": { +"advertiserId": { +"description": "The ID of the advertiser that owns the parent inventory source group. The parent partner does not have access to this assigned inventory source.", +"format": "int64", +"location": "query", +"type": "string" +}, +"assignedInventorySourceId": { +"description": "Required. The ID of the assigned inventory source to delete.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"inventorySourceGroupId": { +"description": "Required. The ID of the inventory source group to which this assignment is assigned.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"partnerId": { +"description": "The ID of the partner that owns the parent inventory source group. Only this partner has write access to this assigned inventory source.", +"format": "int64", +"location": "query", +"type": "string" +} +}, +"path": "v4/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources/{+assignedInventorySourceId}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"list": { +"description": "Lists inventory sources assigned to an inventory source group.", +"flatPath": "v4/inventorySourceGroups/{inventorySourceGroupsId}/assignedInventorySources", +"httpMethod": "GET", +"id": "displayvideo.inventorySourceGroups.assignedInventorySources.list", +"parameterOrder": [ +"inventorySourceGroupId" +], +"parameters": { +"advertiserId": { +"description": "The ID of the advertiser that has access to the assignment. If the parent inventory source group is partner-owned, only advertisers to which the parent group is explicitly shared can access the assigned inventory source.", +"format": "int64", +"location": "query", +"type": "string" +}, +"filter": { +"description": "Allows filtering by assigned inventory source fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedInventorySourceId` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", +"location": "query", +"type": "string" +}, +"inventorySourceGroupId": { +"description": "Required. The ID of the inventory source group to which these assignments are assigned.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"orderBy": { +"description": "Field by which to sort the list. Acceptable values are: * `assignedInventorySourceId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \" desc\" should be added to the field name. Example: `assignedInventorySourceId desc`.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAssignedInventorySources` method. If not specified, the first page of results will be returned.", +"location": "query", +"type": "string" +}, +"partnerId": { +"description": "The ID of the partner that has access to the assignment. If the parent inventory source group is advertiser-owned, the assignment cannot be accessed via a partner.", +"format": "int64", +"location": "query", +"type": "string" +} +}, +"path": "v4/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources", +"response": { +"$ref": "ListAssignedInventorySourcesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +} +} +} +} +}, +"inventorySources": { +"methods": { +"create": { +"description": "Creates a new inventory source. Returns the newly created inventory source if successful.", +"flatPath": "v4/inventorySources", +"httpMethod": "POST", +"id": "displayvideo.inventorySources.create", +"parameterOrder": [], +"parameters": { +"advertiserId": { +"description": "The ID of the advertiser that the request is being made within.", +"format": "int64", +"location": "query", +"type": "string" +}, +"partnerId": { +"description": "The ID of the partner that the request is being made within.", +"format": "int64", +"location": "query", +"type": "string" +} +}, +"path": "v4/inventorySources", +"request": { +"$ref": "InventorySource" +}, +"response": { +"$ref": "InventorySource" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"editInventorySourceReadWriteAccessors": { +"description": "Edits read/write accessors of an inventory source. Returns the updated read_write_accessors for the inventory source.", +"flatPath": "v4/inventorySources/{inventorySourcesId}:editInventorySourceReadWriteAccessors", +"httpMethod": "POST", +"id": "displayvideo.inventorySources.editInventorySourceReadWriteAccessors", +"parameterOrder": [ +"inventorySourceId" +], +"parameters": { +"inventorySourceId": { +"description": "Required. The ID of inventory source to update.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/inventorySources/{+inventorySourceId}:editInventorySourceReadWriteAccessors", +"request": { +"$ref": "EditInventorySourceReadWriteAccessorsRequest" +}, +"response": { +"$ref": "InventorySourceAccessors" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"get": { +"description": "Gets an inventory source.", +"flatPath": "v4/inventorySources/{inventorySourcesId}", +"httpMethod": "GET", +"id": "displayvideo.inventorySources.get", +"parameterOrder": [ +"inventorySourceId" +], +"parameters": { +"advertiserId": { +"description": "Optional. The ID of the DV360 advertiser to which the fetched inventory source is permissioned. If the user only has access to the advertiser and not the parent partner, use this field to specify the relevant advertiser.", +"format": "int64", +"location": "query", +"type": "string" +}, +"inventorySourceId": { +"description": "Required. The ID of the inventory source to fetch.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"partnerId": { +"description": "Required. The ID of the DV360 partner to which the fetched inventory source is permissioned.", +"format": "int64", +"location": "query", +"type": "string" +} +}, +"path": "v4/inventorySources/{+inventorySourceId}", +"response": { +"$ref": "InventorySource" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"list": { +"description": "Lists inventory sources that are accessible to the current user. The order is defined by the order_by parameter. If a filter by entity_status is not specified, inventory sources with entity status `ENTITY_STATUS_ARCHIVED` will not be included in the results.", +"flatPath": "v4/inventorySources", +"httpMethod": "GET", +"id": "displayvideo.inventorySources.list", +"parameterOrder": [], +"parameters": { +"advertiserId": { +"description": "The ID of the advertiser that has access to the inventory source.", +"format": "int64", +"location": "query", +"type": "string" +}, +"filter": { +"description": "Allows filtering by inventory source fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `status.entityStatus` * `commitment` * `deliveryMethod` * `rateDetails.rateType` * `exchange` Examples: * All active inventory sources: `status.entityStatus=\"ENTITY_STATUS_ACTIVE\"` * Inventory sources belonging to Google Ad Manager or Rubicon exchanges: `exchange=\"EXCHANGE_GOOGLE_AD_MANAGER\" OR exchange=\"EXCHANGE_RUBICON\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Field by which to sort the list. Acceptable values are: * `displayName` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. For example, `displayName desc`.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInventorySources` method. If not specified, the first page of results will be returned.", +"location": "query", +"type": "string" +}, +"partnerId": { +"description": "The ID of the partner that has access to the inventory source.", +"format": "int64", +"location": "query", +"type": "string" +} +}, +"path": "v4/inventorySources", +"response": { +"$ref": "ListInventorySourcesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"patch": { +"description": "Updates an existing inventory source. Returns the updated inventory source if successful.", +"flatPath": "v4/inventorySources/{inventorySourcesId}", +"httpMethod": "PATCH", +"id": "displayvideo.inventorySources.patch", +"parameterOrder": [ +"inventorySourceId" +], +"parameters": { +"advertiserId": { +"description": "The ID of the advertiser that the request is being made within.", +"format": "int64", +"location": "query", +"type": "string" +}, +"inventorySourceId": { +"description": "Output only. The unique ID of the inventory source. Assigned by the system.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"partnerId": { +"description": "The ID of the partner that the request is being made within.", +"format": "int64", +"location": "query", +"type": "string" +}, +"updateMask": { +"description": "Required. The mask to control which fields to update.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v4/inventorySources/{+inventorySourceId}", +"request": { +"$ref": "InventorySource" +}, +"response": { +"$ref": "InventorySource" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +} +} +}, +"media": { +"methods": { +"download": { +"description": "Downloads media. Download is supported on the URI `/download/{resource_name=**}?alt=media.` **Note**: Download requests will not be successful without including `alt=media` query string.", +"flatPath": "download/{downloadId}", +"httpMethod": "GET", +"id": "displayvideo.media.download", +"parameterOrder": [ +"resourceName" +], +"parameters": { +"resourceName": { +"description": "Name of the media that is being downloaded. See ReadRequest.resource_name.", +"location": "path", +"pattern": "^.*$", +"required": true, +"type": "string" +} +}, +"path": "download/{+resourceName}", +"response": { +"$ref": "GoogleBytestreamMedia" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video", +"https://www.googleapis.com/auth/doubleclickbidmanager" +], +"supportsMediaDownload": true +}, +"upload": { +"description": "Uploads media. Upload is supported on the URI `/upload/media/{resource_name=**}?upload_type=media.` **Note**: Upload requests will not be successful without including `upload_type=media` query string.", +"flatPath": "media/{mediaId}", +"httpMethod": "POST", +"id": "displayvideo.media.upload", +"mediaUpload": { +"accept": [ +"*/*" +], +"protocols": { +"simple": { +"multipart": true, +"path": "/upload/media/{+resourceName}" +} +} +}, +"parameterOrder": [ +"resourceName" +], +"parameters": { +"resourceName": { +"description": "Name of the media that is being downloaded. See ReadRequest.resource_name.", +"location": "path", +"pattern": "^.*$", +"required": true, +"type": "string" +} +}, +"path": "media/{+resourceName}", +"request": { +"$ref": "GoogleBytestreamMedia" +}, +"response": { +"$ref": "GoogleBytestreamMedia" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video", +"https://www.googleapis.com/auth/doubleclickbidmanager" +], +"supportsMediaUpload": true +} +} +}, +"partners": { +"methods": { +"editAssignedTargetingOptions": { +"description": "Edits targeting options under a single partner. The operation will delete the assigned targeting options provided in BulkEditPartnerAssignedTargetingOptionsRequest.deleteRequests and then create the assigned targeting options provided in BulkEditPartnerAssignedTargetingOptionsRequest.createRequests .", +"flatPath": "v4/partners/{partnersId}:editAssignedTargetingOptions", +"httpMethod": "POST", +"id": "displayvideo.partners.editAssignedTargetingOptions", +"parameterOrder": [ +"partnerId" +], +"parameters": { +"partnerId": { +"description": "Required. The ID of the partner.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/partners/{+partnerId}:editAssignedTargetingOptions", +"request": { +"$ref": "BulkEditPartnerAssignedTargetingOptionsRequest" +}, +"response": { +"$ref": "BulkEditPartnerAssignedTargetingOptionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"get": { +"description": "Gets a partner.", +"flatPath": "v4/partners/{partnersId}", +"httpMethod": "GET", +"id": "displayvideo.partners.get", +"parameterOrder": [ +"partnerId" +], +"parameters": { +"partnerId": { +"description": "Required. The ID of the partner to fetch.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/partners/{+partnerId}", +"response": { +"$ref": "Partner" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"list": { +"description": "Lists partners that are accessible to the current user. The order is defined by the order_by parameter.", +"flatPath": "v4/partners", +"httpMethod": "GET", +"id": "displayvideo.partners.list", +"parameterOrder": [], +"parameters": { +"filter": { +"description": "Allows filtering by partner fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `entityStatus` Examples: * All active partners: `entityStatus=\"ENTITY_STATUS_ACTIVE\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Field by which to sort the list. Acceptable values are: * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. For example, `displayName desc`.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListPartners` method. If not specified, the first page of results will be returned.", +"location": "query", +"type": "string" +} +}, +"path": "v4/partners", +"response": { +"$ref": "ListPartnersResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +} +}, +"resources": { +"channels": { +"methods": { +"create": { +"description": "Creates a new channel. Returns the newly created channel if successful.", +"flatPath": "v4/partners/{partnersId}/channels", +"httpMethod": "POST", +"id": "displayvideo.partners.channels.create", +"parameterOrder": [ +"partnerId" +], +"parameters": { +"advertiserId": { +"description": "The ID of the advertiser that owns the created channel.", +"format": "int64", +"location": "query", +"type": "string" +}, +"partnerId": { +"description": "The ID of the partner that owns the created channel.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/partners/{+partnerId}/channels", +"request": { +"$ref": "Channel" +}, +"response": { +"$ref": "Channel" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"get": { +"description": "Gets a channel for a partner or advertiser.", +"flatPath": "v4/partners/{partnersId}/channels/{channelsId}", +"httpMethod": "GET", +"id": "displayvideo.partners.channels.get", +"parameterOrder": [ +"partnerId", +"channelId" +], +"parameters": { +"advertiserId": { +"description": "The ID of the advertiser that owns the fetched channel.", +"format": "int64", +"location": "query", +"type": "string" +}, +"channelId": { +"description": "Required. The ID of the channel to fetch.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"partnerId": { +"description": "The ID of the partner that owns the fetched channel.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/partners/{+partnerId}/channels/{+channelId}", +"response": { +"$ref": "Channel" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"list": { +"description": "Lists channels for a partner or advertiser.", +"flatPath": "v4/partners/{partnersId}/channels", +"httpMethod": "GET", +"id": "displayvideo.partners.channels.list", +"parameterOrder": [ +"partnerId" +], +"parameters": { +"advertiserId": { +"description": "The ID of the advertiser that owns the channels.", +"format": "int64", +"location": "query", +"type": "string" +}, +"filter": { +"description": "Allows filtering by channel fields. Supported syntax: * Filter expressions for channel can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All channels for which the display name contains \"google\": `displayName : \"google\"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Field by which to sort the list. Acceptable values are: * `displayName` (default) * `channelId` The default sorting order is ascending. To specify descending order for a field, a suffix \" desc\" should be added to the field name. Example: `displayName desc`.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListChannels` method. If not specified, the first page of results will be returned.", +"location": "query", +"type": "string" +}, +"partnerId": { +"description": "The ID of the partner that owns the channels.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/partners/{+partnerId}/channels", +"response": { +"$ref": "ListChannelsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"patch": { +"description": "Updates a channel. Returns the updated channel if successful.", +"flatPath": "v4/partners/{partnersId}/channels/{channelId}", +"httpMethod": "PATCH", +"id": "displayvideo.partners.channels.patch", +"parameterOrder": [ +"partnerId", +"channelId" +], +"parameters": { +"advertiserId": { +"description": "The ID of the advertiser that owns the created channel.", +"format": "int64", +"location": "query", +"type": "string" +}, +"channelId": { +"description": "Output only. The unique ID of the channel. Assigned by the system.", +"format": "int64", +"location": "path", +"required": true, +"type": "string" +}, +"partnerId": { +"description": "The ID of the partner that owns the created channel.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Required. The mask to control which fields to update.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v4/partners/{+partnerId}/channels/{channelId}", +"request": { +"$ref": "Channel" +}, +"response": { +"$ref": "Channel" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +} +}, +"resources": { +"sites": { +"methods": { +"bulkEdit": { +"description": "Bulk edits sites under a single channel. The operation will delete the sites provided in BulkEditSitesRequest.deleted_sites and then create the sites provided in BulkEditSitesRequest.created_sites.", +"flatPath": "v4/partners/{partnerId}/channels/{channelsId}/sites:bulkEdit", +"httpMethod": "POST", +"id": "displayvideo.partners.channels.sites.bulkEdit", +"parameterOrder": [ +"partnerId", +"channelId" +], +"parameters": { +"channelId": { +"description": "Required. The ID of the parent channel to which the sites belong.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"partnerId": { +"description": "The ID of the partner that owns the parent channel.", +"format": "int64", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "v4/partners/{partnerId}/channels/{+channelId}/sites:bulkEdit", +"request": { +"$ref": "BulkEditSitesRequest" +}, +"response": { +"$ref": "BulkEditSitesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"create": { +"description": "Creates a site in a channel.", +"flatPath": "v4/partners/{partnerId}/channels/{channelsId}/sites", +"httpMethod": "POST", +"id": "displayvideo.partners.channels.sites.create", +"parameterOrder": [ +"partnerId", +"channelId" +], +"parameters": { +"advertiserId": { +"description": "The ID of the advertiser that owns the parent channel.", +"format": "int64", +"location": "query", +"type": "string" +}, +"channelId": { +"description": "Required. The ID of the parent channel in which the site will be created.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"partnerId": { +"description": "The ID of the partner that owns the parent channel.", +"format": "int64", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "v4/partners/{partnerId}/channels/{+channelId}/sites", +"request": { +"$ref": "Site" +}, +"response": { +"$ref": "Site" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"delete": { +"description": "Deletes a site from a channel.", +"flatPath": "v4/partners/{partnerId}/channels/{channelsId}/sites/{sitesId}", +"httpMethod": "DELETE", +"id": "displayvideo.partners.channels.sites.delete", +"parameterOrder": [ +"partnerId", +"channelId", +"urlOrAppId" +], +"parameters": { +"advertiserId": { +"description": "The ID of the advertiser that owns the parent channel.", +"format": "int64", +"location": "query", +"type": "string" +}, +"channelId": { +"description": "Required. The ID of the parent channel to which the site belongs.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"partnerId": { +"description": "The ID of the partner that owns the parent channel.", +"format": "int64", +"location": "path", +"required": true, +"type": "string" +}, +"urlOrAppId": { +"description": "Required. The URL or app ID of the site to delete.", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/partners/{partnerId}/channels/{+channelId}/sites/{+urlOrAppId}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"list": { +"description": "Lists sites in a channel.", +"flatPath": "v4/partners/{partnersId}/channels/{channelsId}/sites", +"httpMethod": "GET", +"id": "displayvideo.partners.channels.sites.list", +"parameterOrder": [ +"partnerId", +"channelId" +], +"parameters": { +"advertiserId": { +"description": "The ID of the advertiser that owns the parent channel.", +"format": "int64", +"location": "query", +"type": "string" +}, +"channelId": { +"description": "Required. The ID of the parent channel to which the requested sites belong.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"filter": { +"description": "Allows filtering by site fields. Supported syntax: * Filter expressions for site retrieval can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `urlOrAppId` Examples: * All sites for which the URL or app ID contains \"google\": `urlOrAppId : \"google\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Field by which to sort the list. Acceptable values are: * `urlOrAppId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \" desc\" should be added to the field name. Example: `urlOrAppId desc`.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Requested page size. Must be between `1` and `10000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListSites` method. If not specified, the first page of results will be returned.", +"location": "query", +"type": "string" +}, +"partnerId": { +"description": "The ID of the partner that owns the parent channel.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/partners/{+partnerId}/channels/{+channelId}/sites", +"response": { +"$ref": "ListSitesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"replace": { +"description": "Replaces all of the sites under a single channel. The operation will replace the sites under a channel with the sites provided in ReplaceSitesRequest.new_sites. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.", +"flatPath": "v4/partners/{partnerId}/channels/{channelsId}/sites:replace", +"httpMethod": "POST", +"id": "displayvideo.partners.channels.sites.replace", +"parameterOrder": [ +"partnerId", +"channelId" +], +"parameters": { +"channelId": { +"description": "Required. The ID of the parent channel whose sites will be replaced.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"partnerId": { +"description": "The ID of the partner that owns the parent channel.", +"format": "int64", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "v4/partners/{partnerId}/channels/{+channelId}/sites:replace", +"request": { +"$ref": "ReplaceSitesRequest" +}, +"response": { +"$ref": "ReplaceSitesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +} +} +} +} +}, +"targetingTypes": { +"resources": { +"assignedTargetingOptions": { +"methods": { +"create": { +"description": "Assigns a targeting option to a partner. Returns the assigned targeting option if successful.", +"flatPath": "v4/partners/{partnersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions", +"httpMethod": "POST", +"id": "displayvideo.partners.targetingTypes.assignedTargetingOptions.create", +"parameterOrder": [ +"partnerId", +"targetingType" +], +"parameters": { +"partnerId": { +"description": "Required. The ID of the partner.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"targetingType": { +"description": "Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL`", +"enum": [ +"TARGETING_TYPE_UNSPECIFIED", +"TARGETING_TYPE_CHANNEL", +"TARGETING_TYPE_APP_CATEGORY", +"TARGETING_TYPE_APP", +"TARGETING_TYPE_URL", +"TARGETING_TYPE_DAY_AND_TIME", +"TARGETING_TYPE_AGE_RANGE", +"TARGETING_TYPE_REGIONAL_LOCATION_LIST", +"TARGETING_TYPE_PROXIMITY_LOCATION_LIST", +"TARGETING_TYPE_GENDER", +"TARGETING_TYPE_VIDEO_PLAYER_SIZE", +"TARGETING_TYPE_USER_REWARDED_CONTENT", +"TARGETING_TYPE_PARENTAL_STATUS", +"TARGETING_TYPE_CONTENT_INSTREAM_POSITION", +"TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", +"TARGETING_TYPE_DEVICE_TYPE", +"TARGETING_TYPE_AUDIENCE_GROUP", +"TARGETING_TYPE_BROWSER", +"TARGETING_TYPE_HOUSEHOLD_INCOME", +"TARGETING_TYPE_ON_SCREEN_POSITION", +"TARGETING_TYPE_THIRD_PARTY_VERIFIER", +"TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", +"TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", +"TARGETING_TYPE_ENVIRONMENT", +"TARGETING_TYPE_CARRIER_AND_ISP", +"TARGETING_TYPE_OPERATING_SYSTEM", +"TARGETING_TYPE_DEVICE_MAKE_MODEL", +"TARGETING_TYPE_KEYWORD", +"TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", +"TARGETING_TYPE_VIEWABILITY", +"TARGETING_TYPE_CATEGORY", +"TARGETING_TYPE_INVENTORY_SOURCE", +"TARGETING_TYPE_LANGUAGE", +"TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", +"TARGETING_TYPE_GEO_REGION", +"TARGETING_TYPE_INVENTORY_SOURCE_GROUP", +"TARGETING_TYPE_EXCHANGE", +"TARGETING_TYPE_SUB_EXCHANGE", +"TARGETING_TYPE_POI", +"TARGETING_TYPE_BUSINESS_CHAIN", +"TARGETING_TYPE_CONTENT_DURATION", +"TARGETING_TYPE_CONTENT_STREAM_TYPE", +"TARGETING_TYPE_NATIVE_CONTENT_POSITION", +"TARGETING_TYPE_OMID", +"TARGETING_TYPE_AUDIO_CONTENT_TYPE", +"TARGETING_TYPE_CONTENT_GENRE", +"TARGETING_TYPE_YOUTUBE_VIDEO", +"TARGETING_TYPE_YOUTUBE_CHANNEL", +"TARGETING_TYPE_SESSION_POSITION" +], +"enumDescriptions": [ +"Default value when type is not specified or is unknown in this version.", +"Target a channel (a custom group of related websites or apps).", +"Target an app category (for example, education or puzzle games).", +"Target a specific app (for example, Angry Birds).", +"Target a specific url (for example, quora.com).", +"Target ads during a chosen time period on a specific day.", +"Target ads to a specific age range (for example, 18-24).", +"Target ads to the specified regions on a regional location list.", +"Target ads to the specified points of interest on a proximity location list.", +"Target ads to a specific gender (for example, female or male).", +"Target a specific video player size for video ads.", +"Target user rewarded content for video ads.", +"Target ads to a specific parental status (for example, parent or not a parent).", +"Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", +"Target ads in a specific content outstream position.", +"Target ads to a specific device type (for example, tablet or connected TV).", +"Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", +"Target ads to specific web browsers (for example, Chrome).", +"Target ads to a specific household income range (for example, top 10%).", +"Target ads in a specific on screen position.", +"Filter web sites through third party verification (for example, IAS or DoubleVerify).", +"Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", +"Filter website content by sensitive categories (for example, adult).", +"Target ads to a specific environment (for example, web or app).", +"Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", +"Target ads to a specific operating system (for example, macOS).", +"Target ads to a specific device make or model (for example, Roku or Samsung).", +"Target ads to a specific keyword (for example, dog or retriever).", +"Target ads to a specific negative keyword list.", +"Target ads to a specific viewability (for example, 80% viewable).", +"Target ads to a specific content category (for example, arts & entertainment).", +"Purchase impressions from specific deals and auction packages.", +"Target ads to a specific language (for example, English or Japanese).", +"Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", +"Target ads to a specific regional location (for example, a city or state).", +"Purchase impressions from a group of deals and auction packages.", +"Purchase impressions from specific exchanges.", +"Purchase impressions from specific sub-exchanges.", +"Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", +"Target ads around locations of a business chain within a specific geo region.", +"Target ads to a specific video content duration.", +"Target ads to a specific video content stream type.", +"Target ads to a specific native content position.", +"Target ads in an Open Measurement enabled inventory.", +"Target ads to a specific audio content type.", +"Target ads to a specific content genre.", +"Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", +"Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", +"Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." +], +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions", +"request": { +"$ref": "AssignedTargetingOption" +}, +"response": { +"$ref": "AssignedTargetingOption" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"delete": { +"description": "Deletes an assigned targeting option from a partner.", +"flatPath": "v4/partners/{partnersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}", +"httpMethod": "DELETE", +"id": "displayvideo.partners.targetingTypes.assignedTargetingOptions.delete", +"parameterOrder": [ +"partnerId", +"targetingType", +"assignedTargetingOptionId" +], +"parameters": { +"assignedTargetingOptionId": { +"description": "Required. The ID of the assigned targeting option to delete.", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"partnerId": { +"description": "Required. The ID of the partner.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"targetingType": { +"description": "Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL`", +"enum": [ +"TARGETING_TYPE_UNSPECIFIED", +"TARGETING_TYPE_CHANNEL", +"TARGETING_TYPE_APP_CATEGORY", +"TARGETING_TYPE_APP", +"TARGETING_TYPE_URL", +"TARGETING_TYPE_DAY_AND_TIME", +"TARGETING_TYPE_AGE_RANGE", +"TARGETING_TYPE_REGIONAL_LOCATION_LIST", +"TARGETING_TYPE_PROXIMITY_LOCATION_LIST", +"TARGETING_TYPE_GENDER", +"TARGETING_TYPE_VIDEO_PLAYER_SIZE", +"TARGETING_TYPE_USER_REWARDED_CONTENT", +"TARGETING_TYPE_PARENTAL_STATUS", +"TARGETING_TYPE_CONTENT_INSTREAM_POSITION", +"TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", +"TARGETING_TYPE_DEVICE_TYPE", +"TARGETING_TYPE_AUDIENCE_GROUP", +"TARGETING_TYPE_BROWSER", +"TARGETING_TYPE_HOUSEHOLD_INCOME", +"TARGETING_TYPE_ON_SCREEN_POSITION", +"TARGETING_TYPE_THIRD_PARTY_VERIFIER", +"TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", +"TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", +"TARGETING_TYPE_ENVIRONMENT", +"TARGETING_TYPE_CARRIER_AND_ISP", +"TARGETING_TYPE_OPERATING_SYSTEM", +"TARGETING_TYPE_DEVICE_MAKE_MODEL", +"TARGETING_TYPE_KEYWORD", +"TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", +"TARGETING_TYPE_VIEWABILITY", +"TARGETING_TYPE_CATEGORY", +"TARGETING_TYPE_INVENTORY_SOURCE", +"TARGETING_TYPE_LANGUAGE", +"TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", +"TARGETING_TYPE_GEO_REGION", +"TARGETING_TYPE_INVENTORY_SOURCE_GROUP", +"TARGETING_TYPE_EXCHANGE", +"TARGETING_TYPE_SUB_EXCHANGE", +"TARGETING_TYPE_POI", +"TARGETING_TYPE_BUSINESS_CHAIN", +"TARGETING_TYPE_CONTENT_DURATION", +"TARGETING_TYPE_CONTENT_STREAM_TYPE", +"TARGETING_TYPE_NATIVE_CONTENT_POSITION", +"TARGETING_TYPE_OMID", +"TARGETING_TYPE_AUDIO_CONTENT_TYPE", +"TARGETING_TYPE_CONTENT_GENRE", +"TARGETING_TYPE_YOUTUBE_VIDEO", +"TARGETING_TYPE_YOUTUBE_CHANNEL", +"TARGETING_TYPE_SESSION_POSITION" +], +"enumDescriptions": [ +"Default value when type is not specified or is unknown in this version.", +"Target a channel (a custom group of related websites or apps).", +"Target an app category (for example, education or puzzle games).", +"Target a specific app (for example, Angry Birds).", +"Target a specific url (for example, quora.com).", +"Target ads during a chosen time period on a specific day.", +"Target ads to a specific age range (for example, 18-24).", +"Target ads to the specified regions on a regional location list.", +"Target ads to the specified points of interest on a proximity location list.", +"Target ads to a specific gender (for example, female or male).", +"Target a specific video player size for video ads.", +"Target user rewarded content for video ads.", +"Target ads to a specific parental status (for example, parent or not a parent).", +"Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", +"Target ads in a specific content outstream position.", +"Target ads to a specific device type (for example, tablet or connected TV).", +"Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", +"Target ads to specific web browsers (for example, Chrome).", +"Target ads to a specific household income range (for example, top 10%).", +"Target ads in a specific on screen position.", +"Filter web sites through third party verification (for example, IAS or DoubleVerify).", +"Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", +"Filter website content by sensitive categories (for example, adult).", +"Target ads to a specific environment (for example, web or app).", +"Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", +"Target ads to a specific operating system (for example, macOS).", +"Target ads to a specific device make or model (for example, Roku or Samsung).", +"Target ads to a specific keyword (for example, dog or retriever).", +"Target ads to a specific negative keyword list.", +"Target ads to a specific viewability (for example, 80% viewable).", +"Target ads to a specific content category (for example, arts & entertainment).", +"Purchase impressions from specific deals and auction packages.", +"Target ads to a specific language (for example, English or Japanese).", +"Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", +"Target ads to a specific regional location (for example, a city or state).", +"Purchase impressions from a group of deals and auction packages.", +"Purchase impressions from specific exchanges.", +"Purchase impressions from specific sub-exchanges.", +"Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", +"Target ads around locations of a business chain within a specific geo region.", +"Target ads to a specific video content duration.", +"Target ads to a specific video content stream type.", +"Target ads to a specific native content position.", +"Target ads in an Open Measurement enabled inventory.", +"Target ads to a specific audio content type.", +"Target ads to a specific content genre.", +"Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", +"Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", +"Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." +], +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"get": { +"description": "Gets a single targeting option assigned to a partner.", +"flatPath": "v4/partners/{partnersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}", +"httpMethod": "GET", +"id": "displayvideo.partners.targetingTypes.assignedTargetingOptions.get", +"parameterOrder": [ +"partnerId", +"targetingType", +"assignedTargetingOptionId" +], +"parameters": { +"assignedTargetingOptionId": { +"description": "Required. An identifier unique to the targeting type in this partner that identifies the assigned targeting option being requested.", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"partnerId": { +"description": "Required. The ID of the partner.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"targetingType": { +"description": "Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL`", +"enum": [ +"TARGETING_TYPE_UNSPECIFIED", +"TARGETING_TYPE_CHANNEL", +"TARGETING_TYPE_APP_CATEGORY", +"TARGETING_TYPE_APP", +"TARGETING_TYPE_URL", +"TARGETING_TYPE_DAY_AND_TIME", +"TARGETING_TYPE_AGE_RANGE", +"TARGETING_TYPE_REGIONAL_LOCATION_LIST", +"TARGETING_TYPE_PROXIMITY_LOCATION_LIST", +"TARGETING_TYPE_GENDER", +"TARGETING_TYPE_VIDEO_PLAYER_SIZE", +"TARGETING_TYPE_USER_REWARDED_CONTENT", +"TARGETING_TYPE_PARENTAL_STATUS", +"TARGETING_TYPE_CONTENT_INSTREAM_POSITION", +"TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", +"TARGETING_TYPE_DEVICE_TYPE", +"TARGETING_TYPE_AUDIENCE_GROUP", +"TARGETING_TYPE_BROWSER", +"TARGETING_TYPE_HOUSEHOLD_INCOME", +"TARGETING_TYPE_ON_SCREEN_POSITION", +"TARGETING_TYPE_THIRD_PARTY_VERIFIER", +"TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", +"TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", +"TARGETING_TYPE_ENVIRONMENT", +"TARGETING_TYPE_CARRIER_AND_ISP", +"TARGETING_TYPE_OPERATING_SYSTEM", +"TARGETING_TYPE_DEVICE_MAKE_MODEL", +"TARGETING_TYPE_KEYWORD", +"TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", +"TARGETING_TYPE_VIEWABILITY", +"TARGETING_TYPE_CATEGORY", +"TARGETING_TYPE_INVENTORY_SOURCE", +"TARGETING_TYPE_LANGUAGE", +"TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", +"TARGETING_TYPE_GEO_REGION", +"TARGETING_TYPE_INVENTORY_SOURCE_GROUP", +"TARGETING_TYPE_EXCHANGE", +"TARGETING_TYPE_SUB_EXCHANGE", +"TARGETING_TYPE_POI", +"TARGETING_TYPE_BUSINESS_CHAIN", +"TARGETING_TYPE_CONTENT_DURATION", +"TARGETING_TYPE_CONTENT_STREAM_TYPE", +"TARGETING_TYPE_NATIVE_CONTENT_POSITION", +"TARGETING_TYPE_OMID", +"TARGETING_TYPE_AUDIO_CONTENT_TYPE", +"TARGETING_TYPE_CONTENT_GENRE", +"TARGETING_TYPE_YOUTUBE_VIDEO", +"TARGETING_TYPE_YOUTUBE_CHANNEL", +"TARGETING_TYPE_SESSION_POSITION" +], +"enumDescriptions": [ +"Default value when type is not specified or is unknown in this version.", +"Target a channel (a custom group of related websites or apps).", +"Target an app category (for example, education or puzzle games).", +"Target a specific app (for example, Angry Birds).", +"Target a specific url (for example, quora.com).", +"Target ads during a chosen time period on a specific day.", +"Target ads to a specific age range (for example, 18-24).", +"Target ads to the specified regions on a regional location list.", +"Target ads to the specified points of interest on a proximity location list.", +"Target ads to a specific gender (for example, female or male).", +"Target a specific video player size for video ads.", +"Target user rewarded content for video ads.", +"Target ads to a specific parental status (for example, parent or not a parent).", +"Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", +"Target ads in a specific content outstream position.", +"Target ads to a specific device type (for example, tablet or connected TV).", +"Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", +"Target ads to specific web browsers (for example, Chrome).", +"Target ads to a specific household income range (for example, top 10%).", +"Target ads in a specific on screen position.", +"Filter web sites through third party verification (for example, IAS or DoubleVerify).", +"Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", +"Filter website content by sensitive categories (for example, adult).", +"Target ads to a specific environment (for example, web or app).", +"Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", +"Target ads to a specific operating system (for example, macOS).", +"Target ads to a specific device make or model (for example, Roku or Samsung).", +"Target ads to a specific keyword (for example, dog or retriever).", +"Target ads to a specific negative keyword list.", +"Target ads to a specific viewability (for example, 80% viewable).", +"Target ads to a specific content category (for example, arts & entertainment).", +"Purchase impressions from specific deals and auction packages.", +"Target ads to a specific language (for example, English or Japanese).", +"Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", +"Target ads to a specific regional location (for example, a city or state).", +"Purchase impressions from a group of deals and auction packages.", +"Purchase impressions from specific exchanges.", +"Purchase impressions from specific sub-exchanges.", +"Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", +"Target ads around locations of a business chain within a specific geo region.", +"Target ads to a specific video content duration.", +"Target ads to a specific video content stream type.", +"Target ads to a specific native content position.", +"Target ads in an Open Measurement enabled inventory.", +"Target ads to a specific audio content type.", +"Target ads to a specific content genre.", +"Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", +"Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", +"Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." +], +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}", +"response": { +"$ref": "AssignedTargetingOption" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"list": { +"description": "Lists the targeting options assigned to a partner.", +"flatPath": "v4/partners/{partnersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions", +"httpMethod": "GET", +"id": "displayvideo.partners.targetingTypes.assignedTargetingOptions.list", +"parameterOrder": [ +"partnerId", +"targetingType" +], +"parameters": { +"filter": { +"description": "Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` Examples: * `AssignedTargetingOption` resource with ID 123456: `assignedTargetingOptionId=\"123456\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `assignedTargetingOptionId desc`.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListPartnerAssignedTargetingOptions` method. If not specified, the first page of results will be returned.", +"location": "query", +"type": "string" +}, +"partnerId": { +"description": "Required. The ID of the partner.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"targetingType": { +"description": "Required. Identifies the type of assigned targeting options to list. Supported targeting types: * `TARGETING_TYPE_CHANNEL`", +"enum": [ +"TARGETING_TYPE_UNSPECIFIED", +"TARGETING_TYPE_CHANNEL", +"TARGETING_TYPE_APP_CATEGORY", +"TARGETING_TYPE_APP", +"TARGETING_TYPE_URL", +"TARGETING_TYPE_DAY_AND_TIME", +"TARGETING_TYPE_AGE_RANGE", +"TARGETING_TYPE_REGIONAL_LOCATION_LIST", +"TARGETING_TYPE_PROXIMITY_LOCATION_LIST", +"TARGETING_TYPE_GENDER", +"TARGETING_TYPE_VIDEO_PLAYER_SIZE", +"TARGETING_TYPE_USER_REWARDED_CONTENT", +"TARGETING_TYPE_PARENTAL_STATUS", +"TARGETING_TYPE_CONTENT_INSTREAM_POSITION", +"TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", +"TARGETING_TYPE_DEVICE_TYPE", +"TARGETING_TYPE_AUDIENCE_GROUP", +"TARGETING_TYPE_BROWSER", +"TARGETING_TYPE_HOUSEHOLD_INCOME", +"TARGETING_TYPE_ON_SCREEN_POSITION", +"TARGETING_TYPE_THIRD_PARTY_VERIFIER", +"TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", +"TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", +"TARGETING_TYPE_ENVIRONMENT", +"TARGETING_TYPE_CARRIER_AND_ISP", +"TARGETING_TYPE_OPERATING_SYSTEM", +"TARGETING_TYPE_DEVICE_MAKE_MODEL", +"TARGETING_TYPE_KEYWORD", +"TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", +"TARGETING_TYPE_VIEWABILITY", +"TARGETING_TYPE_CATEGORY", +"TARGETING_TYPE_INVENTORY_SOURCE", +"TARGETING_TYPE_LANGUAGE", +"TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", +"TARGETING_TYPE_GEO_REGION", +"TARGETING_TYPE_INVENTORY_SOURCE_GROUP", +"TARGETING_TYPE_EXCHANGE", +"TARGETING_TYPE_SUB_EXCHANGE", +"TARGETING_TYPE_POI", +"TARGETING_TYPE_BUSINESS_CHAIN", +"TARGETING_TYPE_CONTENT_DURATION", +"TARGETING_TYPE_CONTENT_STREAM_TYPE", +"TARGETING_TYPE_NATIVE_CONTENT_POSITION", +"TARGETING_TYPE_OMID", +"TARGETING_TYPE_AUDIO_CONTENT_TYPE", +"TARGETING_TYPE_CONTENT_GENRE", +"TARGETING_TYPE_YOUTUBE_VIDEO", +"TARGETING_TYPE_YOUTUBE_CHANNEL", +"TARGETING_TYPE_SESSION_POSITION" +], +"enumDescriptions": [ +"Default value when type is not specified or is unknown in this version.", +"Target a channel (a custom group of related websites or apps).", +"Target an app category (for example, education or puzzle games).", +"Target a specific app (for example, Angry Birds).", +"Target a specific url (for example, quora.com).", +"Target ads during a chosen time period on a specific day.", +"Target ads to a specific age range (for example, 18-24).", +"Target ads to the specified regions on a regional location list.", +"Target ads to the specified points of interest on a proximity location list.", +"Target ads to a specific gender (for example, female or male).", +"Target a specific video player size for video ads.", +"Target user rewarded content for video ads.", +"Target ads to a specific parental status (for example, parent or not a parent).", +"Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", +"Target ads in a specific content outstream position.", +"Target ads to a specific device type (for example, tablet or connected TV).", +"Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", +"Target ads to specific web browsers (for example, Chrome).", +"Target ads to a specific household income range (for example, top 10%).", +"Target ads in a specific on screen position.", +"Filter web sites through third party verification (for example, IAS or DoubleVerify).", +"Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", +"Filter website content by sensitive categories (for example, adult).", +"Target ads to a specific environment (for example, web or app).", +"Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", +"Target ads to a specific operating system (for example, macOS).", +"Target ads to a specific device make or model (for example, Roku or Samsung).", +"Target ads to a specific keyword (for example, dog or retriever).", +"Target ads to a specific negative keyword list.", +"Target ads to a specific viewability (for example, 80% viewable).", +"Target ads to a specific content category (for example, arts & entertainment).", +"Purchase impressions from specific deals and auction packages.", +"Target ads to a specific language (for example, English or Japanese).", +"Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", +"Target ads to a specific regional location (for example, a city or state).", +"Purchase impressions from a group of deals and auction packages.", +"Purchase impressions from specific exchanges.", +"Purchase impressions from specific sub-exchanges.", +"Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", +"Target ads around locations of a business chain within a specific geo region.", +"Target ads to a specific video content duration.", +"Target ads to a specific video content stream type.", +"Target ads to a specific native content position.", +"Target ads in an Open Measurement enabled inventory.", +"Target ads to a specific audio content type.", +"Target ads to a specific content genre.", +"Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", +"Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", +"Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." +], +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions", +"response": { +"$ref": "ListPartnerAssignedTargetingOptionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +} +} +} +} +} +} +}, +"sdfdownloadtasks": { +"methods": { +"create": { +"description": "Creates an SDF Download Task. Returns an Operation. An SDF Download Task is a long-running, asynchronous operation. The metadata type of this operation is SdfDownloadTaskMetadata. If the request is successful, the response type of the operation is SdfDownloadTask. The response will not include the download files, which must be retrieved with media.download. The state of operation can be retrieved with sdfdownloadtask.operations.get. Any errors can be found in the error.message. Note that error.details is expected to be empty.", +"flatPath": "v4/sdfdownloadtasks", +"httpMethod": "POST", +"id": "displayvideo.sdfdownloadtasks.create", +"parameterOrder": [], +"parameters": {}, +"path": "v4/sdfdownloadtasks", +"request": { +"$ref": "CreateSdfDownloadTaskRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +} +}, +"resources": { +"operations": { +"methods": { +"get": { +"description": "Gets the latest state of an asynchronous SDF download task operation. Clients should poll this method at intervals of 30 seconds.", +"flatPath": "v4/sdfdownloadtasks/operations/{operationsId}", +"httpMethod": "GET", +"id": "displayvideo.sdfdownloadtasks.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^sdfdownloadtasks/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video", +"https://www.googleapis.com/auth/doubleclickbidmanager" +] +} +} +} +} +}, +"sdfuploadtasks": { +"resources": { +"operations": { +"methods": { +"get": { +"description": "Gets the latest state of an asynchronous SDF download task operation. Clients should poll this method at intervals of 30 seconds.", +"flatPath": "v4/sdfuploadtasks/operations/{operationsId}", +"httpMethod": "GET", +"id": "displayvideo.sdfuploadtasks.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^sdfuploadtasks/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video", +"https://www.googleapis.com/auth/doubleclickbidmanager" +] +} +} +} +} +}, +"targetingTypes": { +"resources": { +"targetingOptions": { +"methods": { +"get": { +"description": "Gets a single targeting option.", +"flatPath": "v4/targetingTypes/{targetingTypesId}/targetingOptions/{targetingOptionsId}", +"httpMethod": "GET", +"id": "displayvideo.targetingTypes.targetingOptions.get", +"parameterOrder": [ +"targetingType", +"targetingOptionId" +], +"parameters": { +"advertiserId": { +"description": "Required. The Advertiser this request is being made in the context of.", +"format": "int64", +"location": "query", +"type": "string" +}, +"targetingOptionId": { +"description": "Required. The ID of the of targeting option to retrieve.", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"targetingType": { +"description": "Required. The type of targeting option to retrieve. Accepted values are: * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID`", +"enum": [ +"TARGETING_TYPE_UNSPECIFIED", +"TARGETING_TYPE_CHANNEL", +"TARGETING_TYPE_APP_CATEGORY", +"TARGETING_TYPE_APP", +"TARGETING_TYPE_URL", +"TARGETING_TYPE_DAY_AND_TIME", +"TARGETING_TYPE_AGE_RANGE", +"TARGETING_TYPE_REGIONAL_LOCATION_LIST", +"TARGETING_TYPE_PROXIMITY_LOCATION_LIST", +"TARGETING_TYPE_GENDER", +"TARGETING_TYPE_VIDEO_PLAYER_SIZE", +"TARGETING_TYPE_USER_REWARDED_CONTENT", +"TARGETING_TYPE_PARENTAL_STATUS", +"TARGETING_TYPE_CONTENT_INSTREAM_POSITION", +"TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", +"TARGETING_TYPE_DEVICE_TYPE", +"TARGETING_TYPE_AUDIENCE_GROUP", +"TARGETING_TYPE_BROWSER", +"TARGETING_TYPE_HOUSEHOLD_INCOME", +"TARGETING_TYPE_ON_SCREEN_POSITION", +"TARGETING_TYPE_THIRD_PARTY_VERIFIER", +"TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", +"TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", +"TARGETING_TYPE_ENVIRONMENT", +"TARGETING_TYPE_CARRIER_AND_ISP", +"TARGETING_TYPE_OPERATING_SYSTEM", +"TARGETING_TYPE_DEVICE_MAKE_MODEL", +"TARGETING_TYPE_KEYWORD", +"TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", +"TARGETING_TYPE_VIEWABILITY", +"TARGETING_TYPE_CATEGORY", +"TARGETING_TYPE_INVENTORY_SOURCE", +"TARGETING_TYPE_LANGUAGE", +"TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", +"TARGETING_TYPE_GEO_REGION", +"TARGETING_TYPE_INVENTORY_SOURCE_GROUP", +"TARGETING_TYPE_EXCHANGE", +"TARGETING_TYPE_SUB_EXCHANGE", +"TARGETING_TYPE_POI", +"TARGETING_TYPE_BUSINESS_CHAIN", +"TARGETING_TYPE_CONTENT_DURATION", +"TARGETING_TYPE_CONTENT_STREAM_TYPE", +"TARGETING_TYPE_NATIVE_CONTENT_POSITION", +"TARGETING_TYPE_OMID", +"TARGETING_TYPE_AUDIO_CONTENT_TYPE", +"TARGETING_TYPE_CONTENT_GENRE", +"TARGETING_TYPE_YOUTUBE_VIDEO", +"TARGETING_TYPE_YOUTUBE_CHANNEL", +"TARGETING_TYPE_SESSION_POSITION" +], +"enumDescriptions": [ +"Default value when type is not specified or is unknown in this version.", +"Target a channel (a custom group of related websites or apps).", +"Target an app category (for example, education or puzzle games).", +"Target a specific app (for example, Angry Birds).", +"Target a specific url (for example, quora.com).", +"Target ads during a chosen time period on a specific day.", +"Target ads to a specific age range (for example, 18-24).", +"Target ads to the specified regions on a regional location list.", +"Target ads to the specified points of interest on a proximity location list.", +"Target ads to a specific gender (for example, female or male).", +"Target a specific video player size for video ads.", +"Target user rewarded content for video ads.", +"Target ads to a specific parental status (for example, parent or not a parent).", +"Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", +"Target ads in a specific content outstream position.", +"Target ads to a specific device type (for example, tablet or connected TV).", +"Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", +"Target ads to specific web browsers (for example, Chrome).", +"Target ads to a specific household income range (for example, top 10%).", +"Target ads in a specific on screen position.", +"Filter web sites through third party verification (for example, IAS or DoubleVerify).", +"Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", +"Filter website content by sensitive categories (for example, adult).", +"Target ads to a specific environment (for example, web or app).", +"Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", +"Target ads to a specific operating system (for example, macOS).", +"Target ads to a specific device make or model (for example, Roku or Samsung).", +"Target ads to a specific keyword (for example, dog or retriever).", +"Target ads to a specific negative keyword list.", +"Target ads to a specific viewability (for example, 80% viewable).", +"Target ads to a specific content category (for example, arts & entertainment).", +"Purchase impressions from specific deals and auction packages.", +"Target ads to a specific language (for example, English or Japanese).", +"Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", +"Target ads to a specific regional location (for example, a city or state).", +"Purchase impressions from a group of deals and auction packages.", +"Purchase impressions from specific exchanges.", +"Purchase impressions from specific sub-exchanges.", +"Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", +"Target ads around locations of a business chain within a specific geo region.", +"Target ads to a specific video content duration.", +"Target ads to a specific video content stream type.", +"Target ads to a specific native content position.", +"Target ads in an Open Measurement enabled inventory.", +"Target ads to a specific audio content type.", +"Target ads to a specific content genre.", +"Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", +"Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", +"Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." +], +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/targetingTypes/{+targetingType}/targetingOptions/{+targetingOptionId}", +"response": { +"$ref": "TargetingOption" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"list": { +"description": "Lists targeting options of a given type.", +"flatPath": "v4/targetingTypes/{targetingTypesId}/targetingOptions", +"httpMethod": "GET", +"id": "displayvideo.targetingTypes.targetingOptions.list", +"parameterOrder": [ +"targetingType" +], +"parameters": { +"advertiserId": { +"description": "Required. The Advertiser this request is being made in the context of.", +"format": "int64", +"location": "query", +"type": "string" +}, +"filter": { +"description": "Allows filtering by targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `OR` logical operators. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `carrierAndIspDetails.type` * `geoRegionDetails.geoRegionType` * `targetingOptionId` Examples: * All `GEO REGION` targeting options that belong to sub type `GEO_REGION_TYPE_COUNTRY` or `GEO_REGION_TYPE_STATE`: `geoRegionDetails.geoRegionType=\"GEO_REGION_TYPE_COUNTRY\" OR geoRegionDetails.geoRegionType=\"GEO_REGION_TYPE_STATE\"` * All `CARRIER AND ISP` targeting options that belong to sub type `CARRIER_AND_ISP_TYPE_CARRIER`: `carrierAndIspDetails.type=\"CARRIER_AND_ISP_TYPE_CARRIER\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Field by which to sort the list. Acceptable values are: * `targetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `targetingOptionId desc`.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListTargetingOptions` method. If not specified, the first page of results will be returned.", +"location": "query", +"type": "string" +}, +"targetingType": { +"description": "Required. The type of targeting option to be listed. Accepted values are: * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID`", +"enum": [ +"TARGETING_TYPE_UNSPECIFIED", +"TARGETING_TYPE_CHANNEL", +"TARGETING_TYPE_APP_CATEGORY", +"TARGETING_TYPE_APP", +"TARGETING_TYPE_URL", +"TARGETING_TYPE_DAY_AND_TIME", +"TARGETING_TYPE_AGE_RANGE", +"TARGETING_TYPE_REGIONAL_LOCATION_LIST", +"TARGETING_TYPE_PROXIMITY_LOCATION_LIST", +"TARGETING_TYPE_GENDER", +"TARGETING_TYPE_VIDEO_PLAYER_SIZE", +"TARGETING_TYPE_USER_REWARDED_CONTENT", +"TARGETING_TYPE_PARENTAL_STATUS", +"TARGETING_TYPE_CONTENT_INSTREAM_POSITION", +"TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", +"TARGETING_TYPE_DEVICE_TYPE", +"TARGETING_TYPE_AUDIENCE_GROUP", +"TARGETING_TYPE_BROWSER", +"TARGETING_TYPE_HOUSEHOLD_INCOME", +"TARGETING_TYPE_ON_SCREEN_POSITION", +"TARGETING_TYPE_THIRD_PARTY_VERIFIER", +"TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", +"TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", +"TARGETING_TYPE_ENVIRONMENT", +"TARGETING_TYPE_CARRIER_AND_ISP", +"TARGETING_TYPE_OPERATING_SYSTEM", +"TARGETING_TYPE_DEVICE_MAKE_MODEL", +"TARGETING_TYPE_KEYWORD", +"TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", +"TARGETING_TYPE_VIEWABILITY", +"TARGETING_TYPE_CATEGORY", +"TARGETING_TYPE_INVENTORY_SOURCE", +"TARGETING_TYPE_LANGUAGE", +"TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", +"TARGETING_TYPE_GEO_REGION", +"TARGETING_TYPE_INVENTORY_SOURCE_GROUP", +"TARGETING_TYPE_EXCHANGE", +"TARGETING_TYPE_SUB_EXCHANGE", +"TARGETING_TYPE_POI", +"TARGETING_TYPE_BUSINESS_CHAIN", +"TARGETING_TYPE_CONTENT_DURATION", +"TARGETING_TYPE_CONTENT_STREAM_TYPE", +"TARGETING_TYPE_NATIVE_CONTENT_POSITION", +"TARGETING_TYPE_OMID", +"TARGETING_TYPE_AUDIO_CONTENT_TYPE", +"TARGETING_TYPE_CONTENT_GENRE", +"TARGETING_TYPE_YOUTUBE_VIDEO", +"TARGETING_TYPE_YOUTUBE_CHANNEL", +"TARGETING_TYPE_SESSION_POSITION" +], +"enumDescriptions": [ +"Default value when type is not specified or is unknown in this version.", +"Target a channel (a custom group of related websites or apps).", +"Target an app category (for example, education or puzzle games).", +"Target a specific app (for example, Angry Birds).", +"Target a specific url (for example, quora.com).", +"Target ads during a chosen time period on a specific day.", +"Target ads to a specific age range (for example, 18-24).", +"Target ads to the specified regions on a regional location list.", +"Target ads to the specified points of interest on a proximity location list.", +"Target ads to a specific gender (for example, female or male).", +"Target a specific video player size for video ads.", +"Target user rewarded content for video ads.", +"Target ads to a specific parental status (for example, parent or not a parent).", +"Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", +"Target ads in a specific content outstream position.", +"Target ads to a specific device type (for example, tablet or connected TV).", +"Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", +"Target ads to specific web browsers (for example, Chrome).", +"Target ads to a specific household income range (for example, top 10%).", +"Target ads in a specific on screen position.", +"Filter web sites through third party verification (for example, IAS or DoubleVerify).", +"Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", +"Filter website content by sensitive categories (for example, adult).", +"Target ads to a specific environment (for example, web or app).", +"Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", +"Target ads to a specific operating system (for example, macOS).", +"Target ads to a specific device make or model (for example, Roku or Samsung).", +"Target ads to a specific keyword (for example, dog or retriever).", +"Target ads to a specific negative keyword list.", +"Target ads to a specific viewability (for example, 80% viewable).", +"Target ads to a specific content category (for example, arts & entertainment).", +"Purchase impressions from specific deals and auction packages.", +"Target ads to a specific language (for example, English or Japanese).", +"Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", +"Target ads to a specific regional location (for example, a city or state).", +"Purchase impressions from a group of deals and auction packages.", +"Purchase impressions from specific exchanges.", +"Purchase impressions from specific sub-exchanges.", +"Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", +"Target ads around locations of a business chain within a specific geo region.", +"Target ads to a specific video content duration.", +"Target ads to a specific video content stream type.", +"Target ads to a specific native content position.", +"Target ads in an Open Measurement enabled inventory.", +"Target ads to a specific audio content type.", +"Target ads to a specific content genre.", +"Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", +"Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", +"Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." +], +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/targetingTypes/{+targetingType}/targetingOptions", +"response": { +"$ref": "ListTargetingOptionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"search": { +"description": "Searches for targeting options of a given type based on the given search terms.", +"flatPath": "v4/targetingTypes/{targetingTypesId}/targetingOptions:search", +"httpMethod": "POST", +"id": "displayvideo.targetingTypes.targetingOptions.search", +"parameterOrder": [ +"targetingType" +], +"parameters": { +"targetingType": { +"description": "Required. The type of targeting options to retrieve. Accepted values are: * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_BUSINESS_CHAIN`", +"enum": [ +"TARGETING_TYPE_UNSPECIFIED", +"TARGETING_TYPE_CHANNEL", +"TARGETING_TYPE_APP_CATEGORY", +"TARGETING_TYPE_APP", +"TARGETING_TYPE_URL", +"TARGETING_TYPE_DAY_AND_TIME", +"TARGETING_TYPE_AGE_RANGE", +"TARGETING_TYPE_REGIONAL_LOCATION_LIST", +"TARGETING_TYPE_PROXIMITY_LOCATION_LIST", +"TARGETING_TYPE_GENDER", +"TARGETING_TYPE_VIDEO_PLAYER_SIZE", +"TARGETING_TYPE_USER_REWARDED_CONTENT", +"TARGETING_TYPE_PARENTAL_STATUS", +"TARGETING_TYPE_CONTENT_INSTREAM_POSITION", +"TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", +"TARGETING_TYPE_DEVICE_TYPE", +"TARGETING_TYPE_AUDIENCE_GROUP", +"TARGETING_TYPE_BROWSER", +"TARGETING_TYPE_HOUSEHOLD_INCOME", +"TARGETING_TYPE_ON_SCREEN_POSITION", +"TARGETING_TYPE_THIRD_PARTY_VERIFIER", +"TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", +"TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", +"TARGETING_TYPE_ENVIRONMENT", +"TARGETING_TYPE_CARRIER_AND_ISP", +"TARGETING_TYPE_OPERATING_SYSTEM", +"TARGETING_TYPE_DEVICE_MAKE_MODEL", +"TARGETING_TYPE_KEYWORD", +"TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", +"TARGETING_TYPE_VIEWABILITY", +"TARGETING_TYPE_CATEGORY", +"TARGETING_TYPE_INVENTORY_SOURCE", +"TARGETING_TYPE_LANGUAGE", +"TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", +"TARGETING_TYPE_GEO_REGION", +"TARGETING_TYPE_INVENTORY_SOURCE_GROUP", +"TARGETING_TYPE_EXCHANGE", +"TARGETING_TYPE_SUB_EXCHANGE", +"TARGETING_TYPE_POI", +"TARGETING_TYPE_BUSINESS_CHAIN", +"TARGETING_TYPE_CONTENT_DURATION", +"TARGETING_TYPE_CONTENT_STREAM_TYPE", +"TARGETING_TYPE_NATIVE_CONTENT_POSITION", +"TARGETING_TYPE_OMID", +"TARGETING_TYPE_AUDIO_CONTENT_TYPE", +"TARGETING_TYPE_CONTENT_GENRE", +"TARGETING_TYPE_YOUTUBE_VIDEO", +"TARGETING_TYPE_YOUTUBE_CHANNEL", +"TARGETING_TYPE_SESSION_POSITION" +], +"enumDescriptions": [ +"Default value when type is not specified or is unknown in this version.", +"Target a channel (a custom group of related websites or apps).", +"Target an app category (for example, education or puzzle games).", +"Target a specific app (for example, Angry Birds).", +"Target a specific url (for example, quora.com).", +"Target ads during a chosen time period on a specific day.", +"Target ads to a specific age range (for example, 18-24).", +"Target ads to the specified regions on a regional location list.", +"Target ads to the specified points of interest on a proximity location list.", +"Target ads to a specific gender (for example, female or male).", +"Target a specific video player size for video ads.", +"Target user rewarded content for video ads.", +"Target ads to a specific parental status (for example, parent or not a parent).", +"Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", +"Target ads in a specific content outstream position.", +"Target ads to a specific device type (for example, tablet or connected TV).", +"Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", +"Target ads to specific web browsers (for example, Chrome).", +"Target ads to a specific household income range (for example, top 10%).", +"Target ads in a specific on screen position.", +"Filter web sites through third party verification (for example, IAS or DoubleVerify).", +"Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", +"Filter website content by sensitive categories (for example, adult).", +"Target ads to a specific environment (for example, web or app).", +"Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", +"Target ads to a specific operating system (for example, macOS).", +"Target ads to a specific device make or model (for example, Roku or Samsung).", +"Target ads to a specific keyword (for example, dog or retriever).", +"Target ads to a specific negative keyword list.", +"Target ads to a specific viewability (for example, 80% viewable).", +"Target ads to a specific content category (for example, arts & entertainment).", +"Purchase impressions from specific deals and auction packages.", +"Target ads to a specific language (for example, English or Japanese).", +"Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", +"Target ads to a specific regional location (for example, a city or state).", +"Purchase impressions from a group of deals and auction packages.", +"Purchase impressions from specific exchanges.", +"Purchase impressions from specific sub-exchanges.", +"Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", +"Target ads around locations of a business chain within a specific geo region.", +"Target ads to a specific video content duration.", +"Target ads to a specific video content stream type.", +"Target ads to a specific native content position.", +"Target ads in an Open Measurement enabled inventory.", +"Target ads to a specific audio content type.", +"Target ads to a specific content genre.", +"Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", +"Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", +"Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." +], +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/targetingTypes/{+targetingType}/targetingOptions:search", +"request": { +"$ref": "SearchTargetingOptionsRequest" +}, +"response": { +"$ref": "SearchTargetingOptionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +} +} +} +} +}, +"users": { +"methods": { +"bulkEditAssignedUserRoles": { +"description": "Bulk edits user roles for a user. The operation will delete the assigned user roles provided in BulkEditAssignedUserRolesRequest.deletedAssignedUserRoles and then assign the user roles provided in BulkEditAssignedUserRolesRequest.createdAssignedUserRoles. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The \"Try this method\" feature does not work for this method.", +"flatPath": "v4/users/{usersId}:bulkEditAssignedUserRoles", +"httpMethod": "POST", +"id": "displayvideo.users.bulkEditAssignedUserRoles", +"parameterOrder": [ +"userId" +], +"parameters": { +"userId": { +"description": "Required. The ID of the user to which the assigned user roles belong.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/users/{+userId}:bulkEditAssignedUserRoles", +"request": { +"$ref": "BulkEditAssignedUserRolesRequest" +}, +"response": { +"$ref": "BulkEditAssignedUserRolesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video-user-management" +] +}, +"create": { +"description": "Creates a new user. Returns the newly created user if successful. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The \"Try this method\" feature does not work for this method.", +"flatPath": "v4/users", +"httpMethod": "POST", +"id": "displayvideo.users.create", +"parameterOrder": [], +"parameters": {}, +"path": "v4/users", +"request": { +"$ref": "User" +}, +"response": { +"$ref": "User" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video-user-management" +] +}, +"delete": { +"description": "Deletes a user. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The \"Try this method\" feature does not work for this method.", +"flatPath": "v4/users/{usersId}", +"httpMethod": "DELETE", +"id": "displayvideo.users.delete", +"parameterOrder": [ +"userId" +], +"parameters": { +"userId": { +"description": "Required. The ID of the user to delete.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/users/{+userId}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video-user-management" +] +}, +"get": { +"description": "Gets a user. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The \"Try this method\" feature does not work for this method.", +"flatPath": "v4/users/{usersId}", +"httpMethod": "GET", +"id": "displayvideo.users.get", +"parameterOrder": [ +"userId" +], +"parameters": { +"userId": { +"description": "Required. The ID of the user to fetch.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/users/{+userId}", +"response": { +"$ref": "User" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video-user-management" +] +}, +"list": { +"description": "Lists users that are accessible to the current user. If two users have user roles on the same partner or advertiser, they can access each other. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The \"Try this method\" feature does not work for this method.", +"flatPath": "v4/users", +"httpMethod": "GET", +"id": "displayvideo.users.list", +"parameterOrder": [], +"parameters": { +"filter": { +"description": "Allows filtering by user fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `displayName` and `email` fields must use the `HAS (:)` operator. * The `lastLoginTime` field must use either the `LESS THAN OR EQUAL TO (<=)` or `GREATER THAN OR EQUAL TO (>=)` operator. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `assignedUserRole.advertiserId` * `assignedUserRole.entityType`: This is synthetic field of `AssignedUserRole` used for filtering. Identifies the type of entity to which the user role is assigned. Valid values are `Partner` and `Advertiser`. * `assignedUserRole.parentPartnerId`: This is a synthetic field of `AssignedUserRole` used for filtering. Identifies the parent partner of the entity to which the user role is assigned. * `assignedUserRole.partnerId` * `assignedUserRole.userRole` * `displayName` * `email` * `lastLoginTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * The user with `displayName` containing \"foo\": `displayName:\"foo\"` * The user with `email` containing \"bar\": `email:\"bar\"` * All users with standard user roles: `assignedUserRole.userRole=\"STANDARD\"` * All users with user roles for partner 123: `assignedUserRole.partnerId=\"123\"` * All users with user roles for advertiser 123: `assignedUserRole.advertiserId=\"123\"` * All users with partner level user roles: `entityType=\"PARTNER\"` * All users with user roles for partner 123 and advertisers under partner 123: `parentPartnerId=\"123\"` * All users that last logged in on or after 2023-01-01T00:00:00Z (format of ISO 8601): `lastLoginTime>=\"2023-01-01T00:00:00Z\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Field by which to sort the list. Acceptable values are: * `displayName` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. For example, `displayName desc`.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListUsers` method. If not specified, the first page of results will be returned.", +"location": "query", +"type": "string" +} +}, +"path": "v4/users", +"response": { +"$ref": "ListUsersResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video-user-management" +] +}, +"patch": { +"description": "Updates an existing user. Returns the updated user if successful. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The \"Try this method\" feature does not work for this method.", +"flatPath": "v4/users/{usersId}", +"httpMethod": "PATCH", +"id": "displayvideo.users.patch", +"parameterOrder": [ +"userId" +], +"parameters": { +"updateMask": { +"description": "Required. The mask to control which fields to update.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +}, +"userId": { +"description": "Output only. The unique ID of the user. Assigned by the system.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/users/{+userId}", +"request": { +"$ref": "User" +}, +"response": { +"$ref": "User" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video-user-management" +] +} +} +} +}, +"revision": "20250220", +"rootUrl": "https://displayvideo.googleapis.com/", +"schemas": { +"ActiveViewVideoViewabilityMetricConfig": { +"description": "Configuration for custom Active View video viewability metrics.", +"id": "ActiveViewVideoViewabilityMetricConfig", +"properties": { +"displayName": { +"description": "Required. The display name of the custom metric.", +"type": "string" +}, +"minimumDuration": { +"description": "The minimum visible video duration required (in seconds) in order for an impression to be recorded. You must specify minimum_duration, minimum_quartile or both. If both are specified, an impression meets the metric criteria if either requirement is met (whichever happens first).", +"enum": [ +"VIDEO_DURATION_UNSPECIFIED", +"VIDEO_DURATION_SECONDS_NONE", +"VIDEO_DURATION_SECONDS_0", +"VIDEO_DURATION_SECONDS_1", +"VIDEO_DURATION_SECONDS_2", +"VIDEO_DURATION_SECONDS_3", +"VIDEO_DURATION_SECONDS_4", +"VIDEO_DURATION_SECONDS_5", +"VIDEO_DURATION_SECONDS_6", +"VIDEO_DURATION_SECONDS_7", +"VIDEO_DURATION_SECONDS_8", +"VIDEO_DURATION_SECONDS_9", +"VIDEO_DURATION_SECONDS_10", +"VIDEO_DURATION_SECONDS_11", +"VIDEO_DURATION_SECONDS_12", +"VIDEO_DURATION_SECONDS_13", +"VIDEO_DURATION_SECONDS_14", +"VIDEO_DURATION_SECONDS_15", +"VIDEO_DURATION_SECONDS_30", +"VIDEO_DURATION_SECONDS_45", +"VIDEO_DURATION_SECONDS_60" +], +"enumDescriptions": [ +"Value is not specified or is unknown in this version.", +"No duration value.", +"0 seconds.", +"1 second.", +"2 seconds.", +"3 seconds.", +"4 seconds.", +"5 seconds.", +"6 seconds.", +"7 seconds.", +"8 seconds.", +"9 seconds.", +"10 seconds.", +"11 seconds.", +"12 seconds.", +"13 seconds.", +"14 seconds.", +"15 seconds.", +"30 seconds.", +"45 seconds.", +"60 seconds." +], +"type": "string" +}, +"minimumQuartile": { +"description": "The minimum visible video duration required, based on the video quartiles, in order for an impression to be recorded. You must specify minimum_duration, minimum_quartile or both. If both are specified, an impression meets the metric criteria if either requirement is met (whichever happens first).", +"enum": [ +"VIDEO_DURATION_QUARTILE_UNSPECIFIED", +"VIDEO_DURATION_QUARTILE_NONE", +"VIDEO_DURATION_QUARTILE_FIRST", +"VIDEO_DURATION_QUARTILE_SECOND", +"VIDEO_DURATION_QUARTILE_THIRD", +"VIDEO_DURATION_QUARTILE_FOURTH" +], +"enumDescriptions": [ +"Value is not specified or is unknown in this version.", +"No quartile value.", +"First quartile.", +"Second quartile (midpoint).", +"Third quartile.", +"Fourth quartile (completion)." +], +"type": "string" +}, +"minimumViewability": { +"description": "Required. The minimum percentage of the video ad's pixels visible on the screen in order for an impression to be recorded.", +"enum": [ +"VIEWABILITY_PERCENT_UNSPECIFIED", +"VIEWABILITY_PERCENT_0", +"VIEWABILITY_PERCENT_25", +"VIEWABILITY_PERCENT_50", +"VIEWABILITY_PERCENT_75", +"VIEWABILITY_PERCENT_100" +], +"enumDescriptions": [ +"Value is not specified or is unknown in this version.", +"0% viewable.", +"25% viewable.", +"50% viewable.", +"75% viewable.", +"100% viewable." +], +"type": "string" +}, +"minimumVolume": { +"description": "Required. The minimum percentage of the video ad's volume required in order for an impression to be recorded.", +"enum": [ +"VIDEO_VOLUME_PERCENT_UNSPECIFIED", +"VIDEO_VOLUME_PERCENT_0", +"VIDEO_VOLUME_PERCENT_10" +], +"enumDescriptions": [ +"Value is not specified or is unknown in this version.", +"0% volume.", +"10% volume." +], +"type": "string" +} +}, +"type": "object" +}, +"AdGroup": { +"description": "A single ad group associated with a line item.", +"id": "AdGroup", +"properties": { +"adGroupFormat": { +"description": "The format of the ads in the ad group.", +"enum": [ +"AD_GROUP_FORMAT_UNSPECIFIED", +"AD_GROUP_FORMAT_IN_STREAM", +"AD_GROUP_FORMAT_VIDEO_DISCOVERY", +"AD_GROUP_FORMAT_BUMPER", +"AD_GROUP_FORMAT_NON_SKIPPABLE_IN_STREAM", +"AD_GROUP_FORMAT_AUDIO", +"AD_GROUP_FORMAT_RESPONSIVE", +"AD_GROUP_FORMAT_REACH", +"AD_GROUP_FORMAT_MASTHEAD" +], +"enumDescriptions": [ +"Format value is not specified or is unknown in this version.", +"In-stream ads.", +"In-feed ads.", +"Bumper ads.", +"Non-skippable in-stream ads.", +"Non-skippable in-stream audio ads.", +"Responsive ads.", +"[Effective reach ad groups] (https://support.google.com/displayvideo/answer/9173684), including in-stream and bumper ads.", +"Masthead Ad that is surfaced on the top slot on the YouTube homepage." +], +"type": "string" +}, +"adGroupId": { +"description": "The unique ID of the ad group. Assigned by the system.", +"format": "int64", +"type": "string" +}, +"advertiserId": { +"description": "The unique ID of the advertiser the ad group belongs to.", +"format": "int64", +"type": "string" +}, +"bidStrategy": { +"$ref": "BiddingStrategy", +"description": "The bidding strategy used by the ad group. Only the youtubeAndPartnersBid field can be used in the bidding strategy." +}, +"displayName": { +"description": "The display name of the ad group. Must be UTF-8 encoded with a maximum size of 255 bytes.", +"type": "string" +}, +"entityStatus": { +"description": "Controls whether or not the ad group can spend its budget and bid on inventory. If the ad group's parent line item is not active, the ad group can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.", +"enum": [ +"ENTITY_STATUS_UNSPECIFIED", +"ENTITY_STATUS_ACTIVE", +"ENTITY_STATUS_ARCHIVED", +"ENTITY_STATUS_DRAFT", +"ENTITY_STATUS_PAUSED", +"ENTITY_STATUS_SCHEDULED_FOR_DELETION" +], +"enumDescriptions": [ +"Default value when status is not specified or is unknown in this version.", +"The entity is enabled to bid and spend budget.", +"The entity is archived. Bidding and budget spending are disabled. An entity can be deleted after archived. Deleted entities cannot be retrieved.", +"The entity is under draft. Bidding and budget spending are disabled.", +"Bidding and budget spending are paused for the entity.", +"The entity is scheduled for deletion." +], +"type": "string" +}, +"lineItemId": { +"description": "The unique ID of the line item that the ad group belongs to.", +"format": "int64", +"type": "string" +}, +"name": { +"description": "The resource name of the ad group.", +"type": "string" +}, +"productFeedData": { +"$ref": "ProductFeedData", +"description": "The settings of the product feed in this ad group." +}, +"targetingExpansion": { +"$ref": "TargetingExpansionConfig", +"description": "The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the ad group." +} +}, +"type": "object" +}, +"AdGroupAd": { +"description": "A single ad associated with an ad group.", +"id": "AdGroupAd", +"properties": { +"adGroupAdId": { +"description": "The unique ID of the ad. Assigned by the system.", +"format": "int64", +"type": "string" +}, +"adGroupId": { +"description": "The unique ID of the ad group that the ad belongs to.", +"format": "int64", +"type": "string" +}, +"adUrls": { +"description": "List of URLs used by the ad.", +"items": { +"$ref": "AdUrl" +}, +"type": "array" +}, +"advertiserId": { +"description": "The unique ID of the advertiser the ad belongs to.", +"format": "int64", +"type": "string" +}, +"audioAd": { +"$ref": "AudioAd", +"description": "Details of an [audio ad](//support.google.com/displayvideo/answer/6274216) used for reach marketing objectives." +}, +"bumperAd": { +"$ref": "BumperAd", +"description": "Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach." +}, +"displayName": { +"description": "The display name of the ad. Must be UTF-8 encoded with a maximum size of 255 bytes.", +"type": "string" +}, +"displayVideoSourceAd": { +"$ref": "DisplayVideoSourceAd", +"description": "Details of an ad sourced from a Display & Video 360 creative." +}, +"entityStatus": { +"description": "The entity status of the ad.", +"enum": [ +"ENTITY_STATUS_UNSPECIFIED", +"ENTITY_STATUS_ACTIVE", +"ENTITY_STATUS_ARCHIVED", +"ENTITY_STATUS_DRAFT", +"ENTITY_STATUS_PAUSED", +"ENTITY_STATUS_SCHEDULED_FOR_DELETION" +], +"enumDescriptions": [ +"Default value when status is not specified or is unknown in this version.", +"The entity is enabled to bid and spend budget.", +"The entity is archived. Bidding and budget spending are disabled. An entity can be deleted after archived. Deleted entities cannot be retrieved.", +"The entity is under draft. Bidding and budget spending are disabled.", +"Bidding and budget spending are paused for the entity.", +"The entity is scheduled for deletion." +], +"type": "string" +}, +"inStreamAd": { +"$ref": "InStreamAd", +"description": "Details of an [in-stream ad skippable after 5 seconds](//support.google.com/displayvideo/answer/6274216), used for brand awareness or reach marketing objectives." +}, +"mastheadAd": { +"$ref": "MastheadAd", +"description": "Details of an [ad served on the YouTube Home feed](//support.google.com/google-ads/answer/9709826)." +}, +"name": { +"description": "The resource name of the ad.", +"type": "string" +}, +"nonSkippableAd": { +"$ref": "NonSkippableAd", +"description": "Details of a [non-skippable short in-stream video ad](//support.google.com/displayvideo/answer/6274216), between 6 and 15 seconds, used for reach marketing objectives." +}, +"videoDiscoverAd": { +"$ref": "VideoDiscoveryAd", +"description": "Details of an [ad promoting a video](//support.google.com/displayvideo/answer/6274216) that shows in places of discovery." +}, +"videoPerformanceAd": { +"$ref": "VideoPerformanceAd", +"description": "Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product." +} +}, +"type": "object" +}, +"AdGroupAssignedTargetingOption": { +"description": "Wrapper object associating an AssignedTargetingOption resource and the ad group it is assigned to.", +"id": "AdGroupAssignedTargetingOption", +"properties": { +"adGroupId": { +"description": "The ID of the ad group the assigned targeting option is assigned to.", +"format": "int64", +"type": "string" +}, +"assignedTargetingOption": { +"$ref": "AssignedTargetingOption", +"description": "The assigned targeting option resource." +} +}, +"type": "object" +}, +"AdUrl": { +"description": "Additional URLs related to the ad, including beacons.", +"id": "AdUrl", +"properties": { +"type": { +"description": "The type of the Ad URL.", +"enum": [ +"AD_URL_TYPE_UNSPECIFIED", +"AD_URL_TYPE_BEACON_IMPRESSION", +"AD_URL_TYPE_BEACON_EXPANDABLE_DCM_IMPRESSION", +"AD_URL_TYPE_BEACON_CLICK", +"AD_URL_TYPE_BEACON_SKIP" +], +"enumDescriptions": [ +"Unknown or unspecified.", +"A 1x1 tracking pixel to ping when an impression of a creative is delivered.", +"Expandable DCM impression beacon. At serving time, it is expanded to several beacons.", +"Tracking URL to ping when the click event is triggered.", +"Tracking URL to ping when the skip event is triggered." +], +"type": "string" +}, +"url": { +"description": "The URL string value.", +"type": "string" +} +}, +"type": "object" +}, +"Adloox": { +"description": "Details of Adloox brand safety settings.", +"id": "Adloox", +"properties": { +"adultExplicitSexualContent": { +"description": "Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.", +"enum": [ +"GARM_RISK_EXCLUSION_UNSPECIFIED", +"GARM_RISK_EXCLUSION_FLOOR", +"GARM_RISK_EXCLUSION_HIGH", +"GARM_RISK_EXCLUSION_MEDIUM", +"GARM_RISK_EXCLUSION_LOW" +], +"enumDescriptions": [ +"This enum is only a placeholder and it doesn't specify any GARM risk exclusion option.", +"Exclude floor risk.", +"Exclude high and floor risk.", +"Exclude medium, high, and floor risk.", +"Exclude all levels of risk (low, medium, high and floor)." +], +"type": "string" +}, +"armsAmmunitionContent": { +"description": "Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.", +"enum": [ +"GARM_RISK_EXCLUSION_UNSPECIFIED", +"GARM_RISK_EXCLUSION_FLOOR", +"GARM_RISK_EXCLUSION_HIGH", +"GARM_RISK_EXCLUSION_MEDIUM", +"GARM_RISK_EXCLUSION_LOW" +], +"enumDescriptions": [ +"This enum is only a placeholder and it doesn't specify any GARM risk exclusion option.", +"Exclude floor risk.", +"Exclude high and floor risk.", +"Exclude medium, high, and floor risk.", +"Exclude all levels of risk (low, medium, high and floor)." +], +"type": "string" +}, +"crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": { +"description": "Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.", +"enum": [ +"GARM_RISK_EXCLUSION_UNSPECIFIED", +"GARM_RISK_EXCLUSION_FLOOR", +"GARM_RISK_EXCLUSION_HIGH", +"GARM_RISK_EXCLUSION_MEDIUM", +"GARM_RISK_EXCLUSION_LOW" +], +"enumDescriptions": [ +"This enum is only a placeholder and it doesn't specify any GARM risk exclusion option.", +"Exclude floor risk.", +"Exclude high and floor risk.", +"Exclude medium, high, and floor risk.", +"Exclude all levels of risk (low, medium, high and floor)." +], +"type": "string" +}, +"deathInjuryMilitaryConflictContent": { +"description": "Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.", +"enum": [ +"GARM_RISK_EXCLUSION_UNSPECIFIED", +"GARM_RISK_EXCLUSION_FLOOR", +"GARM_RISK_EXCLUSION_HIGH", +"GARM_RISK_EXCLUSION_MEDIUM", +"GARM_RISK_EXCLUSION_LOW" +], +"enumDescriptions": [ +"This enum is only a placeholder and it doesn't specify any GARM risk exclusion option.", +"Exclude floor risk.", +"Exclude high and floor risk.", +"Exclude medium, high, and floor risk.", +"Exclude all levels of risk (low, medium, high and floor)." +], +"type": "string" +}, +"debatedSensitiveSocialIssueContent": { +"description": "Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.", +"enum": [ +"GARM_RISK_EXCLUSION_UNSPECIFIED", +"GARM_RISK_EXCLUSION_FLOOR", +"GARM_RISK_EXCLUSION_HIGH", +"GARM_RISK_EXCLUSION_MEDIUM", +"GARM_RISK_EXCLUSION_LOW" +], +"enumDescriptions": [ +"This enum is only a placeholder and it doesn't specify any GARM risk exclusion option.", +"Exclude floor risk.", +"Exclude high and floor risk.", +"Exclude medium, high, and floor risk.", +"Exclude all levels of risk (low, medium, high and floor)." +], +"type": "string" +}, +"displayIabViewability": { +"description": "Optional. IAB viewability threshold for display ads.", +"enum": [ +"DISPLAY_IAB_VIEWABILITY_UNSPECIFIED", +"DISPLAY_IAB_VIEWABILITY_10", +"DISPLAY_IAB_VIEWABILITY_20", +"DISPLAY_IAB_VIEWABILITY_35", +"DISPLAY_IAB_VIEWABILITY_50", +"DISPLAY_IAB_VIEWABILITY_75" +], +"enumDescriptions": [ +"Default value when not specified or is unknown in this version.", +"10%+ in view (IAB display viewability standard).", +"20%+ in view (IAB display viewability standard).", +"35%+ in view (IAB display viewability standard).", +"50%+ in view (IAB display viewability standard).", +"75%+ in view (IAB display viewability standard)." +], +"type": "string" +}, +"excludedAdlooxCategories": { +"description": "Adloox categories to exclude.", +"items": { +"enum": [ +"ADLOOX_UNSPECIFIED", +"ADULT_CONTENT_HARD", +"ADULT_CONTENT_SOFT", +"ILLEGAL_CONTENT", +"BORDERLINE_CONTENT", +"DISCRIMINATORY_CONTENT", +"VIOLENT_CONTENT_WEAPONS", +"LOW_VIEWABILITY_DOMAINS", +"FRAUD" +], +"enumDescriptions": [ +"Default value when a Adloox category is not specified or is unknown in this version.", +"Adult content (hard).", +"Adult content (soft).", +"Illegal content.", +"Borderline content.", +"Discriminatory content.", +"Violent content & weapons.", +"Low viewability domains.", +"Fraud." +], +"type": "string" +}, +"type": "array" +}, +"excludedFraudIvtMfaCategories": { +"description": "Optional. Adloox's fraud IVT MFA categories to exclude.", +"items": { +"enum": [ +"FRAUD_IVT_MFA_CATEGORY_UNSPECIFIED", +"FRAUD_IVT_MFA" +], +"enumDescriptions": [ +"Default value when a Adloox Fraud, IVT, MFA category is not specified or is unknown in this version.", +"FRAUD, IVT, MFA." +], +"type": "string" +}, +"type": "array" +}, +"hateSpeechActsAggressionContent": { +"description": "Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.", +"enum": [ +"GARM_RISK_EXCLUSION_UNSPECIFIED", +"GARM_RISK_EXCLUSION_FLOOR", +"GARM_RISK_EXCLUSION_HIGH", +"GARM_RISK_EXCLUSION_MEDIUM", +"GARM_RISK_EXCLUSION_LOW" +], +"enumDescriptions": [ +"This enum is only a placeholder and it doesn't specify any GARM risk exclusion option.", +"Exclude floor risk.", +"Exclude high and floor risk.", +"Exclude medium, high, and floor risk.", +"Exclude all levels of risk (low, medium, high and floor)." +], +"type": "string" +}, +"illegalDrugsTobaccoEcigarettesVapingAlcoholContent": { +"description": "Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.", +"enum": [ +"GARM_RISK_EXCLUSION_UNSPECIFIED", +"GARM_RISK_EXCLUSION_FLOOR", +"GARM_RISK_EXCLUSION_HIGH", +"GARM_RISK_EXCLUSION_MEDIUM", +"GARM_RISK_EXCLUSION_LOW" +], +"enumDescriptions": [ +"This enum is only a placeholder and it doesn't specify any GARM risk exclusion option.", +"Exclude floor risk.", +"Exclude high and floor risk.", +"Exclude medium, high, and floor risk.", +"Exclude all levels of risk (low, medium, high and floor)." +], +"type": "string" +}, +"misinformationContent": { +"description": "Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.", +"enum": [ +"GARM_RISK_EXCLUSION_UNSPECIFIED", +"GARM_RISK_EXCLUSION_FLOOR", +"GARM_RISK_EXCLUSION_HIGH", +"GARM_RISK_EXCLUSION_MEDIUM", +"GARM_RISK_EXCLUSION_LOW" +], +"enumDescriptions": [ +"This enum is only a placeholder and it doesn't specify any GARM risk exclusion option.", +"Exclude floor risk.", +"Exclude high and floor risk.", +"Exclude medium, high, and floor risk.", +"Exclude all levels of risk (low, medium, high and floor)." +], +"type": "string" +}, +"obscenityProfanityContent": { +"description": "Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.", +"enum": [ +"GARM_RISK_EXCLUSION_UNSPECIFIED", +"GARM_RISK_EXCLUSION_FLOOR", +"GARM_RISK_EXCLUSION_HIGH", +"GARM_RISK_EXCLUSION_MEDIUM", +"GARM_RISK_EXCLUSION_LOW" +], +"enumDescriptions": [ +"This enum is only a placeholder and it doesn't specify any GARM risk exclusion option.", +"Exclude floor risk.", +"Exclude high and floor risk.", +"Exclude medium, high, and floor risk.", +"Exclude all levels of risk (low, medium, high and floor)." +], +"type": "string" +}, +"onlinePiracyContent": { +"description": "Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.", +"enum": [ +"GARM_RISK_EXCLUSION_UNSPECIFIED", +"GARM_RISK_EXCLUSION_FLOOR", +"GARM_RISK_EXCLUSION_HIGH", +"GARM_RISK_EXCLUSION_MEDIUM", +"GARM_RISK_EXCLUSION_LOW" +], +"enumDescriptions": [ +"This enum is only a placeholder and it doesn't specify any GARM risk exclusion option.", +"Exclude floor risk.", +"Exclude high and floor risk.", +"Exclude medium, high, and floor risk.", +"Exclude all levels of risk (low, medium, high and floor)." +], +"type": "string" +}, +"spamHarmfulContent": { +"description": "Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.", +"enum": [ +"GARM_RISK_EXCLUSION_UNSPECIFIED", +"GARM_RISK_EXCLUSION_FLOOR", +"GARM_RISK_EXCLUSION_HIGH", +"GARM_RISK_EXCLUSION_MEDIUM", +"GARM_RISK_EXCLUSION_LOW" +], +"enumDescriptions": [ +"This enum is only a placeholder and it doesn't specify any GARM risk exclusion option.", +"Exclude floor risk.", +"Exclude high and floor risk.", +"Exclude medium, high, and floor risk.", +"Exclude all levels of risk (low, medium, high and floor)." +], +"type": "string" +}, +"terrorismContent": { +"description": "Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.", +"enum": [ +"GARM_RISK_EXCLUSION_UNSPECIFIED", +"GARM_RISK_EXCLUSION_FLOOR", +"GARM_RISK_EXCLUSION_HIGH", +"GARM_RISK_EXCLUSION_MEDIUM", +"GARM_RISK_EXCLUSION_LOW" +], +"enumDescriptions": [ +"This enum is only a placeholder and it doesn't specify any GARM risk exclusion option.", +"Exclude floor risk.", +"Exclude high and floor risk.", +"Exclude medium, high, and floor risk.", +"Exclude all levels of risk (low, medium, high and floor)." +], +"type": "string" +}, +"videoIabViewability": { +"description": "Optional. IAB viewability threshold for video ads.", +"enum": [ +"VIDEO_IAB_VIEWABILITY_UNSPECIFIED", +"VIDEO_IAB_VIEWABILITY_10", +"VIDEO_IAB_VIEWABILITY_20", +"VIDEO_IAB_VIEWABILITY_35", +"VIDEO_IAB_VIEWABILITY_50", +"VIDEO_IAB_VIEWABILITY_75" +], +"enumDescriptions": [ +"Default value when not specified or is unknown in this version.", +"10%+ in view (IAB video viewability standard).", +"20%+ in view (IAB video viewability standard).", +"35%+ in view (IAB video viewability standard).", +"50%+ in view (IAB video viewability standard).", +"75%+ in view (IAB video viewability standard)." +], +"type": "string" +} +}, +"type": "object" +}, +"Advertiser": { +"description": "A single advertiser in Display & Video 360 (DV360).", +"id": "Advertiser", +"properties": { +"adServerConfig": { +"$ref": "AdvertiserAdServerConfig", +"description": "Required. Immutable. Ad server related settings of the advertiser." +}, +"advertiserId": { +"description": "Output only. The unique ID of the advertiser. Assigned by the system.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"billingConfig": { +"$ref": "AdvertiserBillingConfig", +"description": "Required. Billing related settings of the advertiser." +}, +"creativeConfig": { +"$ref": "AdvertiserCreativeConfig", +"description": "Required. Creative related settings of the advertiser." +}, +"dataAccessConfig": { +"$ref": "AdvertiserDataAccessConfig", +"description": "Settings that control how advertiser data may be accessed." +}, +"displayName": { +"description": "Required. The display name of the advertiser. Must be UTF-8 encoded with a maximum size of 240 bytes.", +"type": "string" +}, +"entityStatus": { +"description": "Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_PAUSED` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days from when it was first scheduled for deletion.", +"enum": [ +"ENTITY_STATUS_UNSPECIFIED", +"ENTITY_STATUS_ACTIVE", +"ENTITY_STATUS_ARCHIVED", +"ENTITY_STATUS_DRAFT", +"ENTITY_STATUS_PAUSED", +"ENTITY_STATUS_SCHEDULED_FOR_DELETION" +], +"enumDescriptions": [ +"Default value when status is not specified or is unknown in this version.", +"The entity is enabled to bid and spend budget.", +"The entity is archived. Bidding and budget spending are disabled. An entity can be deleted after archived. Deleted entities cannot be retrieved.", +"The entity is under draft. Bidding and budget spending are disabled.", +"Bidding and budget spending are paused for the entity.", +"The entity is scheduled for deletion." +], +"type": "string" +}, +"generalConfig": { +"$ref": "AdvertiserGeneralConfig", +"description": "Required. General settings of the advertiser." +}, +"integrationDetails": { +"$ref": "IntegrationDetails", +"description": "Integration details of the advertiser. Only integrationCode is currently applicable to advertiser. Other fields of IntegrationDetails are not supported and will be ignored if provided." +}, +"name": { +"description": "Output only. The resource name of the advertiser.", +"readOnly": true, +"type": "string" +}, +"partnerId": { +"description": "Required. Immutable. The unique ID of the partner that the advertiser belongs to.", +"format": "int64", +"type": "string" +}, +"prismaEnabled": { +"description": "Whether integration with Mediaocean (Prisma) is enabled. By enabling this, you agree to the following: On behalf of my company, I authorize Mediaocean (Prisma) to send budget segment plans to Google, and I authorize Google to send corresponding reporting and invoices from DV360 to Mediaocean for the purposes of budget planning, billing, and reconciliation for this advertiser.", +"type": "boolean" +}, +"servingConfig": { +"$ref": "AdvertiserTargetingConfig", +"description": "Targeting settings related to ad serving of the advertiser." +}, +"updateTime": { +"description": "Output only. The timestamp when the advertiser was last updated. Assigned by the system.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"AdvertiserAdServerConfig": { +"description": "Ad server related settings of an advertiser.", +"id": "AdvertiserAdServerConfig", +"properties": { +"cmHybridConfig": { +"$ref": "CmHybridConfig", +"description": "The configuration for advertisers that use both Campaign Manager 360 (CM360) and third-party ad servers." +}, +"thirdPartyOnlyConfig": { +"$ref": "ThirdPartyOnlyConfig", +"description": "The configuration for advertisers that use third-party ad servers only." +} +}, +"type": "object" +}, +"AdvertiserBillingConfig": { +"description": "Billing related settings of an advertiser.", +"id": "AdvertiserBillingConfig", +"properties": { +"billingProfileId": { +"description": "Required. The ID of a billing profile assigned to the advertiser.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"AdvertiserCreativeConfig": { +"description": "Creatives related settings of an advertiser.", +"id": "AdvertiserCreativeConfig", +"properties": { +"dynamicCreativeEnabled": { +"description": "Whether or not the advertiser is enabled for dynamic creatives.", +"type": "boolean" +}, +"iasClientId": { +"description": "An ID for configuring campaign monitoring provided by Integral Ad Service (IAS). The DV360 system will append an IAS \"Campaign Monitor\" tag containing this ID to the creative tag.", +"format": "int64", +"type": "string" +}, +"obaComplianceDisabled": { +"description": "Whether or not to disable Google's About this Ad feature that adds badging (to identify the content as an ad) and transparency information (on interaction with About this Ad) to your ads for Online Behavioral Advertising (OBA) and regulatory requirements. About this Ad gives users greater control over the ads they see and helps you explain why they're seeing your ad. [Learn more](//support.google.com/displayvideo/answer/14315795). If you choose to set this field to `true`, note that ads served through Display & Video 360 must comply to the following: * Be Online Behavioral Advertising (OBA) compliant, as per your contract with Google Marketing Platform. * In the European Economic Area (EEA), include transparency information and a mechanism for users to report illegal content in ads. If using an alternative ad badging, transparency, and reporting solution, you must ensure it includes the required transparency information and illegal content flagging mechanism and that you notify Google of any illegal content reports using the appropriate [form](//support.google.com/legal/troubleshooter/1114905?sjid=6787484030557261960-EU#ts=2981967%2C2982031%2C12980091).", +"type": "boolean" +}, +"videoCreativeDataSharingAuthorized": { +"description": "By setting this field to `true`, you, on behalf of your company, authorize Google to use video creatives associated with this Display & Video 360 advertiser to provide reporting and features related to the advertiser's television campaigns. Applicable only when the advertiser has a CM360 hybrid ad server configuration.", +"type": "boolean" +} +}, +"type": "object" +}, +"AdvertiserDataAccessConfig": { +"description": "Settings that control how advertiser related data may be accessed.", +"id": "AdvertiserDataAccessConfig", +"properties": { +"sdfConfig": { +"$ref": "AdvertiserSdfConfig", +"description": "Structured Data Files (SDF) settings for the advertiser. If not specified, the SDF settings of the parent partner are used." +} +}, +"type": "object" +}, +"AdvertiserGeneralConfig": { +"description": "General settings of an advertiser.", +"id": "AdvertiserGeneralConfig", +"properties": { +"currencyCode": { +"description": "Required. Immutable. Advertiser's currency in ISO 4217 format. Accepted codes and the currencies they represent are: Currency Code : Currency Name * `ARS` : Argentine Peso * `AUD` : Australian Dollar * `BRL` : Brazilian Real * `CAD` : Canadian Dollar * `CHF` : Swiss Franc * `CLP` : Chilean Peso * `CNY` : Chinese Yuan * `COP` : Colombian Peso * `CZK` : Czech Koruna * `DKK` : Danish Krone * `EGP` : Egyption Pound * `EUR` : Euro * `GBP` : British Pound * `HKD` : Hong Kong Dollar * `HUF` : Hungarian Forint * `IDR` : Indonesian Rupiah * `ILS` : Israeli Shekel * `INR` : Indian Rupee * `JPY` : Japanese Yen * `KRW` : South Korean Won * `MXN` : Mexican Pesos * `MYR` : Malaysian Ringgit * `NGN` : Nigerian Naira * `NOK` : Norwegian Krone * `NZD` : New Zealand Dollar * `PEN` : Peruvian Nuevo Sol * `PLN` : Polish Zloty * `RON` : New Romanian Leu * `RUB` : Russian Ruble * `SEK` : Swedish Krona * `TRY` : Turkish Lira * `TWD` : New Taiwan Dollar * `USD` : US Dollar * `ZAR` : South African Rand", +"type": "string" +}, +"domainUrl": { +"description": "Required. The domain URL of the advertiser's primary website. The system will send this information to publishers that require website URL to associate a campaign with an advertiser. Provide a URL with no path or query string, beginning with `http:` or `https:`. For example, http://www.example.com", +"type": "string" +}, +"timeZone": { +"description": "Output only. The standard TZ database name of the advertiser's time zone. For example, `America/New_York`. See more at: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones For CM360 hybrid advertisers, the time zone is the same as that of the associated CM360 account; for third-party only advertisers, the time zone is the same as that of the parent partner.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"AdvertiserSdfConfig": { +"description": "Structured Data Files (SDF) settings of an advertiser.", +"id": "AdvertiserSdfConfig", +"properties": { +"overridePartnerSdfConfig": { +"description": "Whether or not this advertiser overrides the SDF configuration of its parent partner. By default, an advertiser inherits the SDF configuration from the parent partner. To override the partner configuration, set this field to `true` and provide the new configuration in sdfConfig.", +"type": "boolean" +}, +"sdfConfig": { +"$ref": "SdfConfig", +"description": "The SDF configuration for the advertiser. * Required when overridePartnerSdfConfig is `true`. * Output only when overridePartnerSdfConfig is `false`." +} +}, +"type": "object" +}, +"AdvertiserTargetingConfig": { +"description": "Targeting settings related to ad serving of an advertiser.", +"id": "AdvertiserTargetingConfig", +"properties": { +"exemptTvFromViewabilityTargeting": { +"description": "Whether or not connected TV devices are exempt from viewability targeting for all video line items under the advertiser.", +"type": "boolean" +} +}, +"type": "object" +}, +"AgeRangeAssignedTargetingOptionDetails": { +"description": "Represents a targetable age range. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AGE_RANGE`.", +"id": "AgeRangeAssignedTargetingOptionDetails", +"properties": { +"ageRange": { +"description": "Required. The age range of an audience. We only support targeting a continuous age range of an audience. Thus, the age range represented in this field can be 1) targeted solely, or, 2) part of a larger continuous age range. The reach of a continuous age range targeting can be expanded by also targeting an audience of an unknown age.", +"enum": [ +"AGE_RANGE_UNSPECIFIED", +"AGE_RANGE_18_24", +"AGE_RANGE_25_34", +"AGE_RANGE_35_44", +"AGE_RANGE_45_54", +"AGE_RANGE_55_64", +"AGE_RANGE_65_PLUS", +"AGE_RANGE_UNKNOWN", +"AGE_RANGE_18_20", +"AGE_RANGE_21_24", +"AGE_RANGE_25_29", +"AGE_RANGE_30_34", +"AGE_RANGE_35_39", +"AGE_RANGE_40_44", +"AGE_RANGE_45_49", +"AGE_RANGE_50_54", +"AGE_RANGE_55_59", +"AGE_RANGE_60_64" +], +"enumDescriptions": [ +"Default value when age range is not specified in this version. This enum is a placeholder for default value and does not represent a real age range option.", +"The age range of the audience is 18 to 24.", +"The age range of the audience is 25 to 34.", +"The age range of the audience is 35 to 44.", +"The age range of the audience is 45 to 54.", +"The age range of the audience is 55 to 64.", +"The age range of the audience is 65 and up.", +"The age range of the audience is unknown.", +"The age range of the audience is 18 to 20, only supported for the AdGroup of YouTube Programmatic Reservation line item.", +"The age range of the audience is 21 to 24, only supported for the AdGroup of YouTube Programmatic Reservation line item.", +"The age range of the audience is 25 to 29, only supported for the AdGroup of YouTube Programmatic Reservation line item.", +"The age range of the audience is 30 to 34, only supported for the AdGroup of YouTube Programmatic Reservation line item.", +"The age range of the audience is 35 to 39, only supported for the AdGroup of YouTube Programmatic Reservation line item.", +"The age range of the audience is 40 to 44, only supported for the AdGroup of YouTube Programmatic Reservation line item.", +"The age range of the audience is 45 to 49, only supported for the AdGroup of YouTube Programmatic Reservation line item.", +"The age range of the audience is 50 to 54, only supported for the AdGroup of YouTube Programmatic Reservation line item.", +"The age range of the audience is 55 to 59, only supported for the AdGroup of YouTube Programmatic Reservation line item.", +"The age range of the audience is 60 to 64, only supported for the AdGroup of YouTube Programmatic Reservation line item." +], +"type": "string" +} +}, +"type": "object" +}, +"AgeRangeTargetingOptionDetails": { +"description": "Represents a targetable age range. This will be populated in the age_range_details field when targeting_type is `TARGETING_TYPE_AGE_RANGE`.", +"id": "AgeRangeTargetingOptionDetails", +"properties": { +"ageRange": { +"description": "Output only. The age range of an audience.", +"enum": [ +"AGE_RANGE_UNSPECIFIED", +"AGE_RANGE_18_24", +"AGE_RANGE_25_34", +"AGE_RANGE_35_44", +"AGE_RANGE_45_54", +"AGE_RANGE_55_64", +"AGE_RANGE_65_PLUS", +"AGE_RANGE_UNKNOWN", +"AGE_RANGE_18_20", +"AGE_RANGE_21_24", +"AGE_RANGE_25_29", +"AGE_RANGE_30_34", +"AGE_RANGE_35_39", +"AGE_RANGE_40_44", +"AGE_RANGE_45_49", +"AGE_RANGE_50_54", +"AGE_RANGE_55_59", +"AGE_RANGE_60_64" +], +"enumDescriptions": [ +"Default value when age range is not specified in this version. This enum is a placeholder for default value and does not represent a real age range option.", +"The age range of the audience is 18 to 24.", +"The age range of the audience is 25 to 34.", +"The age range of the audience is 35 to 44.", +"The age range of the audience is 45 to 54.", +"The age range of the audience is 55 to 64.", +"The age range of the audience is 65 and up.", +"The age range of the audience is unknown.", +"The age range of the audience is 18 to 20, only supported for the AdGroup of YouTube Programmatic Reservation line item.", +"The age range of the audience is 21 to 24, only supported for the AdGroup of YouTube Programmatic Reservation line item.", +"The age range of the audience is 25 to 29, only supported for the AdGroup of YouTube Programmatic Reservation line item.", +"The age range of the audience is 30 to 34, only supported for the AdGroup of YouTube Programmatic Reservation line item.", +"The age range of the audience is 35 to 39, only supported for the AdGroup of YouTube Programmatic Reservation line item.", +"The age range of the audience is 40 to 44, only supported for the AdGroup of YouTube Programmatic Reservation line item.", +"The age range of the audience is 45 to 49, only supported for the AdGroup of YouTube Programmatic Reservation line item.", +"The age range of the audience is 50 to 54, only supported for the AdGroup of YouTube Programmatic Reservation line item.", +"The age range of the audience is 55 to 59, only supported for the AdGroup of YouTube Programmatic Reservation line item.", +"The age range of the audience is 60 to 64, only supported for the AdGroup of YouTube Programmatic Reservation line item." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"AlgorithmRules": { +"description": "Rule-based algorithm.", +"id": "AlgorithmRules", +"properties": { +"impressionSignalRuleset": { +"$ref": "AlgorithmRulesRuleset", +"description": "Rules for the impression signals." +} +}, +"type": "object" +}, +"AlgorithmRulesComparisonValue": { +"description": "A value to compare the signal to.", +"id": "AlgorithmRulesComparisonValue", +"properties": { +"boolValue": { +"description": "Boolean value.", +"type": "boolean" +}, +"creativeDimensionValue": { +"$ref": "Dimensions", +"description": "Creative dimension value." +}, +"dayAndTimeValue": { +"$ref": "DayAndTime", +"description": "Day and time value. Only `TIME_ZONE_RESOLUTION_END_USER` is supported." +}, +"deviceTypeValue": { +"description": "Device type value.", +"enum": [ +"RULE_DEVICE_TYPE_UNSPECIFIED", +"RULE_DEVICE_TYPE_COMPUTER", +"RULE_DEVICE_TYPE_CONNECTED_TV", +"RULE_DEVICE_TYPE_SMART_PHONE", +"RULE_DEVICE_TYPE_TABLET", +"RULE_DEVICE_TYPE_CONNECTED_DEVICE", +"RULE_DEVICE_TYPE_SET_TOP_BOX" +], +"enumDescriptions": [ +"Default value when device type is not specified in this version. This enum is a placeholder for default value and does not represent a real device type option.", +"Computer.", +"Connected TV.", +"Smart phone.", +"Tablet.", +"Connected device.", +"Set top box." +], +"type": "string" +}, +"doubleValue": { +"description": "Double value.", +"format": "double", +"type": "number" +}, +"environmentValue": { +"description": "Environment value.", +"enum": [ +"ENVIRONMENT_UNSPECIFIED", +"ENVIRONMENT_WEB_OPTIMIZED", +"ENVIRONMENT_WEB_NOT_OPTIMIZED", +"ENVIRONMENT_APP" +], +"enumDescriptions": [ +"Default value when environment is not specified in this version. This enum is a placeholder for default value and does not represent a real environment option.", +"Target inventory displayed in browsers. This includes inventory that was designed for the device it was viewed on, such as mobile websites viewed on a mobile device. ENVIRONMENT_WEB_NOT_OPTIMIZED, if targeted, should be deleted prior to the deletion of this targeting option.", +"Target inventory displayed in browsers. This includes inventory that was not designed for the device but viewed on it, such as websites optimized for desktop but viewed on a mobile device. ENVIRONMENT_WEB_OPTIMIZED should be targeted prior to the addition of this targeting option.", +"Target inventory displayed in apps." +], +"type": "string" +}, +"exchangeValue": { +"description": "Exchange value.", +"enum": [ +"EXCHANGE_UNSPECIFIED", +"EXCHANGE_GOOGLE_AD_MANAGER", +"EXCHANGE_APPNEXUS", +"EXCHANGE_BRIGHTROLL", +"EXCHANGE_ADFORM", +"EXCHANGE_ADMETA", +"EXCHANGE_ADMIXER", +"EXCHANGE_ADSMOGO", +"EXCHANGE_ADSWIZZ", +"EXCHANGE_BIDSWITCH", +"EXCHANGE_BRIGHTROLL_DISPLAY", +"EXCHANGE_CADREON", +"EXCHANGE_DAILYMOTION", +"EXCHANGE_FIVE", +"EXCHANGE_FLUCT", +"EXCHANGE_FREEWHEEL", +"EXCHANGE_GENIEE", +"EXCHANGE_GUMGUM", +"EXCHANGE_IMOBILE", +"EXCHANGE_IBILLBOARD", +"EXCHANGE_IMPROVE_DIGITAL", +"EXCHANGE_INDEX", +"EXCHANGE_KARGO", +"EXCHANGE_MICROAD", +"EXCHANGE_MOPUB", +"EXCHANGE_NEND", +"EXCHANGE_ONE_BY_AOL_DISPLAY", +"EXCHANGE_ONE_BY_AOL_MOBILE", +"EXCHANGE_ONE_BY_AOL_VIDEO", +"EXCHANGE_OOYALA", +"EXCHANGE_OPENX", +"EXCHANGE_PERMODO", +"EXCHANGE_PLATFORMONE", +"EXCHANGE_PLATFORMID", +"EXCHANGE_PUBMATIC", +"EXCHANGE_PULSEPOINT", +"EXCHANGE_REVENUEMAX", +"EXCHANGE_RUBICON", +"EXCHANGE_SMARTCLIP", +"EXCHANGE_SMARTRTB", +"EXCHANGE_SMARTSTREAMTV", +"EXCHANGE_SOVRN", +"EXCHANGE_SPOTXCHANGE", +"EXCHANGE_STROER", +"EXCHANGE_TEADSTV", +"EXCHANGE_TELARIA", +"EXCHANGE_TVN", +"EXCHANGE_UNITED", +"EXCHANGE_YIELDLAB", +"EXCHANGE_YIELDMO", +"EXCHANGE_UNRULYX", +"EXCHANGE_OPEN8", +"EXCHANGE_TRITON", +"EXCHANGE_TRIPLELIFT", +"EXCHANGE_TABOOLA", +"EXCHANGE_INMOBI", +"EXCHANGE_SMAATO", +"EXCHANGE_AJA", +"EXCHANGE_SUPERSHIP", +"EXCHANGE_NEXSTAR_DIGITAL", +"EXCHANGE_WAZE", +"EXCHANGE_SOUNDCAST", +"EXCHANGE_SHARETHROUGH", +"EXCHANGE_FYBER", +"EXCHANGE_RED_FOR_PUBLISHERS", +"EXCHANGE_MEDIANET", +"EXCHANGE_TAPJOY", +"EXCHANGE_VISTAR", +"EXCHANGE_DAX", +"EXCHANGE_JCD", +"EXCHANGE_PLACE_EXCHANGE", +"EXCHANGE_APPLOVIN", +"EXCHANGE_CONNATIX", +"EXCHANGE_RESET_DIGITAL", +"EXCHANGE_HIVESTACK", +"EXCHANGE_DRAX", +"EXCHANGE_APPLOVIN_GBID", +"EXCHANGE_FYBER_GBID", +"EXCHANGE_UNITY_GBID", +"EXCHANGE_CHARTBOOST_GBID", +"EXCHANGE_ADMOST_GBID", +"EXCHANGE_TOPON_GBID", +"EXCHANGE_NETFLIX", +"EXCHANGE_CORE", +"EXCHANGE_TUBI" +], +"enumDescriptions": [ +"Exchange is not specified or is unknown in this version.", +"Google Ad Manager.", +"AppNexus.", +"BrightRoll Exchange for Video from Yahoo!.", +"Adform.", +"Admeta.", +"Admixer.", +"AdsMogo.", +"AdsWizz.", +"BidSwitch.", +"BrightRoll Exchange for Display from Yahoo!.", +"Cadreon.", +"Dailymotion.", +"Five.", +"Fluct.", +"FreeWheel SSP.", +"Geniee.", +"GumGum.", +"i-mobile.", +"iBILLBOARD.", +"Improve Digital.", +"Index Exchange.", +"Kargo.", +"MicroAd.", +"MoPub.", +"Nend.", +"ONE by AOL: Display Market Place.", +"ONE by AOL: Mobile.", +"ONE by AOL: Video.", +"Ooyala.", +"OpenX.", +"Permodo.", +"Platform One.", +"PlatformId.", +"PubMatic.", +"PulsePoint.", +"RevenueMax.", +"Rubicon.", +"SmartClip.", +"SmartRTB+.", +"SmartstreamTv.", +"Sovrn.", +"SpotXchange.", +"Str\u00f6er SSP.", +"TeadsTv.", +"Telaria.", +"TVN.", +"United.", +"Yieldlab.", +"Yieldmo.", +"UnrulyX.", +"Open8.", +"Triton.", +"TripleLift.", +"Taboola.", +"InMobi.", +"Smaato.", +"Aja.", +"Supership.", +"Nexstar Digital.", +"Waze.", +"SoundCast.", +"Sharethrough.", +"Fyber.", +"Red For Publishers.", +"Media.net.", +"Tapjoy.", +"Vistar.", +"DAX.", +"JCD.", +"Place Exchange.", +"AppLovin.", +"Connatix.", +"Reset Digital.", +"Hivestack.", +"Drax.", +"AppLovin MAX.", +"DT Fairbid.", +"Unity LevelPlay.", +"Chartboost Mediation.", +"AdMost.", +"TopOn.", +"Netflix.", +"Core.", +"Tubi." +], +"type": "string" +}, +"int64Value": { +"description": "Integer value.", +"format": "int64", +"type": "string" +}, +"onScreenPositionValue": { +"description": "Ad position value.", +"enum": [ +"ON_SCREEN_POSITION_UNSPECIFIED", +"ON_SCREEN_POSITION_UNKNOWN", +"ON_SCREEN_POSITION_ABOVE_THE_FOLD", +"ON_SCREEN_POSITION_BELOW_THE_FOLD" +], +"enumDescriptions": [ +"On screen position is not specified in this version. This enum is a place holder for a default value and does not represent a real on screen position.", +"The ad position is unknown on the screen.", +"The ad is located above the fold.", +"The ad is located below the fold." +], +"type": "string" +}, +"stringValue": { +"description": "String value.", +"type": "string" +} +}, +"type": "object" +}, +"AlgorithmRulesRule": { +"description": "Set of conditions. The return value of the rule is either: * The return value for single met condition or * The defined default return value if no conditions are met.", +"id": "AlgorithmRulesRule", +"properties": { +"conditions": { +"description": "List of conditions in this rule. The criteria among conditions should be mutually exclusive.", +"items": { +"$ref": "AlgorithmRulesRuleCondition" +}, +"type": "array" +}, +"defaultReturnValue": { +"$ref": "AlgorithmRulesSignalValue", +"description": "The default return value applied when none of the conditions are met." +} +}, +"type": "object" +}, +"AlgorithmRulesRuleCondition": { +"description": "Set of signal comparisons. Equivalent of an `if` statement.", +"id": "AlgorithmRulesRuleCondition", +"properties": { +"returnValue": { +"$ref": "AlgorithmRulesSignalValue", +"description": "The value returned if the `signalComparisons` condition evaluates to `TRUE`." +}, +"signalComparisons": { +"description": "List of comparisons that build `if` statement condition. The comparisons are combined into a single condition with `AND` logical operators.", +"items": { +"$ref": "AlgorithmRulesSignalComparison" +}, +"type": "array" +} +}, +"type": "object" +}, +"AlgorithmRulesRuleset": { +"description": "A ruleset consisting of a list of rules and how to aggregate the resulting values.", +"id": "AlgorithmRulesRuleset", +"properties": { +"aggregationType": { +"description": "How to aggregate values of evaluated rules.", +"enum": [ +"RULE_AGGREGATION_TYPE_UNSPECIFIED", +"SUM_OF_VALUES", +"PRODUCT_OF_VALUES", +"MAXIMUM_VALUE" +], +"enumDescriptions": [ +"Unknown aggregation type.", +"The sum of rule values.", +"The product of rule values.", +"The maximum rule value." +], +"type": "string" +}, +"maxValue": { +"description": "Maximum value the ruleset can evaluate to.", +"format": "double", +"type": "number" +}, +"rules": { +"description": "List of rules to generate the impression value.", +"items": { +"$ref": "AlgorithmRulesRule" +}, +"type": "array" +} +}, +"type": "object" +}, +"AlgorithmRulesSignal": { +"description": "Signal used to evaluate rules.", +"id": "AlgorithmRulesSignal", +"properties": { +"impressionSignal": { +"description": "Signal based on impressions.", +"enum": [ +"IMPRESSION_SIGNAL_UNSPECIFIED", +"DAY_AND_TIME", +"DEVICE_TYPE", +"AD_POSITION", +"OPERATING_SYSTEM_ID", +"MOBILE_MODEL_ID", +"EXCHANGE", +"ENVIRONMENT", +"COUNTRY_ID", +"CITY_ID", +"BROWSER_ID", +"CREATIVE_DIMENSION" +], +"enumDescriptions": [ +"Unknown signal.", +"The day of the week and hour of day the impression was made using browser's local time zone. Value is stored in the dayAndTimeValue field of the comparison value.", +"Device type. Value is stored in the deviceTypeValue field of the comparison value.", +"Ad position. Value is stored in the onScreenPositionValue field of the comparison value.", +"The operating system identifier. Value is stored in the int64Value field of the comparison value.", +"The mobile model identifier. Value is stored in the int64Value field of the comparison value.", +"Exchange. Value is stored in the exchangeValue field of the comparison value.", +"Serving environment. Value is stored in the environmentValue field of the comparison value.", +"The country or region identifier. Value is stored in the int64Value field of the comparison value.", +"The city identifier. Value is stored in the int64Value field of the comparison value.", +"The browser identifier. Value is stored in the int64Value field of the comparison value.", +"Creative height and width in pixels. Value is stored in the creativeDimensionValue field of the comparison value." +], +"type": "string" +} +}, +"type": "object" +}, +"AlgorithmRulesSignalComparison": { +"description": "A single comparison. The comparison compares the `signal` to the `comparisonValue`. The comparison of `siteId==123` is represented with the following field values: * `signal` has an `impressionSignal` of `SITE_ID`. * `comparisonOperator` is set to `EQUAL`. * `comparisonValue` is set to 123.", +"id": "AlgorithmRulesSignalComparison", +"properties": { +"comparisonOperator": { +"description": "Operator used to compare the two values. In the resulting experession, the `signal` will be the first value and the `comparisonValue will be the second.", +"enum": [ +"COMPARISON_OPERATOR_UNSPECIFIED", +"EQUAL", +"GREATER_THAN", +"LESS_THAN", +"GREATER_THAN_OR_EQUAL_TO", +"LESS_THAN_OR_EQUAL_TO" +], +"enumDescriptions": [ +"Unknown operator.", +"Values are equal.", +"Signal value is greater than the comparison value.", +"Signal value is less than the second.", +"Signal value is greater than or equal to the second.", +"Signal value is less than or equal to the comparison value." +], +"type": "string" +}, +"comparisonValue": { +"$ref": "AlgorithmRulesComparisonValue", +"description": "Value to compare signal to." +}, +"signal": { +"$ref": "AlgorithmRulesSignal", +"description": "Signal to compare." +} +}, +"type": "object" +}, +"AlgorithmRulesSignalValue": { +"description": "Adjusted value of the signal used for rule evaluation.", +"id": "AlgorithmRulesSignalValue", +"properties": { +"number": { +"description": "Value to use as result.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"AppAssignedTargetingOptionDetails": { +"description": "Details for assigned app targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP`.", +"id": "AppAssignedTargetingOptionDetails", +"properties": { +"appId": { +"description": "Required. The ID of the app. Android's Play store app uses bundle ID, for example `com.google.android.gm`. Apple's App store app ID uses 9 digit string, for example `422689480`.", +"type": "string" +}, +"appPlatform": { +"description": "Indicates the platform of the targeted app. If this field is not specified, the app platform will be assumed to be mobile (i.e., Android or iOS), and we will derive the appropriate mobile platform from the app ID.", +"enum": [ +"APP_PLATFORM_UNSPECIFIED", +"APP_PLATFORM_IOS", +"APP_PLATFORM_ANDROID", +"APP_PLATFORM_ROKU", +"APP_PLATFORM_AMAZON_FIRETV", +"APP_PLATFORM_PLAYSTATION", +"APP_PLATFORM_APPLE_TV", +"APP_PLATFORM_XBOX", +"APP_PLATFORM_SAMSUNG_TV", +"APP_PLATFORM_ANDROID_TV", +"APP_PLATFORM_GENERIC_CTV", +"APP_PLATFORM_LG_TV", +"APP_PLATFORM_VIZIO_TV" +], +"enumDescriptions": [ +"Default value when app platform is not specified in this version. This enum is a placeholder for default value and does not represent a real platform option.", +"The app platform is iOS.", +"The app platform is Android.", +"The app platform is Roku.", +"The app platform is Amazon FireTV.", +"The app platform is Playstation.", +"The app platform is Apple TV.", +"The app platform is Xbox.", +"The app platform is Samsung TV.", +"The app platform is Android TV.", +"The app platform is a CTV platform that is not explicitly listed elsewhere.", +"The app platform is LG TV.", +"The app platform is VIZIO TV." +], +"type": "string" +}, +"displayName": { +"description": "Output only. The display name of the app.", +"readOnly": true, +"type": "string" +}, +"negative": { +"description": "Indicates if this option is being negatively targeted.", +"type": "boolean" +} +}, +"type": "object" +}, +"AppCategoryAssignedTargetingOptionDetails": { +"description": "Details for assigned app category targeting option. This will be populated in the app_category_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP_CATEGORY`.", +"id": "AppCategoryAssignedTargetingOptionDetails", +"properties": { +"displayName": { +"description": "Output only. The display name of the app category.", +"readOnly": true, +"type": "string" +}, +"negative": { +"description": "Indicates if this option is being negatively targeted.", +"type": "boolean" +}, +"targetingOptionId": { +"description": "Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`.", +"type": "string" +} +}, +"type": "object" +}, +"AppCategoryTargetingOptionDetails": { +"description": "Represents a targetable collection of apps. A collection lets you target dynamic groups of related apps that are maintained by the platform, for example `All Apps/Google Play/Games`. This will be populated in the app_category_details field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`.", +"id": "AppCategoryTargetingOptionDetails", +"properties": { +"displayName": { +"description": "Output only. The name of the app collection.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"Asset": { +"description": "A single asset.", +"id": "Asset", +"properties": { +"content": { +"description": "The asset content. For uploaded assets, the content is the serving path.", +"type": "string" +}, +"mediaId": { +"description": "Media ID of the uploaded asset. This is a unique identifier for the asset. This ID can be passed to other API calls, e.g. CreateCreative to associate the asset with a creative. The Media ID space updated on **April 5, 2023**. Update media IDs cached before **April 5, 2023** by retrieving the new media ID from associated creative resources or re-uploading the asset.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"AssetAssociation": { +"description": "Asset association for the creative.", +"id": "AssetAssociation", +"properties": { +"asset": { +"$ref": "Asset", +"description": "Optional. The associated asset." +}, +"role": { +"description": "Optional. The role of this asset for the creative.", +"enum": [ +"ASSET_ROLE_UNSPECIFIED", +"ASSET_ROLE_MAIN", +"ASSET_ROLE_BACKUP", +"ASSET_ROLE_POLITE_LOAD", +"ASSET_ROLE_HEADLINE", +"ASSET_ROLE_LONG_HEADLINE", +"ASSET_ROLE_BODY", +"ASSET_ROLE_LONG_BODY", +"ASSET_ROLE_CAPTION_URL", +"ASSET_ROLE_CALL_TO_ACTION", +"ASSET_ROLE_ADVERTISER_NAME", +"ASSET_ROLE_PRICE", +"ASSET_ROLE_ANDROID_APP_ID", +"ASSET_ROLE_IOS_APP_ID", +"ASSET_ROLE_RATING", +"ASSET_ROLE_ICON", +"ASSET_ROLE_COVER_IMAGE", +"ASSET_ROLE_BACKGROUND_COLOR", +"ASSET_ROLE_ACCENT_COLOR", +"ASSET_ROLE_REQUIRE_LOGO", +"ASSET_ROLE_REQUIRE_IMAGE", +"ASSET_ROLE_ENABLE_ASSET_ENHANCEMENTS" +], +"enumDescriptions": [ +"Asset role is not specified or is unknown in this version.", +"The asset is the main asset of the creative.", +"The asset is a backup asset of the creative.", +"The asset is a polite load asset of the creative.", +"Headline of a native creative. The content must be UTF-8 encoded with a length of no more than 25 characters. This role is only supported in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", +"Long headline of a native creative. The content must be UTF-8 encoded with a length of no more than 50 characters. This role is only supported in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", +"Body text of a native creative. The content must be UTF-8 encoded with a length of no more than 90 characters. This role is only supported in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", +"Long body text of a native creative. The content must be UTF-8 encoded with a length of no more than 150 characters. This role is only supported in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", +"A short, friendly version of the landing page URL to show in the creative. This URL gives people an idea of where they'll arrive after they click on the creative. The content must be UTF-8 encoded with a length of no more than 30 characters. For example, if the landing page URL is 'http://www.example.com/page', the caption URL can be 'example.com'. The protocol (http://) is optional, but the URL can't contain spaces or special characters. This role is only supported in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", +"The text to use on the call-to-action button of a native creative. The content must be UTF-8 encoded with a length of no more than 15 characters. This role is only supported in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", +"The text that identifies the advertiser or brand name. The content must be UTF-8 encoded with a length of no more than 25 characters. This role is only supported in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", +"The purchase price of your app in the Google play store or iOS app store (for example, $5.99). Note that this value is not automatically synced with the actual value listed in the store. It will always be the one provided when save the creative. The content must be UTF-8 encoded with a length of no more than 15 characters. Assets of this role are read-only.", +"The ID of an Android app in the Google play store. You can find this ID in the App\u2019s Google Play Store URL after \u2018id\u2019. For example, in `https://play.google.com/store/apps/details?id=com.company.appname` the identifier is com.company.appname. Assets of this role are read-only.", +"The ID of an iOS app in the Apple app store. This ID number can be found in the Apple App Store URL as the string of numbers directly after \"id\". For example, in `https://apps.apple.com/us/app/gmail-email-by-google/id422689480` the ID is 422689480. Assets of this role are read-only.", +"The rating of an app in the Google play store or iOS app store. Note that this value is not automatically synced with the actual rating in the store. It will always be the one provided when save the creative. Assets of this role are read-only.", +"The icon of a creative. This role is only supported and required in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`", +"The cover image of a native video creative. This role is only supported and required in the following creative_type: * `CREATIVE_TYPE_VIDEO`", +"The main color to use in a creative. This role is only supported and required in the following creative_type: * `CREATIVE_TYPE_ASSET_BASED_CREATIVE`", +"The accent color to use in a creative. This role is only supported and required in the following creative_type: * `CREATIVE_TYPE_ASSET_BASED_CREATIVE`", +"Whether the creative must use a logo asset. This role is only supported and required in the following creative_type: * `CREATIVE_TYPE_ASSET_BASED_CREATIVE`", +"Whether the creative must use an image asset. This role is only supported and required in the following creative_type: * `CREATIVE_TYPE_ASSET_BASED_CREATIVE`", +"Whether asset enhancements can be applied to the creative. This role is only supported and required in the following creative_type: * `CREATIVE_TYPE_ASSET_BASED_CREATIVE`" +], +"type": "string" +} +}, +"type": "object" +}, +"AssignedInventorySource": { +"description": "An assignment between a targetable inventory source and an inventory source group.", +"id": "AssignedInventorySource", +"properties": { +"assignedInventorySourceId": { +"description": "Output only. The unique ID of the assigned inventory source. The ID is only unique within a given inventory source group. It may be reused in other contexts.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"inventorySourceId": { +"description": "Required. The ID of the inventory source entity being targeted.", +"type": "string" +}, +"name": { +"description": "Output only. The resource name of the assigned inventory source.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"AssignedLocation": { +"description": "An assignment between a location list and a relevant targeting option.", +"id": "AssignedLocation", +"properties": { +"assignedLocationId": { +"description": "Output only. The unique ID of the assigned location. The ID is only unique within a location list. It may be reused in other contexts.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Output only. The resource name of the assigned location.", +"readOnly": true, +"type": "string" +}, +"targetingOptionId": { +"description": "Required. The ID of the targeting option assigned to the location list.", +"type": "string" +} +}, +"type": "object" +}, +"AssignedTargetingOption": { +"description": "A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings.", +"id": "AssignedTargetingOption", +"properties": { +"ageRangeDetails": { +"$ref": "AgeRangeAssignedTargetingOptionDetails", +"description": "Age range details. This field will be populated when the targeting_type is `TARGETING_TYPE_AGE_RANGE`." +}, +"appCategoryDetails": { +"$ref": "AppCategoryAssignedTargetingOptionDetails", +"description": "App category details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP_CATEGORY`." +}, +"appDetails": { +"$ref": "AppAssignedTargetingOptionDetails", +"description": "App details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP`." +}, +"assignedTargetingOptionId": { +"description": "Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts.", +"readOnly": true, +"type": "string" +}, +"assignedTargetingOptionIdAlias": { +"description": "Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`", +"readOnly": true, +"type": "string" +}, +"audienceGroupDetails": { +"$ref": "AudienceGroupAssignedTargetingOptionDetails", +"description": "Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource." +}, +"audioContentTypeDetails": { +"$ref": "AudioContentTypeAssignedTargetingOptionDetails", +"description": "Audio content type details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`." +}, +"authorizedSellerStatusDetails": { +"$ref": "AuthorizedSellerStatusAssignedTargetingOptionDetails", +"description": "Authorized seller status details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. You can only target one authorized seller status option per resource. If a resource doesn't have an authorized seller status option, all authorized sellers indicated as DIRECT or RESELLER in the ads.txt file are targeted by default." +}, +"browserDetails": { +"$ref": "BrowserAssignedTargetingOptionDetails", +"description": "Browser details. This field will be populated when the targeting_type is `TARGETING_TYPE_BROWSER`." +}, +"businessChainDetails": { +"$ref": "BusinessChainAssignedTargetingOptionDetails", +"description": "Business chain details. This field will be populated when the targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`." +}, +"carrierAndIspDetails": { +"$ref": "CarrierAndIspAssignedTargetingOptionDetails", +"description": "Carrier and ISP details. This field will be populated when the targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`." +}, +"categoryDetails": { +"$ref": "CategoryAssignedTargetingOptionDetails", +"description": "Category details. This field will be populated when the targeting_type is `TARGETING_TYPE_CATEGORY`. Targeting a category will also target its subcategories. If a category is excluded from targeting and a subcategory is included, the exclusion will take precedence." +}, +"channelDetails": { +"$ref": "ChannelAssignedTargetingOptionDetails", +"description": "Channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_CHANNEL`." +}, +"contentDurationDetails": { +"$ref": "ContentDurationAssignedTargetingOptionDetails", +"description": "Content duration details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_DURATION`." +}, +"contentGenreDetails": { +"$ref": "ContentGenreAssignedTargetingOptionDetails", +"description": "Content genre details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_GENRE`." +}, +"contentInstreamPositionDetails": { +"$ref": "ContentInstreamPositionAssignedTargetingOptionDetails", +"description": "Content instream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`." +}, +"contentOutstreamPositionDetails": { +"$ref": "ContentOutstreamPositionAssignedTargetingOptionDetails", +"description": "Content outstream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`." +}, +"contentStreamTypeDetails": { +"$ref": "ContentStreamTypeAssignedTargetingOptionDetails", +"description": "Content duration details. This field will be populated when the TargetingType is `TARGETING_TYPE_CONTENT_STREAM_TYPE`." +}, +"dayAndTimeDetails": { +"$ref": "DayAndTimeAssignedTargetingOptionDetails", +"description": "Day and time details. This field will be populated when the targeting_type is `TARGETING_TYPE_DAY_AND_TIME`." +}, +"deviceMakeModelDetails": { +"$ref": "DeviceMakeModelAssignedTargetingOptionDetails", +"description": "Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`." +}, +"deviceTypeDetails": { +"$ref": "DeviceTypeAssignedTargetingOptionDetails", +"description": "Device Type details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_TYPE`." +}, +"digitalContentLabelExclusionDetails": { +"$ref": "DigitalContentLabelAssignedTargetingOptionDetails", +"description": "Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded." +}, +"environmentDetails": { +"$ref": "EnvironmentAssignedTargetingOptionDetails", +"description": "Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`." +}, +"exchangeDetails": { +"$ref": "ExchangeAssignedTargetingOptionDetails", +"description": "Exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_EXCHANGE`." +}, +"genderDetails": { +"$ref": "GenderAssignedTargetingOptionDetails", +"description": "Gender details. This field will be populated when the targeting_type is `TARGETING_TYPE_GENDER`." +}, +"geoRegionDetails": { +"$ref": "GeoRegionAssignedTargetingOptionDetails", +"description": "Geographic region details. This field will be populated when the targeting_type is `TARGETING_TYPE_GEO_REGION`." +}, +"householdIncomeDetails": { +"$ref": "HouseholdIncomeAssignedTargetingOptionDetails", +"description": "Household income details. This field will be populated when the targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`." +}, +"inheritance": { +"description": "Output only. The inheritance status of the assigned targeting option.", +"enum": [ +"INHERITANCE_UNSPECIFIED", +"NOT_INHERITED", +"INHERITED_FROM_PARTNER", +"INHERITED_FROM_ADVERTISER" +], +"enumDescriptions": [ +"The inheritance is unspecified or unknown.", +"The assigned targeting option is not inherited from higher level entity.", +"The assigned targeting option is inherited from partner targeting settings.", +"The assigned targeting option is inherited from advertiser targeting settings." +], +"readOnly": true, +"type": "string" +}, +"inventorySourceDetails": { +"$ref": "InventorySourceAssignedTargetingOptionDetails", +"description": "Inventory source details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`." +}, +"inventorySourceGroupDetails": { +"$ref": "InventorySourceGroupAssignedTargetingOptionDetails", +"description": "Inventory source group details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`." +}, +"keywordDetails": { +"$ref": "KeywordAssignedTargetingOptionDetails", +"description": "Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned." +}, +"languageDetails": { +"$ref": "LanguageAssignedTargetingOptionDetails", +"description": "Language details. This field will be populated when the targeting_type is `TARGETING_TYPE_LANGUAGE`." +}, +"name": { +"description": "Output only. The resource name for this assigned targeting option.", +"readOnly": true, +"type": "string" +}, +"nativeContentPositionDetails": { +"$ref": "NativeContentPositionAssignedTargetingOptionDetails", +"description": "Native content position details. This field will be populated when the targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`." +}, +"negativeKeywordListDetails": { +"$ref": "NegativeKeywordListAssignedTargetingOptionDetails", +"description": "Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. A maximum of 4 negative keyword lists can be assigned to a resource." +}, +"omidDetails": { +"$ref": "OmidAssignedTargetingOptionDetails", +"description": "Open Measurement enabled inventory details. This field will be populated when the targeting_type is `TARGETING_TYPE_OMID`." +}, +"onScreenPositionDetails": { +"$ref": "OnScreenPositionAssignedTargetingOptionDetails", +"description": "On screen position details. This field will be populated when the targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`." +}, +"operatingSystemDetails": { +"$ref": "OperatingSystemAssignedTargetingOptionDetails", +"description": "Operating system details. This field will be populated when the targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`." +}, +"parentalStatusDetails": { +"$ref": "ParentalStatusAssignedTargetingOptionDetails", +"description": "Parental status details. This field will be populated when the targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`." +}, +"poiDetails": { +"$ref": "PoiAssignedTargetingOptionDetails", +"description": "POI details. This field will be populated when the targeting_type is `TARGETING_TYPE_POI`." +}, +"proximityLocationListDetails": { +"$ref": "ProximityLocationListAssignedTargetingOptionDetails", +"description": "Proximity location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`." +}, +"regionalLocationListDetails": { +"$ref": "RegionalLocationListAssignedTargetingOptionDetails", +"description": "Regional location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`." +}, +"sensitiveCategoryExclusionDetails": { +"$ref": "SensitiveCategoryAssignedTargetingOptionDetails", +"description": "Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them." +}, +"sessionPositionDetails": { +"$ref": "SessionPositionAssignedTargetingOptionDetails", +"description": "Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`." +}, +"subExchangeDetails": { +"$ref": "SubExchangeAssignedTargetingOptionDetails", +"description": "Sub-exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`." +}, +"targetingType": { +"description": "Output only. Identifies the type of this assigned targeting option.", +"enum": [ +"TARGETING_TYPE_UNSPECIFIED", +"TARGETING_TYPE_CHANNEL", +"TARGETING_TYPE_APP_CATEGORY", +"TARGETING_TYPE_APP", +"TARGETING_TYPE_URL", +"TARGETING_TYPE_DAY_AND_TIME", +"TARGETING_TYPE_AGE_RANGE", +"TARGETING_TYPE_REGIONAL_LOCATION_LIST", +"TARGETING_TYPE_PROXIMITY_LOCATION_LIST", +"TARGETING_TYPE_GENDER", +"TARGETING_TYPE_VIDEO_PLAYER_SIZE", +"TARGETING_TYPE_USER_REWARDED_CONTENT", +"TARGETING_TYPE_PARENTAL_STATUS", +"TARGETING_TYPE_CONTENT_INSTREAM_POSITION", +"TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", +"TARGETING_TYPE_DEVICE_TYPE", +"TARGETING_TYPE_AUDIENCE_GROUP", +"TARGETING_TYPE_BROWSER", +"TARGETING_TYPE_HOUSEHOLD_INCOME", +"TARGETING_TYPE_ON_SCREEN_POSITION", +"TARGETING_TYPE_THIRD_PARTY_VERIFIER", +"TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", +"TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", +"TARGETING_TYPE_ENVIRONMENT", +"TARGETING_TYPE_CARRIER_AND_ISP", +"TARGETING_TYPE_OPERATING_SYSTEM", +"TARGETING_TYPE_DEVICE_MAKE_MODEL", +"TARGETING_TYPE_KEYWORD", +"TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", +"TARGETING_TYPE_VIEWABILITY", +"TARGETING_TYPE_CATEGORY", +"TARGETING_TYPE_INVENTORY_SOURCE", +"TARGETING_TYPE_LANGUAGE", +"TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", +"TARGETING_TYPE_GEO_REGION", +"TARGETING_TYPE_INVENTORY_SOURCE_GROUP", +"TARGETING_TYPE_EXCHANGE", +"TARGETING_TYPE_SUB_EXCHANGE", +"TARGETING_TYPE_POI", +"TARGETING_TYPE_BUSINESS_CHAIN", +"TARGETING_TYPE_CONTENT_DURATION", +"TARGETING_TYPE_CONTENT_STREAM_TYPE", +"TARGETING_TYPE_NATIVE_CONTENT_POSITION", +"TARGETING_TYPE_OMID", +"TARGETING_TYPE_AUDIO_CONTENT_TYPE", +"TARGETING_TYPE_CONTENT_GENRE", +"TARGETING_TYPE_YOUTUBE_VIDEO", +"TARGETING_TYPE_YOUTUBE_CHANNEL", +"TARGETING_TYPE_SESSION_POSITION" +], +"enumDescriptions": [ +"Default value when type is not specified or is unknown in this version.", +"Target a channel (a custom group of related websites or apps).", +"Target an app category (for example, education or puzzle games).", +"Target a specific app (for example, Angry Birds).", +"Target a specific url (for example, quora.com).", +"Target ads during a chosen time period on a specific day.", +"Target ads to a specific age range (for example, 18-24).", +"Target ads to the specified regions on a regional location list.", +"Target ads to the specified points of interest on a proximity location list.", +"Target ads to a specific gender (for example, female or male).", +"Target a specific video player size for video ads.", +"Target user rewarded content for video ads.", +"Target ads to a specific parental status (for example, parent or not a parent).", +"Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", +"Target ads in a specific content outstream position.", +"Target ads to a specific device type (for example, tablet or connected TV).", +"Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", +"Target ads to specific web browsers (for example, Chrome).", +"Target ads to a specific household income range (for example, top 10%).", +"Target ads in a specific on screen position.", +"Filter web sites through third party verification (for example, IAS or DoubleVerify).", +"Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", +"Filter website content by sensitive categories (for example, adult).", +"Target ads to a specific environment (for example, web or app).", +"Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", +"Target ads to a specific operating system (for example, macOS).", +"Target ads to a specific device make or model (for example, Roku or Samsung).", +"Target ads to a specific keyword (for example, dog or retriever).", +"Target ads to a specific negative keyword list.", +"Target ads to a specific viewability (for example, 80% viewable).", +"Target ads to a specific content category (for example, arts & entertainment).", +"Purchase impressions from specific deals and auction packages.", +"Target ads to a specific language (for example, English or Japanese).", +"Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", +"Target ads to a specific regional location (for example, a city or state).", +"Purchase impressions from a group of deals and auction packages.", +"Purchase impressions from specific exchanges.", +"Purchase impressions from specific sub-exchanges.", +"Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", +"Target ads around locations of a business chain within a specific geo region.", +"Target ads to a specific video content duration.", +"Target ads to a specific video content stream type.", +"Target ads to a specific native content position.", +"Target ads in an Open Measurement enabled inventory.", +"Target ads to a specific audio content type.", +"Target ads to a specific content genre.", +"Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", +"Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", +"Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." +], +"readOnly": true, +"type": "string" +}, +"thirdPartyVerifierDetails": { +"$ref": "ThirdPartyVerifierAssignedTargetingOptionDetails", +"description": "Third party verification details. This field will be populated when the targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`." +}, +"urlDetails": { +"$ref": "UrlAssignedTargetingOptionDetails", +"description": "URL details. This field will be populated when the targeting_type is `TARGETING_TYPE_URL`." +}, +"userRewardedContentDetails": { +"$ref": "UserRewardedContentAssignedTargetingOptionDetails", +"description": "User rewarded content details. This field will be populated when the targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`." +}, +"videoPlayerSizeDetails": { +"$ref": "VideoPlayerSizeAssignedTargetingOptionDetails", +"description": "Video player size details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`." +}, +"viewabilityDetails": { +"$ref": "ViewabilityAssignedTargetingOptionDetails", +"description": "Viewability details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIEWABILITY`. You can only target one viewability option per resource." +}, +"youtubeChannelDetails": { +"$ref": "YoutubeChannelAssignedTargetingOptionDetails", +"description": "YouTube channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`." +}, +"youtubeVideoDetails": { +"$ref": "YoutubeVideoAssignedTargetingOptionDetails", +"description": "YouTube video details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`." +} +}, +"type": "object" +}, +"AssignedUserRole": { +"description": "A single assigned user role, which defines a user's authorized interaction with a specified partner or advertiser.", +"id": "AssignedUserRole", +"properties": { +"advertiserId": { +"description": "The ID of the advertiser that the assigend user role applies to.", +"format": "int64", +"type": "string" +}, +"assignedUserRoleId": { +"description": "Output only. The ID of the assigned user role.", +"readOnly": true, +"type": "string" +}, +"partnerId": { +"description": "The ID of the partner that the assigned user role applies to.", +"format": "int64", +"type": "string" +}, +"userRole": { +"description": "Required. The user role to assign to a user for the entity.", +"enum": [ +"USER_ROLE_UNSPECIFIED", +"ADMIN", +"ADMIN_PARTNER_CLIENT", +"STANDARD", +"STANDARD_PLANNER", +"STANDARD_PLANNER_LIMITED", +"STANDARD_PARTNER_CLIENT", +"READ_ONLY", +"REPORTING_ONLY", +"LIMITED_REPORTING_ONLY", +"CREATIVE", +"CREATIVE_ADMIN" +], +"enumDescriptions": [ +"Default value when the user role is not specified or is unknown in this version.", +"The user can manage campaigns, creatives, insertion orders, line items, and reports for the entity. They can view and edit billing information, create or modify users, and enable or disable exchanges. This role can only be assigned for a partner entity.", +"The user can manage campaigns, creatives, insertion orders, line items, and reports for the entity. They can create and modify other `ADMIN_PARTNER_CLIENT` users and view billing information. They cannot view revenue models, markups, or any other reseller-sensitive fields. This role can only be assigned for a partner entity.", +"The user can manage campaigns, creatives, insertion orders, line items, and reports for the entity. They cannot create and modify users or view billing information.", +"The user can view all campaigns, creatives, insertion orders, line items, and reports for the entity, including all cost data. They can create and modify planning-related features, including plans and inventory.", +"The user can view all campaigns, creatives, insertion orders, line items, and reports for the entity. They can create or modify planning-related features, including plans and inventory. They have no access to cost data and cannot start, accept, or negotiate deals.", +"The user can manage campaigns, creatives, insertion orders, line items, and reports for the entity. They cannot create or modify other users or view billing information. They cannot view revenue models, markups, or any other reseller-sensitive fields. This role can only be assigned for an advertiser entity.", +"The user can only build reports and view data for the entity.", +"The user can only create and manage reports.", +"The user can only create and manage the following client-safe reports: General, Audience Performance, Cross-Partner, Keyword, Order ID, Category, and Third-Party Data Provider.", +"The user can view media plan information they need to collaborate, but can't view cost-related data or Marketplace.", +"The user can view media plan information they need to collaborate, but can't view cost-related data or Marketplace. In addition, they can add other creative admins or creative users to the entity." +], +"type": "string" +} +}, +"type": "object" +}, +"AudienceGroupAssignedTargetingOptionDetails": { +"description": "Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups.", +"id": "AudienceGroupAssignedTargetingOptionDetails", +"properties": { +"excludedFirstPartyAndPartnerAudienceGroup": { +"$ref": "FirstPartyAndPartnerAudienceGroup", +"description": "Optional. The first party and partner audience ids and recencies of the excluded first party and partner audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically \u2018OR\u2019 of each other." +}, +"excludedGoogleAudienceGroup": { +"$ref": "GoogleAudienceGroup", +"description": "Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically \u2018OR\u2019 of each other." +}, +"includedCombinedAudienceGroup": { +"$ref": "CombinedAudienceGroup", +"description": "Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only." +}, +"includedCustomListGroup": { +"$ref": "CustomListGroup", +"description": "Optional. The custom list ids of the included custom list group. Contains custom list ids only." +}, +"includedFirstPartyAndPartnerAudienceGroups": { +"description": "Optional. The first party and partner audience ids and recencies of included first party and partner audience groups. Each first party and partner audience group contains first party and partner audience ids only. The relation between each first party and partner audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored.", +"items": { +"$ref": "FirstPartyAndPartnerAudienceGroup" +}, +"type": "array" +}, +"includedGoogleAudienceGroup": { +"$ref": "GoogleAudienceGroup", +"description": "Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only." +} +}, +"type": "object" +}, +"AudioAd": { +"description": "Details for an audio ad.", +"id": "AudioAd", +"properties": { +"displayUrl": { +"description": "The webpage address that appears with the ad.", +"type": "string" +}, +"finalUrl": { +"description": "The URL address of the webpage that people reach after they click the ad.", +"type": "string" +}, +"trackingUrl": { +"description": "The URL address loaded in the background for tracking purposes.", +"type": "string" +}, +"video": { +"$ref": "YoutubeVideoDetails", +"description": "The YouTube video of the ad." +} +}, +"type": "object" +}, +"AudioContentTypeAssignedTargetingOptionDetails": { +"description": "Details for audio content type assigned targeting option. This will be populated in the audio_content_type_details field when targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`. Explicitly targeting all options is not supported. Remove all audio content type targeting options to achieve this effect.", +"id": "AudioContentTypeAssignedTargetingOptionDetails", +"properties": { +"audioContentType": { +"description": "Required. The audio content type.", +"enum": [ +"AUDIO_CONTENT_TYPE_UNSPECIFIED", +"AUDIO_CONTENT_TYPE_UNKNOWN", +"AUDIO_CONTENT_TYPE_MUSIC", +"AUDIO_CONTENT_TYPE_BROADCAST", +"AUDIO_CONTENT_TYPE_PODCAST" +], +"enumDescriptions": [ +"Audio content type is not specified in this version. This enum is a place holder for a default value and does not represent a real content stream type.", +"The audio content type is unknown.", +"The audio content type is music.", +"The audio content type is broadcast.", +"The audio content type is podcast." +], +"type": "string" +} +}, +"type": "object" +}, +"AudioContentTypeTargetingOptionDetails": { +"description": "Represents a targetable audio content type. This will be populated in the audio_content_type_details field when targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`.", +"id": "AudioContentTypeTargetingOptionDetails", +"properties": { +"audioContentType": { +"description": "Output only. The audio content type.", +"enum": [ +"AUDIO_CONTENT_TYPE_UNSPECIFIED", +"AUDIO_CONTENT_TYPE_UNKNOWN", +"AUDIO_CONTENT_TYPE_MUSIC", +"AUDIO_CONTENT_TYPE_BROADCAST", +"AUDIO_CONTENT_TYPE_PODCAST" +], +"enumDescriptions": [ +"Audio content type is not specified in this version. This enum is a place holder for a default value and does not represent a real content stream type.", +"The audio content type is unknown.", +"The audio content type is music.", +"The audio content type is broadcast.", +"The audio content type is podcast." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"AudioVideoOffset": { +"description": "The length an audio or a video has been played.", +"id": "AudioVideoOffset", +"properties": { +"percentage": { +"description": "Optional. The offset in percentage of the audio or video duration.", +"format": "int64", +"type": "string" +}, +"seconds": { +"description": "Optional. The offset in seconds from the start of the audio or video.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"AuditAdvertiserResponse": { +"description": "Response message for AdvertiserService.AuditAdvertiser.", +"id": "AuditAdvertiserResponse", +"properties": { +"adGroupCriteriaCount": { +"description": "The number of individual targeting options from the following targeting types that are assigned to a line item under this advertiser. These individual targeting options count towards the limit of 4500000 ad group targeting options per advertiser. Qualifying Targeting types: * Channels, URLs, apps, and collections * Demographic * Google Audiences, including Affinity, Custom Affinity, and In-market audiences * Inventory source * Keyword * Mobile app category * User lists * Video targeting * Viewability", +"format": "int64", +"type": "string" +}, +"campaignCriteriaCount": { +"description": "The number of individual targeting options from the following targeting types that are assigned to a line item under this advertiser. These individual targeting options count towards the limit of 900000 campaign targeting options per advertiser. Qualifying Targeting types: * Position * Browser * Connection speed * Day and time * Device and operating system * Digital content label * Sensitive categories * Environment * Geography, including business chains and proximity * ISP * Language * Third-party verification", +"format": "int64", +"type": "string" +}, +"channelsCount": { +"description": "The number of channels created under this advertiser. These channels count towards the limit of 1000 channels per advertiser.", +"format": "int64", +"type": "string" +}, +"negativeKeywordListsCount": { +"description": "The number of negative keyword lists created under this advertiser. These negative keyword lists count towards the limit of 20 negative keyword lists per advertiser.", +"format": "int64", +"type": "string" +}, +"negativelyTargetedChannelsCount": { +"description": "The number of negatively targeted channels created under this advertiser. These negatively targeted channels count towards the limit of 5 negatively targeted channels per advertiser.", +"format": "int64", +"type": "string" +}, +"usedCampaignsCount": { +"description": "The number of ACTIVE and PAUSED campaigns under this advertiser. These campaigns count towards the limit of 9999 campaigns per advertiser.", +"format": "int64", +"type": "string" +}, +"usedInsertionOrdersCount": { +"description": "The number of ACTIVE, PAUSED and DRAFT insertion orders under this advertiser. These insertion orders count towards the limit of 9999 insertion orders per advertiser.", +"format": "int64", +"type": "string" +}, +"usedLineItemsCount": { +"description": "The number of ACTIVE, PAUSED, and DRAFT line items under this advertiser. These line items count towards the limit of 9999 line items per advertiser.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"AuthorizedSellerStatusAssignedTargetingOptionDetails": { +"description": "Represents an assigned authorized seller status. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. If a resource does not have an `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` assigned targeting option, it is using the \"Authorized Direct Sellers and Resellers\" option.", +"id": "AuthorizedSellerStatusAssignedTargetingOptionDetails", +"properties": { +"authorizedSellerStatus": { +"description": "Output only. The authorized seller status to target.", +"enum": [ +"AUTHORIZED_SELLER_STATUS_UNSPECIFIED", +"AUTHORIZED_SELLER_STATUS_AUTHORIZED_DIRECT_SELLERS_ONLY", +"AUTHORIZED_SELLER_STATUS_AUTHORIZED_AND_NON_PARTICIPATING_PUBLISHERS" +], +"enumDescriptions": [ +"Default value when authorized seller status is not specified in this version. This enum is a placeholder for the default value, or \"Authorized Direct Sellers and Resellers\" in the UI.", +"Only authorized sellers that directly own the inventory being monetized, as indicated by a DIRECT declaration in the ads.txt file. This value is equivalent to \"Authorized Direct Sellers\" in the UI.", +"All authorized sellers, including publishers that have not posted an ads.txt file. Display & Video 360 automatically disallows unauthorized sellers. This value is equivalent to \"Authorized and Non-Participating Publishers\" in the UI." +], +"readOnly": true, +"type": "string" +}, +"targetingOptionId": { +"description": "Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.", +"type": "string" +} +}, +"type": "object" +}, +"AuthorizedSellerStatusTargetingOptionDetails": { +"description": "Represents a targetable authorized seller status. This will be populated in the authorized_seller_status_details field when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.", +"id": "AuthorizedSellerStatusTargetingOptionDetails", +"properties": { +"authorizedSellerStatus": { +"description": "Output only. The authorized seller status.", +"enum": [ +"AUTHORIZED_SELLER_STATUS_UNSPECIFIED", +"AUTHORIZED_SELLER_STATUS_AUTHORIZED_DIRECT_SELLERS_ONLY", +"AUTHORIZED_SELLER_STATUS_AUTHORIZED_AND_NON_PARTICIPATING_PUBLISHERS" +], +"enumDescriptions": [ +"Default value when authorized seller status is not specified in this version. This enum is a placeholder for the default value, or \"Authorized Direct Sellers and Resellers\" in the UI.", +"Only authorized sellers that directly own the inventory being monetized, as indicated by a DIRECT declaration in the ads.txt file. This value is equivalent to \"Authorized Direct Sellers\" in the UI.", +"All authorized sellers, including publishers that have not posted an ads.txt file. Display & Video 360 automatically disallows unauthorized sellers. This value is equivalent to \"Authorized and Non-Participating Publishers\" in the UI." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"BiddingStrategy": { +"description": "Settings that control the bid strategy. Bid strategy determines the bid price.", +"id": "BiddingStrategy", +"properties": { +"fixedBid": { +"$ref": "FixedBidStrategy", +"description": "A strategy that uses a fixed bid price." +}, +"maximizeSpendAutoBid": { +"$ref": "MaximizeSpendBidStrategy", +"description": "A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, when performance_goal_type is one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , the line_item_type of the insertion order line items must be either: * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , and when performance_goal_type is either: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` the line_item_type of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`." +}, +"performanceGoalAutoBid": { +"$ref": "PerformanceGoalBidStrategy", +"description": "A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity." +}, +"youtubeAndPartnersBid": { +"$ref": "YoutubeAndPartnersBiddingStrategy", +"description": "A bid strategy used by YouTube and Partners resources. It can only be used for a YouTube and Partners line item or ad group entity." +} +}, +"type": "object" +}, +"BrowserAssignedTargetingOptionDetails": { +"description": "Details for assigned browser targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BROWSER`.", +"id": "BrowserAssignedTargetingOptionDetails", +"properties": { +"displayName": { +"description": "Output only. The display name of the browser.", +"readOnly": true, +"type": "string" +}, +"negative": { +"description": "Indicates if this option is being negatively targeted. All assigned browser targeting options on the same resource must have the same value for this field.", +"type": "boolean" +}, +"targetingOptionId": { +"description": "Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BROWSER`.", +"type": "string" +} +}, +"type": "object" +}, +"BrowserTargetingOptionDetails": { +"description": "Represents a targetable browser. This will be populated in the browser_details field when targeting_type is `TARGETING_TYPE_BROWSER`.", +"id": "BrowserTargetingOptionDetails", +"properties": { +"displayName": { +"description": "Output only. The display name of the browser.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"BudgetSummary": { +"description": "Summarized information of an individual campaign budget.", +"id": "BudgetSummary", +"properties": { +"externalBudgetId": { +"description": "Corresponds to the external_budget_id of a campaign budget. If the value is not set in the campaign budget, this field will be empty.", +"type": "string" +}, +"preTaxAmountMicros": { +"description": "The sum of charges made under this budget before taxes, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar.", +"format": "int64", +"type": "string" +}, +"prismaCpeCode": { +"$ref": "PrismaCpeCode", +"description": "Relevant client, product, and estimate codes from the Mediaocean Prisma tool. Only applicable for campaign budgets with an external_budget_source of EXTERNAL_BUDGET_SOURCE_MEDIA_OCEAN." +}, +"taxAmountMicros": { +"description": "The amount of tax applied to charges under this budget, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar.", +"format": "int64", +"type": "string" +}, +"totalAmountMicros": { +"description": "The total sum of charges made under this budget, including tax, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"BulkEditAdvertiserAssignedTargetingOptionsRequest": { +"description": "Request message for BulkEditAdvertiserAssignedTargetingOptions.", +"id": "BulkEditAdvertiserAssignedTargetingOptionsRequest", +"properties": { +"createRequests": { +"description": "The assigned targeting options to create in batch, specified as a list of `CreateAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD`", +"items": { +"$ref": "CreateAssignedTargetingOptionsRequest" +}, +"type": "array" +}, +"deleteRequests": { +"description": "The assigned targeting options to delete in batch, specified as a list of `DeleteAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD`", +"items": { +"$ref": "DeleteAssignedTargetingOptionsRequest" +}, +"type": "array" +} +}, +"type": "object" +}, +"BulkEditAdvertiserAssignedTargetingOptionsResponse": { +"id": "BulkEditAdvertiserAssignedTargetingOptionsResponse", +"properties": { +"createdAssignedTargetingOptions": { +"description": "The list of assigned targeting options that have been successfully created. This list will be absent if empty.", +"items": { +"$ref": "AssignedTargetingOption" +}, +"type": "array" +} +}, +"type": "object" +}, +"BulkEditAssignedInventorySourcesRequest": { +"description": "Request message for AssignedInventorySourceService.BulkEdit.", +"id": "BulkEditAssignedInventorySourcesRequest", +"properties": { +"advertiserId": { +"description": "The ID of the advertiser that owns the parent inventory source group. The parent partner does not have access to these assigned inventory sources.", +"format": "int64", +"type": "string" +}, +"createdAssignedInventorySources": { +"description": "The assigned inventory sources to create in bulk, specified as a list of AssignedInventorySources.", +"items": { +"$ref": "AssignedInventorySource" +}, +"type": "array" +}, +"deletedAssignedInventorySources": { +"description": "The IDs of the assigned inventory sources to delete in bulk, specified as a list of assigned_inventory_source_ids.", +"items": { +"format": "int64", +"type": "string" +}, +"type": "array" +}, +"partnerId": { +"description": "The ID of the partner that owns the inventory source group. Only this partner has write access to these assigned inventory sources.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"BulkEditAssignedInventorySourcesResponse": { +"description": "Response message for AssignedInventorySourceService.BulkEdit.", +"id": "BulkEditAssignedInventorySourcesResponse", +"properties": { +"assignedInventorySources": { +"description": "The list of assigned inventory sources that have been successfully created. This list will be absent if empty.", +"items": { +"$ref": "AssignedInventorySource" +}, +"type": "array" +} +}, +"type": "object" +}, +"BulkEditAssignedLocationsRequest": { +"description": "Request message for AssignedLocationService.BulkEditAssignedLocations.", +"id": "BulkEditAssignedLocationsRequest", +"properties": { +"createdAssignedLocations": { +"description": "The assigned locations to create in bulk, specified as a list of AssignedLocation resources.", +"items": { +"$ref": "AssignedLocation" +}, +"type": "array" +}, +"deletedAssignedLocations": { +"description": "The IDs of the assigned locations to delete in bulk, specified as a list of assignedLocationId values.", +"items": { +"format": "int64", +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"BulkEditAssignedLocationsResponse": { +"id": "BulkEditAssignedLocationsResponse", +"properties": { +"assignedLocations": { +"description": "The list of assigned locations that have been successfully created. This list will be absent if empty.", +"items": { +"$ref": "AssignedLocation" +}, +"type": "array" +} +}, +"type": "object" +}, +"BulkEditAssignedTargetingOptionsRequest": { +"description": "Request message for BulkEditLineItemsAssignedTargetingOptions.", +"id": "BulkEditAssignedTargetingOptionsRequest", +"properties": { +"createRequests": { +"description": "The assigned targeting options to create in batch, specified as a list of CreateAssignedTargetingOptionsRequest. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY`", +"items": { +"$ref": "CreateAssignedTargetingOptionsRequest" +}, +"type": "array" +}, +"deleteRequests": { +"description": "The assigned targeting options to delete in batch, specified as a list of DeleteAssignedTargetingOptionsRequest. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY`", +"items": { +"$ref": "DeleteAssignedTargetingOptionsRequest" +}, +"type": "array" +}, +"lineItemIds": { +"description": "Required. The ID of the line items whose targeting is being updated.", +"items": { +"format": "int64", +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"BulkEditAssignedTargetingOptionsResponse": { +"id": "BulkEditAssignedTargetingOptionsResponse", +"properties": { +"errors": { +"description": "The error information for each line item that failed to update.", +"items": { +"$ref": "Status" +}, +"type": "array" +}, +"failedLineItemIds": { +"description": "Output only. The IDs of the line items which failed.", +"items": { +"format": "int64", +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"updatedLineItemIds": { +"description": "Output only. The IDs of the line items which successfully updated.", +"items": { +"format": "int64", +"type": "string" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, +"BulkEditAssignedUserRolesRequest": { +"description": "Request message for BulkEditAssignedUserRoles.", +"id": "BulkEditAssignedUserRolesRequest", +"properties": { +"createdAssignedUserRoles": { +"description": "The assigned user roles to create in batch, specified as a list of AssignedUserRoles.", +"items": { +"$ref": "AssignedUserRole" +}, +"type": "array" +}, +"deletedAssignedUserRoles": { +"description": "The assigned user roles to delete in batch, specified as a list of assigned_user_role_ids. The format of assigned_user_role_id is `entityType-entityid`, for example `partner-123`.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"BulkEditAssignedUserRolesResponse": { +"id": "BulkEditAssignedUserRolesResponse", +"properties": { +"createdAssignedUserRoles": { +"description": "The list of assigned user roles that have been successfully created. This list will be absent if empty.", +"items": { +"$ref": "AssignedUserRole" +}, +"type": "array" +} +}, +"type": "object" +}, +"BulkEditNegativeKeywordsRequest": { +"description": "Request message for NegativeKeywordService.BulkEditNegativeKeywords.", +"id": "BulkEditNegativeKeywordsRequest", +"properties": { +"createdNegativeKeywords": { +"description": "The negative keywords to create in batch, specified as a list of NegativeKeywords.", +"items": { +"$ref": "NegativeKeyword" +}, +"type": "array" +}, +"deletedNegativeKeywords": { +"description": "The negative keywords to delete in batch, specified as a list of keyword_values.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"BulkEditNegativeKeywordsResponse": { +"description": "Response message for NegativeKeywordService.BulkEditNegativeKeywords.", +"id": "BulkEditNegativeKeywordsResponse", +"properties": { +"negativeKeywords": { +"description": "The list of negative keywords that have been successfully created. This list will be absent if empty.", +"items": { +"$ref": "NegativeKeyword" +}, +"type": "array" +} +}, +"type": "object" +}, +"BulkEditPartnerAssignedTargetingOptionsRequest": { +"description": "Request message for BulkEditPartnerAssignedTargetingOptions.", +"id": "BulkEditPartnerAssignedTargetingOptionsRequest", +"properties": { +"createRequests": { +"description": "The assigned targeting options to create in batch, specified as a list of `CreateAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL`", +"items": { +"$ref": "CreateAssignedTargetingOptionsRequest" +}, +"type": "array" +}, +"deleteRequests": { +"description": "The assigned targeting options to delete in batch, specified as a list of `DeleteAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL`", +"items": { +"$ref": "DeleteAssignedTargetingOptionsRequest" +}, +"type": "array" +} +}, +"type": "object" +}, +"BulkEditPartnerAssignedTargetingOptionsResponse": { +"id": "BulkEditPartnerAssignedTargetingOptionsResponse", +"properties": { +"createdAssignedTargetingOptions": { +"description": "The list of assigned targeting options that have been successfully created. This list will be absent if empty.", +"items": { +"$ref": "AssignedTargetingOption" +}, +"type": "array" +} +}, +"type": "object" +}, +"BulkEditSitesRequest": { +"description": "Request message for SiteService.BulkEditSites.", +"id": "BulkEditSitesRequest", +"properties": { +"advertiserId": { +"description": "The ID of the advertiser that owns the parent channel.", +"format": "int64", +"type": "string" +}, +"createdSites": { +"description": "The sites to create in batch, specified as a list of Sites.", +"items": { +"$ref": "Site" +}, +"type": "array" +}, +"deletedSites": { +"description": "The sites to delete in batch, specified as a list of site url_or_app_ids.", +"items": { +"type": "string" +}, +"type": "array" +}, +"partnerId": { +"description": "The ID of the partner that owns the parent channel.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"BulkEditSitesResponse": { +"description": "Response message for SiteService.BulkEditSites.", +"id": "BulkEditSitesResponse", +"properties": { +"sites": { +"description": "The list of sites that have been successfully created. This list will be absent if empty.", +"items": { +"$ref": "Site" +}, +"type": "array" +} +}, +"type": "object" +}, +"BulkListAdGroupAssignedTargetingOptionsResponse": { +"id": "BulkListAdGroupAssignedTargetingOptionsResponse", +"properties": { +"adGroupAssignedTargetingOptions": { +"description": "The list of wrapper objects, each providing an assigned targeting option and the ad group it is assigned to. This list will be absent if empty.", +"items": { +"$ref": "AdGroupAssignedTargetingOption" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token identifying the next page of results. This value should be specified as the pageToken in a subsequent call to `BulkListAdGroupAssignedTargetingOptions` to fetch the next page of results. This token will be absent if there are no more AdGroupAssignedTargetingOption resources to return.", +"type": "string" +} +}, +"type": "object" +}, +"BulkListAdvertiserAssignedTargetingOptionsResponse": { +"id": "BulkListAdvertiserAssignedTargetingOptionsResponse", +"properties": { +"assignedTargetingOptions": { +"description": "The list of assigned targeting options. This list will be absent if empty.", +"items": { +"$ref": "AssignedTargetingOption" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token identifying the next page of results. This value should be specified as the pageToken in a subsequent BulkListAdvertiserAssignedTargetingOptionsRequest to fetch the next page of results. This token will be absent if there are no more assigned_targeting_options to return.", +"type": "string" +} +}, +"type": "object" +}, +"BulkListAssignedTargetingOptionsResponse": { +"id": "BulkListAssignedTargetingOptionsResponse", +"properties": { +"lineItemAssignedTargetingOptions": { +"description": "The list of wrapper objects, each providing an assigned targeting option and the line item it is assigned to. This list will be absent if empty.", +"items": { +"$ref": "LineItemAssignedTargetingOption" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token identifying the next page of results. This value should be specified as the pageToken in a subsequent call to `BulkListAssignedTargetingOptions` to fetch the next page of results. This token will be absent if there are no more line_item_assigned_targeting_options to return.", +"type": "string" +} +}, +"type": "object" +}, +"BulkUpdateLineItemsRequest": { +"description": "Request message for LineItemService.BulkUpdateLineItems.", +"id": "BulkUpdateLineItemsRequest", +"properties": { +"lineItemIds": { +"description": "Required. IDs of line items to update.", +"items": { +"format": "int64", +"type": "string" +}, +"type": "array" +}, +"targetLineItem": { +"$ref": "LineItem", +"description": "Required. A line item object containing the fields to be updated and the new values to assign to all line items specified in line_item_ids.\"" +}, +"updateMask": { +"description": "Required. A field mask identifying which fields to update. Only the following fields are currently supported: * entityStatus", +"format": "google-fieldmask", +"type": "string" +} +}, +"type": "object" +}, +"BulkUpdateLineItemsResponse": { +"description": "Response message for LineItemService.BulkUpdateLineItems.", +"id": "BulkUpdateLineItemsResponse", +"properties": { +"errors": { +"description": "Errors returned by line items that failed to update.", +"items": { +"$ref": "Status" +}, +"type": "array" +}, +"failedLineItemIds": { +"description": "The IDs of line items that failed to update.", +"items": { +"format": "int64", +"type": "string" +}, +"type": "array" +}, +"skippedLineItemIds": { +"description": "The IDs of line items that are skipped for updates. For example, unnecessary mutates that will result in effectively no changes to line items will be skipped and corresponding line item IDs can be tracked here.", +"items": { +"format": "int64", +"type": "string" +}, +"type": "array" +}, +"updatedLineItemIds": { +"description": "The IDs of successfully updated line items.", +"items": { +"format": "int64", +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"BumperAd": { +"description": "Details for a bumper ad.", +"id": "BumperAd", +"properties": { +"commonInStreamAttribute": { +"$ref": "CommonInStreamAttribute", +"description": "Common ad attributes." +} +}, +"type": "object" +}, +"BusinessChainAssignedTargetingOptionDetails": { +"description": "Details for assigned Business chain targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`.", +"id": "BusinessChainAssignedTargetingOptionDetails", +"properties": { +"displayName": { +"description": "Output only. The display name of a business chain, e.g. \"KFC\", \"Chase Bank\".", +"readOnly": true, +"type": "string" +}, +"proximityRadiusAmount": { +"description": "Required. The radius of the area around the business chain that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`. The minimum increment for both cases is 0.1. Inputs will be rounded to the nearest acceptable value if it is too granular, e.g. 15.57 will become 15.6.", +"format": "double", +"type": "number" +}, +"proximityRadiusUnit": { +"description": "Required. The unit of distance by which the targeting radius is measured.", +"enum": [ +"DISTANCE_UNIT_UNSPECIFIED", +"DISTANCE_UNIT_MILES", +"DISTANCE_UNIT_KILOMETERS" +], +"enumDescriptions": [ +"Type value is not specified or is unknown in this version.", +"Miles.", +"Kilometers." +], +"type": "string" +}, +"targetingOptionId": { +"description": "Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BUSINESS_CHAIN`. Accepted business chain targeting option IDs can be retrieved using SearchTargetingOptions.", +"type": "string" +} +}, +"type": "object" +}, +"BusinessChainSearchTerms": { +"description": "Search terms for Business Chain targeting options. At least one of the field should be populated.", +"id": "BusinessChainSearchTerms", +"properties": { +"businessChainQuery": { +"description": "The search query for the desired business chain. The query must be the full name of the business, e.g. \"KFC\", \"mercedes-benz\".", +"type": "string" +}, +"regionQuery": { +"description": "The search query for the desired geo region, e.g. \"Seattle\", \"United State\".", +"type": "string" +} +}, +"type": "object" +}, +"BusinessChainTargetingOptionDetails": { +"description": "Represents a targetable business chain within a geo region. This will be populated in the business_chain_details field when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`.", +"id": "BusinessChainTargetingOptionDetails", +"properties": { +"businessChain": { +"description": "Output only. The display name of the business chain, e.g. \"KFC\", \"Chase Bank\".", +"readOnly": true, +"type": "string" +}, +"geoRegion": { +"description": "Output only. The display name of the geographic region, e.g. \"Ontario, Canada\".", +"readOnly": true, +"type": "string" +}, +"geoRegionType": { +"description": "Output only. The type of the geographic region.", +"enum": [ +"GEO_REGION_TYPE_UNKNOWN", +"GEO_REGION_TYPE_OTHER", +"GEO_REGION_TYPE_COUNTRY", +"GEO_REGION_TYPE_REGION", +"GEO_REGION_TYPE_TERRITORY", +"GEO_REGION_TYPE_PROVINCE", +"GEO_REGION_TYPE_STATE", +"GEO_REGION_TYPE_PREFECTURE", +"GEO_REGION_TYPE_GOVERNORATE", +"GEO_REGION_TYPE_CANTON", +"GEO_REGION_TYPE_UNION_TERRITORY", +"GEO_REGION_TYPE_AUTONOMOUS_COMMUNITY", +"GEO_REGION_TYPE_DMA_REGION", +"GEO_REGION_TYPE_METRO", +"GEO_REGION_TYPE_CONGRESSIONAL_DISTRICT", +"GEO_REGION_TYPE_COUNTY", +"GEO_REGION_TYPE_MUNICIPALITY", +"GEO_REGION_TYPE_CITY", +"GEO_REGION_TYPE_POSTAL_CODE", +"GEO_REGION_TYPE_DEPARTMENT", +"GEO_REGION_TYPE_AIRPORT", +"GEO_REGION_TYPE_TV_REGION", +"GEO_REGION_TYPE_OKRUG", +"GEO_REGION_TYPE_BOROUGH", +"GEO_REGION_TYPE_CITY_REGION", +"GEO_REGION_TYPE_ARRONDISSEMENT", +"GEO_REGION_TYPE_NEIGHBORHOOD", +"GEO_REGION_TYPE_UNIVERSITY", +"GEO_REGION_TYPE_DISTRICT", +"GEO_REGION_TYPE_NATIONAL_PARK", +"GEO_REGION_TYPE_BARRIO", +"GEO_REGION_TYPE_SUB_WARD", +"GEO_REGION_TYPE_MUNICIPALITY_DISTRICT", +"GEO_REGION_TYPE_SUB_DISTRICT", +"GEO_REGION_TYPE_QUARTER", +"GEO_REGION_TYPE_DIVISION", +"GEO_REGION_TYPE_COMMUNE", +"GEO_REGION_TYPE_COLLOQUIAL_AREA" +], +"enumDescriptions": [ +"The geographic region type is unknown.", +"The geographic region type is other.", +"The geographic region is a country.", +"The geographic region type is region.", +"The geographic region is a territory.", +"The geographic region is a province.", +"The geographic region is a state.", +"The geographic region is a prefecture.", +"The geographic region is a governorate.", +"The geographic region is a canton.", +"The geographic region is a union territory.", +"The geographic region is an autonomous community.", +"The geographic region is a designated market area (DMA) region.", +"The geographic region type is metro.", +"The geographic region is a congressional district.", +"The geographic region is a county.", +"The geographic region is a municipality.", +"The geographic region is a city.", +"The geographic region targeting type is postal code.", +"The geographic region targeting type is department.", +"The geographic region is an airport.", +"The geographic region is a TV region.", +"The geographic region is an okrug.", +"The geographic region is a borough.", +"The geographic region is a city region.", +"The geographic region is an arrondissement.", +"The geographic region is a neighborhood.", +"The geographic region is a university.", +"The geographic region is a district.", +"The geographic region is a national park.", +"The geographic region is a barrio.", +"The geographic region is a sub ward.", +"The geographic region is a municipality district.", +"The geographic region is a sub district.", +"The geographic region is a quarter.", +"The geographic region is a division.", +"The geographic region is a commune.", +"The geographic region is a colloquial area." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"Campaign": { +"description": "A single campaign.", +"id": "Campaign", +"properties": { +"advertiserId": { +"description": "Output only. The unique ID of the advertiser the campaign belongs to.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"campaignBudgets": { +"description": "The list of budgets available to this campaign. If this field is not set, the campaign uses an unlimited budget.", +"items": { +"$ref": "CampaignBudget" +}, +"type": "array" +}, +"campaignFlight": { +"$ref": "CampaignFlight", +"description": "Required. The planned spend and duration of the campaign." +}, +"campaignGoal": { +"$ref": "CampaignGoal", +"description": "Required. The goal of the campaign." +}, +"campaignId": { +"description": "Output only. The unique ID of the campaign. Assigned by the system.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"displayName": { +"description": "Required. The display name of the campaign. Must be UTF-8 encoded with a maximum size of 240 bytes.", +"type": "string" +}, +"entityStatus": { +"description": "Required. Controls whether or not the insertion orders under this campaign can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. * For CreateCampaign method, `ENTITY_STATUS_ARCHIVED` is not allowed.", +"enum": [ +"ENTITY_STATUS_UNSPECIFIED", +"ENTITY_STATUS_ACTIVE", +"ENTITY_STATUS_ARCHIVED", +"ENTITY_STATUS_DRAFT", +"ENTITY_STATUS_PAUSED", +"ENTITY_STATUS_SCHEDULED_FOR_DELETION" +], +"enumDescriptions": [ +"Default value when status is not specified or is unknown in this version.", +"The entity is enabled to bid and spend budget.", +"The entity is archived. Bidding and budget spending are disabled. An entity can be deleted after archived. Deleted entities cannot be retrieved.", +"The entity is under draft. Bidding and budget spending are disabled.", +"Bidding and budget spending are paused for the entity.", +"The entity is scheduled for deletion." +], +"type": "string" +}, +"frequencyCap": { +"$ref": "FrequencyCap", +"description": "Required. The frequency cap setting of the campaign. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap)" +}, +"name": { +"description": "Output only. The resource name of the campaign.", +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. The timestamp when the campaign was last updated. Assigned by the system.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"CampaignBudget": { +"description": "Settings that control how the campaign budget is allocated.", +"id": "CampaignBudget", +"properties": { +"budgetAmountMicros": { +"description": "Required. The total amount the linked insertion order segments can budget. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency.", +"format": "int64", +"type": "string" +}, +"budgetId": { +"description": "The unique ID of the campaign budget. Assigned by the system. Do not set for new budgets. Must be included when updating or adding budgets to campaign_budgets. Otherwise, a new ID will be generated and assigned.", +"format": "int64", +"type": "string" +}, +"budgetUnit": { +"description": "Required. Immutable. Specifies whether the budget is measured in currency or impressions.", +"enum": [ +"BUDGET_UNIT_UNSPECIFIED", +"BUDGET_UNIT_CURRENCY", +"BUDGET_UNIT_IMPRESSIONS" +], +"enumDescriptions": [ +"Type value is not specified or is unknown in this version.", +"Budgeting in currency amounts.", +"Budgeting in impression amounts." +], +"type": "string" +}, +"dateRange": { +"$ref": "DateRange", +"description": "Required. The date range for the campaign budget. Linked budget segments may have a different date range. They are resolved relative to the parent advertiser's time zone. Both `start_date` and `end_date` must be before the year 2037." +}, +"displayName": { +"description": "Required. The display name of the budget. Must be UTF-8 encoded with a maximum size of 240 bytes.", +"type": "string" +}, +"externalBudgetId": { +"description": "Immutable. The ID identifying this budget to the external source. If this field is set and the invoice detail level of the corresponding billing profile is set to \"Budget level PO\", all impressions served against this budget will include this ID on the invoice. Must be unique under the campaign.", +"type": "string" +}, +"externalBudgetSource": { +"description": "Required. The external source of the budget.", +"enum": [ +"EXTERNAL_BUDGET_SOURCE_UNSPECIFIED", +"EXTERNAL_BUDGET_SOURCE_NONE", +"EXTERNAL_BUDGET_SOURCE_MEDIA_OCEAN" +], +"enumDescriptions": [ +"External budget source value is not specified or unknown in this version.", +"Budget has no external source.", +"Budget source is Mediaocean." +], +"type": "string" +}, +"invoiceGroupingId": { +"description": "Immutable. The ID used to group budgets to be included the same invoice. If this field is set and the invoice level of the corresponding billing profile is set to \"Budget invoice grouping ID\", all external_budget_id sharing the same invoice_grouping_id will be grouped in the same invoice.", +"type": "string" +}, +"prismaConfig": { +"$ref": "PrismaConfig", +"description": "Additional metadata for use by the Mediaocean Prisma tool. Required for Mediaocean budgets. Only applicable to prisma_enabled advertisers." +} +}, +"type": "object" +}, +"CampaignFlight": { +"description": "Settings that track the planned spend and duration of a campaign.", +"id": "CampaignFlight", +"properties": { +"plannedDates": { +"$ref": "DateRange", +"description": "Required. The dates that the campaign is expected to run. They are resolved relative to the parent advertiser's time zone. * The dates specified here will not affect serving. They are used to generate alerts and warnings. For example, if the flight date of any child insertion order is outside the range of these dates, the user interface will show a warning. * `start_date` is required and must be the current date or later. * `end_date` is optional. If specified, it must be the `start_date` or later. * Any specified date must be before the year 2037." +}, +"plannedSpendAmountMicros": { +"description": "The amount the campaign is expected to spend for its given planned_dates. This will not limit serving, but will be used for tracking spend in the DV360 UI. The amount is in micros. Must be greater than or equal to 0. For example, 500000000 represents 500 standard units of the currency.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"CampaignGoal": { +"description": "Settings that control the goal of a campaign.", +"id": "CampaignGoal", +"properties": { +"campaignGoalType": { +"description": "Required. The type of the campaign goal.", +"enum": [ +"CAMPAIGN_GOAL_TYPE_UNSPECIFIED", +"CAMPAIGN_GOAL_TYPE_APP_INSTALL", +"CAMPAIGN_GOAL_TYPE_BRAND_AWARENESS", +"CAMPAIGN_GOAL_TYPE_OFFLINE_ACTION", +"CAMPAIGN_GOAL_TYPE_ONLINE_ACTION" +], +"enumDescriptions": [ +"Goal value is not specified or unknown in this version.", +"Drive app installs or engagements.", +"Raise awareness of a brand or product.", +"Drive offline or in-store sales.", +"Drive online action or visits." +], +"type": "string" +}, +"performanceGoal": { +"$ref": "PerformanceGoal", +"description": "Required. The performance goal of the campaign. Acceptable values for performance_goal_type are: * `PERFORMANCE_GOAL_TYPE_CPM` * `PERFORMANCE_GOAL_TYPE_CPC` * `PERFORMANCE_GOAL_TYPE_CPA` * `PERFORMANCE_GOAL_TYPE_CPIAVC` * `PERFORMANCE_GOAL_TYPE_CTR` * `PERFORMANCE_GOAL_TYPE_VIEWABILITY` * `PERFORMANCE_GOAL_TYPE_OTHER`" +} +}, +"type": "object" +}, +"CarrierAndIspAssignedTargetingOptionDetails": { +"description": "Details for assigned carrier and ISP targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`.", +"id": "CarrierAndIspAssignedTargetingOptionDetails", +"properties": { +"displayName": { +"description": "Output only. The display name of the carrier or ISP.", +"readOnly": true, +"type": "string" +}, +"negative": { +"description": "Indicates if this option is being negatively targeted. All assigned carrier and ISP targeting options on the same resource must have the same value for this field.", +"type": "boolean" +}, +"targetingOptionId": { +"description": "Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`.", +"type": "string" +} +}, +"type": "object" +}, +"CarrierAndIspTargetingOptionDetails": { +"description": "Represents a targetable carrier or ISP. This will be populated in the carrier_and_isp_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`.", +"id": "CarrierAndIspTargetingOptionDetails", +"properties": { +"displayName": { +"description": "Output only. The display name of the carrier or ISP.", +"readOnly": true, +"type": "string" +}, +"type": { +"description": "Output only. The type indicating if it's carrier or ISP.", +"enum": [ +"CARRIER_AND_ISP_TYPE_UNSPECIFIED", +"CARRIER_AND_ISP_TYPE_ISP", +"CARRIER_AND_ISP_TYPE_CARRIER" +], +"enumDescriptions": [ +"Default value when type is not specified or is unknown in this version.", +"Indicates this targeting resource refers to an ISP.", +"Indicates this targeting resource refers to a mobile carrier." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"CategoryAssignedTargetingOptionDetails": { +"description": "Assigned category targeting option details. This will be populated in the category_details field when targeting_type is `TARGETING_TYPE_CATEGORY`.", +"id": "CategoryAssignedTargetingOptionDetails", +"properties": { +"displayName": { +"description": "Output only. The display name of the category.", +"readOnly": true, +"type": "string" +}, +"negative": { +"description": "Indicates if this option is being negatively targeted.", +"type": "boolean" +}, +"targetingOptionId": { +"description": "Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CATEGORY`.", +"type": "string" +} +}, +"type": "object" +}, +"CategoryTargetingOptionDetails": { +"description": "Represents a targetable category. This will be populated in the category_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_CATEGORY`.", +"id": "CategoryTargetingOptionDetails", +"properties": { +"displayName": { +"description": "Output only. The display name of the category.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"Channel": { +"description": "A single channel. Channels are custom groups of related websites and apps.", +"id": "Channel", +"properties": { +"advertiserId": { +"description": "The ID of the advertiser that owns the channel.", +"format": "int64", +"type": "string" +}, +"channelId": { +"description": "Output only. The unique ID of the channel. Assigned by the system.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"displayName": { +"description": "Required. The display name of the channel. Must be UTF-8 encoded with a maximum length of 240 bytes.", +"type": "string" +}, +"name": { +"description": "Output only. The resource name of the channel.", +"readOnly": true, +"type": "string" +}, +"negativelyTargetedLineItemCount": { +"description": "Output only. Number of line items that are directly targeting this channel negatively.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"partnerId": { +"description": "The ID of the partner that owns the channel.", +"format": "int64", +"type": "string" +}, +"positivelyTargetedLineItemCount": { +"description": "Output only. Number of line items that are directly targeting this channel positively.", +"format": "int64", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"ChannelAssignedTargetingOptionDetails": { +"description": "Details for assigned channel targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CHANNEL`.", +"id": "ChannelAssignedTargetingOptionDetails", +"properties": { +"channelId": { +"description": "Required. ID of the channel. Should refer to the channel ID field on a [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id) resource.", +"format": "int64", +"type": "string" +}, +"negative": { +"description": "Indicates if this option is being negatively targeted. For advertiser level assigned targeting option, this field must be true.", +"type": "boolean" +} +}, +"type": "object" +}, +"CmHybridConfig": { +"description": "Settings for advertisers that use both Campaign Manager 360 (CM360) and third-party ad servers.", +"id": "CmHybridConfig", +"properties": { +"cmAccountId": { +"description": "Required. Immutable. Account ID of the CM360 Floodlight configuration linked with the DV360 advertiser.", +"format": "int64", +"type": "string" +}, +"cmAdvertiserIds": { +"description": "Output only. The set of CM360 Advertiser IDs sharing the CM360 Floodlight configuration.", +"items": { +"format": "int64", +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"cmFloodlightConfigId": { +"description": "Required. Immutable. ID of the CM360 Floodlight configuration linked with the DV360 advertiser.", +"format": "int64", +"type": "string" +}, +"cmFloodlightLinkingAuthorized": { +"description": "Required. Immutable. By setting this field to `true`, you, on behalf of your company, authorize the sharing of information from the given Floodlight configuration to this Display & Video 360 advertiser.", +"type": "boolean" +}, +"cmSyncableSiteIds": { +"description": "A list of CM360 sites whose placements will be synced to DV360 as creatives. If absent or empty in CreateAdvertiser method, the system will automatically create a CM360 site. Removing sites from this list may cause DV360 creatives synced from CM360 to be deleted. At least one site must be specified.", +"items": { +"format": "int64", +"type": "string" +}, +"type": "array" +}, +"dv360ToCmCostReportingEnabled": { +"description": "Whether or not to report DV360 cost to CM360.", +"type": "boolean" +}, +"dv360ToCmDataSharingEnabled": { +"description": "Whether or not to include DV360 data in CM360 data transfer reports.", +"type": "boolean" +} +}, +"type": "object" +}, +"CmTrackingAd": { +"description": "A Campaign Manager 360 tracking ad.", +"id": "CmTrackingAd", +"properties": { +"cmAdId": { +"description": "Optional. The ad ID of the campaign manager 360 tracking Ad.", +"format": "int64", +"type": "string" +}, +"cmCreativeId": { +"description": "Optional. The creative ID of the campaign manager 360 tracking Ad.", +"format": "int64", +"type": "string" +}, +"cmPlacementId": { +"description": "Optional. The placement ID of the campaign manager 360 tracking Ad.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"CombinedAudience": { +"description": "Describes a combined audience resource.", +"id": "CombinedAudience", +"properties": { +"combinedAudienceId": { +"description": "Output only. The unique ID of the combined audience. Assigned by the system.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"displayName": { +"description": "Output only. The display name of the combined audience. .", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Output only. The resource name of the combined audience.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"CombinedAudienceGroup": { +"description": "Details of combined audience group. All combined audience targeting settings are logically \u2018OR\u2019 of each other.", +"id": "CombinedAudienceGroup", +"properties": { +"settings": { +"description": "Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise.", +"items": { +"$ref": "CombinedAudienceTargetingSetting" +}, +"type": "array" +} +}, +"type": "object" +}, +"CombinedAudienceTargetingSetting": { +"description": "Details of combined audience targeting setting.", +"id": "CombinedAudienceTargetingSetting", +"properties": { +"combinedAudienceId": { +"description": "Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"CommonInStreamAttribute": { +"description": "Common attributes for in-stream, non-skippable and bumper ads.", +"id": "CommonInStreamAttribute", +"properties": { +"actionButtonLabel": { +"description": "The text on the call-to-action button.", +"type": "string" +}, +"actionHeadline": { +"description": "The headline of the call-to-action banner.", +"type": "string" +}, +"companionBanner": { +"$ref": "ImageAsset", +"description": "The image which shows next to the video ad." +}, +"displayUrl": { +"description": "The webpage address that appears with the ad.", +"type": "string" +}, +"finalUrl": { +"description": "The URL address of the webpage that people reach after they click the ad.", +"type": "string" +}, +"trackingUrl": { +"description": "The URL address loaded in the background for tracking purposes.", +"type": "string" +}, +"video": { +"$ref": "YoutubeVideoDetails", +"description": "The YouTube video of the ad." +} +}, +"type": "object" +}, +"Consent": { +"description": "User consent status.", +"id": "Consent", +"properties": { +"adPersonalization": { +"description": "Represents consent for ad personalization.", +"enum": [ +"CONSENT_STATUS_UNSPECIFIED", +"CONSENT_STATUS_GRANTED", +"CONSENT_STATUS_DENIED" +], +"enumDescriptions": [ +"Type value is not specified or is unknown in this version.", +"Consent is granted.", +"Consent is denied." +], +"type": "string" +}, +"adUserData": { +"description": "Represents consent for ad user data.", +"enum": [ +"CONSENT_STATUS_UNSPECIFIED", +"CONSENT_STATUS_GRANTED", +"CONSENT_STATUS_DENIED" +], +"enumDescriptions": [ +"Type value is not specified or is unknown in this version.", +"Consent is granted.", +"Consent is denied." +], +"type": "string" +} +}, +"type": "object" +}, +"ContactInfo": { +"description": "Contact information defining a Customer Match audience member.", +"id": "ContactInfo", +"properties": { +"countryCode": { +"description": "Country code of the member. Must also be set with the following fields: * hashed_first_name * hashed_last_name * zip_codes", +"type": "string" +}, +"hashedEmails": { +"description": "A list of SHA256 hashed email of the member. Before hashing, remove all whitespace and make sure the string is all lowercase.", +"items": { +"type": "string" +}, +"type": "array" +}, +"hashedFirstName": { +"description": "SHA256 hashed first name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_last_name * zip_codes", +"type": "string" +}, +"hashedLastName": { +"description": "SHA256 hashed last name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_first_name * zip_codes", +"type": "string" +}, +"hashedPhoneNumbers": { +"description": "A list of SHA256 hashed phone numbers of the member. Before hashing, all phone numbers must be formatted using the [E.164 format](//en.wikipedia.org/wiki/E.164) and include the country calling code.", +"items": { +"type": "string" +}, +"type": "array" +}, +"zipCodes": { +"description": "A list of zip codes of the member. Must also be set with the following fields: * country_code * hashed_first_name * hashed_last_name", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ContactInfoList": { +"description": "Wrapper message for a list of contact information defining Customer Match audience members.", +"id": "ContactInfoList", +"properties": { +"consent": { +"$ref": "Consent", +"description": "Input only. The consent setting for the users in contact_infos. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error." +}, +"contactInfos": { +"description": "A list of ContactInfo objects defining Customer Match audience members. The size of members after splitting the contact_infos mustn't be greater than 500,000.", +"items": { +"$ref": "ContactInfo" +}, +"type": "array" +} +}, +"type": "object" +}, +"ContentDurationAssignedTargetingOptionDetails": { +"description": "Details for content duration assigned targeting option. This will be populated in the content_duration_details field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`. Explicitly targeting all options is not supported. Remove all content duration targeting options to achieve this effect.", +"id": "ContentDurationAssignedTargetingOptionDetails", +"properties": { +"contentDuration": { +"description": "Output only. The content duration.", +"enum": [ +"CONTENT_DURATION_UNSPECIFIED", +"CONTENT_DURATION_UNKNOWN", +"CONTENT_DURATION_0_TO_1_MIN", +"CONTENT_DURATION_1_TO_5_MIN", +"CONTENT_DURATION_5_TO_15_MIN", +"CONTENT_DURATION_15_TO_30_MIN", +"CONTENT_DURATION_30_TO_60_MIN", +"CONTENT_DURATION_OVER_60_MIN" +], +"enumDescriptions": [ +"Content duration is not specified in this version. This enum is a place holder for a default value and does not represent a real content duration.", +"The content duration is unknown.", +"Content is 0-1 minute long.", +"Content is 1-5 minutes long.", +"Content is 5-15 minutes long.", +"Content is 15-30 minutes long.", +"Content is 30-60 minutes long.", +"Content is over 60 minutes long." +], +"readOnly": true, +"type": "string" +}, +"targetingOptionId": { +"description": "Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.", +"type": "string" +} +}, +"type": "object" +}, +"ContentDurationTargetingOptionDetails": { +"description": "Represents a targetable content duration. This will be populated in the content_duration_details field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.", +"id": "ContentDurationTargetingOptionDetails", +"properties": { +"contentDuration": { +"description": "Output only. The content duration.", +"enum": [ +"CONTENT_DURATION_UNSPECIFIED", +"CONTENT_DURATION_UNKNOWN", +"CONTENT_DURATION_0_TO_1_MIN", +"CONTENT_DURATION_1_TO_5_MIN", +"CONTENT_DURATION_5_TO_15_MIN", +"CONTENT_DURATION_15_TO_30_MIN", +"CONTENT_DURATION_30_TO_60_MIN", +"CONTENT_DURATION_OVER_60_MIN" +], +"enumDescriptions": [ +"Content duration is not specified in this version. This enum is a place holder for a default value and does not represent a real content duration.", +"The content duration is unknown.", +"Content is 0-1 minute long.", +"Content is 1-5 minutes long.", +"Content is 5-15 minutes long.", +"Content is 15-30 minutes long.", +"Content is 30-60 minutes long.", +"Content is over 60 minutes long." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"ContentGenreAssignedTargetingOptionDetails": { +"description": "Details for content genre assigned targeting option. This will be populated in the content_genre_details field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`. Explicitly targeting all options is not supported. Remove all content genre targeting options to achieve this effect.", +"id": "ContentGenreAssignedTargetingOptionDetails", +"properties": { +"displayName": { +"description": "Output only. The display name of the content genre.", +"readOnly": true, +"type": "string" +}, +"negative": { +"description": "Indicates if this option is being negatively targeted.", +"type": "boolean" +}, +"targetingOptionId": { +"description": "Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.", +"type": "string" +} +}, +"type": "object" +}, +"ContentGenreTargetingOptionDetails": { +"description": "Represents a targetable content genre. This will be populated in the content_genre_details field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.", +"id": "ContentGenreTargetingOptionDetails", +"properties": { +"displayName": { +"description": "Output only. The display name of the content genre", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"ContentInstreamPositionAssignedTargetingOptionDetails": { +"description": "Assigned content instream position targeting option details. This will be populated in the content_instream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.", +"id": "ContentInstreamPositionAssignedTargetingOptionDetails", +"properties": { +"adType": { +"description": "Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`. * `AD_TYPE_AUDIO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_AUDIO_DEFAULT`.", +"enum": [ +"AD_TYPE_UNSPECIFIED", +"AD_TYPE_DISPLAY", +"AD_TYPE_VIDEO", +"AD_TYPE_AUDIO" +], +"enumDescriptions": [ +"Ad type is not specified or is unknown in this version.", +"Display creatives, e.g. image and HTML5.", +"Video creatives, e.g. video ads that play during streaming content in video players.", +"Audio creatives, e.g. audio ads that play during audio content." +], +"readOnly": true, +"type": "string" +}, +"contentInstreamPosition": { +"description": "Required. The content instream position for video or audio ads.", +"enum": [ +"CONTENT_INSTREAM_POSITION_UNSPECIFIED", +"CONTENT_INSTREAM_POSITION_PRE_ROLL", +"CONTENT_INSTREAM_POSITION_MID_ROLL", +"CONTENT_INSTREAM_POSITION_POST_ROLL", +"CONTENT_INSTREAM_POSITION_UNKNOWN" +], +"enumDescriptions": [ +"Content instream position is not specified in this version. This enum is a place holder for a default value and does not represent a real in stream ad position.", +"Ads that play before streaming content.", +"Ads that play between the beginning and end of streaming content.", +"Ads that play at the end of streaming content.", +"Ads instream position is unknown." +], +"type": "string" +} +}, +"type": "object" +}, +"ContentInstreamPositionTargetingOptionDetails": { +"description": "Represents a targetable content instream position, which could be used by video and audio ads. This will be populated in the content_instream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.", +"id": "ContentInstreamPositionTargetingOptionDetails", +"properties": { +"contentInstreamPosition": { +"description": "Output only. The content instream position.", +"enum": [ +"CONTENT_INSTREAM_POSITION_UNSPECIFIED", +"CONTENT_INSTREAM_POSITION_PRE_ROLL", +"CONTENT_INSTREAM_POSITION_MID_ROLL", +"CONTENT_INSTREAM_POSITION_POST_ROLL", +"CONTENT_INSTREAM_POSITION_UNKNOWN" +], +"enumDescriptions": [ +"Content instream position is not specified in this version. This enum is a place holder for a default value and does not represent a real in stream ad position.", +"Ads that play before streaming content.", +"Ads that play between the beginning and end of streaming content.", +"Ads that play at the end of streaming content.", +"Ads instream position is unknown." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"ContentOutstreamPositionAssignedTargetingOptionDetails": { +"description": "Assigned content outstream position targeting option details. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.", +"id": "ContentOutstreamPositionAssignedTargetingOptionDetails", +"properties": { +"adType": { +"description": "Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.", +"enum": [ +"AD_TYPE_UNSPECIFIED", +"AD_TYPE_DISPLAY", +"AD_TYPE_VIDEO", +"AD_TYPE_AUDIO" +], +"enumDescriptions": [ +"Ad type is not specified or is unknown in this version.", +"Display creatives, e.g. image and HTML5.", +"Video creatives, e.g. video ads that play during streaming content in video players.", +"Audio creatives, e.g. audio ads that play during audio content." +], +"readOnly": true, +"type": "string" +}, +"contentOutstreamPosition": { +"description": "Required. The content outstream position.", +"enum": [ +"CONTENT_OUTSTREAM_POSITION_UNSPECIFIED", +"CONTENT_OUTSTREAM_POSITION_UNKNOWN", +"CONTENT_OUTSTREAM_POSITION_IN_ARTICLE", +"CONTENT_OUTSTREAM_POSITION_IN_BANNER", +"CONTENT_OUTSTREAM_POSITION_IN_FEED", +"CONTENT_OUTSTREAM_POSITION_INTERSTITIAL" +], +"enumDescriptions": [ +"Content outstream position is not specified in this version. This enum is a place holder for a default value and does not represent a real content outstream position.", +"The ad position is unknown in the content outstream.", +"Ads that appear between the paragraphs of your pages.", +"Ads that display on the top and the sides of a page.", +"Ads that appear in a scrollable stream of content. A feed is typically editorial (e.g. a list of articles or news) or listings (e.g. a list of products or services).", +"Ads shown before or between content loads." +], +"type": "string" +} +}, +"type": "object" +}, +"ContentOutstreamPositionTargetingOptionDetails": { +"description": "Represents a targetable content outstream position, which could be used by display and video ads. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.", +"id": "ContentOutstreamPositionTargetingOptionDetails", +"properties": { +"contentOutstreamPosition": { +"description": "Output only. The content outstream position.", +"enum": [ +"CONTENT_OUTSTREAM_POSITION_UNSPECIFIED", +"CONTENT_OUTSTREAM_POSITION_UNKNOWN", +"CONTENT_OUTSTREAM_POSITION_IN_ARTICLE", +"CONTENT_OUTSTREAM_POSITION_IN_BANNER", +"CONTENT_OUTSTREAM_POSITION_IN_FEED", +"CONTENT_OUTSTREAM_POSITION_INTERSTITIAL" +], +"enumDescriptions": [ +"Content outstream position is not specified in this version. This enum is a place holder for a default value and does not represent a real content outstream position.", +"The ad position is unknown in the content outstream.", +"Ads that appear between the paragraphs of your pages.", +"Ads that display on the top and the sides of a page.", +"Ads that appear in a scrollable stream of content. A feed is typically editorial (e.g. a list of articles or news) or listings (e.g. a list of products or services).", +"Ads shown before or between content loads." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"ContentStreamTypeAssignedTargetingOptionDetails": { +"description": "Details for content stream type assigned targeting option. This will be populated in the content_stream_type_details field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`. Explicitly targeting all options is not supported. Remove all content stream type targeting options to achieve this effect.", +"id": "ContentStreamTypeAssignedTargetingOptionDetails", +"properties": { +"contentStreamType": { +"description": "Output only. The content stream type.", +"enum": [ +"CONTENT_STREAM_TYPE_UNSPECIFIED", +"CONTENT_LIVE_STREAM", +"CONTENT_ON_DEMAND" +], +"enumDescriptions": [ +"Content stream type is not specified in this version. This enum is a place holder for a default value and does not represent a real content stream type.", +"The content is being live-streamed.", +"The content is viewed on-demand." +], +"readOnly": true, +"type": "string" +}, +"targetingOptionId": { +"description": "Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.", +"type": "string" +} +}, +"type": "object" +}, +"ContentStreamTypeTargetingOptionDetails": { +"description": "Represents a targetable content stream type. This will be populated in the content_stream_type_details field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.", +"id": "ContentStreamTypeTargetingOptionDetails", +"properties": { +"contentStreamType": { +"description": "Output only. The content stream type.", +"enum": [ +"CONTENT_STREAM_TYPE_UNSPECIFIED", +"CONTENT_LIVE_STREAM", +"CONTENT_ON_DEMAND" +], +"enumDescriptions": [ +"Content stream type is not specified in this version. This enum is a place holder for a default value and does not represent a real content stream type.", +"The content is being live-streamed.", +"The content is viewed on-demand." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"ConversionCountingConfig": { +"description": "Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting.", +"id": "ConversionCountingConfig", +"properties": { +"floodlightActivityConfigs": { +"description": "The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. *Warning*: Starting **April 1, 2025**, this field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).", +"items": { +"$ref": "TrackingFloodlightActivityConfig" +}, +"type": "array" +}, +"postViewCountPercentageMillis": { +"description": "The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"CounterEvent": { +"description": "Counter event of the creative.", +"id": "CounterEvent", +"properties": { +"name": { +"description": "Required. The name of the counter event.", +"type": "string" +}, +"reportingName": { +"description": "Required. The name used to identify this counter event in reports.", +"type": "string" +} +}, +"type": "object" +}, +"CreateAssetRequest": { +"description": "A request message for CreateAsset.", +"id": "CreateAssetRequest", +"properties": { +"filename": { +"description": "Required. The filename of the asset, including the file extension. The filename must be UTF-8 encoded with a maximum size of 240 bytes.", +"type": "string" +} +}, +"type": "object" +}, +"CreateAssetResponse": { +"description": "A response message for CreateAsset.", +"id": "CreateAssetResponse", +"properties": { +"asset": { +"$ref": "Asset", +"description": "The uploaded asset, if successful." +} +}, +"type": "object" +}, +"CreateAssignedTargetingOptionsRequest": { +"description": "A request listing which assigned targeting options of a given targeting type should be created and added.", +"id": "CreateAssignedTargetingOptionsRequest", +"properties": { +"assignedTargetingOptions": { +"description": "Required. The assigned targeting options to create and add.", +"items": { +"$ref": "AssignedTargetingOption" +}, +"type": "array" +}, +"targetingType": { +"description": "Required. Identifies the type of this assigned targeting option.", +"enum": [ +"TARGETING_TYPE_UNSPECIFIED", +"TARGETING_TYPE_CHANNEL", +"TARGETING_TYPE_APP_CATEGORY", +"TARGETING_TYPE_APP", +"TARGETING_TYPE_URL", +"TARGETING_TYPE_DAY_AND_TIME", +"TARGETING_TYPE_AGE_RANGE", +"TARGETING_TYPE_REGIONAL_LOCATION_LIST", +"TARGETING_TYPE_PROXIMITY_LOCATION_LIST", +"TARGETING_TYPE_GENDER", +"TARGETING_TYPE_VIDEO_PLAYER_SIZE", +"TARGETING_TYPE_USER_REWARDED_CONTENT", +"TARGETING_TYPE_PARENTAL_STATUS", +"TARGETING_TYPE_CONTENT_INSTREAM_POSITION", +"TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", +"TARGETING_TYPE_DEVICE_TYPE", +"TARGETING_TYPE_AUDIENCE_GROUP", +"TARGETING_TYPE_BROWSER", +"TARGETING_TYPE_HOUSEHOLD_INCOME", +"TARGETING_TYPE_ON_SCREEN_POSITION", +"TARGETING_TYPE_THIRD_PARTY_VERIFIER", +"TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", +"TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", +"TARGETING_TYPE_ENVIRONMENT", +"TARGETING_TYPE_CARRIER_AND_ISP", +"TARGETING_TYPE_OPERATING_SYSTEM", +"TARGETING_TYPE_DEVICE_MAKE_MODEL", +"TARGETING_TYPE_KEYWORD", +"TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", +"TARGETING_TYPE_VIEWABILITY", +"TARGETING_TYPE_CATEGORY", +"TARGETING_TYPE_INVENTORY_SOURCE", +"TARGETING_TYPE_LANGUAGE", +"TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", +"TARGETING_TYPE_GEO_REGION", +"TARGETING_TYPE_INVENTORY_SOURCE_GROUP", +"TARGETING_TYPE_EXCHANGE", +"TARGETING_TYPE_SUB_EXCHANGE", +"TARGETING_TYPE_POI", +"TARGETING_TYPE_BUSINESS_CHAIN", +"TARGETING_TYPE_CONTENT_DURATION", +"TARGETING_TYPE_CONTENT_STREAM_TYPE", +"TARGETING_TYPE_NATIVE_CONTENT_POSITION", +"TARGETING_TYPE_OMID", +"TARGETING_TYPE_AUDIO_CONTENT_TYPE", +"TARGETING_TYPE_CONTENT_GENRE", +"TARGETING_TYPE_YOUTUBE_VIDEO", +"TARGETING_TYPE_YOUTUBE_CHANNEL", +"TARGETING_TYPE_SESSION_POSITION" +], +"enumDescriptions": [ +"Default value when type is not specified or is unknown in this version.", +"Target a channel (a custom group of related websites or apps).", +"Target an app category (for example, education or puzzle games).", +"Target a specific app (for example, Angry Birds).", +"Target a specific url (for example, quora.com).", +"Target ads during a chosen time period on a specific day.", +"Target ads to a specific age range (for example, 18-24).", +"Target ads to the specified regions on a regional location list.", +"Target ads to the specified points of interest on a proximity location list.", +"Target ads to a specific gender (for example, female or male).", +"Target a specific video player size for video ads.", +"Target user rewarded content for video ads.", +"Target ads to a specific parental status (for example, parent or not a parent).", +"Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", +"Target ads in a specific content outstream position.", +"Target ads to a specific device type (for example, tablet or connected TV).", +"Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", +"Target ads to specific web browsers (for example, Chrome).", +"Target ads to a specific household income range (for example, top 10%).", +"Target ads in a specific on screen position.", +"Filter web sites through third party verification (for example, IAS or DoubleVerify).", +"Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", +"Filter website content by sensitive categories (for example, adult).", +"Target ads to a specific environment (for example, web or app).", +"Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", +"Target ads to a specific operating system (for example, macOS).", +"Target ads to a specific device make or model (for example, Roku or Samsung).", +"Target ads to a specific keyword (for example, dog or retriever).", +"Target ads to a specific negative keyword list.", +"Target ads to a specific viewability (for example, 80% viewable).", +"Target ads to a specific content category (for example, arts & entertainment).", +"Purchase impressions from specific deals and auction packages.", +"Target ads to a specific language (for example, English or Japanese).", +"Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", +"Target ads to a specific regional location (for example, a city or state).", +"Purchase impressions from a group of deals and auction packages.", +"Purchase impressions from specific exchanges.", +"Purchase impressions from specific sub-exchanges.", +"Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", +"Target ads around locations of a business chain within a specific geo region.", +"Target ads to a specific video content duration.", +"Target ads to a specific video content stream type.", +"Target ads to a specific native content position.", +"Target ads in an Open Measurement enabled inventory.", +"Target ads to a specific audio content type.", +"Target ads to a specific content genre.", +"Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", +"Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", +"Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." +], +"type": "string" +} +}, +"type": "object" +}, +"CreateSdfDownloadTaskRequest": { +"description": "Request message for [SdfDownloadTaskService.CreateSdfDownloadTask].", +"id": "CreateSdfDownloadTaskRequest", +"properties": { +"advertiserId": { +"description": "The ID of the advertiser to download SDF for.", +"format": "int64", +"type": "string" +}, +"idFilter": { +"$ref": "IdFilter", +"description": "Filters on entities by their entity IDs." +}, +"inventorySourceFilter": { +"$ref": "InventorySourceFilter", +"description": "Filters on Inventory Sources by their IDs." +}, +"parentEntityFilter": { +"$ref": "ParentEntityFilter", +"description": "Filters on selected file types. The entities in each file are filtered by a chosen set of filter entities. The filter entities must be the same type as, or a parent type of, the selected file types." +}, +"partnerId": { +"description": "The ID of the partner to download SDF for.", +"format": "int64", +"type": "string" +}, +"version": { +"description": "Required. The SDF version of the downloaded file. If set to `SDF_VERSION_UNSPECIFIED`, this will default to the version specified by the advertiser or partner identified by `root_id`. An advertiser inherits its SDF version from its partner unless configured otherwise.", +"enum": [ +"SDF_VERSION_UNSPECIFIED", +"SDF_VERSION_3_1", +"SDF_VERSION_4", +"SDF_VERSION_4_1", +"SDF_VERSION_4_2", +"SDF_VERSION_5", +"SDF_VERSION_5_1", +"SDF_VERSION_5_2", +"SDF_VERSION_5_3", +"SDF_VERSION_5_4", +"SDF_VERSION_5_5", +"SDF_VERSION_6", +"SDF_VERSION_7", +"SDF_VERSION_7_1", +"SDF_VERSION_8" +], +"enumDeprecated": [ +false, +true, +true, +true, +true, +true, +true, +true, +true, +true, +true, +false, +false, +false, +false +], +"enumDescriptions": [ +"SDF version value is not specified or is unknown in this version.", +"SDF version 3.1", +"SDF version 4", +"SDF version 4.1", +"SDF version 4.2", +"SDF version 5.", +"SDF version 5.1", +"SDF version 5.2", +"SDF version 5.3", +"SDF version 5.4", +"SDF version 5.5", +"SDF version 6", +"SDF version 7. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version.", +"SDF version 7.1. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version.", +"SDF version 8. Read the [v8 migration guide](/display-video/api/structured-data-file/v8-migration-guide) before migrating to this version." +], +"type": "string" +} +}, +"type": "object" +}, +"Creative": { +"description": "A single Creative.", +"id": "Creative", +"properties": { +"additionalDimensions": { +"description": "Optional. Additional dimensions. Applicable when creative_type is one of: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_LIGHTBOX` * `CREATIVE_TYPE_PUBLISHER_HOSTED` If this field is specified, width_pixels and height_pixels are both required and must be greater than or equal to 0.", +"items": { +"$ref": "Dimensions" +}, +"type": "array" +}, +"advertiserId": { +"description": "Output only. The unique ID of the advertiser the creative belongs to.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"appendedTag": { +"description": "Optional. Third-party HTML tracking tag to be appended to the creative tag.", +"type": "string" +}, +"assets": { +"description": "Required. Assets associated to this creative.", +"items": { +"$ref": "AssetAssociation" +}, +"type": "array" +}, +"cmPlacementId": { +"description": "Output only. The unique ID of the Campaign Manager 360 placement associated with the creative. This field is only applicable for creatives that are synced from Campaign Manager.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"cmTrackingAd": { +"$ref": "CmTrackingAd", +"description": "Optional. The Campaign Manager 360 tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager 360 and third-party ad serving: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` Output only for other cases." +}, +"companionCreativeIds": { +"description": "Optional. The IDs of companion creatives for a video creative. You can assign existing display creatives (with image or HTML5 assets) to serve surrounding the publisher's video player. Companions display around the video player while the video is playing and remain after the video has completed. Creatives contain additional dimensions can not be companion creatives. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO`", +"items": { +"format": "int64", +"type": "string" +}, +"type": "array" +}, +"counterEvents": { +"description": "Optional. Counter events for a rich media creative. Counters track the number of times that a user interacts with any part of a rich media creative in a specified way (mouse-overs, mouse-outs, clicks, taps, data loading, keyboard entries, etc.). Any event that can be captured in the creative can be recorded as a counter. Leave it empty or unset for creatives containing image assets only.", +"items": { +"$ref": "CounterEvent" +}, +"type": "array" +}, +"createTime": { +"description": "Output only. The timestamp when the creative was created. Assigned by the system.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"creativeAttributes": { +"description": "Output only. A list of attributes of the creative that is generated by the system.", +"items": { +"enum": [ +"CREATIVE_ATTRIBUTE_UNSPECIFIED", +"CREATIVE_ATTRIBUTE_VAST", +"CREATIVE_ATTRIBUTE_VPAID_LINEAR", +"CREATIVE_ATTRIBUTE_VPAID_NON_LINEAR" +], +"enumDescriptions": [ +"The creative attribute is not specified or is unknown in this version.", +"The creative is a VAST creative.", +"The creative is a linear VPAID creative.", +"The creative is a non-linear VPAID creative." +], +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"creativeId": { +"description": "Output only. The unique ID of the creative. Assigned by the system.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"creativeType": { +"description": "Required. Immutable. The type of the creative.", +"enum": [ +"CREATIVE_TYPE_UNSPECIFIED", +"CREATIVE_TYPE_STANDARD", +"CREATIVE_TYPE_EXPANDABLE", +"CREATIVE_TYPE_VIDEO", +"CREATIVE_TYPE_NATIVE", +"CREATIVE_TYPE_TEMPLATED_APP_INSTALL", +"CREATIVE_TYPE_NATIVE_SITE_SQUARE", +"CREATIVE_TYPE_TEMPLATED_APP_INSTALL_INTERSTITIAL", +"CREATIVE_TYPE_LIGHTBOX", +"CREATIVE_TYPE_NATIVE_APP_INSTALL", +"CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE", +"CREATIVE_TYPE_AUDIO", +"CREATIVE_TYPE_PUBLISHER_HOSTED", +"CREATIVE_TYPE_NATIVE_VIDEO", +"CREATIVE_TYPE_TEMPLATED_APP_INSTALL_VIDEO", +"CREATIVE_TYPE_ASSET_BASED_CREATIVE" +], +"enumDescriptions": [ +"Type value is not specified or is unknown in this version.", +"Standard display creative. Create and update methods are supported for this creative type if the hosting_source is one of the following: * `HOSTING_SOURCE_HOSTED` * `HOSTING_SOURCE_THIRD_PARTY`", +"Expandable creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_THIRD_PARTY`", +"Video creative. Create and update methods are supported for this creative type if the hosting_source is one of the following: * `HOSTING_SOURCE_HOSTED` * `HOSTING_SOURCE_THIRD_PARTY`", +"Native creative rendered by publishers with assets from advertiser. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`", +"Templated app install mobile creative (banner). Create and update methods are **not** supported for this creative type.", +"Square native creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`", +"Interstitial creative including both display and video. Create and update methods are **not** supported for this creative type.", +"Responsive and expandable Lightbox creative. Create and update methods are **not** supported for this creative type.", +"Native app install creative. Create and update methods are **not** supported for this creative type.", +"Square native app install creative. Create and update methods are **not** supported for this creative type.", +"Audio creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`", +"Publisher hosted creative. Create and update methods are **not** supported for this creative type.", +"Native video creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`", +"Templated app install mobile video creative. Create and update methods are **not** supported for this creative type.", +"Asset-based creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`." +], +"type": "string" +}, +"dimensions": { +"$ref": "Dimensions", +"description": "Required. Primary dimensions of the creative. Applicable to all creative types. The value of width_pixels and height_pixels defaults to `0` when creative_type is one of: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_NATIVE_VIDEO`" +}, +"displayName": { +"description": "Required. The display name of the creative. Must be UTF-8 encoded with a maximum size of 240 bytes.", +"type": "string" +}, +"dynamic": { +"description": "Output only. Indicates whether the creative is dynamic.", +"readOnly": true, +"type": "boolean" +}, +"entityStatus": { +"description": "Required. Controls whether or not the creative can serve. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED` * `ENTITY_STATUS_PAUSED`", +"enum": [ +"ENTITY_STATUS_UNSPECIFIED", +"ENTITY_STATUS_ACTIVE", +"ENTITY_STATUS_ARCHIVED", +"ENTITY_STATUS_DRAFT", +"ENTITY_STATUS_PAUSED", +"ENTITY_STATUS_SCHEDULED_FOR_DELETION" +], +"enumDescriptions": [ +"Default value when status is not specified or is unknown in this version.", +"The entity is enabled to bid and spend budget.", +"The entity is archived. Bidding and budget spending are disabled. An entity can be deleted after archived. Deleted entities cannot be retrieved.", +"The entity is under draft. Bidding and budget spending are disabled.", +"Bidding and budget spending are paused for the entity.", +"The entity is scheduled for deletion." +], +"type": "string" +}, +"exitEvents": { +"description": "Required. Exit events for this creative. An exit (also known as a click tag) is any area in your creative that someone can click or tap to open an advertiser's landing page. Every creative must include at least one exit. You can add an exit to your creative in any of the following ways: * Use Google Web Designer's tap area. * Define a JavaScript variable called \"clickTag\". * Use the Enabler (Enabler.exit()) to track exits in rich media formats.", +"items": { +"$ref": "ExitEvent" +}, +"type": "array" +}, +"expandOnHover": { +"description": "Optional. Indicates the creative will automatically expand on hover. Optional and only valid for third-party expandable creatives. Third-party expandable creatives are creatives with following hosting source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_EXPANDABLE`", +"type": "boolean" +}, +"expandingDirection": { +"description": "Optional. Specifies the expanding direction of the creative. Required and only valid for third-party expandable creatives. Third-party expandable creatives are creatives with following hosting source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_EXPANDABLE`", +"enum": [ +"EXPANDING_DIRECTION_UNSPECIFIED", +"EXPANDING_DIRECTION_NONE", +"EXPANDING_DIRECTION_UP", +"EXPANDING_DIRECTION_DOWN", +"EXPANDING_DIRECTION_LEFT", +"EXPANDING_DIRECTION_RIGHT", +"EXPANDING_DIRECTION_UP_AND_LEFT", +"EXPANDING_DIRECTION_UP_AND_RIGHT", +"EXPANDING_DIRECTION_DOWN_AND_LEFT", +"EXPANDING_DIRECTION_DOWN_AND_RIGHT", +"EXPANDING_DIRECTION_UP_OR_DOWN", +"EXPANDING_DIRECTION_LEFT_OR_RIGHT", +"EXPANDING_DIRECTION_ANY_DIAGONAL" +], +"enumDescriptions": [ +"The expanding direction is not specified.", +"Does not expand in any direction.", +"Expands up.", +"Expands down.", +"Expands left.", +"Expands right.", +"Expands up and to the left side.", +"Expands up and to the right side.", +"Expands down and to the left side.", +"Expands down and to the right side.", +"Expands either up or down.", +"Expands to either the left or the right side.", +"Can expand in any diagonal direction." +], +"type": "string" +}, +"hostingSource": { +"description": "Required. Indicates where the creative is hosted.", +"enum": [ +"HOSTING_SOURCE_UNSPECIFIED", +"HOSTING_SOURCE_CM", +"HOSTING_SOURCE_THIRD_PARTY", +"HOSTING_SOURCE_HOSTED", +"HOSTING_SOURCE_RICH_MEDIA" +], +"enumDescriptions": [ +"Hosting source is not specified or is unknown in this version.", +"A creative synced from Campaign Manager 360. Create and update methods are **not** supported for this hosting type.", +"A creative hosted by a third-party ad server (3PAS). Create and update methods are supported for this hosting type if the creative_type is one of the following: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_VIDEO`", +"A creative created in DV360 and hosted by Campaign Manager 360. Create and update methods are supported for this hosting type if the creative_type is one of the following: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_VIDEO`", +"A rich media creative created in Studio and hosted by Campaign Manager 360. Create and update methods are **not** supported for this hosting type." +], +"type": "string" +}, +"html5Video": { +"description": "Output only. Indicates the third-party VAST tag creative requires HTML5 Video support. Output only and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_VIDEO`", +"readOnly": true, +"type": "boolean" +}, +"iasCampaignMonitoring": { +"description": "Optional. Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. To enable this for the creative, make sure the Advertiser.creative_config.ias_client_id has been set to your IAS client ID.", +"type": "boolean" +}, +"integrationCode": { +"description": "Optional. ID information used to link this creative to an external system. Must be UTF-8 encoded with a length of no more than 10,000 characters.", +"type": "string" +}, +"jsTrackerUrl": { +"description": "Optional. JavaScript measurement URL from supported third-party verification providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not supported. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", +"type": "string" +}, +"lineItemIds": { +"description": "Output only. The IDs of the line items this creative is associated with. To associate a creative to a line item, use LineItem.creative_ids instead.", +"items": { +"format": "int64", +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"mediaDuration": { +"description": "Output only. Media duration of the creative. Applicable when creative_type is one of: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_PUBLISHER_HOSTED`", +"format": "google-duration", +"readOnly": true, +"type": "string" +}, +"mp3Audio": { +"description": "Output only. Indicates the third-party audio creative supports MP3. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO`", +"readOnly": true, +"type": "boolean" +}, +"name": { +"description": "Output only. The resource name of the creative.", +"readOnly": true, +"type": "string" +}, +"notes": { +"description": "Optional. User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters.", +"type": "string" +}, +"obaIcon": { +"$ref": "ObaIcon", +"description": "Optional. Specifies the OBA icon for a video creative. This field is only supported in the following creative_type: * `CREATIVE_TYPE_VIDEO`" +}, +"oggAudio": { +"description": "Output only. Indicates the third-party audio creative supports OGG. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO`", +"readOnly": true, +"type": "boolean" +}, +"progressOffset": { +"$ref": "AudioVideoOffset", +"description": "Optional. Amount of time to play the video before counting a view. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`" +}, +"requireHtml5": { +"description": "Optional. Indicates that the creative relies on HTML5 to render properly. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE`", +"type": "boolean" +}, +"requireMraid": { +"description": "Optional. Indicates that the creative requires MRAID (Mobile Rich Media Ad Interface Definitions system). Set this if the creative relies on mobile gestures for interactivity, such as swiping or tapping. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE`", +"type": "boolean" +}, +"requirePingForAttribution": { +"description": "Optional. Indicates that the creative will wait for a return ping for attribution. Only valid when using a Campaign Manager 360 tracking ad with a third-party ad server parameter and the ${DC_DBM_TOKEN} macro. Optional and only valid for third-party tag creatives or third-party VAST tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO`", +"type": "boolean" +}, +"reviewStatus": { +"$ref": "ReviewStatusInfo", +"description": "Output only. The current status of the creative review process.", +"readOnly": true +}, +"skipOffset": { +"$ref": "AudioVideoOffset", +"description": "Optional. Amount of time to play the video before the skip button appears. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`" +}, +"skippable": { +"description": "Optional. Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`", +"type": "boolean" +}, +"thirdPartyTag": { +"description": "Optional. The original third-party tag used for the creative. Required and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE`", +"type": "string" +}, +"thirdPartyUrls": { +"description": "Optional. Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO`", +"items": { +"$ref": "ThirdPartyUrl" +}, +"type": "array" +}, +"timerEvents": { +"description": "Optional. Timer custom events for a rich media creative. Timers track the time during which a user views and interacts with a specified part of a rich media creative. A creative can have multiple timer events, each timed independently. Leave it empty or unset for creatives containing image assets only.", +"items": { +"$ref": "TimerEvent" +}, +"type": "array" +}, +"trackerUrls": { +"description": "Optional. Tracking URLs for analytics providers or third-party ad technology vendors. The URLs must start with `https:` (except on inventory that doesn't require SSL compliance). If using macros in your URL, use only macros supported by Display & Video 360. Standard URLs only, no IMG or SCRIPT tags. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", +"items": { +"type": "string" +}, +"type": "array" +}, +"transcodes": { +"description": "Output only. Audio/Video transcodes. Display & Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher's system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer\u2019s connection and screen size. This field is only supported in the following creative_type: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_AUDIO`", +"items": { +"$ref": "Transcode" +}, +"readOnly": true, +"type": "array" +}, +"universalAdId": { +"$ref": "UniversalAdId", +"description": "Optional. An optional creative identifier provided by a registry that is unique across all platforms. Universal Ad ID is part of the VAST 4.0 standard. It can be modified after the creative is created. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`" +}, +"updateTime": { +"description": "Output only. The timestamp when the creative was last updated, either by the user or system (e.g. creative review). Assigned by the system.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"vastTagUrl": { +"description": "Optional. The URL of the VAST tag for a third-party VAST tag creative. Required and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO`", +"type": "string" +}, +"vpaid": { +"description": "Output only. Indicates the third-party VAST tag creative requires VPAID (Digital Video Player-Ad Interface). Output only and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_VIDEO`", +"readOnly": true, +"type": "boolean" +} +}, +"type": "object" +}, +"CreativeConfig": { +"description": "Creative requirements configuration for the inventory source.", +"id": "CreativeConfig", +"properties": { +"creativeType": { +"description": "The type of creative that can be assigned to the inventory source. Only the following types are supported: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_VIDEO`", +"enum": [ +"CREATIVE_TYPE_UNSPECIFIED", +"CREATIVE_TYPE_STANDARD", +"CREATIVE_TYPE_EXPANDABLE", +"CREATIVE_TYPE_VIDEO", +"CREATIVE_TYPE_NATIVE", +"CREATIVE_TYPE_TEMPLATED_APP_INSTALL", +"CREATIVE_TYPE_NATIVE_SITE_SQUARE", +"CREATIVE_TYPE_TEMPLATED_APP_INSTALL_INTERSTITIAL", +"CREATIVE_TYPE_LIGHTBOX", +"CREATIVE_TYPE_NATIVE_APP_INSTALL", +"CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE", +"CREATIVE_TYPE_AUDIO", +"CREATIVE_TYPE_PUBLISHER_HOSTED", +"CREATIVE_TYPE_NATIVE_VIDEO", +"CREATIVE_TYPE_TEMPLATED_APP_INSTALL_VIDEO", +"CREATIVE_TYPE_ASSET_BASED_CREATIVE" +], +"enumDescriptions": [ +"Type value is not specified or is unknown in this version.", +"Standard display creative. Create and update methods are supported for this creative type if the hosting_source is one of the following: * `HOSTING_SOURCE_HOSTED` * `HOSTING_SOURCE_THIRD_PARTY`", +"Expandable creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_THIRD_PARTY`", +"Video creative. Create and update methods are supported for this creative type if the hosting_source is one of the following: * `HOSTING_SOURCE_HOSTED` * `HOSTING_SOURCE_THIRD_PARTY`", +"Native creative rendered by publishers with assets from advertiser. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`", +"Templated app install mobile creative (banner). Create and update methods are **not** supported for this creative type.", +"Square native creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`", +"Interstitial creative including both display and video. Create and update methods are **not** supported for this creative type.", +"Responsive and expandable Lightbox creative. Create and update methods are **not** supported for this creative type.", +"Native app install creative. Create and update methods are **not** supported for this creative type.", +"Square native app install creative. Create and update methods are **not** supported for this creative type.", +"Audio creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`", +"Publisher hosted creative. Create and update methods are **not** supported for this creative type.", +"Native video creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`", +"Templated app install mobile video creative. Create and update methods are **not** supported for this creative type.", +"Asset-based creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`." +], +"type": "string" +}, +"displayCreativeConfig": { +"$ref": "InventorySourceDisplayCreativeConfig", +"description": "The configuration for display creatives. Applicable when creative_type is `CREATIVE_TYPE_STANDARD`." +}, +"videoCreativeConfig": { +"$ref": "InventorySourceVideoCreativeConfig", +"description": "The configuration for video creatives. Applicable when creative_type is `CREATIVE_TYPE_VIDEO`." +} +}, +"type": "object" +}, +"CustomBiddingAlgorithm": { +"description": "A single custom bidding algorithm.", +"id": "CustomBiddingAlgorithm", +"properties": { +"advertiserId": { +"description": "Immutable. The unique ID of the advertiser that owns the custom bidding algorithm.", +"format": "int64", +"type": "string" +}, +"customBiddingAlgorithmId": { +"description": "Output only. The unique ID of the custom bidding algorithm. Assigned by the system.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"customBiddingAlgorithmType": { +"description": "Required. Immutable. The type of custom bidding algorithm.", +"enum": [ +"CUSTOM_BIDDING_ALGORITHM_TYPE_UNSPECIFIED", +"SCRIPT_BASED", +"RULE_BASED" +], +"enumDescriptions": [ +"Algorithm type is not specified or is unknown in this version.", +"Algorithm generated through customer-uploaded custom bidding script files.", +"Algorithm based in defined rules. These rules are defined in the API using the AlgorithmRules object. This algorithm type is only available to allowlisted customers. Other customers attempting to use this type will receive an error." +], +"type": "string" +}, +"displayName": { +"description": "Required. The display name of the custom bidding algorithm. Must be UTF-8 encoded with a maximum size of 240 bytes.", +"type": "string" +}, +"entityStatus": { +"description": "Controls whether or not the custom bidding algorithm can be used as a bidding strategy. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED`", +"enum": [ +"ENTITY_STATUS_UNSPECIFIED", +"ENTITY_STATUS_ACTIVE", +"ENTITY_STATUS_ARCHIVED", +"ENTITY_STATUS_DRAFT", +"ENTITY_STATUS_PAUSED", +"ENTITY_STATUS_SCHEDULED_FOR_DELETION" +], +"enumDescriptions": [ +"Default value when status is not specified or is unknown in this version.", +"The entity is enabled to bid and spend budget.", +"The entity is archived. Bidding and budget spending are disabled. An entity can be deleted after archived. Deleted entities cannot be retrieved.", +"The entity is under draft. Bidding and budget spending are disabled.", +"Bidding and budget spending are paused for the entity.", +"The entity is scheduled for deletion." +], +"type": "string" +}, +"modelDetails": { +"description": "Output only. The details of custom bidding models for each advertiser who has access. This field may only include the details of the queried advertiser if the algorithm [`owner`](/display-video/api/reference/rest/v1/customBiddingAlgorithms#CustomBiddingAlgorithm.FIELDS.oneof_owner) is a partner and is being retrieved using an advertiser [`accessor`](/display-video/api/reference/rest/v1/customBiddingAlgorithms/list#body.QUERY_PARAMETERS.oneof_accessor).", +"items": { +"$ref": "CustomBiddingModelDetails" +}, +"readOnly": true, +"type": "array" +}, +"name": { +"description": "Output only. The resource name of the custom bidding algorithm.", +"readOnly": true, +"type": "string" +}, +"partnerId": { +"description": "Immutable. The unique ID of the partner that owns the custom bidding algorithm.", +"format": "int64", +"type": "string" +}, +"sharedAdvertiserIds": { +"description": "The IDs of the advertisers who have access to this algorithm. If advertiser_id is set, this field will only consist of that value. This field will not be set if the algorithm [`owner`](/display-video/api/reference/rest/v1/customBiddingAlgorithms#CustomBiddingAlgorithm.FIELDS.oneof_owner) is a partner and is being retrieved using an advertiser [`accessor`](/display-video/api/reference/rest/v1/customBiddingAlgorithms/list#body.QUERY_PARAMETERS.oneof_accessor).", +"items": { +"format": "int64", +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"CustomBiddingAlgorithmRules": { +"description": "A single custom bidding algorithm rules.", +"id": "CustomBiddingAlgorithmRules", +"properties": { +"active": { +"description": "Output only. Whether the rules resource is currently being used for scoring by the parent algorithm.", +"readOnly": true, +"type": "boolean" +}, +"createTime": { +"description": "Output only. The time when the rules resource was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"customBiddingAlgorithmId": { +"description": "Output only. The unique ID of the custom bidding algorithm that the rules resource belongs to.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"customBiddingAlgorithmRulesId": { +"description": "Output only. The unique ID of the rules resource.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"error": { +"$ref": "CustomBiddingAlgorithmRulesError", +"description": "Output only. Error code of the rejected rules resource. This field will only be populated when the state is `REJECTED`.", +"readOnly": true +}, +"name": { +"description": "Output only. The resource name of the rules resource.", +"readOnly": true, +"type": "string" +}, +"rules": { +"$ref": "CustomBiddingAlgorithmRulesRef", +"description": "Required. Immutable. The reference to the uploaded AlgorithmRules file." +}, +"state": { +"description": "Output only. The state of the rules resource.", +"enum": [ +"STATE_UNSPECIFIED", +"ACCEPTED", +"REJECTED" +], +"enumDescriptions": [ +"The rules state are unspecified or unknown in this version.", +"The rules have been accepted for scoring impressions.", +"The rules have been rejected by backend pipelines. They may have errors." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"CustomBiddingAlgorithmRulesError": { +"description": "An error message for a CustomBiddingAlgorithmRules resource.", +"id": "CustomBiddingAlgorithmRulesError", +"properties": { +"errorCode": { +"description": "The type of error.", +"enum": [ +"ERROR_CODE_UNSPECIFIED", +"SYNTAX_ERROR", +"CONSTRAINT_VIOLATION_ERROR", +"INTERNAL_ERROR" +], +"enumDescriptions": [ +"The error is not specified or is unknown in this version.", +"The rules have a syntax error.", +"The rules have a constraint violation error.", +"Internal errors were thrown while processing the rules." +], +"type": "string" +} +}, +"type": "object" +}, +"CustomBiddingAlgorithmRulesRef": { +"description": "The reference to the uploaded AlgorithmRules file. Retrieve the location to upload new AlgorithmRules file to using customBiddingAlgorithms.uploadRules.", +"id": "CustomBiddingAlgorithmRulesRef", +"properties": { +"resourceName": { +"description": "A resource name to be used in media.download to download the rules files. Or media.upload to upload the rules files. Resource names have the format `customBiddingAlgorithms/{custom_bidding_algorithm_id}/rulesRef/{ref_id}`.", +"type": "string" +} +}, +"type": "object" +}, +"CustomBiddingModelDetails": { +"description": "The details of a custom bidding algorithm model for a single shared advertiser.", +"id": "CustomBiddingModelDetails", +"properties": { +"advertiserId": { +"description": "The unique ID of the relevant advertiser.", +"format": "int64", +"type": "string" +}, +"readinessState": { +"description": "The readiness state of custom bidding model.", +"enum": [ +"READINESS_STATE_UNSPECIFIED", +"READINESS_STATE_ACTIVE", +"READINESS_STATE_INSUFFICIENT_DATA", +"READINESS_STATE_TRAINING", +"READINESS_STATE_NO_VALID_SCRIPT", +"READINESS_STATE_EVALUATION_FAILURE" +], +"enumDescriptions": [ +"State is not specified or is unknown in this version.", +"The model is trained and ready for serving.", +"There is not enough data to train the serving model.", +"The model is training and not ready for serving.", +"A valid custom bidding script has not been provided with which to train the model. This state will only be applied to algorithms whose `custom_bidding_algorithm_type` is `SCRIPT_BASED`.", +"A valid script was provided but failed evaluation. This is applicable for scripts that could not be evaluated in the alloted time." +], +"type": "string" +}, +"suspensionState": { +"description": "Output only. The suspension state of custom bidding model.", +"enum": [ +"SUSPENSION_STATE_UNSPECIFIED", +"SUSPENSION_STATE_ENABLED", +"SUSPENSION_STATE_DORMANT", +"SUSPENSION_STATE_SUSPENDED" +], +"enumDescriptions": [ +"State is not specified or is unknown in this version.", +"Model is enabled, either recently used, currently used or scheduled to be used. The algorithm is actively scoring impressions for this advertiser.", +"Model has not been used recently. Although the model still acts as `ENABLED`, it will eventually be suspended if not used.", +"Model is suspended from scoring impressions and cannot serve. If the algorithm is assigned to a line item under this advertiser or otherwise updated, it will switch back to the `ENABLED` state and require time to prepare the serving model again." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"CustomBiddingScript": { +"description": "A single custom bidding script.", +"id": "CustomBiddingScript", +"properties": { +"active": { +"description": "Output only. Whether the script is currently being used for scoring by the parent algorithm.", +"readOnly": true, +"type": "boolean" +}, +"createTime": { +"description": "Output only. The time when the script was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"customBiddingAlgorithmId": { +"description": "Output only. The unique ID of the custom bidding algorithm the script belongs to.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"customBiddingScriptId": { +"description": "Output only. The unique ID of the custom bidding script.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"errors": { +"description": "Output only. Error details of a rejected custom bidding script. This field will only be populated when state is REJECTED.", +"items": { +"$ref": "ScriptError" +}, +"readOnly": true, +"type": "array" +}, +"name": { +"description": "Output only. The resource name of the custom bidding script.", +"readOnly": true, +"type": "string" +}, +"script": { +"$ref": "CustomBiddingScriptRef", +"description": "The reference to the uploaded script file." +}, +"state": { +"description": "Output only. The state of the custom bidding script.", +"enum": [ +"STATE_UNSPECIFIED", +"ACCEPTED", +"REJECTED", +"PENDING" +], +"enumDescriptions": [ +"The script state is not specified or is unknown in this version.", +"The script has been accepted for scoring impressions.", +"The script has been rejected by backend pipelines. It may have errors.", +"The script is being processed for backend pipelines." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"CustomBiddingScriptRef": { +"description": "The reference to the uploaded custom bidding script file.", +"id": "CustomBiddingScriptRef", +"properties": { +"resourceName": { +"description": "A resource name to be used in media.download to Download the script files. Or media.upload to Upload the script files. Resource names have the format `customBiddingAlgorithms/{custom_bidding_algorithm_id}/scriptRef/{ref_id}`.", +"type": "string" +} +}, +"type": "object" +}, +"CustomLabel": { +"description": "The key and value of a custom label.", +"id": "CustomLabel", +"properties": { +"key": { +"description": "The key of the label.", +"enum": [ +"CUSTOM_LABEL_KEY_UNSPECIFIED", +"CUSTOM_LABEL_KEY_0", +"CUSTOM_LABEL_KEY_1", +"CUSTOM_LABEL_KEY_2", +"CUSTOM_LABEL_KEY_3", +"CUSTOM_LABEL_KEY_4" +], +"enumDescriptions": [ +"Not specified or unknown.", +"Key index 0.", +"Key index 1.", +"Key index 2.", +"Key index 3.", +"Key index 4." +], +"type": "string" +}, +"value": { +"description": "The value of the label.", +"type": "string" +} +}, +"type": "object" +}, +"CustomList": { +"description": "Describes a custom list entity, such as a custom affinity or custom intent audience list.", +"id": "CustomList", +"properties": { +"customListId": { +"description": "Output only. The unique ID of the custom list. Assigned by the system.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"displayName": { +"description": "Output only. The display name of the custom list. .", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Output only. The resource name of the custom list.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"CustomListGroup": { +"description": "Details of custom list group. All custom list targeting settings are logically \u2018OR\u2019 of each other.", +"id": "CustomListGroup", +"properties": { +"settings": { +"description": "Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored.", +"items": { +"$ref": "CustomListTargetingSetting" +}, +"type": "array" +} +}, +"type": "object" +}, +"CustomListTargetingSetting": { +"description": "Details of custom list targeting setting.", +"id": "CustomListTargetingSetting", +"properties": { +"customListId": { +"description": "Required. Custom id of custom list targeting setting. This id is custom_list_id.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"Date": { +"description": "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", +"id": "Date", +"properties": { +"day": { +"description": "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.", +"format": "int32", +"type": "integer" +}, +"month": { +"description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", +"format": "int32", +"type": "integer" +}, +"year": { +"description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"DateRange": { +"description": "A date range.", +"id": "DateRange", +"properties": { +"endDate": { +"$ref": "Date", +"description": "The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`." +}, +"startDate": { +"$ref": "Date", +"description": "The lower bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`." +} +}, +"type": "object" +}, +"DayAndTime": { +"description": "Representation of time defined by day of the week and hour of the day.", +"id": "DayAndTime", +"properties": { +"dayOfWeek": { +"description": "Required. Day of the week.", +"enum": [ +"DAY_OF_WEEK_UNSPECIFIED", +"MONDAY", +"TUESDAY", +"WEDNESDAY", +"THURSDAY", +"FRIDAY", +"SATURDAY", +"SUNDAY" +], +"enumDescriptions": [ +"The day of the week is unspecified.", +"Monday", +"Tuesday", +"Wednesday", +"Thursday", +"Friday", +"Saturday", +"Sunday" +], +"type": "string" +}, +"hourOfDay": { +"description": "Required. Hour of the day.", +"format": "int32", +"type": "integer" +}, +"timeZoneResolution": { +"description": "Required. The mechanism used to determine the relevant timezone.", +"enum": [ +"TIME_ZONE_RESOLUTION_UNSPECIFIED", +"TIME_ZONE_RESOLUTION_END_USER", +"TIME_ZONE_RESOLUTION_ADVERTISER" +], +"enumDescriptions": [ +"Time zone resolution is either unspecific or unknown.", +"Times are resolved in the time zone of the user that saw the ad.", +"Times are resolved in the time zone of the advertiser that served the ad." +], +"type": "string" +} +}, +"type": "object" +}, +"DayAndTimeAssignedTargetingOptionDetails": { +"description": "Representation of a segment of time defined on a specific day of the week and with a start and end time. The time represented by `start_hour` must be before the time represented by `end_hour`.", +"id": "DayAndTimeAssignedTargetingOptionDetails", +"properties": { +"dayOfWeek": { +"description": "Required. The day of the week for this day and time targeting setting.", +"enum": [ +"DAY_OF_WEEK_UNSPECIFIED", +"MONDAY", +"TUESDAY", +"WEDNESDAY", +"THURSDAY", +"FRIDAY", +"SATURDAY", +"SUNDAY" +], +"enumDescriptions": [ +"The day of the week is unspecified.", +"Monday", +"Tuesday", +"Wednesday", +"Thursday", +"Friday", +"Saturday", +"Sunday" +], +"type": "string" +}, +"endHour": { +"description": "Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day).", +"format": "int32", +"type": "integer" +}, +"startHour": { +"description": "Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day).", +"format": "int32", +"type": "integer" +}, +"timeZoneResolution": { +"description": "Required. The mechanism used to determine which timezone to use for this day and time targeting setting.", +"enum": [ +"TIME_ZONE_RESOLUTION_UNSPECIFIED", +"TIME_ZONE_RESOLUTION_END_USER", +"TIME_ZONE_RESOLUTION_ADVERTISER" +], +"enumDescriptions": [ +"Time zone resolution is either unspecific or unknown.", +"Times are resolved in the time zone of the user that saw the ad.", +"Times are resolved in the time zone of the advertiser that served the ad." +], +"type": "string" +} +}, +"type": "object" +}, +"DeleteAssignedTargetingOptionsRequest": { +"description": "A request listing which assigned targeting options of a given targeting type should be deleted.", +"id": "DeleteAssignedTargetingOptionsRequest", +"properties": { +"assignedTargetingOptionIds": { +"description": "Required. The assigned targeting option IDs to delete.", +"items": { +"type": "string" +}, +"type": "array" +}, +"targetingType": { +"description": "Required. Identifies the type of this assigned targeting option.", +"enum": [ +"TARGETING_TYPE_UNSPECIFIED", +"TARGETING_TYPE_CHANNEL", +"TARGETING_TYPE_APP_CATEGORY", +"TARGETING_TYPE_APP", +"TARGETING_TYPE_URL", +"TARGETING_TYPE_DAY_AND_TIME", +"TARGETING_TYPE_AGE_RANGE", +"TARGETING_TYPE_REGIONAL_LOCATION_LIST", +"TARGETING_TYPE_PROXIMITY_LOCATION_LIST", +"TARGETING_TYPE_GENDER", +"TARGETING_TYPE_VIDEO_PLAYER_SIZE", +"TARGETING_TYPE_USER_REWARDED_CONTENT", +"TARGETING_TYPE_PARENTAL_STATUS", +"TARGETING_TYPE_CONTENT_INSTREAM_POSITION", +"TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", +"TARGETING_TYPE_DEVICE_TYPE", +"TARGETING_TYPE_AUDIENCE_GROUP", +"TARGETING_TYPE_BROWSER", +"TARGETING_TYPE_HOUSEHOLD_INCOME", +"TARGETING_TYPE_ON_SCREEN_POSITION", +"TARGETING_TYPE_THIRD_PARTY_VERIFIER", +"TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", +"TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", +"TARGETING_TYPE_ENVIRONMENT", +"TARGETING_TYPE_CARRIER_AND_ISP", +"TARGETING_TYPE_OPERATING_SYSTEM", +"TARGETING_TYPE_DEVICE_MAKE_MODEL", +"TARGETING_TYPE_KEYWORD", +"TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", +"TARGETING_TYPE_VIEWABILITY", +"TARGETING_TYPE_CATEGORY", +"TARGETING_TYPE_INVENTORY_SOURCE", +"TARGETING_TYPE_LANGUAGE", +"TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", +"TARGETING_TYPE_GEO_REGION", +"TARGETING_TYPE_INVENTORY_SOURCE_GROUP", +"TARGETING_TYPE_EXCHANGE", +"TARGETING_TYPE_SUB_EXCHANGE", +"TARGETING_TYPE_POI", +"TARGETING_TYPE_BUSINESS_CHAIN", +"TARGETING_TYPE_CONTENT_DURATION", +"TARGETING_TYPE_CONTENT_STREAM_TYPE", +"TARGETING_TYPE_NATIVE_CONTENT_POSITION", +"TARGETING_TYPE_OMID", +"TARGETING_TYPE_AUDIO_CONTENT_TYPE", +"TARGETING_TYPE_CONTENT_GENRE", +"TARGETING_TYPE_YOUTUBE_VIDEO", +"TARGETING_TYPE_YOUTUBE_CHANNEL", +"TARGETING_TYPE_SESSION_POSITION" +], +"enumDescriptions": [ +"Default value when type is not specified or is unknown in this version.", +"Target a channel (a custom group of related websites or apps).", +"Target an app category (for example, education or puzzle games).", +"Target a specific app (for example, Angry Birds).", +"Target a specific url (for example, quora.com).", +"Target ads during a chosen time period on a specific day.", +"Target ads to a specific age range (for example, 18-24).", +"Target ads to the specified regions on a regional location list.", +"Target ads to the specified points of interest on a proximity location list.", +"Target ads to a specific gender (for example, female or male).", +"Target a specific video player size for video ads.", +"Target user rewarded content for video ads.", +"Target ads to a specific parental status (for example, parent or not a parent).", +"Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", +"Target ads in a specific content outstream position.", +"Target ads to a specific device type (for example, tablet or connected TV).", +"Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", +"Target ads to specific web browsers (for example, Chrome).", +"Target ads to a specific household income range (for example, top 10%).", +"Target ads in a specific on screen position.", +"Filter web sites through third party verification (for example, IAS or DoubleVerify).", +"Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", +"Filter website content by sensitive categories (for example, adult).", +"Target ads to a specific environment (for example, web or app).", +"Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", +"Target ads to a specific operating system (for example, macOS).", +"Target ads to a specific device make or model (for example, Roku or Samsung).", +"Target ads to a specific keyword (for example, dog or retriever).", +"Target ads to a specific negative keyword list.", +"Target ads to a specific viewability (for example, 80% viewable).", +"Target ads to a specific content category (for example, arts & entertainment).", +"Purchase impressions from specific deals and auction packages.", +"Target ads to a specific language (for example, English or Japanese).", +"Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", +"Target ads to a specific regional location (for example, a city or state).", +"Purchase impressions from a group of deals and auction packages.", +"Purchase impressions from specific exchanges.", +"Purchase impressions from specific sub-exchanges.", +"Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", +"Target ads around locations of a business chain within a specific geo region.", +"Target ads to a specific video content duration.", +"Target ads to a specific video content stream type.", +"Target ads to a specific native content position.", +"Target ads in an Open Measurement enabled inventory.", +"Target ads to a specific audio content type.", +"Target ads to a specific content genre.", +"Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", +"Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", +"Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." +], +"type": "string" +} +}, +"type": "object" +}, +"DeviceMakeModelAssignedTargetingOptionDetails": { +"description": "Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.", +"id": "DeviceMakeModelAssignedTargetingOptionDetails", +"properties": { +"displayName": { +"description": "Output only. The display name of the device make and model.", +"readOnly": true, +"type": "string" +}, +"negative": { +"description": "Indicates if this option is being negatively targeted.", +"type": "boolean" +}, +"targetingOptionId": { +"description": "Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.", +"type": "string" +} +}, +"type": "object" +}, +"DeviceMakeModelTargetingOptionDetails": { +"description": "Represents a targetable device make and model. This will be populated in the device_make_model_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.", +"id": "DeviceMakeModelTargetingOptionDetails", +"properties": { +"displayName": { +"description": "Output only. The display name of the device make and model.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"DeviceTypeAssignedTargetingOptionDetails": { +"description": "Targeting details for device type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`.", +"id": "DeviceTypeAssignedTargetingOptionDetails", +"properties": { +"deviceType": { +"description": "Required. The display name of the device type.", +"enum": [ +"DEVICE_TYPE_UNSPECIFIED", +"DEVICE_TYPE_COMPUTER", +"DEVICE_TYPE_CONNECTED_TV", +"DEVICE_TYPE_SMART_PHONE", +"DEVICE_TYPE_TABLET", +"DEVICE_TYPE_CONNECTED_DEVICE" +], +"enumDescriptions": [ +"Default value when device type is not specified in this version. This enum is a placeholder for default value and does not represent a real device type option.", +"Computer.", +"Connected TV.", +"Smart phone.", +"Tablet.", +"Connected device." +], +"type": "string" +}, +"youtubeAndPartnersBidMultiplier": { +"description": "Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items.", +"format": "double", +"readOnly": true, +"type": "number" +} +}, +"type": "object" +}, +"DeviceTypeTargetingOptionDetails": { +"description": "Represents a targetable device type. This will be populated in the device_type_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`.", +"id": "DeviceTypeTargetingOptionDetails", +"properties": { +"deviceType": { +"description": "Output only. The device type that is used to be targeted.", +"enum": [ +"DEVICE_TYPE_UNSPECIFIED", +"DEVICE_TYPE_COMPUTER", +"DEVICE_TYPE_CONNECTED_TV", +"DEVICE_TYPE_SMART_PHONE", +"DEVICE_TYPE_TABLET", +"DEVICE_TYPE_CONNECTED_DEVICE" +], +"enumDescriptions": [ +"Default value when device type is not specified in this version. This enum is a placeholder for default value and does not represent a real device type option.", +"Computer.", +"Connected TV.", +"Smart phone.", +"Tablet.", +"Connected device." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"DigitalContentLabelAssignedTargetingOptionDetails": { +"description": "Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`.", +"id": "DigitalContentLabelAssignedTargetingOptionDetails", +"properties": { +"excludedContentRatingTier": { +"description": "Required. The display name of the digital content label rating tier to be EXCLUDED.", +"enum": [ +"CONTENT_RATING_TIER_UNSPECIFIED", +"CONTENT_RATING_TIER_UNRATED", +"CONTENT_RATING_TIER_GENERAL", +"CONTENT_RATING_TIER_PARENTAL_GUIDANCE", +"CONTENT_RATING_TIER_TEENS", +"CONTENT_RATING_TIER_MATURE", +"CONTENT_RATING_TIER_FAMILIES" +], +"enumDescriptions": [ +"Content label is not specified in this version. This enum is a place holder for a default value and does not represent a real content rating.", +"Content that has not been labeled.", +"Content suitable for general audiences.", +"Content suitable for most audiences with parental guidance.", +"Content suitable for teen and older audiences.", +"Content suitable only for mature audiences.", +"Content suitable for family audiences. It is a subset of CONTENT_RATING_TIER_GENERAL. Only applicable to YouTube and Partners line items." +], +"type": "string" +} +}, +"type": "object" +}, +"DigitalContentLabelTargetingOptionDetails": { +"description": "Represents a targetable digital content label rating tier. This will be populated in the digital_content_label_details field of the TargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`.", +"id": "DigitalContentLabelTargetingOptionDetails", +"properties": { +"contentRatingTier": { +"description": "Output only. An enum for the content label brand safety tiers.", +"enum": [ +"CONTENT_RATING_TIER_UNSPECIFIED", +"CONTENT_RATING_TIER_UNRATED", +"CONTENT_RATING_TIER_GENERAL", +"CONTENT_RATING_TIER_PARENTAL_GUIDANCE", +"CONTENT_RATING_TIER_TEENS", +"CONTENT_RATING_TIER_MATURE", +"CONTENT_RATING_TIER_FAMILIES" +], +"enumDescriptions": [ +"Content label is not specified in this version. This enum is a place holder for a default value and does not represent a real content rating.", +"Content that has not been labeled.", +"Content suitable for general audiences.", +"Content suitable for most audiences with parental guidance.", +"Content suitable for teen and older audiences.", +"Content suitable only for mature audiences.", +"Content suitable for family audiences. It is a subset of CONTENT_RATING_TIER_GENERAL. Only applicable to YouTube and Partners line items." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"Dimensions": { +"description": "Dimensions.", +"id": "Dimensions", +"properties": { +"heightPixels": { +"description": "The height in pixels.", +"format": "int32", +"type": "integer" +}, +"widthPixels": { +"description": "The width in pixels.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"DisplayVideoSourceAd": { +"description": "The ad sourced from a DV360 creative.", +"id": "DisplayVideoSourceAd", +"properties": { +"creativeId": { +"description": "The ID of the source creative.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"DoubleVerify": { +"description": "Details of DoubleVerify settings.", +"id": "DoubleVerify", +"properties": { +"appStarRating": { +"$ref": "DoubleVerifyAppStarRating", +"description": "Avoid bidding on apps with the star ratings." +}, +"avoidedAgeRatings": { +"description": "Avoid bidding on apps with the age rating.", +"items": { +"enum": [ +"AGE_RATING_UNSPECIFIED", +"APP_AGE_RATE_UNKNOWN", +"APP_AGE_RATE_4_PLUS", +"APP_AGE_RATE_9_PLUS", +"APP_AGE_RATE_12_PLUS", +"APP_AGE_RATE_17_PLUS", +"APP_AGE_RATE_18_PLUS" +], +"enumDescriptions": [ +"This enum is only a placeholder and it doesn't specify any age rating options.", +"Apps with unknown age rating.", +"Apps rated for Everyone (4+).", +"Apps rated for Everyone (9+).", +"Apps rated for Teens (12+).", +"Apps rated for Mature (17+).", +"Apps rated for Adults Only (18+)." +], +"type": "string" +}, +"type": "array" +}, +"brandSafetyCategories": { +"$ref": "DoubleVerifyBrandSafetyCategories", +"description": "DV Brand Safety Controls." +}, +"customSegmentId": { +"description": "The custom segment ID provided by DoubleVerify. The ID must start with \"51\" and consist of eight digits. Custom segment ID cannot be specified along with any of the following fields: * brand_safety_categories * avoided_age_ratings * app_star_rating * fraud_invalid_traffic", +"format": "int64", +"type": "string" +}, +"displayViewability": { +"$ref": "DoubleVerifyDisplayViewability", +"description": "Display viewability settings (applicable to display line items only)." +}, +"fraudInvalidTraffic": { +"$ref": "DoubleVerifyFraudInvalidTraffic", +"description": "Avoid Sites and Apps with historical Fraud & IVT Rates." +}, +"videoViewability": { +"$ref": "DoubleVerifyVideoViewability", +"description": "Video viewability settings (applicable to video line items only)." +} +}, +"type": "object" +}, +"DoubleVerifyAppStarRating": { +"description": "Details of DoubleVerify star ratings settings.", +"id": "DoubleVerifyAppStarRating", +"properties": { +"avoidInsufficientStarRating": { +"description": "Avoid bidding on apps with insufficient star ratings.", +"type": "boolean" +}, +"avoidedStarRating": { +"description": "Avoid bidding on apps with the star ratings.", +"enum": [ +"APP_STAR_RATE_UNSPECIFIED", +"APP_STAR_RATE_1_POINT_5_LESS", +"APP_STAR_RATE_2_LESS", +"APP_STAR_RATE_2_POINT_5_LESS", +"APP_STAR_RATE_3_LESS", +"APP_STAR_RATE_3_POINT_5_LESS", +"APP_STAR_RATE_4_LESS", +"APP_STAR_RATE_4_POINT_5_LESS" +], +"enumDescriptions": [ +"This enum is only a placeholder and it doesn't specify any app star rating options.", +"Official Apps with rating < 1.5 Stars.", +"Official Apps with rating < 2 Stars.", +"Official Apps with rating < 2.5 Stars.", +"Official Apps with rating < 3 Stars.", +"Official Apps with rating < 3.5 Stars.", +"Official Apps with rating < 4 Stars.", +"Official Apps with rating < 4.5 Stars." +], +"type": "string" +} +}, +"type": "object" +}, +"DoubleVerifyBrandSafetyCategories": { +"description": "Settings for brand safety controls.", +"id": "DoubleVerifyBrandSafetyCategories", +"properties": { +"avoidUnknownBrandSafetyCategory": { +"description": "Unknown or unrateable.", +"type": "boolean" +}, +"avoidedHighSeverityCategories": { +"description": "Brand safety high severity avoidance categories.", +"items": { +"enum": [ +"HIGHER_SEVERITY_UNSPECIFIED", +"ADULT_CONTENT_PORNOGRAPHY", +"COPYRIGHT_INFRINGEMENT", +"SUBSTANCE_ABUSE", +"GRAPHIC_VIOLENCE_WEAPONS", +"HATE_PROFANITY", +"CRIMINAL_SKILLS", +"NUISANCE_INCENTIVIZED_MALWARE_CLUTTER" +], +"enumDescriptions": [ +"This enum is only a placeholder and it doesn't specify any high severity categories.", +"Adult Content: Pornography, Mature Topics & Nudity.", +"Copyright Infringement.", +"Drugs/Alcohol/Controlled Substances: Substance Abuse.", +"Extreme Graphic/Explicit Violence/Weapons.", +"Hate/Profanity.", +"Illegal Activities: Criminal Skills.", +"Incentivized/Malware/Clutter." +], +"type": "string" +}, +"type": "array" +}, +"avoidedMediumSeverityCategories": { +"description": "Brand safety medium severity avoidance categories.", +"items": { +"enum": [ +"MEDIUM_SEVERITY_UNSPECIFIED", +"AD_SERVERS", +"ADULT_CONTENT_SWIMSUIT", +"ALTERNATIVE_LIFESTYLES", +"CELEBRITY_GOSSIP", +"GAMBLING", +"OCCULT", +"SEX_EDUCATION", +"DISASTER_AVIATION", +"DISASTER_MAN_MADE", +"DISASTER_NATURAL", +"DISASTER_TERRORIST_EVENTS", +"DISASTER_VEHICLE", +"ALCOHOL", +"SMOKING", +"NEGATIVE_NEWS_FINANCIAL", +"NON_ENGLISH", +"PARKING_PAGE", +"UNMODERATED_UGC", +"INFLAMMATORY_POLITICS_AND_NEWS", +"NEGATIVE_NEWS_PHARMACEUTICAL" +], +"enumDescriptions": [ +"This enum is only a placeholder and it doesn't specify any medium severity categories.", +"Ad Servers.", +"Adult Content: Swimsuit.", +"Controversial Subjects: Alternative Lifestyles.", +"Controversial Subjects: Celebrity Gossip.", +"Controversial Subjects: Gambling.", +"Controversial Subjects: Occult.", +"Controversial Subjects: Sex Education.", +"Disaster: Aviation.", +"Disaster: Man-made.", +"Disaster: Natural.", +"Disaster: Terrorist Events.", +"Disaster: Vehicle.", +"Drugs/Alcohol/Controlled Substances: Alcohol.", +"Drugs/Alcohol/Controlled Substances: Smoking.", +"Negative News: Financial.", +"Non-Std Content: Non-English.", +"Non-Std Content: Parking Page.", +"Unmoderated UGC: Forums, Images & Video.", +"Controversial Subjects: Inflammatory Politics and News.", +"Negative News: Pharmaceutical." +], +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"DoubleVerifyDisplayViewability": { +"description": "Details of DoubleVerify display viewability settings.", +"id": "DoubleVerifyDisplayViewability", +"properties": { +"iab": { +"description": "Target web and app inventory to maximize IAB viewable rate.", +"enum": [ +"IAB_VIEWED_RATE_UNSPECIFIED", +"IAB_VIEWED_RATE_80_PERCENT_HIGHER", +"IAB_VIEWED_RATE_75_PERCENT_HIGHER", +"IAB_VIEWED_RATE_70_PERCENT_HIGHER", +"IAB_VIEWED_RATE_65_PERCENT_HIGHER", +"IAB_VIEWED_RATE_60_PERCENT_HIGHER", +"IAB_VIEWED_RATE_55_PERCENT_HIGHER", +"IAB_VIEWED_RATE_50_PERCENT_HIGHER", +"IAB_VIEWED_RATE_40_PERCENT_HIGHER", +"IAB_VIEWED_RATE_30_PERCENT_HIGHER" +], +"enumDescriptions": [ +"This enum is only a placeholder and it doesn't specify any IAB viewed rate options.", +"Target web and app inventory to maximize IAB viewable rate 80% or higher.", +"Target web and app inventory to maximize IAB viewable rate 75% or higher.", +"Target web and app inventory to maximize IAB viewable rate 70% or higher.", +"Target web and app inventory to maximize IAB viewable rate 65% or higher.", +"Target web and app inventory to maximize IAB viewable rate 60% or higher.", +"Target web and app inventory to maximize IAB viewable rate 55% or higher.", +"Target web and app inventory to maximize IAB viewable rate 50% or higher.", +"Target web and app inventory to maximize IAB viewable rate 40% or higher.", +"Target web and app inventory to maximize IAB viewable rate 30% or higher." +], +"type": "string" +}, +"viewableDuring": { +"description": "Target web and app inventory to maximize 100% viewable duration.", +"enum": [ +"AVERAGE_VIEW_DURATION_UNSPECIFIED", +"AVERAGE_VIEW_DURATION_5_SEC", +"AVERAGE_VIEW_DURATION_10_SEC", +"AVERAGE_VIEW_DURATION_15_SEC" +], +"enumDescriptions": [ +"This enum is only a placeholder and it doesn't specify any average view duration options.", +"Target web and app inventory to maximize 100% viewable duration 5 seconds or more.", +"Target web and app inventory to maximize 100% viewable duration 10 seconds or more.", +"Target web and app inventory to maximize 100% viewable duration 15 seconds or more." +], +"type": "string" +} +}, +"type": "object" +}, +"DoubleVerifyFraudInvalidTraffic": { +"description": "DoubleVerify Fraud & Invalid Traffic settings.", +"id": "DoubleVerifyFraudInvalidTraffic", +"properties": { +"avoidInsufficientOption": { +"description": "Insufficient Historical Fraud & IVT Stats.", +"type": "boolean" +}, +"avoidedFraudOption": { +"description": "Avoid Sites and Apps with historical Fraud & IVT.", +"enum": [ +"FRAUD_UNSPECIFIED", +"AD_IMPRESSION_FRAUD_100", +"AD_IMPRESSION_FRAUD_50", +"AD_IMPRESSION_FRAUD_25", +"AD_IMPRESSION_FRAUD_10", +"AD_IMPRESSION_FRAUD_8", +"AD_IMPRESSION_FRAUD_6", +"AD_IMPRESSION_FRAUD_4", +"AD_IMPRESSION_FRAUD_2" +], +"enumDescriptions": [ +"This enum is only a placeholder and it doesn't specify any fraud and invalid traffic options.", +"100% Fraud & IVT.", +"50% or Higher Fraud & IVT.", +"25% or Higher Fraud & IVT.", +"10% or Higher Fraud & IVT.", +"8% or Higher Fraud & IVT.", +"6% or Higher Fraud & IVT.", +"4% or Higher Fraud & IVT.", +"2% or Higher Fraud & IVT." +], +"type": "string" +} +}, +"type": "object" +}, +"DoubleVerifyVideoViewability": { +"description": "Details of DoubleVerify video viewability settings.", +"id": "DoubleVerifyVideoViewability", +"properties": { +"playerImpressionRate": { +"description": "Target inventory to maximize impressions with 400x300 or greater player size.", +"enum": [ +"PLAYER_SIZE_400X300_UNSPECIFIED", +"PLAYER_SIZE_400X300_95", +"PLAYER_SIZE_400X300_70", +"PLAYER_SIZE_400X300_25", +"PLAYER_SIZE_400X300_5" +], +"enumDescriptions": [ +"This enum is only a placeholder and it doesn't specify any impressions options.", +"Sites with 95%+ of impressions.", +"Sites with 70%+ of impressions.", +"Sites with 25%+ of impressions.", +"Sites with 5%+ of impressions." +], +"type": "string" +}, +"videoIab": { +"description": "Target web inventory to maximize IAB viewable rate.", +"enum": [ +"VIDEO_IAB_UNSPECIFIED", +"IAB_VIEWABILITY_80_PERCENT_HIGHER", +"IAB_VIEWABILITY_75_PERCENT_HIGHER", +"IAB_VIEWABILITY_70_PERCENT_HIGHER", +"IAB_VIEWABILITY_65_PERCENT_HIHGER", +"IAB_VIEWABILITY_60_PERCENT_HIGHER", +"IAB_VIEWABILITY_55_PERCENT_HIHGER", +"IAB_VIEWABILITY_50_PERCENT_HIGHER", +"IAB_VIEWABILITY_40_PERCENT_HIHGER", +"IAB_VIEWABILITY_30_PERCENT_HIHGER" +], +"enumDescriptions": [ +"This enum is only a placeholder and it doesn't specify any video IAB viewable rate options.", +"Target web and app inventory to maximize IAB viewable rate 80% or higher.", +"Target web and app inventory to maximize IAB viewable rate 75% or higher.", +"Target web and app inventory to maximize IAB viewable rate 70% or higher.", +"Target web and app inventory to maximize IAB viewable rate 65% or higher.", +"Target web and app inventory to maximize IAB viewable rate 60% or higher.", +"Target web and app inventory to maximize IAB viewable rate 55% or higher.", +"Target web and app inventory to maximize IAB viewable rate 50% or higher.", +"Target web and app inventory to maximize IAB viewable rate 40% or higher.", +"Target web and app inventory to maximize IAB viewable rate 30% or higher." +], +"type": "string" +}, +"videoViewableRate": { +"description": "Target web inventory to maximize fully viewable rate.", +"enum": [ +"VIDEO_VIEWABLE_RATE_UNSPECIFIED", +"VIEWED_PERFORMANCE_40_PERCENT_HIGHER", +"VIEWED_PERFORMANCE_35_PERCENT_HIGHER", +"VIEWED_PERFORMANCE_30_PERCENT_HIGHER", +"VIEWED_PERFORMANCE_25_PERCENT_HIGHER", +"VIEWED_PERFORMANCE_20_PERCENT_HIGHER", +"VIEWED_PERFORMANCE_10_PERCENT_HIGHER" +], +"enumDescriptions": [ +"This enum is only a placeholder and it doesn't specify any video viewable rate options.", +"Target web inventory to maximize fully viewable rate 40% or higher.", +"Target web inventory to maximize fully viewable rate 35% or higher.", +"Target web inventory to maximize fully viewable rate 30% or higher.", +"Target web inventory to maximize fully viewable rate 25% or higher.", +"Target web inventory to maximize fully viewable rate 20% or higher.", +"Target web inventory to maximize fully viewable rate 10% or higher." +], +"type": "string" +} +}, +"type": "object" +}, +"DuplicateLineItemRequest": { +"description": "Request message for LineItemService.DuplicateLineItem.", +"id": "DuplicateLineItemRequest", +"properties": { +"targetDisplayName": { +"description": "The display name of the new line item. Must be UTF-8 encoded with a maximum size of 240 bytes.", +"type": "string" +} +}, +"type": "object" +}, +"DuplicateLineItemResponse": { +"id": "DuplicateLineItemResponse", +"properties": { +"duplicateLineItemId": { +"description": "The ID of the created line item.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"EditCustomerMatchMembersRequest": { +"description": "Request message for FirstAndThirdPartyAudienceService.EditCustomerMatchMembers.", +"id": "EditCustomerMatchMembersRequest", +"properties": { +"addedContactInfoList": { +"$ref": "ContactInfoList", +"description": "Input only. A list of contact information to define the members to be added." +}, +"addedMobileDeviceIdList": { +"$ref": "MobileDeviceIdList", +"description": "Input only. A list of mobile device IDs to define the members to be added." +}, +"advertiserId": { +"description": "Required. The ID of the owner advertiser of the updated Customer Match FirstAndThirdPartyAudience.", +"format": "int64", +"type": "string" +}, +"removedContactInfoList": { +"$ref": "ContactInfoList", +"description": "Input only. A list of contact information to define the members to be removed." +}, +"removedMobileDeviceIdList": { +"$ref": "MobileDeviceIdList", +"description": "Input only. A list of mobile device IDs to define the members to be removed." +} +}, +"type": "object" +}, +"EditCustomerMatchMembersResponse": { +"description": "The response of FirstAndThirdPartyAudienceService.EditCustomerMatchMembers.", +"id": "EditCustomerMatchMembersResponse", +"properties": { +"firstPartyAndPartnerAudienceId": { +"description": "Required. The ID of the updated Customer Match FirstPartyAndPartnerAudience.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"EditGuaranteedOrderReadAccessorsRequest": { +"description": "Request message for GuaranteedOrderService.EditGuaranteedOrderReadAccessors.", +"id": "EditGuaranteedOrderReadAccessorsRequest", +"properties": { +"addedAdvertisers": { +"description": "The advertisers to add as read accessors to the guaranteed order.", +"items": { +"format": "int64", +"type": "string" +}, +"type": "array" +}, +"partnerId": { +"description": "Required. The partner context in which the change is being made.", +"format": "int64", +"type": "string" +}, +"readAccessInherited": { +"description": "Whether to give all advertisers of the read/write accessor partner read access to the guaranteed order. Only applicable if read_write_partner_id is set in the guaranteed order.", +"type": "boolean" +}, +"removedAdvertisers": { +"description": "The advertisers to remove as read accessors to the guaranteed order.", +"items": { +"format": "int64", +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"EditGuaranteedOrderReadAccessorsResponse": { +"id": "EditGuaranteedOrderReadAccessorsResponse", +"properties": { +"readAccessInherited": { +"description": "Whether all advertisers of read_write_partner_id have read access to the guaranteed order.", +"type": "boolean" +}, +"readAdvertiserIds": { +"description": "The IDs of advertisers with read access to the guaranteed order.", +"items": { +"format": "int64", +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"EditInventorySourceReadWriteAccessorsRequest": { +"description": "Request message for InventorySourceService.EditInventorySourceReadWriteAccessors.", +"id": "EditInventorySourceReadWriteAccessorsRequest", +"properties": { +"advertisersUpdate": { +"$ref": "EditInventorySourceReadWriteAccessorsRequestAdvertisersUpdate", +"description": "The advertisers to add or remove from the list of advertisers that have read/write access to the inventory source. This change will remove an existing partner read/write accessor." +}, +"assignPartner": { +"description": "Set the partner context as read/write accessor of the inventory source. This will remove all other current read/write advertiser accessors.", +"type": "boolean" +}, +"partnerId": { +"description": "Required. The partner context by which the accessors change is being made.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"EditInventorySourceReadWriteAccessorsRequestAdvertisersUpdate": { +"description": "Update to the list of advertisers with read/write access to the inventory source.", +"id": "EditInventorySourceReadWriteAccessorsRequestAdvertisersUpdate", +"properties": { +"addedAdvertisers": { +"description": "The advertisers to add.", +"items": { +"format": "int64", +"type": "string" +}, +"type": "array" +}, +"removedAdvertisers": { +"description": "The advertisers to remove.", +"items": { +"format": "int64", +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"Empty": { +"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", +"id": "Empty", +"properties": {}, +"type": "object" +}, +"EnvironmentAssignedTargetingOptionDetails": { +"description": "Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`.", +"id": "EnvironmentAssignedTargetingOptionDetails", +"properties": { +"environment": { +"description": "Required. The serving environment.", +"enum": [ +"ENVIRONMENT_UNSPECIFIED", +"ENVIRONMENT_WEB_OPTIMIZED", +"ENVIRONMENT_WEB_NOT_OPTIMIZED", +"ENVIRONMENT_APP" +], +"enumDescriptions": [ +"Default value when environment is not specified in this version. This enum is a placeholder for default value and does not represent a real environment option.", +"Target inventory displayed in browsers. This includes inventory that was designed for the device it was viewed on, such as mobile websites viewed on a mobile device. ENVIRONMENT_WEB_NOT_OPTIMIZED, if targeted, should be deleted prior to the deletion of this targeting option.", +"Target inventory displayed in browsers. This includes inventory that was not designed for the device but viewed on it, such as websites optimized for desktop but viewed on a mobile device. ENVIRONMENT_WEB_OPTIMIZED should be targeted prior to the addition of this targeting option.", +"Target inventory displayed in apps." +], +"type": "string" +} +}, +"type": "object" +}, +"EnvironmentTargetingOptionDetails": { +"description": "Represents a targetable environment. This will be populated in the environment_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`.", +"id": "EnvironmentTargetingOptionDetails", +"properties": { +"environment": { +"description": "Output only. The serving environment.", +"enum": [ +"ENVIRONMENT_UNSPECIFIED", +"ENVIRONMENT_WEB_OPTIMIZED", +"ENVIRONMENT_WEB_NOT_OPTIMIZED", +"ENVIRONMENT_APP" +], +"enumDescriptions": [ +"Default value when environment is not specified in this version. This enum is a placeholder for default value and does not represent a real environment option.", +"Target inventory displayed in browsers. This includes inventory that was designed for the device it was viewed on, such as mobile websites viewed on a mobile device. ENVIRONMENT_WEB_NOT_OPTIMIZED, if targeted, should be deleted prior to the deletion of this targeting option.", +"Target inventory displayed in browsers. This includes inventory that was not designed for the device but viewed on it, such as websites optimized for desktop but viewed on a mobile device. ENVIRONMENT_WEB_OPTIMIZED should be targeted prior to the addition of this targeting option.", +"Target inventory displayed in apps." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"ExchangeAssignedTargetingOptionDetails": { +"description": "Details for assigned exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`.", +"id": "ExchangeAssignedTargetingOptionDetails", +"properties": { +"exchange": { +"description": "Required. The enum value for the exchange.", +"enum": [ +"EXCHANGE_UNSPECIFIED", +"EXCHANGE_GOOGLE_AD_MANAGER", +"EXCHANGE_APPNEXUS", +"EXCHANGE_BRIGHTROLL", +"EXCHANGE_ADFORM", +"EXCHANGE_ADMETA", +"EXCHANGE_ADMIXER", +"EXCHANGE_ADSMOGO", +"EXCHANGE_ADSWIZZ", +"EXCHANGE_BIDSWITCH", +"EXCHANGE_BRIGHTROLL_DISPLAY", +"EXCHANGE_CADREON", +"EXCHANGE_DAILYMOTION", +"EXCHANGE_FIVE", +"EXCHANGE_FLUCT", +"EXCHANGE_FREEWHEEL", +"EXCHANGE_GENIEE", +"EXCHANGE_GUMGUM", +"EXCHANGE_IMOBILE", +"EXCHANGE_IBILLBOARD", +"EXCHANGE_IMPROVE_DIGITAL", +"EXCHANGE_INDEX", +"EXCHANGE_KARGO", +"EXCHANGE_MICROAD", +"EXCHANGE_MOPUB", +"EXCHANGE_NEND", +"EXCHANGE_ONE_BY_AOL_DISPLAY", +"EXCHANGE_ONE_BY_AOL_MOBILE", +"EXCHANGE_ONE_BY_AOL_VIDEO", +"EXCHANGE_OOYALA", +"EXCHANGE_OPENX", +"EXCHANGE_PERMODO", +"EXCHANGE_PLATFORMONE", +"EXCHANGE_PLATFORMID", +"EXCHANGE_PUBMATIC", +"EXCHANGE_PULSEPOINT", +"EXCHANGE_REVENUEMAX", +"EXCHANGE_RUBICON", +"EXCHANGE_SMARTCLIP", +"EXCHANGE_SMARTRTB", +"EXCHANGE_SMARTSTREAMTV", +"EXCHANGE_SOVRN", +"EXCHANGE_SPOTXCHANGE", +"EXCHANGE_STROER", +"EXCHANGE_TEADSTV", +"EXCHANGE_TELARIA", +"EXCHANGE_TVN", +"EXCHANGE_UNITED", +"EXCHANGE_YIELDLAB", +"EXCHANGE_YIELDMO", +"EXCHANGE_UNRULYX", +"EXCHANGE_OPEN8", +"EXCHANGE_TRITON", +"EXCHANGE_TRIPLELIFT", +"EXCHANGE_TABOOLA", +"EXCHANGE_INMOBI", +"EXCHANGE_SMAATO", +"EXCHANGE_AJA", +"EXCHANGE_SUPERSHIP", +"EXCHANGE_NEXSTAR_DIGITAL", +"EXCHANGE_WAZE", +"EXCHANGE_SOUNDCAST", +"EXCHANGE_SHARETHROUGH", +"EXCHANGE_FYBER", +"EXCHANGE_RED_FOR_PUBLISHERS", +"EXCHANGE_MEDIANET", +"EXCHANGE_TAPJOY", +"EXCHANGE_VISTAR", +"EXCHANGE_DAX", +"EXCHANGE_JCD", +"EXCHANGE_PLACE_EXCHANGE", +"EXCHANGE_APPLOVIN", +"EXCHANGE_CONNATIX", +"EXCHANGE_RESET_DIGITAL", +"EXCHANGE_HIVESTACK", +"EXCHANGE_DRAX", +"EXCHANGE_APPLOVIN_GBID", +"EXCHANGE_FYBER_GBID", +"EXCHANGE_UNITY_GBID", +"EXCHANGE_CHARTBOOST_GBID", +"EXCHANGE_ADMOST_GBID", +"EXCHANGE_TOPON_GBID", +"EXCHANGE_NETFLIX", +"EXCHANGE_CORE", +"EXCHANGE_TUBI" +], +"enumDescriptions": [ +"Exchange is not specified or is unknown in this version.", +"Google Ad Manager.", +"AppNexus.", +"BrightRoll Exchange for Video from Yahoo!.", +"Adform.", +"Admeta.", +"Admixer.", +"AdsMogo.", +"AdsWizz.", +"BidSwitch.", +"BrightRoll Exchange for Display from Yahoo!.", +"Cadreon.", +"Dailymotion.", +"Five.", +"Fluct.", +"FreeWheel SSP.", +"Geniee.", +"GumGum.", +"i-mobile.", +"iBILLBOARD.", +"Improve Digital.", +"Index Exchange.", +"Kargo.", +"MicroAd.", +"MoPub.", +"Nend.", +"ONE by AOL: Display Market Place.", +"ONE by AOL: Mobile.", +"ONE by AOL: Video.", +"Ooyala.", +"OpenX.", +"Permodo.", +"Platform One.", +"PlatformId.", +"PubMatic.", +"PulsePoint.", +"RevenueMax.", +"Rubicon.", +"SmartClip.", +"SmartRTB+.", +"SmartstreamTv.", +"Sovrn.", +"SpotXchange.", +"Str\u00f6er SSP.", +"TeadsTv.", +"Telaria.", +"TVN.", +"United.", +"Yieldlab.", +"Yieldmo.", +"UnrulyX.", +"Open8.", +"Triton.", +"TripleLift.", +"Taboola.", +"InMobi.", +"Smaato.", +"Aja.", +"Supership.", +"Nexstar Digital.", +"Waze.", +"SoundCast.", +"Sharethrough.", +"Fyber.", +"Red For Publishers.", +"Media.net.", +"Tapjoy.", +"Vistar.", +"DAX.", +"JCD.", +"Place Exchange.", +"AppLovin.", +"Connatix.", +"Reset Digital.", +"Hivestack.", +"Drax.", +"AppLovin MAX.", +"DT Fairbid.", +"Unity LevelPlay.", +"Chartboost Mediation.", +"AdMost.", +"TopOn.", +"Netflix.", +"Core.", +"Tubi." +], +"type": "string" +} +}, +"type": "object" +}, +"ExchangeConfig": { +"description": "Settings that control which exchanges are enabled for a partner.", +"id": "ExchangeConfig", +"properties": { +"enabledExchanges": { +"description": "All enabled exchanges in the partner. Duplicate enabled exchanges will be ignored.", +"items": { +"$ref": "ExchangeConfigEnabledExchange" +}, +"type": "array" +} +}, +"type": "object" +}, +"ExchangeConfigEnabledExchange": { +"description": "An enabled exchange in the partner.", +"id": "ExchangeConfigEnabledExchange", +"properties": { +"exchange": { +"description": "The enabled exchange.", +"enum": [ +"EXCHANGE_UNSPECIFIED", +"EXCHANGE_GOOGLE_AD_MANAGER", +"EXCHANGE_APPNEXUS", +"EXCHANGE_BRIGHTROLL", +"EXCHANGE_ADFORM", +"EXCHANGE_ADMETA", +"EXCHANGE_ADMIXER", +"EXCHANGE_ADSMOGO", +"EXCHANGE_ADSWIZZ", +"EXCHANGE_BIDSWITCH", +"EXCHANGE_BRIGHTROLL_DISPLAY", +"EXCHANGE_CADREON", +"EXCHANGE_DAILYMOTION", +"EXCHANGE_FIVE", +"EXCHANGE_FLUCT", +"EXCHANGE_FREEWHEEL", +"EXCHANGE_GENIEE", +"EXCHANGE_GUMGUM", +"EXCHANGE_IMOBILE", +"EXCHANGE_IBILLBOARD", +"EXCHANGE_IMPROVE_DIGITAL", +"EXCHANGE_INDEX", +"EXCHANGE_KARGO", +"EXCHANGE_MICROAD", +"EXCHANGE_MOPUB", +"EXCHANGE_NEND", +"EXCHANGE_ONE_BY_AOL_DISPLAY", +"EXCHANGE_ONE_BY_AOL_MOBILE", +"EXCHANGE_ONE_BY_AOL_VIDEO", +"EXCHANGE_OOYALA", +"EXCHANGE_OPENX", +"EXCHANGE_PERMODO", +"EXCHANGE_PLATFORMONE", +"EXCHANGE_PLATFORMID", +"EXCHANGE_PUBMATIC", +"EXCHANGE_PULSEPOINT", +"EXCHANGE_REVENUEMAX", +"EXCHANGE_RUBICON", +"EXCHANGE_SMARTCLIP", +"EXCHANGE_SMARTRTB", +"EXCHANGE_SMARTSTREAMTV", +"EXCHANGE_SOVRN", +"EXCHANGE_SPOTXCHANGE", +"EXCHANGE_STROER", +"EXCHANGE_TEADSTV", +"EXCHANGE_TELARIA", +"EXCHANGE_TVN", +"EXCHANGE_UNITED", +"EXCHANGE_YIELDLAB", +"EXCHANGE_YIELDMO", +"EXCHANGE_UNRULYX", +"EXCHANGE_OPEN8", +"EXCHANGE_TRITON", +"EXCHANGE_TRIPLELIFT", +"EXCHANGE_TABOOLA", +"EXCHANGE_INMOBI", +"EXCHANGE_SMAATO", +"EXCHANGE_AJA", +"EXCHANGE_SUPERSHIP", +"EXCHANGE_NEXSTAR_DIGITAL", +"EXCHANGE_WAZE", +"EXCHANGE_SOUNDCAST", +"EXCHANGE_SHARETHROUGH", +"EXCHANGE_FYBER", +"EXCHANGE_RED_FOR_PUBLISHERS", +"EXCHANGE_MEDIANET", +"EXCHANGE_TAPJOY", +"EXCHANGE_VISTAR", +"EXCHANGE_DAX", +"EXCHANGE_JCD", +"EXCHANGE_PLACE_EXCHANGE", +"EXCHANGE_APPLOVIN", +"EXCHANGE_CONNATIX", +"EXCHANGE_RESET_DIGITAL", +"EXCHANGE_HIVESTACK", +"EXCHANGE_DRAX", +"EXCHANGE_APPLOVIN_GBID", +"EXCHANGE_FYBER_GBID", +"EXCHANGE_UNITY_GBID", +"EXCHANGE_CHARTBOOST_GBID", +"EXCHANGE_ADMOST_GBID", +"EXCHANGE_TOPON_GBID", +"EXCHANGE_NETFLIX", +"EXCHANGE_CORE", +"EXCHANGE_TUBI" +], +"enumDescriptions": [ +"Exchange is not specified or is unknown in this version.", +"Google Ad Manager.", +"AppNexus.", +"BrightRoll Exchange for Video from Yahoo!.", +"Adform.", +"Admeta.", +"Admixer.", +"AdsMogo.", +"AdsWizz.", +"BidSwitch.", +"BrightRoll Exchange for Display from Yahoo!.", +"Cadreon.", +"Dailymotion.", +"Five.", +"Fluct.", +"FreeWheel SSP.", +"Geniee.", +"GumGum.", +"i-mobile.", +"iBILLBOARD.", +"Improve Digital.", +"Index Exchange.", +"Kargo.", +"MicroAd.", +"MoPub.", +"Nend.", +"ONE by AOL: Display Market Place.", +"ONE by AOL: Mobile.", +"ONE by AOL: Video.", +"Ooyala.", +"OpenX.", +"Permodo.", +"Platform One.", +"PlatformId.", +"PubMatic.", +"PulsePoint.", +"RevenueMax.", +"Rubicon.", +"SmartClip.", +"SmartRTB+.", +"SmartstreamTv.", +"Sovrn.", +"SpotXchange.", +"Str\u00f6er SSP.", +"TeadsTv.", +"Telaria.", +"TVN.", +"United.", +"Yieldlab.", +"Yieldmo.", +"UnrulyX.", +"Open8.", +"Triton.", +"TripleLift.", +"Taboola.", +"InMobi.", +"Smaato.", +"Aja.", +"Supership.", +"Nexstar Digital.", +"Waze.", +"SoundCast.", +"Sharethrough.", +"Fyber.", +"Red For Publishers.", +"Media.net.", +"Tapjoy.", +"Vistar.", +"DAX.", +"JCD.", +"Place Exchange.", +"AppLovin.", +"Connatix.", +"Reset Digital.", +"Hivestack.", +"Drax.", +"AppLovin MAX.", +"DT Fairbid.", +"Unity LevelPlay.", +"Chartboost Mediation.", +"AdMost.", +"TopOn.", +"Netflix.", +"Core.", +"Tubi." +], +"type": "string" +}, +"googleAdManagerAgencyId": { +"description": "Output only. Agency ID of Google Ad Manager. The field is only relevant when Google Ad Manager is the enabled exchange.", +"readOnly": true, +"type": "string" +}, +"googleAdManagerBuyerNetworkId": { +"description": "Output only. Network ID of Google Ad Manager. The field is only relevant when Google Ad Manager is the enabled exchange.", +"readOnly": true, +"type": "string" +}, +"seatId": { +"description": "Output only. Seat ID of the enabled exchange.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"ExchangeReviewStatus": { +"description": "Exchange review status for the creative.", +"id": "ExchangeReviewStatus", +"properties": { +"exchange": { +"description": "The exchange reviewing the creative.", +"enum": [ +"EXCHANGE_UNSPECIFIED", +"EXCHANGE_GOOGLE_AD_MANAGER", +"EXCHANGE_APPNEXUS", +"EXCHANGE_BRIGHTROLL", +"EXCHANGE_ADFORM", +"EXCHANGE_ADMETA", +"EXCHANGE_ADMIXER", +"EXCHANGE_ADSMOGO", +"EXCHANGE_ADSWIZZ", +"EXCHANGE_BIDSWITCH", +"EXCHANGE_BRIGHTROLL_DISPLAY", +"EXCHANGE_CADREON", +"EXCHANGE_DAILYMOTION", +"EXCHANGE_FIVE", +"EXCHANGE_FLUCT", +"EXCHANGE_FREEWHEEL", +"EXCHANGE_GENIEE", +"EXCHANGE_GUMGUM", +"EXCHANGE_IMOBILE", +"EXCHANGE_IBILLBOARD", +"EXCHANGE_IMPROVE_DIGITAL", +"EXCHANGE_INDEX", +"EXCHANGE_KARGO", +"EXCHANGE_MICROAD", +"EXCHANGE_MOPUB", +"EXCHANGE_NEND", +"EXCHANGE_ONE_BY_AOL_DISPLAY", +"EXCHANGE_ONE_BY_AOL_MOBILE", +"EXCHANGE_ONE_BY_AOL_VIDEO", +"EXCHANGE_OOYALA", +"EXCHANGE_OPENX", +"EXCHANGE_PERMODO", +"EXCHANGE_PLATFORMONE", +"EXCHANGE_PLATFORMID", +"EXCHANGE_PUBMATIC", +"EXCHANGE_PULSEPOINT", +"EXCHANGE_REVENUEMAX", +"EXCHANGE_RUBICON", +"EXCHANGE_SMARTCLIP", +"EXCHANGE_SMARTRTB", +"EXCHANGE_SMARTSTREAMTV", +"EXCHANGE_SOVRN", +"EXCHANGE_SPOTXCHANGE", +"EXCHANGE_STROER", +"EXCHANGE_TEADSTV", +"EXCHANGE_TELARIA", +"EXCHANGE_TVN", +"EXCHANGE_UNITED", +"EXCHANGE_YIELDLAB", +"EXCHANGE_YIELDMO", +"EXCHANGE_UNRULYX", +"EXCHANGE_OPEN8", +"EXCHANGE_TRITON", +"EXCHANGE_TRIPLELIFT", +"EXCHANGE_TABOOLA", +"EXCHANGE_INMOBI", +"EXCHANGE_SMAATO", +"EXCHANGE_AJA", +"EXCHANGE_SUPERSHIP", +"EXCHANGE_NEXSTAR_DIGITAL", +"EXCHANGE_WAZE", +"EXCHANGE_SOUNDCAST", +"EXCHANGE_SHARETHROUGH", +"EXCHANGE_FYBER", +"EXCHANGE_RED_FOR_PUBLISHERS", +"EXCHANGE_MEDIANET", +"EXCHANGE_TAPJOY", +"EXCHANGE_VISTAR", +"EXCHANGE_DAX", +"EXCHANGE_JCD", +"EXCHANGE_PLACE_EXCHANGE", +"EXCHANGE_APPLOVIN", +"EXCHANGE_CONNATIX", +"EXCHANGE_RESET_DIGITAL", +"EXCHANGE_HIVESTACK", +"EXCHANGE_DRAX", +"EXCHANGE_APPLOVIN_GBID", +"EXCHANGE_FYBER_GBID", +"EXCHANGE_UNITY_GBID", +"EXCHANGE_CHARTBOOST_GBID", +"EXCHANGE_ADMOST_GBID", +"EXCHANGE_TOPON_GBID", +"EXCHANGE_NETFLIX", +"EXCHANGE_CORE", +"EXCHANGE_TUBI" +], +"enumDescriptions": [ +"Exchange is not specified or is unknown in this version.", +"Google Ad Manager.", +"AppNexus.", +"BrightRoll Exchange for Video from Yahoo!.", +"Adform.", +"Admeta.", +"Admixer.", +"AdsMogo.", +"AdsWizz.", +"BidSwitch.", +"BrightRoll Exchange for Display from Yahoo!.", +"Cadreon.", +"Dailymotion.", +"Five.", +"Fluct.", +"FreeWheel SSP.", +"Geniee.", +"GumGum.", +"i-mobile.", +"iBILLBOARD.", +"Improve Digital.", +"Index Exchange.", +"Kargo.", +"MicroAd.", +"MoPub.", +"Nend.", +"ONE by AOL: Display Market Place.", +"ONE by AOL: Mobile.", +"ONE by AOL: Video.", +"Ooyala.", +"OpenX.", +"Permodo.", +"Platform One.", +"PlatformId.", +"PubMatic.", +"PulsePoint.", +"RevenueMax.", +"Rubicon.", +"SmartClip.", +"SmartRTB+.", +"SmartstreamTv.", +"Sovrn.", +"SpotXchange.", +"Str\u00f6er SSP.", +"TeadsTv.", +"Telaria.", +"TVN.", +"United.", +"Yieldlab.", +"Yieldmo.", +"UnrulyX.", +"Open8.", +"Triton.", +"TripleLift.", +"Taboola.", +"InMobi.", +"Smaato.", +"Aja.", +"Supership.", +"Nexstar Digital.", +"Waze.", +"SoundCast.", +"Sharethrough.", +"Fyber.", +"Red For Publishers.", +"Media.net.", +"Tapjoy.", +"Vistar.", +"DAX.", +"JCD.", +"Place Exchange.", +"AppLovin.", +"Connatix.", +"Reset Digital.", +"Hivestack.", +"Drax.", +"AppLovin MAX.", +"DT Fairbid.", +"Unity LevelPlay.", +"Chartboost Mediation.", +"AdMost.", +"TopOn.", +"Netflix.", +"Core.", +"Tubi." +], +"type": "string" +}, +"status": { +"description": "Status of the exchange review.", +"enum": [ +"REVIEW_STATUS_UNSPECIFIED", +"REVIEW_STATUS_APPROVED", +"REVIEW_STATUS_REJECTED", +"REVIEW_STATUS_PENDING" +], +"enumDescriptions": [ +"Type value is not specified or is unknown in this version.", +"The creative is approved.", +"The creative is rejected.", +"The creative is pending review." +], +"type": "string" +} +}, +"type": "object" +}, +"ExchangeTargetingOptionDetails": { +"description": "Represents a targetable exchange. This will be populated in the exchange_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`.", +"id": "ExchangeTargetingOptionDetails", +"properties": { +"exchange": { +"description": "Output only. The type of exchange.", +"enum": [ +"EXCHANGE_UNSPECIFIED", +"EXCHANGE_GOOGLE_AD_MANAGER", +"EXCHANGE_APPNEXUS", +"EXCHANGE_BRIGHTROLL", +"EXCHANGE_ADFORM", +"EXCHANGE_ADMETA", +"EXCHANGE_ADMIXER", +"EXCHANGE_ADSMOGO", +"EXCHANGE_ADSWIZZ", +"EXCHANGE_BIDSWITCH", +"EXCHANGE_BRIGHTROLL_DISPLAY", +"EXCHANGE_CADREON", +"EXCHANGE_DAILYMOTION", +"EXCHANGE_FIVE", +"EXCHANGE_FLUCT", +"EXCHANGE_FREEWHEEL", +"EXCHANGE_GENIEE", +"EXCHANGE_GUMGUM", +"EXCHANGE_IMOBILE", +"EXCHANGE_IBILLBOARD", +"EXCHANGE_IMPROVE_DIGITAL", +"EXCHANGE_INDEX", +"EXCHANGE_KARGO", +"EXCHANGE_MICROAD", +"EXCHANGE_MOPUB", +"EXCHANGE_NEND", +"EXCHANGE_ONE_BY_AOL_DISPLAY", +"EXCHANGE_ONE_BY_AOL_MOBILE", +"EXCHANGE_ONE_BY_AOL_VIDEO", +"EXCHANGE_OOYALA", +"EXCHANGE_OPENX", +"EXCHANGE_PERMODO", +"EXCHANGE_PLATFORMONE", +"EXCHANGE_PLATFORMID", +"EXCHANGE_PUBMATIC", +"EXCHANGE_PULSEPOINT", +"EXCHANGE_REVENUEMAX", +"EXCHANGE_RUBICON", +"EXCHANGE_SMARTCLIP", +"EXCHANGE_SMARTRTB", +"EXCHANGE_SMARTSTREAMTV", +"EXCHANGE_SOVRN", +"EXCHANGE_SPOTXCHANGE", +"EXCHANGE_STROER", +"EXCHANGE_TEADSTV", +"EXCHANGE_TELARIA", +"EXCHANGE_TVN", +"EXCHANGE_UNITED", +"EXCHANGE_YIELDLAB", +"EXCHANGE_YIELDMO", +"EXCHANGE_UNRULYX", +"EXCHANGE_OPEN8", +"EXCHANGE_TRITON", +"EXCHANGE_TRIPLELIFT", +"EXCHANGE_TABOOLA", +"EXCHANGE_INMOBI", +"EXCHANGE_SMAATO", +"EXCHANGE_AJA", +"EXCHANGE_SUPERSHIP", +"EXCHANGE_NEXSTAR_DIGITAL", +"EXCHANGE_WAZE", +"EXCHANGE_SOUNDCAST", +"EXCHANGE_SHARETHROUGH", +"EXCHANGE_FYBER", +"EXCHANGE_RED_FOR_PUBLISHERS", +"EXCHANGE_MEDIANET", +"EXCHANGE_TAPJOY", +"EXCHANGE_VISTAR", +"EXCHANGE_DAX", +"EXCHANGE_JCD", +"EXCHANGE_PLACE_EXCHANGE", +"EXCHANGE_APPLOVIN", +"EXCHANGE_CONNATIX", +"EXCHANGE_RESET_DIGITAL", +"EXCHANGE_HIVESTACK", +"EXCHANGE_DRAX", +"EXCHANGE_APPLOVIN_GBID", +"EXCHANGE_FYBER_GBID", +"EXCHANGE_UNITY_GBID", +"EXCHANGE_CHARTBOOST_GBID", +"EXCHANGE_ADMOST_GBID", +"EXCHANGE_TOPON_GBID", +"EXCHANGE_NETFLIX", +"EXCHANGE_CORE", +"EXCHANGE_TUBI" +], +"enumDescriptions": [ +"Exchange is not specified or is unknown in this version.", +"Google Ad Manager.", +"AppNexus.", +"BrightRoll Exchange for Video from Yahoo!.", +"Adform.", +"Admeta.", +"Admixer.", +"AdsMogo.", +"AdsWizz.", +"BidSwitch.", +"BrightRoll Exchange for Display from Yahoo!.", +"Cadreon.", +"Dailymotion.", +"Five.", +"Fluct.", +"FreeWheel SSP.", +"Geniee.", +"GumGum.", +"i-mobile.", +"iBILLBOARD.", +"Improve Digital.", +"Index Exchange.", +"Kargo.", +"MicroAd.", +"MoPub.", +"Nend.", +"ONE by AOL: Display Market Place.", +"ONE by AOL: Mobile.", +"ONE by AOL: Video.", +"Ooyala.", +"OpenX.", +"Permodo.", +"Platform One.", +"PlatformId.", +"PubMatic.", +"PulsePoint.", +"RevenueMax.", +"Rubicon.", +"SmartClip.", +"SmartRTB+.", +"SmartstreamTv.", +"Sovrn.", +"SpotXchange.", +"Str\u00f6er SSP.", +"TeadsTv.", +"Telaria.", +"TVN.", +"United.", +"Yieldlab.", +"Yieldmo.", +"UnrulyX.", +"Open8.", +"Triton.", +"TripleLift.", +"Taboola.", +"InMobi.", +"Smaato.", +"Aja.", +"Supership.", +"Nexstar Digital.", +"Waze.", +"SoundCast.", +"Sharethrough.", +"Fyber.", +"Red For Publishers.", +"Media.net.", +"Tapjoy.", +"Vistar.", +"DAX.", +"JCD.", +"Place Exchange.", +"AppLovin.", +"Connatix.", +"Reset Digital.", +"Hivestack.", +"Drax.", +"AppLovin MAX.", +"DT Fairbid.", +"Unity LevelPlay.", +"Chartboost Mediation.", +"AdMost.", +"TopOn.", +"Netflix.", +"Core.", +"Tubi." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"ExitEvent": { +"description": "Exit event of the creative.", +"id": "ExitEvent", +"properties": { +"name": { +"description": "Optional. The name of the click tag of the exit event. The name must be unique within one creative. Leave it empty or unset for creatives containing image assets only.", +"type": "string" +}, +"reportingName": { +"description": "Optional. The name used to identify this event in reports. Leave it empty or unset for creatives containing image assets only.", +"type": "string" +}, +"type": { +"description": "Required. The type of the exit event.", +"enum": [ +"EXIT_EVENT_TYPE_UNSPECIFIED", +"EXIT_EVENT_TYPE_DEFAULT", +"EXIT_EVENT_TYPE_BACKUP" +], +"enumDescriptions": [ +"Exit event type is not specified or is unknown in this version.", +"The exit event is the default one.", +"The exit event is a backup exit event. There could be multiple backup exit events in a creative." +], +"type": "string" +}, +"url": { +"description": "Required. The click through URL of the exit event. This is required when type is: * `EXIT_EVENT_TYPE_DEFAULT` * `EXIT_EVENT_TYPE_BACKUP`", +"type": "string" +} +}, +"type": "object" +}, +"FirstPartyAndPartnerAudience": { +"description": "Describes a first or partner audience list used for targeting. First party audiences are created via usage of client data. Partner audiences are provided by Third Party data providers and can only be licensed to customers.", +"id": "FirstPartyAndPartnerAudience", +"properties": { +"activeDisplayAudienceSize": { +"description": "Output only. The estimated audience size for the Display network in the past month. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only returned in GET request.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"appId": { +"description": "Optional. The app_id matches with the type of the mobile_device_ids being uploaded. Only applicable to audience_type `CUSTOMER_MATCH_DEVICE_ID`", +"type": "string" +}, +"audienceSource": { +"description": "Output only. The source of the audience.", +"enum": [ +"AUDIENCE_SOURCE_UNSPECIFIED", +"DISPLAY_VIDEO_360", +"CAMPAIGN_MANAGER", +"AD_MANAGER", +"SEARCH_ADS_360", +"YOUTUBE", +"ADS_DATA_HUB" +], +"enumDescriptions": [ +"Default value when audience source is not specified or is unknown.", +"Originated from Display & Video 360.", +"Originated from Campaign Manager 360.", +"Originated from Google Ad Manager.", +"Originated from Search Ads 360.", +"Originated from Youtube.", +"Originated from Ads Data Hub." +], +"readOnly": true, +"type": "string" +}, +"audienceType": { +"description": "Output only. The type of the audience.", +"enum": [ +"AUDIENCE_TYPE_UNSPECIFIED", +"CUSTOMER_MATCH_CONTACT_INFO", +"CUSTOMER_MATCH_DEVICE_ID", +"CUSTOMER_MATCH_USER_ID", +"ACTIVITY_BASED", +"FREQUENCY_CAP", +"TAG_BASED", +"YOUTUBE_USERS", +"THIRD_PARTY", +"COMMERCE", +"LINEAR" +], +"enumDeprecated": [ +false, +false, +false, +false, +true, +true, +false, +false, +false, +false, +false +], +"enumDescriptions": [ +"Default value when type is not specified or is unknown.", +"Audience was generated through matching customers to known contact information.", +"Audience was generated through matching customers to known Mobile device IDs.", +"Audience was generated through matching customers to known User IDs.", +"Audience was created based on campaign activity.", +"Audience was created based on excluding the number of impressions they were served.", +"Audience was created based on custom variables attached to pixel.", +"Audience was created based on past interactions with videos, YouTube ads, or YouTube channel.", +"Audience has been licensed for use from a third party.", +"Audience provided by commerce partners for a fee.", +"Audience for Linear TV content." +], +"readOnly": true, +"type": "string" +}, +"contactInfoList": { +"$ref": "ContactInfoList", +"description": "Input only. A list of contact information to define the initial audience members. Only applicable to audience_type `CUSTOMER_MATCH_CONTACT_INFO`" +}, +"description": { +"description": "Output only. The user-provided description of the audience. Only applicable to first party audiences.", +"readOnly": true, +"type": "string" +}, +"displayAudienceSize": { +"description": "Output only. The estimated audience size for the Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only returned in GET request.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"displayDesktopAudienceSize": { +"description": "Output only. The estimated desktop audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"displayMobileAppAudienceSize": { +"description": "Output only. The estimated mobile app audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"displayMobileWebAudienceSize": { +"description": "Output only. The estimated mobile web audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"displayName": { +"description": "Output only. The display name of the first party and partner audience.", +"readOnly": true, +"type": "string" +}, +"firstPartyAndPartnerAudienceId": { +"description": "Identifier. The unique ID of the first party and partner audience. Assigned by the system.", +"format": "int64", +"type": "string" +}, +"firstPartyAndPartnerAudienceType": { +"description": "Output only. Whether the audience is a first party and partner audience.", +"enum": [ +"FIRST_PARTY_AND_PARTNER_AUDIENCE_TYPE_UNSPECIFIED", +"TYPE_FIRST_PARTY", +"TYPE_PARTNER" +], +"enumDescriptions": [ +"Default value when type is not specified or is unknown.", +"Audience that is created via usage of client data.", +"Audience that is provided by Third Party data providers." +], +"readOnly": true, +"type": "string" +}, +"gmailAudienceSize": { +"description": "Output only. The estimated audience size for Gmail network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"membershipDurationDays": { +"description": "Output only. The duration in days that an entry remains in the audience after the qualifying event. If the audience has no expiration, set the value of this field to 10000. Otherwise, the set value must be greater than 0 and less than or equal to 540. Only applicable to first party audiences. This field is required if one of the following audience_type is used: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"mobileDeviceIdList": { +"$ref": "MobileDeviceIdList", +"description": "Input only. A list of mobile device IDs to define the initial audience members. Only applicable to audience_type `CUSTOMER_MATCH_DEVICE_ID`" +}, +"name": { +"description": "Output only. The resource name of the first party and partner audience.", +"readOnly": true, +"type": "string" +}, +"youtubeAudienceSize": { +"description": "Output only. The estimated audience size for YouTube network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.", +"format": "int64", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"FirstPartyAndPartnerAudienceGroup": { +"description": "Details of first party and partner audience group. All first party and partner audience targeting settings are logically \u2018OR\u2019 of each other.", +"id": "FirstPartyAndPartnerAudienceGroup", +"properties": { +"settings": { +"description": "Required. All first party and partner audience targeting settings in first party and partner audience group. Repeated settings with the same id are not allowed.", +"items": { +"$ref": "FirstPartyAndPartnerAudienceTargetingSetting" +}, +"type": "array" +} +}, +"type": "object" +}, +"FirstPartyAndPartnerAudienceTargetingSetting": { +"description": "Details of first party and partner audience targeting setting.", +"id": "FirstPartyAndPartnerAudienceTargetingSetting", +"properties": { +"firstPartyAndPartnerAudienceId": { +"description": "Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.", +"format": "int64", +"type": "string" +}, +"recency": { +"description": "Required. The recency of the first party and partner audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.", +"enum": [ +"RECENCY_NO_LIMIT", +"RECENCY_1_MINUTE", +"RECENCY_5_MINUTES", +"RECENCY_10_MINUTES", +"RECENCY_15_MINUTES", +"RECENCY_30_MINUTES", +"RECENCY_1_HOUR", +"RECENCY_2_HOURS", +"RECENCY_3_HOURS", +"RECENCY_6_HOURS", +"RECENCY_12_HOURS", +"RECENCY_1_DAY", +"RECENCY_2_DAYS", +"RECENCY_3_DAYS", +"RECENCY_5_DAYS", +"RECENCY_7_DAYS", +"RECENCY_10_DAYS", +"RECENCY_14_DAYS", +"RECENCY_15_DAYS", +"RECENCY_21_DAYS", +"RECENCY_28_DAYS", +"RECENCY_30_DAYS", +"RECENCY_40_DAYS", +"RECENCY_45_DAYS", +"RECENCY_60_DAYS", +"RECENCY_90_DAYS", +"RECENCY_120_DAYS", +"RECENCY_180_DAYS", +"RECENCY_270_DAYS", +"RECENCY_365_DAYS" +], +"enumDescriptions": [ +"No limit of recency.", +"Recency is 1 minute.", +"Recency is 5 minutes.", +"Recency is 10 minutes.", +"Recency is 15 minutes.", +"Recency is 30 minutes.", +"Recency is 1 hour.", +"Recency is 2 hours.", +"Recency is 3 hours.", +"Recency is 6 hours.", +"Recency is 12 hours.", +"Recency is 1 day.", +"Recency is 2 days.", +"Recency is 3 days.", +"Recency is 5 days.", +"Recency is 7 days.", +"Recency is 10 days.", +"Recency is 14 days.", +"Recency is 15 days.", +"Recency is 21 days.", +"Recency is 28 days.", +"Recency is 30 days.", +"Recency is 40 days.", +"Recency is 45 days.", +"Recency is 60 days.", +"Recency is 90 days.", +"Recency is 120 days.", +"Recency is 180 days.", +"Recency is 270 days.", +"Recency is 365 days." +], +"type": "string" +} +}, +"type": "object" +}, +"FixedBidStrategy": { +"description": "A strategy that uses a fixed bidding price.", +"id": "FixedBidStrategy", +"properties": { +"bidAmountMicros": { +"description": "The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"FloodlightActivity": { +"description": "A single Floodlight activity.", +"id": "FloodlightActivity", +"properties": { +"advertiserIds": { +"description": "Output only. IDs of the advertisers that have access to the parent Floodlight group. Only advertisers under the provided partner ID will be listed in this field.", +"items": { +"format": "int64", +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"displayName": { +"description": "Required. The display name of the Floodlight activity.", +"type": "string" +}, +"floodlightActivityId": { +"description": "Output only. The unique ID of the Floodlight activity. Assigned by the system.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"floodlightGroupId": { +"description": "Required. Immutable. The ID of the parent Floodlight group.", +"format": "int64", +"type": "string" +}, +"name": { +"description": "Output only. The resource name of the Floodlight activity.", +"readOnly": true, +"type": "string" +}, +"remarketingConfigs": { +"description": "Output only. A list of configuration objects designating whether remarketing for this Floodlight Activity is enabled and available for a specifc advertiser. If enabled, this Floodlight Activity generates a remarketing user list that is able to be used in targeting under the advertiser.", +"items": { +"$ref": "RemarketingConfig" +}, +"readOnly": true, +"type": "array" +}, +"servingStatus": { +"description": "Optional. Whether the Floodlight activity is served.", +"enum": [ +"FLOODLIGHT_ACTIVITY_SERVING_STATUS_UNSPECIFIED", +"FLOODLIGHT_ACTIVITY_SERVING_STATUS_ENABLED", +"FLOODLIGHT_ACTIVITY_SERVING_STATUS_DISABLED" +], +"enumDescriptions": [ +"Type value is not specified or is unknown in this version.", +"Enabled.", +"Disabled." +], +"type": "string" +}, +"sslRequired": { +"description": "Output only. Whether tags are required to be compliant.", +"readOnly": true, +"type": "boolean" +} +}, +"type": "object" +}, +"FloodlightGroup": { +"description": "A single Floodlight group.", +"id": "FloodlightGroup", +"properties": { +"activeViewConfig": { +"$ref": "ActiveViewVideoViewabilityMetricConfig", +"description": "The Active View video viewability metric configuration for the Floodlight group." +}, +"customVariables": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "User-defined custom variables owned by the Floodlight group. Use custom Floodlight variables to create reporting data that is tailored to your unique business needs. Custom Floodlight variables use the keys `U1=`, `U2=`, and so on, and can take any values that you choose to pass to them. You can use them to track virtually any type of data that you collect about your customers, such as the genre of movie that a customer purchases, the country to which the item is shipped, and so on. Custom Floodlight variables may not be used to pass any data that could be used or recognized as personally identifiable information (PII). Example: `custom_variables { fields { \"U1\": value { number_value: 123.4 }, \"U2\": value { string_value: \"MyVariable2\" }, \"U3\": value { string_value: \"MyVariable3\" } } }` Acceptable values for keys are \"U1\" through \"U100\", inclusive. String values must be less than 64 characters long, and cannot contain the following characters: `\"<>`.", +"type": "object" +}, +"displayName": { +"description": "Required. The display name of the Floodlight group.", +"type": "string" +}, +"floodlightGroupId": { +"description": "Output only. The unique ID of the Floodlight group. Assigned by the system.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"lookbackWindow": { +"$ref": "LookbackWindow", +"description": "Required. The lookback window for the Floodlight group. Both click_days and impression_days are required. Acceptable values for both are `0` to `90`, inclusive." +}, +"name": { +"description": "Output only. The resource name of the Floodlight group.", +"readOnly": true, +"type": "string" +}, +"webTagType": { +"description": "Required. The web tag type enabled for the Floodlight group.", +"enum": [ +"WEB_TAG_TYPE_UNSPECIFIED", +"WEB_TAG_TYPE_NONE", +"WEB_TAG_TYPE_IMAGE", +"WEB_TAG_TYPE_DYNAMIC" +], +"enumDescriptions": [ +"Type value is not specified or is unknown in this version.", +"No tag type.", +"Image tag.", +"Dynamic tag." +], +"type": "string" +} +}, +"type": "object" +}, +"FrequencyCap": { +"description": "Settings that control the number of times a user may be shown with the same ad during a given time period.", +"id": "FrequencyCap", +"properties": { +"maxImpressions": { +"description": "The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set.", +"format": "int32", +"type": "integer" +}, +"maxViews": { +"description": "Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set.", +"format": "int32", +"type": "integer" +}, +"timeUnit": { +"description": "The time unit in which the frequency cap will be applied. Required when unlimited is `false`. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value `TIME_UNIT_LIFETIME`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).", +"enum": [ +"TIME_UNIT_UNSPECIFIED", +"TIME_UNIT_LIFETIME", +"TIME_UNIT_MONTHS", +"TIME_UNIT_WEEKS", +"TIME_UNIT_DAYS", +"TIME_UNIT_HOURS", +"TIME_UNIT_MINUTES" +], +"enumDescriptions": [ +"Time unit value is not specified or is unknown in this version.", +"The frequency cap will be applied to the whole life time of the line item.", +"The frequency cap will be applied to a number of months.", +"The frequency cap will be applied to a number of weeks.", +"The frequency cap will be applied to a number of days.", +"The frequency cap will be applied to a number of hours.", +"The frequency cap will be applied to a number of minutes." +], +"type": "string" +}, +"timeUnitCount": { +"description": "The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. This field will no longer accept the value 2 if the value of time_unit is `TIME_UNIT_MONTHS`. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap).", +"format": "int32", +"type": "integer" +}, +"unlimited": { +"description": "Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable.", +"type": "boolean" +} +}, +"type": "object" +}, +"GenderAssignedTargetingOptionDetails": { +"description": "Details for assigned gender targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GENDER`.", +"id": "GenderAssignedTargetingOptionDetails", +"properties": { +"gender": { +"description": "Required. The gender of the audience.", +"enum": [ +"GENDER_UNSPECIFIED", +"GENDER_MALE", +"GENDER_FEMALE", +"GENDER_UNKNOWN" +], +"enumDescriptions": [ +"Default value when gender is not specified in this version. This enum is a place holder for default value and does not represent a real gender option.", +"The audience gender is male.", +"The audience gender is female.", +"The audience gender is unknown." +], +"type": "string" +} +}, +"type": "object" +}, +"GenderTargetingOptionDetails": { +"description": "Represents a targetable gender. This will be populated in the gender_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_GENDER`.", +"id": "GenderTargetingOptionDetails", +"properties": { +"gender": { +"description": "Output only. The gender of an audience.", +"enum": [ +"GENDER_UNSPECIFIED", +"GENDER_MALE", +"GENDER_FEMALE", +"GENDER_UNKNOWN" +], +"enumDescriptions": [ +"Default value when gender is not specified in this version. This enum is a place holder for default value and does not represent a real gender option.", +"The audience gender is male.", +"The audience gender is female.", +"The audience gender is unknown." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GenerateDefaultLineItemRequest": { +"description": "Request message for LineItemService.GenerateDefaultLineItem.", +"id": "GenerateDefaultLineItemRequest", +"properties": { +"displayName": { +"description": "Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes.", +"type": "string" +}, +"insertionOrderId": { +"description": "Required. The unique ID of the insertion order that the line item belongs to.", +"format": "int64", +"type": "string" +}, +"lineItemType": { +"description": "Required. The type of the line item.", +"enum": [ +"LINE_ITEM_TYPE_UNSPECIFIED", +"LINE_ITEM_TYPE_DISPLAY_DEFAULT", +"LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INSTALL", +"LINE_ITEM_TYPE_VIDEO_DEFAULT", +"LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL", +"LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INVENTORY", +"LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INVENTORY", +"LINE_ITEM_TYPE_AUDIO_DEFAULT", +"LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP", +"LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_ACTION", +"LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE", +"LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE", +"LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_AUDIO", +"LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_REACH", +"LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_SIMPLE", +"LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE_OVER_THE_TOP", +"LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_REACH_OVER_THE_TOP", +"LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_SIMPLE_OVER_THE_TOP", +"LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_TARGET_FREQUENCY", +"LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIEW", +"LINE_ITEM_TYPE_DISPLAY_OUT_OF_HOME", +"LINE_ITEM_TYPE_VIDEO_OUT_OF_HOME" +], +"enumDescriptions": [ +"Type value is not specified or is unknown in this version. Line items of this type and their targeting cannot be created or updated using the API.", +"Image, HTML5, native, or rich media ads.", +"Display ads that drive installs of an app.", +"Video ads sold on a CPM basis for a variety of environments.", +"Video ads that drive installs of an app.", +"Display ads served on mobile app inventory. Line items of this type and their targeting cannot be created or updated using the API.", +"Video ads served on mobile app inventory. Line items of this type and their targeting cannot be created or updated using the API.", +"RTB Audio ads sold for a variety of environments.", +"Over-the-top ads present in OTT insertion orders. This type is only applicable to line items with an insertion order of insertion_order_type `OVER_THE_TOP`.", +"YouTube video ads that promote conversions. Line items of this type and their targeting cannot be created or updated using the API.", +"YouTube video ads (up to 15 seconds) that cannot be skipped. Line items of this type and their targeting cannot be created or updated using the API.", +"YouTube video ads that show a story in a particular sequence using a mix of formats. Line items of this type and their targeting cannot be created or updated using the API.", +"YouTube audio ads. Line items of this type and their targeting cannot be created or updated using the API.", +"YouTube video ads that optimize reaching more unique users at lower cost. May include bumper ads, skippable in-stream ads, or a mix of types. Line items of this type and their targeting cannot be created or updated using the API.", +"Default YouTube video ads. Line items of this type and their targeting cannot be created or updated using the API.", +"Connected TV youTube video ads (up to 15 seconds) that cannot be skipped. Line items of this type and their targeting cannot be created or updated using the API.", +"Connected TV youTube video ads that optimize reaching more unique users at lower cost. May include bumper ads, skippable in-stream ads, or a mix of types. Line items of this type and their targeting cannot be created or updated using the API.", +"Connected TV default YouTube video ads. Only include in-stream ad-format. Line items of this type and their targeting cannot be created or updated using the API.", +"The goal of this line item type is to show the YouTube ads target number of times to the same person in a certain period of time. Line items of this type and their targeting cannot be created or updated using the API.", +"YouTube video ads that aim to get more views with a variety of ad formats. Line items of this type and their targeting cannot be created or updated using the API.", +"Display ads served on digital-out-of-home inventory. Line items of this type and their targeting cannot be created or updated using the API.", +"Video ads served on digital-out-of-home inventory. Line items of this type and their targeting cannot be created or updated using the API." +], +"type": "string" +}, +"mobileApp": { +"$ref": "MobileApp", +"description": "The mobile app promoted by the line item. This is applicable only when line_item_type is either `LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INSTALL` or `LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL`." +} +}, +"type": "object" +}, +"GeoRegionAssignedTargetingOptionDetails": { +"description": "Details for assigned geographic region targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GEO_REGION`.", +"id": "GeoRegionAssignedTargetingOptionDetails", +"properties": { +"displayName": { +"description": "Output only. The display name of the geographic region (e.g., \"Ontario, Canada\").", +"readOnly": true, +"type": "string" +}, +"geoRegionType": { +"description": "Output only. The type of geographic region targeting.", +"enum": [ +"GEO_REGION_TYPE_UNKNOWN", +"GEO_REGION_TYPE_OTHER", +"GEO_REGION_TYPE_COUNTRY", +"GEO_REGION_TYPE_REGION", +"GEO_REGION_TYPE_TERRITORY", +"GEO_REGION_TYPE_PROVINCE", +"GEO_REGION_TYPE_STATE", +"GEO_REGION_TYPE_PREFECTURE", +"GEO_REGION_TYPE_GOVERNORATE", +"GEO_REGION_TYPE_CANTON", +"GEO_REGION_TYPE_UNION_TERRITORY", +"GEO_REGION_TYPE_AUTONOMOUS_COMMUNITY", +"GEO_REGION_TYPE_DMA_REGION", +"GEO_REGION_TYPE_METRO", +"GEO_REGION_TYPE_CONGRESSIONAL_DISTRICT", +"GEO_REGION_TYPE_COUNTY", +"GEO_REGION_TYPE_MUNICIPALITY", +"GEO_REGION_TYPE_CITY", +"GEO_REGION_TYPE_POSTAL_CODE", +"GEO_REGION_TYPE_DEPARTMENT", +"GEO_REGION_TYPE_AIRPORT", +"GEO_REGION_TYPE_TV_REGION", +"GEO_REGION_TYPE_OKRUG", +"GEO_REGION_TYPE_BOROUGH", +"GEO_REGION_TYPE_CITY_REGION", +"GEO_REGION_TYPE_ARRONDISSEMENT", +"GEO_REGION_TYPE_NEIGHBORHOOD", +"GEO_REGION_TYPE_UNIVERSITY", +"GEO_REGION_TYPE_DISTRICT", +"GEO_REGION_TYPE_NATIONAL_PARK", +"GEO_REGION_TYPE_BARRIO", +"GEO_REGION_TYPE_SUB_WARD", +"GEO_REGION_TYPE_MUNICIPALITY_DISTRICT", +"GEO_REGION_TYPE_SUB_DISTRICT", +"GEO_REGION_TYPE_QUARTER", +"GEO_REGION_TYPE_DIVISION", +"GEO_REGION_TYPE_COMMUNE", +"GEO_REGION_TYPE_COLLOQUIAL_AREA" +], +"enumDescriptions": [ +"The geographic region type is unknown.", +"The geographic region type is other.", +"The geographic region is a country.", +"The geographic region type is region.", +"The geographic region is a territory.", +"The geographic region is a province.", +"The geographic region is a state.", +"The geographic region is a prefecture.", +"The geographic region is a governorate.", +"The geographic region is a canton.", +"The geographic region is a union territory.", +"The geographic region is an autonomous community.", +"The geographic region is a designated market area (DMA) region.", +"The geographic region type is metro.", +"The geographic region is a congressional district.", +"The geographic region is a county.", +"The geographic region is a municipality.", +"The geographic region is a city.", +"The geographic region targeting type is postal code.", +"The geographic region targeting type is department.", +"The geographic region is an airport.", +"The geographic region is a TV region.", +"The geographic region is an okrug.", +"The geographic region is a borough.", +"The geographic region is a city region.", +"The geographic region is an arrondissement.", +"The geographic region is a neighborhood.", +"The geographic region is a university.", +"The geographic region is a district.", +"The geographic region is a national park.", +"The geographic region is a barrio.", +"The geographic region is a sub ward.", +"The geographic region is a municipality district.", +"The geographic region is a sub district.", +"The geographic region is a quarter.", +"The geographic region is a division.", +"The geographic region is a commune.", +"The geographic region is a colloquial area." +], +"readOnly": true, +"type": "string" +}, +"negative": { +"description": "Indicates if this option is being negatively targeted.", +"type": "boolean" +}, +"targetingOptionId": { +"description": "Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GEO_REGION`.", +"type": "string" +} +}, +"type": "object" +}, +"GeoRegionSearchTerms": { +"description": "Search terms for geo region targeting options.", +"id": "GeoRegionSearchTerms", +"properties": { +"geoRegionQuery": { +"description": "The search query for the desired geo region. The query can be a prefix, e.g. \"New Yor\", \"Seattle\", \"USA\", etc.", +"type": "string" +} +}, +"type": "object" +}, +"GeoRegionTargetingOptionDetails": { +"description": "Represents a targetable geographic region. This will be populated in the geo_region_details field when targeting_type is `TARGETING_TYPE_GEO_REGION`.", +"id": "GeoRegionTargetingOptionDetails", +"properties": { +"displayName": { +"description": "Output only. The display name of the geographic region (e.g., \"Ontario, Canada\").", +"readOnly": true, +"type": "string" +}, +"geoRegionType": { +"description": "Output only. The type of geographic region targeting.", +"enum": [ +"GEO_REGION_TYPE_UNKNOWN", +"GEO_REGION_TYPE_OTHER", +"GEO_REGION_TYPE_COUNTRY", +"GEO_REGION_TYPE_REGION", +"GEO_REGION_TYPE_TERRITORY", +"GEO_REGION_TYPE_PROVINCE", +"GEO_REGION_TYPE_STATE", +"GEO_REGION_TYPE_PREFECTURE", +"GEO_REGION_TYPE_GOVERNORATE", +"GEO_REGION_TYPE_CANTON", +"GEO_REGION_TYPE_UNION_TERRITORY", +"GEO_REGION_TYPE_AUTONOMOUS_COMMUNITY", +"GEO_REGION_TYPE_DMA_REGION", +"GEO_REGION_TYPE_METRO", +"GEO_REGION_TYPE_CONGRESSIONAL_DISTRICT", +"GEO_REGION_TYPE_COUNTY", +"GEO_REGION_TYPE_MUNICIPALITY", +"GEO_REGION_TYPE_CITY", +"GEO_REGION_TYPE_POSTAL_CODE", +"GEO_REGION_TYPE_DEPARTMENT", +"GEO_REGION_TYPE_AIRPORT", +"GEO_REGION_TYPE_TV_REGION", +"GEO_REGION_TYPE_OKRUG", +"GEO_REGION_TYPE_BOROUGH", +"GEO_REGION_TYPE_CITY_REGION", +"GEO_REGION_TYPE_ARRONDISSEMENT", +"GEO_REGION_TYPE_NEIGHBORHOOD", +"GEO_REGION_TYPE_UNIVERSITY", +"GEO_REGION_TYPE_DISTRICT", +"GEO_REGION_TYPE_NATIONAL_PARK", +"GEO_REGION_TYPE_BARRIO", +"GEO_REGION_TYPE_SUB_WARD", +"GEO_REGION_TYPE_MUNICIPALITY_DISTRICT", +"GEO_REGION_TYPE_SUB_DISTRICT", +"GEO_REGION_TYPE_QUARTER", +"GEO_REGION_TYPE_DIVISION", +"GEO_REGION_TYPE_COMMUNE", +"GEO_REGION_TYPE_COLLOQUIAL_AREA" +], +"enumDescriptions": [ +"The geographic region type is unknown.", +"The geographic region type is other.", +"The geographic region is a country.", +"The geographic region type is region.", +"The geographic region is a territory.", +"The geographic region is a province.", +"The geographic region is a state.", +"The geographic region is a prefecture.", +"The geographic region is a governorate.", +"The geographic region is a canton.", +"The geographic region is a union territory.", +"The geographic region is an autonomous community.", +"The geographic region is a designated market area (DMA) region.", +"The geographic region type is metro.", +"The geographic region is a congressional district.", +"The geographic region is a county.", +"The geographic region is a municipality.", +"The geographic region is a city.", +"The geographic region targeting type is postal code.", +"The geographic region targeting type is department.", +"The geographic region is an airport.", +"The geographic region is a TV region.", +"The geographic region is an okrug.", +"The geographic region is a borough.", +"The geographic region is a city region.", +"The geographic region is an arrondissement.", +"The geographic region is a neighborhood.", +"The geographic region is a university.", +"The geographic region is a district.", +"The geographic region is a national park.", +"The geographic region is a barrio.", +"The geographic region is a sub ward.", +"The geographic region is a municipality district.", +"The geographic region is a sub district.", +"The geographic region is a quarter.", +"The geographic region is a division.", +"The geographic region is a commune.", +"The geographic region is a colloquial area." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleAudience": { +"description": "Describes a Google audience resource. Includes Google audience lists.", +"id": "GoogleAudience", +"properties": { +"displayName": { +"description": "Output only. The display name of the Google audience. .", +"readOnly": true, +"type": "string" +}, +"googleAudienceId": { +"description": "Output only. The unique ID of the Google audience. Assigned by the system.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"googleAudienceType": { +"description": "Output only. The type of Google audience. .", +"enum": [ +"GOOGLE_AUDIENCE_TYPE_UNSPECIFIED", +"GOOGLE_AUDIENCE_TYPE_AFFINITY", +"GOOGLE_AUDIENCE_TYPE_IN_MARKET", +"GOOGLE_AUDIENCE_TYPE_INSTALLED_APPS", +"GOOGLE_AUDIENCE_TYPE_NEW_MOBILE_DEVICES", +"GOOGLE_AUDIENCE_TYPE_LIFE_EVENT", +"GOOGLE_AUDIENCE_TYPE_EXTENDED_DEMOGRAPHIC" +], +"enumDeprecated": [ +false, +false, +false, +true, +true, +false, +false +], +"enumDescriptions": [ +"Default value when type is not specified or is unknown.", +"Affinity type Google audience.", +"In-Market type Google audience.", +"Installed-Apps type Google audience.", +"New-Mobile-Devices type Google audience.", +"Life-Event type Google audience.", +"Extended-Demographic type Google audience." +], +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Output only. The resource name of the google audience.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleAudienceGroup": { +"description": "Details of Google audience group. All Google audience targeting settings are logically \u2018OR\u2019 of each other.", +"id": "GoogleAudienceGroup", +"properties": { +"settings": { +"description": "Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.", +"items": { +"$ref": "GoogleAudienceTargetingSetting" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleAudienceTargetingSetting": { +"description": "Details of Google audience targeting setting.", +"id": "GoogleAudienceTargetingSetting", +"properties": { +"googleAudienceId": { +"description": "Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"GoogleBytestreamMedia": { +"description": "Media resource.", +"id": "GoogleBytestreamMedia", +"properties": { +"resourceName": { +"description": "Name of the media resource.", +"type": "string" +} +}, +"type": "object" +}, +"GuaranteedOrder": { +"description": "A guaranteed order. Guaranteed orders are parent entity of guaranteed inventory sources. When creating a guaranteed inventory source, a guaranteed order ID must be assigned to the inventory source.", +"id": "GuaranteedOrder", +"properties": { +"defaultAdvertiserId": { +"description": "Output only. The ID of default advertiser of the guaranteed order. The default advertiser is either the read_write_advertiser_id or, if that is not set, the first advertiser listed in read_advertiser_ids. Otherwise, there is no default advertiser.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"defaultCampaignId": { +"description": "The ID of the default campaign that is assigned to the guaranteed order. The default campaign must belong to the default advertiser.", +"format": "int64", +"type": "string" +}, +"displayName": { +"description": "Required. The display name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes.", +"type": "string" +}, +"exchange": { +"description": "Required. Immutable. The exchange where the guaranteed order originated.", +"enum": [ +"EXCHANGE_UNSPECIFIED", +"EXCHANGE_GOOGLE_AD_MANAGER", +"EXCHANGE_APPNEXUS", +"EXCHANGE_BRIGHTROLL", +"EXCHANGE_ADFORM", +"EXCHANGE_ADMETA", +"EXCHANGE_ADMIXER", +"EXCHANGE_ADSMOGO", +"EXCHANGE_ADSWIZZ", +"EXCHANGE_BIDSWITCH", +"EXCHANGE_BRIGHTROLL_DISPLAY", +"EXCHANGE_CADREON", +"EXCHANGE_DAILYMOTION", +"EXCHANGE_FIVE", +"EXCHANGE_FLUCT", +"EXCHANGE_FREEWHEEL", +"EXCHANGE_GENIEE", +"EXCHANGE_GUMGUM", +"EXCHANGE_IMOBILE", +"EXCHANGE_IBILLBOARD", +"EXCHANGE_IMPROVE_DIGITAL", +"EXCHANGE_INDEX", +"EXCHANGE_KARGO", +"EXCHANGE_MICROAD", +"EXCHANGE_MOPUB", +"EXCHANGE_NEND", +"EXCHANGE_ONE_BY_AOL_DISPLAY", +"EXCHANGE_ONE_BY_AOL_MOBILE", +"EXCHANGE_ONE_BY_AOL_VIDEO", +"EXCHANGE_OOYALA", +"EXCHANGE_OPENX", +"EXCHANGE_PERMODO", +"EXCHANGE_PLATFORMONE", +"EXCHANGE_PLATFORMID", +"EXCHANGE_PUBMATIC", +"EXCHANGE_PULSEPOINT", +"EXCHANGE_REVENUEMAX", +"EXCHANGE_RUBICON", +"EXCHANGE_SMARTCLIP", +"EXCHANGE_SMARTRTB", +"EXCHANGE_SMARTSTREAMTV", +"EXCHANGE_SOVRN", +"EXCHANGE_SPOTXCHANGE", +"EXCHANGE_STROER", +"EXCHANGE_TEADSTV", +"EXCHANGE_TELARIA", +"EXCHANGE_TVN", +"EXCHANGE_UNITED", +"EXCHANGE_YIELDLAB", +"EXCHANGE_YIELDMO", +"EXCHANGE_UNRULYX", +"EXCHANGE_OPEN8", +"EXCHANGE_TRITON", +"EXCHANGE_TRIPLELIFT", +"EXCHANGE_TABOOLA", +"EXCHANGE_INMOBI", +"EXCHANGE_SMAATO", +"EXCHANGE_AJA", +"EXCHANGE_SUPERSHIP", +"EXCHANGE_NEXSTAR_DIGITAL", +"EXCHANGE_WAZE", +"EXCHANGE_SOUNDCAST", +"EXCHANGE_SHARETHROUGH", +"EXCHANGE_FYBER", +"EXCHANGE_RED_FOR_PUBLISHERS", +"EXCHANGE_MEDIANET", +"EXCHANGE_TAPJOY", +"EXCHANGE_VISTAR", +"EXCHANGE_DAX", +"EXCHANGE_JCD", +"EXCHANGE_PLACE_EXCHANGE", +"EXCHANGE_APPLOVIN", +"EXCHANGE_CONNATIX", +"EXCHANGE_RESET_DIGITAL", +"EXCHANGE_HIVESTACK", +"EXCHANGE_DRAX", +"EXCHANGE_APPLOVIN_GBID", +"EXCHANGE_FYBER_GBID", +"EXCHANGE_UNITY_GBID", +"EXCHANGE_CHARTBOOST_GBID", +"EXCHANGE_ADMOST_GBID", +"EXCHANGE_TOPON_GBID", +"EXCHANGE_NETFLIX", +"EXCHANGE_CORE", +"EXCHANGE_TUBI" +], +"enumDescriptions": [ +"Exchange is not specified or is unknown in this version.", +"Google Ad Manager.", +"AppNexus.", +"BrightRoll Exchange for Video from Yahoo!.", +"Adform.", +"Admeta.", +"Admixer.", +"AdsMogo.", +"AdsWizz.", +"BidSwitch.", +"BrightRoll Exchange for Display from Yahoo!.", +"Cadreon.", +"Dailymotion.", +"Five.", +"Fluct.", +"FreeWheel SSP.", +"Geniee.", +"GumGum.", +"i-mobile.", +"iBILLBOARD.", +"Improve Digital.", +"Index Exchange.", +"Kargo.", +"MicroAd.", +"MoPub.", +"Nend.", +"ONE by AOL: Display Market Place.", +"ONE by AOL: Mobile.", +"ONE by AOL: Video.", +"Ooyala.", +"OpenX.", +"Permodo.", +"Platform One.", +"PlatformId.", +"PubMatic.", +"PulsePoint.", +"RevenueMax.", +"Rubicon.", +"SmartClip.", +"SmartRTB+.", +"SmartstreamTv.", +"Sovrn.", +"SpotXchange.", +"Str\u00f6er SSP.", +"TeadsTv.", +"Telaria.", +"TVN.", +"United.", +"Yieldlab.", +"Yieldmo.", +"UnrulyX.", +"Open8.", +"Triton.", +"TripleLift.", +"Taboola.", +"InMobi.", +"Smaato.", +"Aja.", +"Supership.", +"Nexstar Digital.", +"Waze.", +"SoundCast.", +"Sharethrough.", +"Fyber.", +"Red For Publishers.", +"Media.net.", +"Tapjoy.", +"Vistar.", +"DAX.", +"JCD.", +"Place Exchange.", +"AppLovin.", +"Connatix.", +"Reset Digital.", +"Hivestack.", +"Drax.", +"AppLovin MAX.", +"DT Fairbid.", +"Unity LevelPlay.", +"Chartboost Mediation.", +"AdMost.", +"TopOn.", +"Netflix.", +"Core.", +"Tubi." +], +"type": "string" +}, +"guaranteedOrderId": { +"description": "Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format `{exchange}-{legacy_guaranteed_order_id}`.", +"readOnly": true, +"type": "string" +}, +"legacyGuaranteedOrderId": { +"description": "Output only. The legacy ID of the guaranteed order. Assigned by the original exchange. The legacy ID is unique within one exchange, but is not guaranteed to be unique across all guaranteed orders. This ID is used in SDF and UI.", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Output only. The resource name of the guaranteed order.", +"readOnly": true, +"type": "string" +}, +"publisherName": { +"description": "Required. The publisher name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes.", +"type": "string" +}, +"readAccessInherited": { +"description": "Whether all advertisers of read_write_partner_id have read access to the guaranteed order. Only applicable if read_write_partner_id is set. If True, overrides read_advertiser_ids.", +"type": "boolean" +}, +"readAdvertiserIds": { +"description": "The IDs of advertisers with read access to the guaranteed order. This field must not include the advertiser assigned to read_write_advertiser_id if it is set. All advertisers in this field must belong to read_write_partner_id or the same partner as read_write_advertiser_id.", +"items": { +"format": "int64", +"type": "string" +}, +"type": "array" +}, +"readWriteAdvertiserId": { +"description": "The advertiser with read/write access to the guaranteed order. This is also the default advertiser of the guaranteed order.", +"format": "int64", +"type": "string" +}, +"readWritePartnerId": { +"description": "The partner with read/write access to the guaranteed order.", +"format": "int64", +"type": "string" +}, +"status": { +"$ref": "GuaranteedOrderStatus", +"description": "The status settings of the guaranteed order." +}, +"updateTime": { +"description": "Output only. The timestamp when the guaranteed order was last updated. Assigned by the system.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GuaranteedOrderStatus": { +"description": "The status settings of the guaranteed order.", +"id": "GuaranteedOrderStatus", +"properties": { +"configStatus": { +"description": "Output only. The configuration status of the guaranteed order. Acceptable values are `PENDING` and `COMPLETED`. A guaranteed order must be configured (fill in the required fields, choose creatives, and select a default campaign) before it can serve. Currently the configuration action can only be performed via UI.", +"enum": [ +"GUARANTEED_ORDER_CONFIG_STATUS_UNSPECIFIED", +"PENDING", +"COMPLETED" +], +"enumDescriptions": [ +"The approval status is not specified or is unknown in this version.", +"The beginning state of a guaranteed order. The guaranteed order in this state needs to be configured before it can serve.", +"The state after the buyer configures a guaranteed order." +], +"readOnly": true, +"type": "string" +}, +"entityPauseReason": { +"description": "The user-provided reason for pausing this guaranteed order. Must be UTF-8 encoded with a maximum length of 100 bytes. Only applicable when entity_status is set to `ENTITY_STATUS_PAUSED`.", +"type": "string" +}, +"entityStatus": { +"description": "Whether or not the guaranteed order is servable. Acceptable values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. Default value is `ENTITY_STATUS_ACTIVE`.", +"enum": [ +"ENTITY_STATUS_UNSPECIFIED", +"ENTITY_STATUS_ACTIVE", +"ENTITY_STATUS_ARCHIVED", +"ENTITY_STATUS_DRAFT", +"ENTITY_STATUS_PAUSED", +"ENTITY_STATUS_SCHEDULED_FOR_DELETION" +], +"enumDescriptions": [ +"Default value when status is not specified or is unknown in this version.", +"The entity is enabled to bid and spend budget.", +"The entity is archived. Bidding and budget spending are disabled. An entity can be deleted after archived. Deleted entities cannot be retrieved.", +"The entity is under draft. Bidding and budget spending are disabled.", +"Bidding and budget spending are paused for the entity.", +"The entity is scheduled for deletion." +], +"type": "string" +} +}, +"type": "object" +}, +"HouseholdIncomeAssignedTargetingOptionDetails": { +"description": "Details for assigned household income targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`.", +"id": "HouseholdIncomeAssignedTargetingOptionDetails", +"properties": { +"householdIncome": { +"description": "Required. The household income of the audience.", +"enum": [ +"HOUSEHOLD_INCOME_UNSPECIFIED", +"HOUSEHOLD_INCOME_UNKNOWN", +"HOUSEHOLD_INCOME_LOWER_50_PERCENT", +"HOUSEHOLD_INCOME_TOP_41_TO_50_PERCENT", +"HOUSEHOLD_INCOME_TOP_31_TO_40_PERCENT", +"HOUSEHOLD_INCOME_TOP_21_TO_30_PERCENT", +"HOUSEHOLD_INCOME_TOP_11_TO_20_PERCENT", +"HOUSEHOLD_INCOME_TOP_10_PERCENT" +], +"enumDescriptions": [ +"Default value when household income is not specified in this version. This enum is a placeholder for default value and does not represent a real household income option.", +"The household income of the audience is unknown.", +"The audience is in the lower 50% of U.S. household incomes.", +"The audience is in the top 41-50% of U.S. household incomes.", +"The audience is in the top 31-40% of U.S. household incomes.", +"The audience is in the top 21-30% of U.S. household incomes.", +"The audience is in the top 11-20% of U.S. household incomes.", +"The audience is in the top 10% of U.S. household incomes." +], +"type": "string" +} +}, +"type": "object" +}, +"HouseholdIncomeTargetingOptionDetails": { +"description": "Represents a targetable household income. This will be populated in the household_income_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`.", +"id": "HouseholdIncomeTargetingOptionDetails", +"properties": { +"householdIncome": { +"description": "Output only. The household income of an audience.", +"enum": [ +"HOUSEHOLD_INCOME_UNSPECIFIED", +"HOUSEHOLD_INCOME_UNKNOWN", +"HOUSEHOLD_INCOME_LOWER_50_PERCENT", +"HOUSEHOLD_INCOME_TOP_41_TO_50_PERCENT", +"HOUSEHOLD_INCOME_TOP_31_TO_40_PERCENT", +"HOUSEHOLD_INCOME_TOP_21_TO_30_PERCENT", +"HOUSEHOLD_INCOME_TOP_11_TO_20_PERCENT", +"HOUSEHOLD_INCOME_TOP_10_PERCENT" +], +"enumDescriptions": [ +"Default value when household income is not specified in this version. This enum is a placeholder for default value and does not represent a real household income option.", +"The household income of the audience is unknown.", +"The audience is in the lower 50% of U.S. household incomes.", +"The audience is in the top 41-50% of U.S. household incomes.", +"The audience is in the top 31-40% of U.S. household incomes.", +"The audience is in the top 21-30% of U.S. household incomes.", +"The audience is in the top 11-20% of U.S. household incomes.", +"The audience is in the top 10% of U.S. household incomes." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"IdFilter": { +"description": "A filtering option that filters entities by their entity IDs.", +"id": "IdFilter", +"properties": { +"adGroupAdIds": { +"description": "YouTube Ads to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest.", +"items": { +"format": "int64", +"type": "string" +}, +"type": "array" +}, +"adGroupIds": { +"description": "YouTube Ad Groups to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest.", +"items": { +"format": "int64", +"type": "string" +}, +"type": "array" +}, +"adGroupQaIds": { +"description": "Optional. YouTube Ad Groups, by ID, to download in QA format. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest.", +"items": { +"format": "int64", +"type": "string" +}, +"type": "array" +}, +"campaignIds": { +"description": "Campaigns to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest.", +"items": { +"format": "int64", +"type": "string" +}, +"type": "array" +}, +"insertionOrderIds": { +"description": "Insertion Orders to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest.", +"items": { +"format": "int64", +"type": "string" +}, +"type": "array" +}, +"lineItemIds": { +"description": "Line Items to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest.", +"items": { +"format": "int64", +"type": "string" +}, +"type": "array" +}, +"lineItemQaIds": { +"description": "Optional. Line Items, by ID, to download in QA format. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest.", +"items": { +"format": "int64", +"type": "string" +}, +"type": "array" +}, +"mediaProductIds": { +"description": "Media Products to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest.", +"items": { +"format": "int64", +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ImageAsset": { +"description": "Meta data of an image asset.", +"id": "ImageAsset", +"properties": { +"fileSize": { +"description": "File size of the image asset in bytes.", +"format": "int64", +"type": "string" +}, +"fullSize": { +"$ref": "Dimensions", +"description": "Metadata for this image at its original size." +}, +"mimeType": { +"description": "MIME type of the image asset.", +"type": "string" +} +}, +"type": "object" +}, +"InStreamAd": { +"description": "Details for an in-stream ad.", +"id": "InStreamAd", +"properties": { +"commonInStreamAttribute": { +"$ref": "CommonInStreamAttribute", +"description": "Common ad attributes." +}, +"customParameters": { +"additionalProperties": { +"type": "string" +}, +"description": "The custom parameters to pass custom values to tracking URL template.", +"type": "object" +} +}, +"type": "object" +}, +"InsertionOrder": { +"description": "A single insertion order.", +"id": "InsertionOrder", +"properties": { +"advertiserId": { +"description": "Output only. The unique ID of the advertiser the insertion order belongs to.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"bidStrategy": { +"$ref": "BiddingStrategy", +"description": "Optional. The bidding strategy of the insertion order. By default, fixed_bid is set." +}, +"budget": { +"$ref": "InsertionOrderBudget", +"description": "Required. The budget allocation settings of the insertion order." +}, +"campaignId": { +"description": "Required. Immutable. The unique ID of the campaign that the insertion order belongs to.", +"format": "int64", +"type": "string" +}, +"displayName": { +"description": "Required. The display name of the insertion order. Must be UTF-8 encoded with a maximum size of 240 bytes.", +"type": "string" +}, +"entityStatus": { +"description": "Required. Controls whether or not the insertion order can spend its budget and bid on inventory. * For CreateInsertionOrder method, only `ENTITY_STATUS_DRAFT` is allowed. To activate an insertion order, use UpdateInsertionOrder method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * An insertion order cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * An insertion order cannot be set to `ENTITY_STATUS_ACTIVE` if its parent campaign is not active.", +"enum": [ +"ENTITY_STATUS_UNSPECIFIED", +"ENTITY_STATUS_ACTIVE", +"ENTITY_STATUS_ARCHIVED", +"ENTITY_STATUS_DRAFT", +"ENTITY_STATUS_PAUSED", +"ENTITY_STATUS_SCHEDULED_FOR_DELETION" +], +"enumDescriptions": [ +"Default value when status is not specified or is unknown in this version.", +"The entity is enabled to bid and spend budget.", +"The entity is archived. Bidding and budget spending are disabled. An entity can be deleted after archived. Deleted entities cannot be retrieved.", +"The entity is under draft. Bidding and budget spending are disabled.", +"Bidding and budget spending are paused for the entity.", +"The entity is scheduled for deletion." +], +"type": "string" +}, +"frequencyCap": { +"$ref": "FrequencyCap", +"description": "Required. The frequency capping setting of the insertion order. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap)" +}, +"insertionOrderId": { +"description": "Output only. The unique ID of the insertion order. Assigned by the system.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"insertionOrderType": { +"description": "Optional. The type of insertion order. If this field is unspecified in creation, the value defaults to `RTB`.", +"enum": [ +"INSERTION_ORDER_TYPE_UNSPECIFIED", +"RTB", +"OVER_THE_TOP" +], +"enumDescriptions": [ +"Insertion order type is not specified or is unknown.", +"Real-time bidding.", +"Over-the-top." +], +"type": "string" +}, +"integrationDetails": { +"$ref": "IntegrationDetails", +"description": "Optional. Additional integration details of the insertion order." +}, +"kpi": { +"$ref": "Kpi", +"description": "Required. The key performance indicator (KPI) of the insertion order. This is represented as referred to as the \"Goal\" in the Display & Video 360 interface." +}, +"name": { +"description": "Output only. The resource name of the insertion order.", +"readOnly": true, +"type": "string" +}, +"optimizationObjective": { +"description": "Optional. Required. The optimization objective of the insertion order.", +"enum": [ +"OPTIMIZATION_OBJECTIVE_UNSPECIFIED", +"CONVERSION", +"CLICK", +"BRAND_AWARENESS", +"CUSTOM", +"NO_OBJECTIVE" +], +"enumDescriptions": [ +"Type value is not specified or is unknown in this version.", +"Prioritize impressions that increase sales and conversions.", +"Prioritize impressions that increase website traffic, apps, app stores.", +"Prioritize impressions of specific quality.", +"Objective is defined by the assigned custom bidding algorithm.", +"Objective is not defined. Any KPI or bidding strategy can be used." +], +"type": "string" +}, +"pacing": { +"$ref": "Pacing", +"description": "Required. The budget spending speed setting of the insertion order. pacing_type `PACING_TYPE_ASAP` is not compatible with pacing_period `PACING_PERIOD_FLIGHT`." +}, +"partnerCosts": { +"description": "Optional. The partner costs associated with the insertion order. If absent or empty in CreateInsertionOrder method, the newly created insertion order will inherit partner costs from the partner settings.", +"items": { +"$ref": "PartnerCost" +}, +"type": "array" +}, +"reservationType": { +"description": "Output only. The reservation type of the insertion order.", +"enum": [ +"RESERVATION_TYPE_UNSPECIFIED", +"RESERVATION_TYPE_NOT_GUARANTEED", +"RESERVATION_TYPE_PROGRAMMATIC_GUARANTEED", +"RESERVATION_TYPE_TAG_GUARANTEED", +"RESERVATION_TYPE_PETRA_VIRAL", +"RESERVATION_TYPE_INSTANT_RESERVE" +], +"enumDescriptions": [ +"Reservation type value is not specified or is unknown in this version.", +"Not created through a guaranteed inventory source.", +"Created through a programmatic guaranteed inventory source.", +"Created through a tag guaranteed inventory source.", +"Created through a Petra inventory source. Only applicable to YouTube and Partners line items.", +"Created with an instant quote. Only applicable to YouTube and partners line items." +], +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. The timestamp when the insertion order was last updated. Assigned by the system.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"InsertionOrderBudget": { +"description": "Settings that control how insertion order budget is allocated.", +"id": "InsertionOrderBudget", +"properties": { +"automationType": { +"description": "Optional. The type of automation used to manage bid and budget for the insertion order. If this field is unspecified in creation, the value defaults to `INSERTION_ORDER_AUTOMATION_TYPE_NONE`.", +"enum": [ +"INSERTION_ORDER_AUTOMATION_TYPE_UNSPECIFIED", +"INSERTION_ORDER_AUTOMATION_TYPE_BUDGET", +"INSERTION_ORDER_AUTOMATION_TYPE_NONE", +"INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET" +], +"enumDescriptions": [ +"Insertion order automation option is not specified or is unknown in this version.", +"Automatic budget allocation. Allow the system to automatically shift budget to owning line items to optimize performance defined by kpi. No automation on bid settings.", +"No automation of bid or budget on insertion order level. Bid and budget must be manually configured at the line item level.", +"Allow the system to automatically adjust bids and shift budget to owning line items to optimize performance defined by kpi." +], +"type": "string" +}, +"budgetSegments": { +"description": "Required. The list of budget segments. Use a budget segment to specify a specific budget for a given period of time an insertion order is running.", +"items": { +"$ref": "InsertionOrderBudgetSegment" +}, +"type": "array" +}, +"budgetUnit": { +"description": "Required. Immutable. The budget unit specifies whether the budget is currency based or impression based.", +"enum": [ +"BUDGET_UNIT_UNSPECIFIED", +"BUDGET_UNIT_CURRENCY", +"BUDGET_UNIT_IMPRESSIONS" +], +"enumDescriptions": [ +"Type value is not specified or is unknown in this version.", +"Budgeting in currency amounts.", +"Budgeting in impression amounts." +], +"type": "string" +} +}, +"type": "object" +}, +"InsertionOrderBudgetSegment": { +"description": "Settings that control the budget of a single budget segment.", +"id": "InsertionOrderBudgetSegment", +"properties": { +"budgetAmountMicros": { +"description": "Required. The budget amount the insertion order will spend for the given date_range. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency.", +"format": "int64", +"type": "string" +}, +"campaignBudgetId": { +"description": "Optional. The budget_id of the campaign budget that this insertion order budget segment is a part of.", +"format": "int64", +"type": "string" +}, +"dateRange": { +"$ref": "DateRange", +"description": "Required. The start and end date settings of the budget segment. They are resolved relative to the parent advertiser's time zone. * When creating a new budget segment, both `start_date` and `end_date` must be in the future. * An existing budget segment with a `start_date` in the past has a mutable `end_date` but an immutable `start_date`. * `end_date` must be the `start_date` or later, both before the year 2037." +}, +"description": { +"description": "Optional. The budget segment description. It can be used to enter Purchase Order information for each budget segment and have that information printed on the invoices. Must be UTF-8 encoded.", +"type": "string" +} +}, +"type": "object" +}, +"IntegralAdScience": { +"description": "Details of Integral Ad Science settings.", +"id": "IntegralAdScience", +"properties": { +"customSegmentId": { +"description": "The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive.", +"items": { +"format": "int64", +"type": "string" +}, +"type": "array" +}, +"displayViewability": { +"description": "Display Viewability section (applicable to display line items only).", +"enum": [ +"PERFORMANCE_VIEWABILITY_UNSPECIFIED", +"PERFORMANCE_VIEWABILITY_40", +"PERFORMANCE_VIEWABILITY_50", +"PERFORMANCE_VIEWABILITY_60", +"PERFORMANCE_VIEWABILITY_70" +], +"enumDescriptions": [ +"This enum is only a placeholder and it doesn't specify any display viewability options.", +"Target 40% Viewability or Higher.", +"Target 50% Viewability or Higher.", +"Target 60% Viewability or Higher.", +"Target 70% Viewability or Higher." +], +"type": "string" +}, +"excludeUnrateable": { +"description": "Brand Safety - **Unrateable**.", +"type": "boolean" +}, +"excludedAdFraudRisk": { +"description": "Ad Fraud settings.", +"enum": [ +"SUSPICIOUS_ACTIVITY_UNSPECIFIED", +"SUSPICIOUS_ACTIVITY_HR", +"SUSPICIOUS_ACTIVITY_HMR" +], +"enumDescriptions": [ +"This enum is only a placeholder and it doesn't specify any ad fraud prevention options.", +"Ad Fraud - Exclude High Risk.", +"Ad Fraud - Exclude High and Moderate Risk." +], +"type": "string" +}, +"excludedAdultRisk": { +"description": "Brand Safety - **Adult content**.", +"enum": [ +"ADULT_UNSPECIFIED", +"ADULT_HR", +"ADULT_HMR" +], +"enumDescriptions": [ +"This enum is only a placeholder and it doesn't specify any adult options.", +"Adult - Exclude High Risk.", +"Adult - Exclude High and Moderate Risk." +], +"type": "string" +}, +"excludedAlcoholRisk": { +"description": "Brand Safety - **Alcohol**.", +"enum": [ +"ALCOHOL_UNSPECIFIED", +"ALCOHOL_HR", +"ALCOHOL_HMR" +], +"enumDescriptions": [ +"This enum is only a placeholder and it doesn't specify any alcohol options.", +"Alcohol - Exclude High Risk.", +"Alcohol - Exclude High and Moderate Risk." +], +"type": "string" +}, +"excludedDrugsRisk": { +"description": "Brand Safety - **Drugs**.", +"enum": [ +"DRUGS_UNSPECIFIED", +"DRUGS_HR", +"DRUGS_HMR" +], +"enumDescriptions": [ +"This enum is only a placeholder and it doesn't specify any drugs options.", +"Drugs - Exclude High Risk.", +"Drugs - Exclude High and Moderate Risk." +], +"type": "string" +}, +"excludedGamblingRisk": { +"description": "Brand Safety - **Gambling**.", +"enum": [ +"GAMBLING_UNSPECIFIED", +"GAMBLING_HR", +"GAMBLING_HMR" +], +"enumDescriptions": [ +"This enum is only a placeholder and it doesn't specify any gambling options.", +"Gambling - Exclude High Risk.", +"Gambling - Exclude High and Moderate Risk." +], +"type": "string" +}, +"excludedHateSpeechRisk": { +"description": "Brand Safety - **Hate speech**.", +"enum": [ +"HATE_SPEECH_UNSPECIFIED", +"HATE_SPEECH_HR", +"HATE_SPEECH_HMR" +], +"enumDescriptions": [ +"This enum is only a placeholder and it doesn't specify any hate speech options.", +"Hate Speech - Exclude High Risk.", +"Hate Speech - Exclude High and Moderate Risk." +], +"type": "string" +}, +"excludedIllegalDownloadsRisk": { +"description": "Brand Safety - **Illegal downloads**.", +"enum": [ +"ILLEGAL_DOWNLOADS_UNSPECIFIED", +"ILLEGAL_DOWNLOADS_HR", +"ILLEGAL_DOWNLOADS_HMR" +], +"enumDescriptions": [ +"This enum is only a placeholder and it doesn't specify any illegal downloads options.", +"Illegal Downloads - Exclude High Risk.", +"Illegal Downloads - Exclude High and Moderate Risk." +], +"type": "string" +}, +"excludedOffensiveLanguageRisk": { +"description": "Brand Safety - **Offensive language**.", +"enum": [ +"OFFENSIVE_LANGUAGE_UNSPECIFIED", +"OFFENSIVE_LANGUAGE_HR", +"OFFENSIVE_LANGUAGE_HMR" +], +"enumDescriptions": [ +"This enum is only a placeholder and it doesn't specify any language options.", +"Offensive Language - Exclude High Risk.", +"Offensive Language - Exclude High and Moderate Risk." +], +"type": "string" +}, +"excludedViolenceRisk": { +"description": "Brand Safety - **Violence**.", +"enum": [ +"VIOLENCE_UNSPECIFIED", +"VIOLENCE_HR", +"VIOLENCE_HMR" +], +"enumDescriptions": [ +"This enum is only a placeholder and it doesn't specify any violence options.", +"Violence - Exclude High Risk.", +"Violence - Exclude High and Moderate Risk." +], +"type": "string" +}, +"qualitySyncCustomSegmentId": { +"description": "Optional. The quality sync custom segment ID provided by Integral Ad Science. The ID must be between `3000000` and `4999999`, inclusive.", +"items": { +"format": "int64", +"type": "string" +}, +"type": "array" +}, +"traqScoreOption": { +"description": "True advertising quality (applicable to Display line items only).", +"enum": [ +"TRAQ_UNSPECIFIED", +"TRAQ_250", +"TRAQ_500", +"TRAQ_600", +"TRAQ_700", +"TRAQ_750", +"TRAQ_875", +"TRAQ_1000" +], +"enumDescriptions": [ +"This enum is only a placeholder and it doesn't specify any true advertising quality scores.", +"TRAQ score 250-1000.", +"TRAQ score 500-1000.", +"TRAQ score 600-1000.", +"TRAQ score 700-1000.", +"TRAQ score 750-1000.", +"TRAQ score 875-1000.", +"TRAQ score 1000." +], +"type": "string" +}, +"videoViewability": { +"description": "Video Viewability Section (applicable to video line items only).", +"enum": [ +"VIDEO_VIEWABILITY_UNSPECIFIED", +"VIDEO_VIEWABILITY_40", +"VIDEO_VIEWABILITY_50", +"VIDEO_VIEWABILITY_60", +"VIDEO_VIEWABILITY_70" +], +"enumDescriptions": [ +"This enum is only a placeholder and it doesn't specify any video viewability options.", +"40%+ in view (IAB video viewability standard).", +"50%+ in view (IAB video viewability standard).", +"60%+ in view (IAB video viewability standard).", +"70%+ in view (IAB video viewability standard)." +], +"type": "string" +} +}, +"type": "object" +}, +"IntegrationDetails": { +"description": "Integration details of an entry.", +"id": "IntegrationDetails", +"properties": { +"details": { +"description": "Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters.", +"type": "string" +}, +"integrationCode": { +"description": "An external identifier to be associated with the entry. The integration code will show up together with the entry in many places in the system, for example, reporting. Must be UTF-8 encoded with a length of no more than 500 characters.", +"type": "string" +} +}, +"type": "object" +}, +"InventorySource": { +"description": "An inventory source.", +"id": "InventorySource", +"properties": { +"commitment": { +"description": "Whether the inventory source has a guaranteed or non-guaranteed delivery.", +"enum": [ +"INVENTORY_SOURCE_COMMITMENT_UNSPECIFIED", +"INVENTORY_SOURCE_COMMITMENT_GUARANTEED", +"INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED" +], +"enumDescriptions": [ +"The commitment is not specified or is unknown in this version.", +"The commitment is guaranteed delivery.", +"The commitment is non-guaranteed delivery." +], +"type": "string" +}, +"creativeConfigs": { +"description": "The creative requirements of the inventory source. Not applicable for auction packages.", +"items": { +"$ref": "CreativeConfig" +}, +"type": "array" +}, +"dealId": { +"description": "The ID in the exchange space that uniquely identifies the inventory source. Must be unique across buyers within each exchange but not necessarily unique across exchanges.", +"type": "string" +}, +"deliveryMethod": { +"description": "The delivery method of the inventory source. * For non-guaranteed inventory sources, the only acceptable value is `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`. * For guaranteed inventory sources, acceptable values are `INVENTORY_SOURCE_DELIVERY_METHOD_TAG` and `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`.", +"enum": [ +"INVENTORY_SOURCE_DELIVERY_METHOD_UNSPECIFIED", +"INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC", +"INVENTORY_SOURCE_DELIVERY_METHOD_TAG" +], +"enumDescriptions": [ +"The delivery method is not specified or is unknown in this version.", +"The delivery method is programmatic.", +"The delivery method is tag." +], +"type": "string" +}, +"displayName": { +"description": "The display name of the inventory source. Must be UTF-8 encoded with a maximum size of 240 bytes.", +"type": "string" +}, +"exchange": { +"description": "The exchange to which the inventory source belongs.", +"enum": [ +"EXCHANGE_UNSPECIFIED", +"EXCHANGE_GOOGLE_AD_MANAGER", +"EXCHANGE_APPNEXUS", +"EXCHANGE_BRIGHTROLL", +"EXCHANGE_ADFORM", +"EXCHANGE_ADMETA", +"EXCHANGE_ADMIXER", +"EXCHANGE_ADSMOGO", +"EXCHANGE_ADSWIZZ", +"EXCHANGE_BIDSWITCH", +"EXCHANGE_BRIGHTROLL_DISPLAY", +"EXCHANGE_CADREON", +"EXCHANGE_DAILYMOTION", +"EXCHANGE_FIVE", +"EXCHANGE_FLUCT", +"EXCHANGE_FREEWHEEL", +"EXCHANGE_GENIEE", +"EXCHANGE_GUMGUM", +"EXCHANGE_IMOBILE", +"EXCHANGE_IBILLBOARD", +"EXCHANGE_IMPROVE_DIGITAL", +"EXCHANGE_INDEX", +"EXCHANGE_KARGO", +"EXCHANGE_MICROAD", +"EXCHANGE_MOPUB", +"EXCHANGE_NEND", +"EXCHANGE_ONE_BY_AOL_DISPLAY", +"EXCHANGE_ONE_BY_AOL_MOBILE", +"EXCHANGE_ONE_BY_AOL_VIDEO", +"EXCHANGE_OOYALA", +"EXCHANGE_OPENX", +"EXCHANGE_PERMODO", +"EXCHANGE_PLATFORMONE", +"EXCHANGE_PLATFORMID", +"EXCHANGE_PUBMATIC", +"EXCHANGE_PULSEPOINT", +"EXCHANGE_REVENUEMAX", +"EXCHANGE_RUBICON", +"EXCHANGE_SMARTCLIP", +"EXCHANGE_SMARTRTB", +"EXCHANGE_SMARTSTREAMTV", +"EXCHANGE_SOVRN", +"EXCHANGE_SPOTXCHANGE", +"EXCHANGE_STROER", +"EXCHANGE_TEADSTV", +"EXCHANGE_TELARIA", +"EXCHANGE_TVN", +"EXCHANGE_UNITED", +"EXCHANGE_YIELDLAB", +"EXCHANGE_YIELDMO", +"EXCHANGE_UNRULYX", +"EXCHANGE_OPEN8", +"EXCHANGE_TRITON", +"EXCHANGE_TRIPLELIFT", +"EXCHANGE_TABOOLA", +"EXCHANGE_INMOBI", +"EXCHANGE_SMAATO", +"EXCHANGE_AJA", +"EXCHANGE_SUPERSHIP", +"EXCHANGE_NEXSTAR_DIGITAL", +"EXCHANGE_WAZE", +"EXCHANGE_SOUNDCAST", +"EXCHANGE_SHARETHROUGH", +"EXCHANGE_FYBER", +"EXCHANGE_RED_FOR_PUBLISHERS", +"EXCHANGE_MEDIANET", +"EXCHANGE_TAPJOY", +"EXCHANGE_VISTAR", +"EXCHANGE_DAX", +"EXCHANGE_JCD", +"EXCHANGE_PLACE_EXCHANGE", +"EXCHANGE_APPLOVIN", +"EXCHANGE_CONNATIX", +"EXCHANGE_RESET_DIGITAL", +"EXCHANGE_HIVESTACK", +"EXCHANGE_DRAX", +"EXCHANGE_APPLOVIN_GBID", +"EXCHANGE_FYBER_GBID", +"EXCHANGE_UNITY_GBID", +"EXCHANGE_CHARTBOOST_GBID", +"EXCHANGE_ADMOST_GBID", +"EXCHANGE_TOPON_GBID", +"EXCHANGE_NETFLIX", +"EXCHANGE_CORE", +"EXCHANGE_TUBI" +], +"enumDescriptions": [ +"Exchange is not specified or is unknown in this version.", +"Google Ad Manager.", +"AppNexus.", +"BrightRoll Exchange for Video from Yahoo!.", +"Adform.", +"Admeta.", +"Admixer.", +"AdsMogo.", +"AdsWizz.", +"BidSwitch.", +"BrightRoll Exchange for Display from Yahoo!.", +"Cadreon.", +"Dailymotion.", +"Five.", +"Fluct.", +"FreeWheel SSP.", +"Geniee.", +"GumGum.", +"i-mobile.", +"iBILLBOARD.", +"Improve Digital.", +"Index Exchange.", +"Kargo.", +"MicroAd.", +"MoPub.", +"Nend.", +"ONE by AOL: Display Market Place.", +"ONE by AOL: Mobile.", +"ONE by AOL: Video.", +"Ooyala.", +"OpenX.", +"Permodo.", +"Platform One.", +"PlatformId.", +"PubMatic.", +"PulsePoint.", +"RevenueMax.", +"Rubicon.", +"SmartClip.", +"SmartRTB+.", +"SmartstreamTv.", +"Sovrn.", +"SpotXchange.", +"Str\u00f6er SSP.", +"TeadsTv.", +"Telaria.", +"TVN.", +"United.", +"Yieldlab.", +"Yieldmo.", +"UnrulyX.", +"Open8.", +"Triton.", +"TripleLift.", +"Taboola.", +"InMobi.", +"Smaato.", +"Aja.", +"Supership.", +"Nexstar Digital.", +"Waze.", +"SoundCast.", +"Sharethrough.", +"Fyber.", +"Red For Publishers.", +"Media.net.", +"Tapjoy.", +"Vistar.", +"DAX.", +"JCD.", +"Place Exchange.", +"AppLovin.", +"Connatix.", +"Reset Digital.", +"Hivestack.", +"Drax.", +"AppLovin MAX.", +"DT Fairbid.", +"Unity LevelPlay.", +"Chartboost Mediation.", +"AdMost.", +"TopOn.", +"Netflix.", +"Core.", +"Tubi." +], +"type": "string" +}, +"guaranteedOrderId": { +"description": "Immutable. The ID of the guaranteed order that this inventory source belongs to. Only applicable when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`.", +"type": "string" +}, +"inventorySourceId": { +"description": "Output only. The unique ID of the inventory source. Assigned by the system.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"inventorySourceProductType": { +"description": "Output only. The product type of the inventory source, denoting the way through which it sells inventory.", +"enum": [ +"INVENTORY_SOURCE_PRODUCT_TYPE_UNSPECIFIED", +"PREFERRED_DEAL", +"PRIVATE_AUCTION", +"PROGRAMMATIC_GUARANTEED", +"TAG_GUARANTEED", +"YOUTUBE_RESERVE", +"INSTANT_RESERVE", +"GUARANTEED_PACKAGE", +"PROGRAMMATIC_TV", +"AUCTION_PACKAGE" +], +"enumDescriptions": [ +"The product type is not specified or is unknown in this version. Modifying inventory sources of this product type are not supported via API.", +"The inventory source sells inventory through Preferred Deal.", +"The inventory source sells inventory through Private Auction.", +"The inventory source sells inventory through Programmatic Guaranteed.", +"The inventory source sells inventory through Tag Guaranteed.", +"The inventory source sells inventory through YouTube Reserve.", +"The inventory source sells inventory through Instant Reserve. Modifying inventory sources of this product type are not supported via API.", +"The inventory source sells inventory through Guaranteed Package. Modifying inventory sources of this product type are not supported via API.", +"The inventory source sells inventory through Programmtic TV. Modifying inventory sources of this product type are not supported via API.", +"The inventory source sells inventory through Auction Package. Modifying inventory sources of this product type are not supported via API." +], +"readOnly": true, +"type": "string" +}, +"inventorySourceType": { +"description": "Denotes the type of the inventory source.", +"enum": [ +"INVENTORY_SOURCE_TYPE_UNSPECIFIED", +"INVENTORY_SOURCE_TYPE_PRIVATE", +"INVENTORY_SOURCE_TYPE_AUCTION_PACKAGE" +], +"enumDescriptions": [ +"The inventory source type is not specified or is unknown in this version.", +"Private inventory source.", +"Auction package." +], +"type": "string" +}, +"name": { +"description": "Output only. The resource name of the inventory source.", +"readOnly": true, +"type": "string" +}, +"publisherName": { +"description": "The publisher/seller name of the inventory source.", +"type": "string" +}, +"rateDetails": { +"$ref": "RateDetails", +"description": "Required. The rate details of the inventory source." +}, +"readAdvertiserIds": { +"description": "Output only. The IDs of advertisers with read-only access to the inventory source.", +"items": { +"format": "int64", +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"readPartnerIds": { +"description": "Output only. The IDs of partners with read-only access to the inventory source. All advertisers of partners in this field inherit read-only access to the inventory source.", +"items": { +"format": "int64", +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"readWriteAccessors": { +"$ref": "InventorySourceAccessors", +"description": "The partner or advertisers that have read/write access to the inventory source. Output only when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`, in which case the read/write accessors are inherited from the parent guaranteed order. Required when commitment is `INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED`. If commitment is `INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED` and a partner is set in this field, all advertisers under this partner will automatically have read-only access to the inventory source. These advertisers will not be included in read_advertiser_ids." +}, +"status": { +"$ref": "InventorySourceStatus", +"description": "The status settings of the inventory source." +}, +"timeRange": { +"$ref": "TimeRange", +"description": "The time range when this inventory source starts and stops serving." +}, +"updateTime": { +"description": "Output only. The timestamp when the inventory source was last updated. Assigned by the system.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"InventorySourceAccessors": { +"description": "The partner or advertisers with access to the inventory source.", +"id": "InventorySourceAccessors", +"properties": { +"advertisers": { +"$ref": "InventorySourceAccessorsAdvertiserAccessors", +"description": "The advertisers with access to the inventory source. All advertisers must belong to the same partner." +}, +"partner": { +"$ref": "InventorySourceAccessorsPartnerAccessor", +"description": "The partner with access to the inventory source." +} +}, +"type": "object" +}, +"InventorySourceAccessorsAdvertiserAccessors": { +"description": "The advertisers with access to the inventory source.", +"id": "InventorySourceAccessorsAdvertiserAccessors", +"properties": { +"advertiserIds": { +"description": "The IDs of the advertisers.", +"items": { +"format": "int64", +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"InventorySourceAccessorsPartnerAccessor": { +"description": "The partner with access to the inventory source.", +"id": "InventorySourceAccessorsPartnerAccessor", +"properties": { +"partnerId": { +"description": "The ID of the partner.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"InventorySourceAssignedTargetingOptionDetails": { +"description": "Targeting details for inventory source. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`.", +"id": "InventorySourceAssignedTargetingOptionDetails", +"properties": { +"inventorySourceId": { +"description": "Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"InventorySourceDisplayCreativeConfig": { +"description": "The configuration for display creatives.", +"id": "InventorySourceDisplayCreativeConfig", +"properties": { +"creativeSize": { +"$ref": "Dimensions", +"description": "The size requirements for display creatives that can be assigned to the inventory source." +} +}, +"type": "object" +}, +"InventorySourceFilter": { +"description": "A filtering option for filtering on Inventory Source entities.", +"id": "InventorySourceFilter", +"properties": { +"inventorySourceIds": { +"description": "Inventory Sources to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. Leave empty to download all Inventory Sources for the selected Advertiser or Partner.", +"items": { +"format": "int64", +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"InventorySourceGroup": { +"description": "A collection of targetable inventory sources.", +"id": "InventorySourceGroup", +"properties": { +"displayName": { +"description": "Required. The display name of the inventory source group. Must be UTF-8 encoded with a maximum size of 240 bytes.", +"type": "string" +}, +"inventorySourceGroupId": { +"description": "Output only. The unique ID of the inventory source group. Assigned by the system.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Output only. The resource name of the inventory source group.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"InventorySourceGroupAssignedTargetingOptionDetails": { +"description": "Targeting details for inventory source group. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`.", +"id": "InventorySourceGroupAssignedTargetingOptionDetails", +"properties": { +"inventorySourceGroupId": { +"description": "Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"InventorySourceStatus": { +"description": "The status related settings of the inventory source.", +"id": "InventorySourceStatus", +"properties": { +"configStatus": { +"description": "Output only. The configuration status of the inventory source. Only applicable for guaranteed inventory sources. Acceptable values are `INVENTORY_SOURCE_CONFIG_STATUS_PENDING` and `INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED`. An inventory source must be configured (fill in the required fields, choose creatives, and select a default campaign) before it can serve.", +"enum": [ +"INVENTORY_SOURCE_CONFIG_STATUS_UNSPECIFIED", +"INVENTORY_SOURCE_CONFIG_STATUS_PENDING", +"INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED" +], +"enumDescriptions": [ +"The approval status is not specified or is unknown in this version.", +"The beginning state of a guaranteed inventory source. The inventory source in this state needs to be configured.", +"The state after the buyer configures a guaranteed inventory source." +], +"readOnly": true, +"type": "string" +}, +"entityPauseReason": { +"description": "The user-provided reason for pausing this inventory source. Must not exceed 100 characters. Only applicable when entity_status is set to `ENTITY_STATUS_PAUSED`.", +"type": "string" +}, +"entityStatus": { +"description": "Whether or not the inventory source is servable. Acceptable values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. Default value is `ENTITY_STATUS_ACTIVE`.", +"enum": [ +"ENTITY_STATUS_UNSPECIFIED", +"ENTITY_STATUS_ACTIVE", +"ENTITY_STATUS_ARCHIVED", +"ENTITY_STATUS_DRAFT", +"ENTITY_STATUS_PAUSED", +"ENTITY_STATUS_SCHEDULED_FOR_DELETION" +], +"enumDescriptions": [ +"Default value when status is not specified or is unknown in this version.", +"The entity is enabled to bid and spend budget.", +"The entity is archived. Bidding and budget spending are disabled. An entity can be deleted after archived. Deleted entities cannot be retrieved.", +"The entity is under draft. Bidding and budget spending are disabled.", +"Bidding and budget spending are paused for the entity.", +"The entity is scheduled for deletion." +], +"type": "string" +}, +"sellerPauseReason": { +"description": "Output only. The seller-provided reason for pausing this inventory source. Only applicable for inventory sources synced directly from the publishers and when seller_status is set to `ENTITY_STATUS_PAUSED`.", +"readOnly": true, +"type": "string" +}, +"sellerStatus": { +"description": "Output only. The status set by the seller for the inventory source. Only applicable for inventory sources synced directly from the publishers. Acceptable values are `ENTITY_STATUS_ACTIVE` and `ENTITY_STATUS_PAUSED`.", +"enum": [ +"ENTITY_STATUS_UNSPECIFIED", +"ENTITY_STATUS_ACTIVE", +"ENTITY_STATUS_ARCHIVED", +"ENTITY_STATUS_DRAFT", +"ENTITY_STATUS_PAUSED", +"ENTITY_STATUS_SCHEDULED_FOR_DELETION" +], +"enumDescriptions": [ +"Default value when status is not specified or is unknown in this version.", +"The entity is enabled to bid and spend budget.", +"The entity is archived. Bidding and budget spending are disabled. An entity can be deleted after archived. Deleted entities cannot be retrieved.", +"The entity is under draft. Bidding and budget spending are disabled.", +"Bidding and budget spending are paused for the entity.", +"The entity is scheduled for deletion." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"InventorySourceVideoCreativeConfig": { +"description": "The configuration for video creatives.", +"id": "InventorySourceVideoCreativeConfig", +"properties": { +"duration": { +"description": "The duration requirements for the video creatives that can be assigned to the inventory source.", +"format": "google-duration", +"type": "string" +} +}, +"type": "object" +}, +"Invoice": { +"description": "A single invoice.", +"id": "Invoice", +"properties": { +"budgetInvoiceGroupingId": { +"description": "The budget grouping ID for this invoice. This field will only be set if the invoice level of the corresponding billing profile was set to \"Budget invoice grouping ID\".", +"type": "string" +}, +"budgetSummaries": { +"description": "The list of summarized information for each budget associated with this invoice. This field will only be set if the invoice detail level of the corresponding billing profile was set to \"Budget level PO\".", +"items": { +"$ref": "BudgetSummary" +}, +"type": "array" +}, +"correctedInvoiceId": { +"description": "The ID of the original invoice being adjusted by this invoice, if applicable. May appear on the invoice PDF as `Reference invoice number`. If replaced_invoice_ids is set, this field will be empty.", +"type": "string" +}, +"currencyCode": { +"description": "The currency used in the invoice in ISO 4217 format.", +"type": "string" +}, +"displayName": { +"description": "The display name of the invoice.", +"type": "string" +}, +"dueDate": { +"$ref": "Date", +"description": "The date when the invoice is due." +}, +"invoiceId": { +"description": "The unique ID of the invoice.", +"type": "string" +}, +"invoiceType": { +"description": "The type of invoice document.", +"enum": [ +"INVOICE_TYPE_UNSPECIFIED", +"INVOICE_TYPE_CREDIT", +"INVOICE_TYPE_INVOICE" +], +"enumDescriptions": [ +"Not specified or is unknown in this version.", +"The invoice has a negative amount.", +"The invoice has a positive amount." +], +"type": "string" +}, +"issueDate": { +"$ref": "Date", +"description": "The date when the invoice was issued." +}, +"name": { +"description": "The resource name of the invoice.", +"type": "string" +}, +"nonBudgetMicros": { +"description": "The total amount of costs or adjustments not tied to a particular budget, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar.", +"format": "int64", +"type": "string" +}, +"paymentsAccountId": { +"description": "The ID of the payments account the invoice belongs to. Appears on the invoice PDF as `Billing Account Number`.", +"type": "string" +}, +"paymentsProfileId": { +"description": "The ID of the payments profile the invoice belongs to. Appears on the invoice PDF as `Billing ID`.", +"type": "string" +}, +"pdfUrl": { +"description": "The URL to download a PDF copy of the invoice. This URL is user specific and requires a valid OAuth 2.0 access token to access. The access token must be provided in an `Authorization: Bearer` HTTP header and be authorized for one of the following scopes: * `https://www.googleapis.com/auth/display-video-mediaplanning` * `https://www.googleapis.com/auth/display-video` The URL will be valid for 7 days after retrieval of this invoice object or until this invoice is retrieved again.", +"type": "string" +}, +"purchaseOrderNumber": { +"description": "Purchase order number associated with the invoice.", +"type": "string" +}, +"replacedInvoiceIds": { +"description": "The ID(s) of any originally issued invoice that is being cancelled by this invoice, if applicable. Multiple invoices may be listed if those invoices are being consolidated into a single invoice. May appear on invoice PDF as `Replaced invoice numbers`. If corrected_invoice_id is set, this field will be empty.", +"items": { +"type": "string" +}, +"type": "array" +}, +"serviceDateRange": { +"$ref": "DateRange", +"description": "The service start and end dates which are covered by this invoice." +}, +"subtotalAmountMicros": { +"description": "The pre-tax subtotal amount, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar.", +"format": "int64", +"type": "string" +}, +"totalAmountMicros": { +"description": "The invoice total amount, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar.", +"format": "int64", +"type": "string" +}, +"totalTaxAmountMicros": { +"description": "The sum of all taxes in invoice, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"KeywordAssignedTargetingOptionDetails": { +"description": "Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`.", +"id": "KeywordAssignedTargetingOptionDetails", +"properties": { +"keyword": { +"description": "Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10.", +"type": "string" +}, +"negative": { +"description": "Indicates if this option is being negatively targeted.", +"type": "boolean" +} +}, +"type": "object" +}, +"Kpi": { +"description": "Settings that control the key performance indicator, or KPI, of an insertion order.", +"id": "Kpi", +"properties": { +"kpiAlgorithmId": { +"description": "Optional. Custom Bidding Algorithm ID associated with KPI_CUSTOM_IMPRESSION_VALUE_OVER_COST. This field is ignored if the proper KPI is not selected.", +"format": "int64", +"type": "string" +}, +"kpiAmountMicros": { +"description": "The goal amount, in micros of the advertiser's currency. Applicable when kpi_type is one of: * `KPI_TYPE_CPM` * `KPI_TYPE_CPC` * `KPI_TYPE_CPA` * `KPI_TYPE_CPIAVC` * `KPI_TYPE_VCPM` For example: 1500000 represents 1.5 standard units of the currency.", +"format": "int64", +"type": "string" +}, +"kpiPercentageMicros": { +"description": "The decimal representation of the goal percentage in micros. Applicable when kpi_type is one of: * `KPI_TYPE_CTR` * `KPI_TYPE_VIEWABILITY` * `KPI_TYPE_CLICK_CVR` * `KPI_TYPE_IMPRESSION_CVR` * `KPI_TYPE_VTR` * `KPI_TYPE_AUDIO_COMPLETION_RATE` * `KPI_TYPE_VIDEO_COMPLETION_RATE` For example: 70000 represents 7% (decimal 0.07).", +"format": "int64", +"type": "string" +}, +"kpiString": { +"description": "A KPI string, which can be empty. Must be UTF-8 encoded with a length of no more than 100 characters. Applicable when kpi_type is `KPI_TYPE_OTHER`.", +"type": "string" +}, +"kpiType": { +"description": "Required. The type of KPI.", +"enum": [ +"KPI_TYPE_UNSPECIFIED", +"KPI_TYPE_CPM", +"KPI_TYPE_CPC", +"KPI_TYPE_CPA", +"KPI_TYPE_CTR", +"KPI_TYPE_VIEWABILITY", +"KPI_TYPE_CPIAVC", +"KPI_TYPE_CPE", +"KPI_TYPE_CPV", +"KPI_TYPE_CLICK_CVR", +"KPI_TYPE_IMPRESSION_CVR", +"KPI_TYPE_VCPM", +"KPI_TYPE_VTR", +"KPI_TYPE_AUDIO_COMPLETION_RATE", +"KPI_TYPE_VIDEO_COMPLETION_RATE", +"KPI_TYPE_CPCL", +"KPI_TYPE_CPCV", +"KPI_TYPE_TOS10", +"KPI_TYPE_MAXIMIZE_PACING", +"KPI_TYPE_CUSTOM_IMPRESSION_VALUE_OVER_COST", +"KPI_TYPE_OTHER" +], +"enumDescriptions": [ +"KPI type is not specified or is unknown in this version.", +"The KPI is CPM (cost per mille).", +"The KPI is CPC (cost per click).", +"The KPI is CPA (cost per action).", +"The KPI is CTR (click-through rate) percentage.", +"The KPI is Viewability percentage.", +"The KPI is CPIAVC (cost per impression audible and visible at completion).", +"The KPI is CPE (cost per engagement).", +"The KPI is set in CPV (cost per view).", +"The KPI is click conversion rate (conversions per click) percentage.", +"The KPI is impression conversion rate (conversions per impression) percentage.", +"The KPI is VCPM (cost per thousand viewable impressions).", +"The KPI is YouTube view rate (YouTube views per impression) percentage.", +"The KPI is audio completion rate (complete audio listens per impression) percentage.", +"The KPI is video completion rate (complete video views per impression) percentage.", +"The KPI is set in CPCL (cost per complete audio listen).", +"The KPI is set in CPCV (cost per complete video view).", +"The KPI is set in rate of time on screen 10+ seconds (Percentage of measurable, non-skippable impressions that were on the screen for at least 10 seconds).", +"The KPI is set to maximize brand impact while prioritizing spending the full budget.", +"The KPI is set in custom impression value divided by cost.", +"The KPI is some other value." +], +"type": "string" +} +}, +"type": "object" +}, +"LanguageAssignedTargetingOptionDetails": { +"description": "Details for assigned language targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_LANGUAGE`.", +"id": "LanguageAssignedTargetingOptionDetails", +"properties": { +"displayName": { +"description": "Output only. The display name of the language (e.g., \"French\").", +"readOnly": true, +"type": "string" +}, +"negative": { +"description": "Indicates if this option is being negatively targeted. All assigned language targeting options on the same resource must have the same value for this field.", +"type": "boolean" +}, +"targetingOptionId": { +"description": "Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_LANGUAGE`.", +"type": "string" +} +}, +"type": "object" +}, +"LanguageTargetingOptionDetails": { +"description": "Represents a targetable language. This will be populated in the language_details field when targeting_type is `TARGETING_TYPE_LANGUAGE`.", +"id": "LanguageTargetingOptionDetails", +"properties": { +"displayName": { +"description": "Output only. The display name of the language (e.g., \"French\").", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"LineItem": { +"description": "A single line item.", +"id": "LineItem", +"properties": { +"advertiserId": { +"description": "Output only. The unique ID of the advertiser the line item belongs to.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"bidStrategy": { +"$ref": "BiddingStrategy", +"description": "Required. The bidding strategy of the line item." +}, +"budget": { +"$ref": "LineItemBudget", +"description": "Required. The budget allocation setting of the line item." +}, +"campaignId": { +"description": "Output only. The unique ID of the campaign that the line item belongs to.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"conversionCounting": { +"$ref": "ConversionCountingConfig", +"description": "The conversion tracking setting of the line item. *Warning*: Starting **April 1, 2025**, the floodlight_activity_configs field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight)." +}, +"creativeIds": { +"description": "The IDs of the creatives associated with the line item.", +"items": { +"format": "int64", +"type": "string" +}, +"type": "array" +}, +"displayName": { +"description": "Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes.", +"type": "string" +}, +"entityStatus": { +"description": "Required. Controls whether or not the line item can spend its budget and bid on inventory. * For CreateLineItem method, only `ENTITY_STATUS_DRAFT` is allowed. To activate a line item, use UpdateLineItem method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * A line item cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * If the line item's parent insertion order is not active, the line item can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.", +"enum": [ +"ENTITY_STATUS_UNSPECIFIED", +"ENTITY_STATUS_ACTIVE", +"ENTITY_STATUS_ARCHIVED", +"ENTITY_STATUS_DRAFT", +"ENTITY_STATUS_PAUSED", +"ENTITY_STATUS_SCHEDULED_FOR_DELETION" +], +"enumDescriptions": [ +"Default value when status is not specified or is unknown in this version.", +"The entity is enabled to bid and spend budget.", +"The entity is archived. Bidding and budget spending are disabled. An entity can be deleted after archived. Deleted entities cannot be retrieved.", +"The entity is under draft. Bidding and budget spending are disabled.", +"Bidding and budget spending are paused for the entity.", +"The entity is scheduled for deletion." +], +"type": "string" +}, +"excludeNewExchanges": { +"description": "Whether to exclude new exchanges from automatically being targeted by the line item. This field is false by default.", +"type": "boolean" +}, +"flight": { +"$ref": "LineItemFlight", +"description": "Required. The start and end time of the line item's flight." +}, +"frequencyCap": { +"$ref": "FrequencyCap", +"description": "Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap)" +}, +"insertionOrderId": { +"description": "Required. Immutable. The unique ID of the insertion order that the line item belongs to.", +"format": "int64", +"type": "string" +}, +"integrationDetails": { +"$ref": "IntegrationDetails", +"description": "Integration details of the line item." +}, +"lineItemId": { +"description": "Output only. The unique ID of the line item. Assigned by the system.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"lineItemType": { +"description": "Required. Immutable. The type of the line item.", +"enum": [ +"LINE_ITEM_TYPE_UNSPECIFIED", +"LINE_ITEM_TYPE_DISPLAY_DEFAULT", +"LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INSTALL", +"LINE_ITEM_TYPE_VIDEO_DEFAULT", +"LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL", +"LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INVENTORY", +"LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INVENTORY", +"LINE_ITEM_TYPE_AUDIO_DEFAULT", +"LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP", +"LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_ACTION", +"LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE", +"LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE", +"LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_AUDIO", +"LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_REACH", +"LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_SIMPLE", +"LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE_OVER_THE_TOP", +"LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_REACH_OVER_THE_TOP", +"LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_SIMPLE_OVER_THE_TOP", +"LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_TARGET_FREQUENCY", +"LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIEW", +"LINE_ITEM_TYPE_DISPLAY_OUT_OF_HOME", +"LINE_ITEM_TYPE_VIDEO_OUT_OF_HOME" +], +"enumDescriptions": [ +"Type value is not specified or is unknown in this version. Line items of this type and their targeting cannot be created or updated using the API.", +"Image, HTML5, native, or rich media ads.", +"Display ads that drive installs of an app.", +"Video ads sold on a CPM basis for a variety of environments.", +"Video ads that drive installs of an app.", +"Display ads served on mobile app inventory. Line items of this type and their targeting cannot be created or updated using the API.", +"Video ads served on mobile app inventory. Line items of this type and their targeting cannot be created or updated using the API.", +"RTB Audio ads sold for a variety of environments.", +"Over-the-top ads present in OTT insertion orders. This type is only applicable to line items with an insertion order of insertion_order_type `OVER_THE_TOP`.", +"YouTube video ads that promote conversions. Line items of this type and their targeting cannot be created or updated using the API.", +"YouTube video ads (up to 15 seconds) that cannot be skipped. Line items of this type and their targeting cannot be created or updated using the API.", +"YouTube video ads that show a story in a particular sequence using a mix of formats. Line items of this type and their targeting cannot be created or updated using the API.", +"YouTube audio ads. Line items of this type and their targeting cannot be created or updated using the API.", +"YouTube video ads that optimize reaching more unique users at lower cost. May include bumper ads, skippable in-stream ads, or a mix of types. Line items of this type and their targeting cannot be created or updated using the API.", +"Default YouTube video ads. Line items of this type and their targeting cannot be created or updated using the API.", +"Connected TV youTube video ads (up to 15 seconds) that cannot be skipped. Line items of this type and their targeting cannot be created or updated using the API.", +"Connected TV youTube video ads that optimize reaching more unique users at lower cost. May include bumper ads, skippable in-stream ads, or a mix of types. Line items of this type and their targeting cannot be created or updated using the API.", +"Connected TV default YouTube video ads. Only include in-stream ad-format. Line items of this type and their targeting cannot be created or updated using the API.", +"The goal of this line item type is to show the YouTube ads target number of times to the same person in a certain period of time. Line items of this type and their targeting cannot be created or updated using the API.", +"YouTube video ads that aim to get more views with a variety of ad formats. Line items of this type and their targeting cannot be created or updated using the API.", +"Display ads served on digital-out-of-home inventory. Line items of this type and their targeting cannot be created or updated using the API.", +"Video ads served on digital-out-of-home inventory. Line items of this type and their targeting cannot be created or updated using the API." +], +"type": "string" +}, +"mobileApp": { +"$ref": "MobileApp", +"description": "The mobile app promoted by the line item. This is applicable only when line_item_type is either `LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INSTALL` or `LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL`." +}, +"name": { +"description": "Output only. The resource name of the line item.", +"readOnly": true, +"type": "string" +}, +"pacing": { +"$ref": "Pacing", +"description": "Required. The budget spending speed setting of the line item." +}, +"partnerCosts": { +"description": "The partner costs associated with the line item. If absent or empty in CreateLineItem method, the newly created line item will inherit partner costs from its parent insertion order.", +"items": { +"$ref": "PartnerCost" +}, +"type": "array" +}, +"partnerRevenueModel": { +"$ref": "PartnerRevenueModel", +"description": "Required. The partner revenue model setting of the line item." +}, +"reservationType": { +"description": "Output only. The reservation type of the line item.", +"enum": [ +"RESERVATION_TYPE_UNSPECIFIED", +"RESERVATION_TYPE_NOT_GUARANTEED", +"RESERVATION_TYPE_PROGRAMMATIC_GUARANTEED", +"RESERVATION_TYPE_TAG_GUARANTEED", +"RESERVATION_TYPE_PETRA_VIRAL", +"RESERVATION_TYPE_INSTANT_RESERVE" +], +"enumDescriptions": [ +"Reservation type value is not specified or is unknown in this version.", +"Not created through a guaranteed inventory source.", +"Created through a programmatic guaranteed inventory source.", +"Created through a tag guaranteed inventory source.", +"Created through a Petra inventory source. Only applicable to YouTube and Partners line items.", +"Created with an instant quote. Only applicable to YouTube and partners line items." +], +"readOnly": true, +"type": "string" +}, +"targetingExpansion": { +"$ref": "TargetingExpansionConfig", +"description": "The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists." +}, +"updateTime": { +"description": "Output only. The timestamp when the line item was last updated. Assigned by the system.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"warningMessages": { +"description": "Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running.", +"items": { +"enum": [ +"LINE_ITEM_WARNING_MESSAGE_UNSPECIFIED", +"INVALID_FLIGHT_DATES", +"EXPIRED", +"PENDING_FLIGHT", +"ALL_PARTNER_ENABLED_EXCHANGES_NEGATIVELY_TARGETED", +"INVALID_INVENTORY_SOURCE", +"APP_INVENTORY_INVALID_SITE_TARGETING", +"APP_INVENTORY_INVALID_AUDIENCE_LISTS", +"NO_VALID_CREATIVE", +"PARENT_INSERTION_ORDER_PAUSED", +"PARENT_INSERTION_ORDER_EXPIRED" +], +"enumDescriptions": [ +"Not specified or is unknown.", +"This line item has invalid flight dates. The line item will not run.", +"This line item's end date is in the past.", +"This line item will begin running in the future.", +"All partner enabled exchanges are negatively targeted. The line item will not run.", +"No active inventory sources are being targeted. The line item will not run.", +"This line item's Apps & URLs targeting doesn't include any mobile apps. This line item's type requires you to include mobile apps in your channel, sitelist, or apps targeting. The line item will not run.", +"This line item isn't targeting any mobile users. This line item's type requires you to target a user list with mobile users. The line item will not run.", +"This line item does not contain any valid creative. The line item will not run.", +"The insertion order of this line item is paused. The line item will not run.", +"The insertion order of this line item has its end date set in the past. The line item will not run." +], +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"youtubeAndPartnersSettings": { +"$ref": "YoutubeAndPartnersSettings", +"description": "Output only. Settings specific to YouTube and Partners line items.", +"readOnly": true +} +}, +"type": "object" +}, +"LineItemAssignedTargetingOption": { +"description": "Wrapper object associating an assigned_targeting_option resource and the line item it is assigned to.", +"id": "LineItemAssignedTargetingOption", +"properties": { +"assignedTargetingOption": { +"$ref": "AssignedTargetingOption", +"description": "The assigned targeting option resource." +}, +"lineItemId": { +"description": "The ID of the line item the assigned targeting option is assigned to.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"LineItemBudget": { +"description": "Settings that control how budget is allocated.", +"id": "LineItemBudget", +"properties": { +"budgetAllocationType": { +"description": "Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order.", +"enum": [ +"LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNSPECIFIED", +"LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC", +"LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED", +"LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED" +], +"enumDescriptions": [ +"Type value is not specified or is unknown in this version.", +"Automatic budget allocation is enabled for the line item.", +"A fixed max budget amount is allocated for the line item.", +"No budget limit is applied to the line item." +], +"type": "string" +}, +"budgetUnit": { +"description": "Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order.", +"enum": [ +"BUDGET_UNIT_UNSPECIFIED", +"BUDGET_UNIT_CURRENCY", +"BUDGET_UNIT_IMPRESSIONS" +], +"enumDescriptions": [ +"Type value is not specified or is unknown in this version.", +"Budgeting in currency amounts.", +"Budgeting in impression amounts." +], +"readOnly": true, +"type": "string" +}, +"maxAmount": { +"description": "The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"LineItemFlight": { +"description": "Settings that control the active duration of a line item.", +"id": "LineItemFlight", +"properties": { +"dateRange": { +"$ref": "DateRange", +"description": "The flight start and end dates of the line item. They are resolved relative to the parent advertiser's time zone. * Required when flight_date_type is `LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM`. Output only otherwise. * When creating a new flight, both `start_date` and `end_date` must be in the future. * An existing flight with a `start_date` in the past has a mutable `end_date` but an immutable `start_date`. * `end_date` must be the `start_date` or later, both before the year 2037." +}, +"flightDateType": { +"description": "Required. The type of the line item's flight dates.", +"enum": [ +"LINE_ITEM_FLIGHT_DATE_TYPE_UNSPECIFIED", +"LINE_ITEM_FLIGHT_DATE_TYPE_INHERITED", +"LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM" +], +"enumDescriptions": [ +"Type value is not specified or is unknown in this version.", +"The line item's flight dates are inherited from its parent insertion order.", +"The line item uses its own custom flight dates." +], +"type": "string" +} +}, +"type": "object" +}, +"ListAdGroupAdsResponse": { +"id": "ListAdGroupAdsResponse", +"properties": { +"adGroupAds": { +"description": "The list of ad group ads. This list will be absent if empty.", +"items": { +"$ref": "AdGroupAd" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListAdGroupAds` method to retrieve the next page of results.", +"type": "string" +} +}, +"type": "object" +}, +"ListAdGroupAssignedTargetingOptionsResponse": { +"description": "Response message for ListAdGroupAssignedTargetingOptions.", +"id": "ListAdGroupAssignedTargetingOptionsResponse", +"properties": { +"assignedTargetingOptions": { +"description": "The list of assigned targeting options. This list will be absent if empty.", +"items": { +"$ref": "AssignedTargetingOption" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token identifying the next page of results. This value should be specified as the pageToken in a subsequent ListAdGroupAssignedTargetingOptionsRequest to fetch the next page of results. This token will be absent if there are no more AssignedTargetingOption resources to return.", +"type": "string" +} +}, +"type": "object" +}, +"ListAdGroupsResponse": { +"id": "ListAdGroupsResponse", +"properties": { +"adGroups": { +"description": "The list of ad groups. This list will be absent if empty.", +"items": { +"$ref": "AdGroup" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListAdGroups` method to retrieve the next page of results.", +"type": "string" +} +}, +"type": "object" +}, +"ListAdvertiserAssignedTargetingOptionsResponse": { +"description": "Response message for ListAdvertiserAssignedTargetingOptions.", +"id": "ListAdvertiserAssignedTargetingOptionsResponse", +"properties": { +"assignedTargetingOptions": { +"description": "The list of assigned targeting options. This list will be absent if empty.", +"items": { +"$ref": "AssignedTargetingOption" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token identifying the next page of results. This value should be specified as the pageToken in a subsequent ListAdvertiserAssignedTargetingOptionsRequest to fetch the next page of results. This token will be absent if there are no more assigned_targeting_options to return.", +"type": "string" +} +}, +"type": "object" +}, +"ListAdvertisersResponse": { +"id": "ListAdvertisersResponse", +"properties": { +"advertisers": { +"description": "The list of advertisers. This list will be absent if empty.", +"items": { +"$ref": "Advertiser" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListAdvertisers` method to retrieve the next page of results.", +"type": "string" +} +}, +"type": "object" +}, +"ListAssignedInventorySourcesResponse": { +"description": "Response message for AssignedInventorySourceService.ListAssignedInventorySources.", +"id": "ListAssignedInventorySourcesResponse", +"properties": { +"assignedInventorySources": { +"description": "The list of assigned inventory sources. This list will be absent if empty.", +"items": { +"$ref": "AssignedInventorySource" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListAssignedInventorySources` method to retrieve the next page of results.", +"type": "string" +} +}, +"type": "object" +}, +"ListAssignedLocationsResponse": { +"description": "Response message for AssignedLocationService.ListAssignedLocations.", +"id": "ListAssignedLocationsResponse", +"properties": { +"assignedLocations": { +"description": "The list of assigned locations. This list will be absent if empty.", +"items": { +"$ref": "AssignedLocation" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListAssignedLocations` method to retrieve the next page of results.", +"type": "string" +} +}, +"type": "object" +}, +"ListCampaignsResponse": { +"id": "ListCampaignsResponse", +"properties": { +"campaigns": { +"description": "The list of campaigns. This list will be absent if empty.", +"items": { +"$ref": "Campaign" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListCampaigns` method to retrieve the next page of results.", +"type": "string" +} +}, +"type": "object" +}, +"ListChannelsResponse": { +"id": "ListChannelsResponse", +"properties": { +"channels": { +"description": "The list of channels. This list will be absent if empty.", +"items": { +"$ref": "Channel" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListChannels` method to retrieve the next page of results.", +"type": "string" +} +}, +"type": "object" +}, +"ListCombinedAudiencesResponse": { +"id": "ListCombinedAudiencesResponse", +"properties": { +"combinedAudiences": { +"description": "The list of combined audiences. This list will be absent if empty.", +"items": { +"$ref": "CombinedAudience" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListCombinedAudiences` method to retrieve the next page of results.", +"type": "string" +} +}, +"type": "object" +}, +"ListCreativesResponse": { +"id": "ListCreativesResponse", +"properties": { +"creatives": { +"description": "The list of creatives. This list will be absent if empty.", +"items": { +"$ref": "Creative" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListCreativesRequest` method to retrieve the next page of results. If this field is null, it means this is the last page.", +"type": "string" +} +}, +"type": "object" +}, +"ListCustomBiddingAlgorithmRulesResponse": { +"id": "ListCustomBiddingAlgorithmRulesResponse", +"properties": { +"customBiddingRules": { +"description": "The list of CustomBiddingAlgorithmRules resources. This list will be absent if empty.", +"items": { +"$ref": "CustomBiddingAlgorithmRules" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListCustomBiddingAlgorithmRulesRequest` method to retrieve the next page of results. If this field is null, it means this is the last page.", +"type": "string" +} +}, +"type": "object" +}, +"ListCustomBiddingAlgorithmsResponse": { +"id": "ListCustomBiddingAlgorithmsResponse", +"properties": { +"customBiddingAlgorithms": { +"description": "The list of custom bidding algorithms. This list will be absent if empty.", +"items": { +"$ref": "CustomBiddingAlgorithm" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListCustomBiddingAlgorithmsRequest` method to retrieve the next page of results. If this field is null, it means this is the last page.", +"type": "string" +} +}, +"type": "object" +}, +"ListCustomBiddingScriptsResponse": { +"id": "ListCustomBiddingScriptsResponse", +"properties": { +"customBiddingScripts": { +"description": "The list of custom bidding scripts. This list will be absent if empty.", +"items": { +"$ref": "CustomBiddingScript" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListCustomBiddingScriptsRequest` method to retrieve the next page of results. If this field is null, it means this is the last page.", +"type": "string" +} +}, +"type": "object" +}, +"ListCustomListsResponse": { +"id": "ListCustomListsResponse", +"properties": { +"customLists": { +"description": "The list of custom lists. This list will be absent if empty.", +"items": { +"$ref": "CustomList" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListCustomLists` method to retrieve the next page of results.", +"type": "string" +} +}, +"type": "object" +}, +"ListFirstPartyAndPartnerAudiencesResponse": { +"id": "ListFirstPartyAndPartnerAudiencesResponse", +"properties": { +"firstPartyAndPartnerAudiences": { +"description": "The list of first party and partner audiences. Audience size properties will not be included. This list will be absent if empty.", +"items": { +"$ref": "FirstPartyAndPartnerAudience" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListFirstPartyAndPartnerAudiences` method to retrieve the next page of results.", +"type": "string" +} +}, +"type": "object" +}, +"ListFloodlightActivitiesResponse": { +"id": "ListFloodlightActivitiesResponse", +"properties": { +"floodlightActivities": { +"description": "The list of Floodlight activities. This list will be absent if empty.", +"items": { +"$ref": "FloodlightActivity" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListFloodlightActivities` method to retrieve the next page of results.", +"type": "string" +} +}, +"type": "object" +}, +"ListGoogleAudiencesResponse": { +"id": "ListGoogleAudiencesResponse", +"properties": { +"googleAudiences": { +"description": "The list of Google audiences. This list will be absent if empty.", +"items": { +"$ref": "GoogleAudience" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListGoogleAudiences` method to retrieve the next page of results.", +"type": "string" +} +}, +"type": "object" +}, +"ListGuaranteedOrdersResponse": { +"id": "ListGuaranteedOrdersResponse", +"properties": { +"guaranteedOrders": { +"description": "The list of guaranteed orders. This list will be absent if empty.", +"items": { +"$ref": "GuaranteedOrder" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListGuaranteedOrders` method to retrieve the next page of results.", +"type": "string" +} +}, +"type": "object" +}, +"ListInsertionOrdersResponse": { +"id": "ListInsertionOrdersResponse", +"properties": { +"insertionOrders": { +"description": "The list of insertion orders. This list will be absent if empty.", +"items": { +"$ref": "InsertionOrder" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListInsertionOrders` method to retrieve the next page of results.", +"type": "string" +} +}, +"type": "object" +}, +"ListInventorySourceGroupsResponse": { +"description": "Response message for InventorySourceGroupService.ListInventorySourceGroups.", +"id": "ListInventorySourceGroupsResponse", +"properties": { +"inventorySourceGroups": { +"description": "The list of inventory source groups. This list will be absent if empty.", +"items": { +"$ref": "InventorySourceGroup" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListInventorySourceGroups` method to retrieve the next page of results.", +"type": "string" +} +}, +"type": "object" +}, +"ListInventorySourcesResponse": { +"id": "ListInventorySourcesResponse", +"properties": { +"inventorySources": { +"description": "The list of inventory sources. This list will be absent if empty.", +"items": { +"$ref": "InventorySource" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListInventorySources` method to retrieve the next page of results.", +"type": "string" +} +}, +"type": "object" +}, +"ListInvoicesResponse": { +"id": "ListInvoicesResponse", +"properties": { +"invoices": { +"description": "The list of invoices. This list will be absent if empty.", +"items": { +"$ref": "Invoice" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListInvoices` method to retrieve the next page of results. This token will be absent if there are no more invoices to return.", +"type": "string" +} +}, +"type": "object" +}, +"ListLineItemAssignedTargetingOptionsResponse": { +"description": "Response message for ListLineItemAssignedTargetingOptions.", +"id": "ListLineItemAssignedTargetingOptionsResponse", +"properties": { +"assignedTargetingOptions": { +"description": "The list of assigned targeting options. This list will be absent if empty.", +"items": { +"$ref": "AssignedTargetingOption" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token identifying the next page of results. This value should be specified as the pageToken in a subsequent ListLineItemAssignedTargetingOptionsRequest to fetch the next page of results. This token will be absent if there are no more assigned_targeting_options to return.", +"type": "string" +} +}, +"type": "object" +}, +"ListLineItemsResponse": { +"id": "ListLineItemsResponse", +"properties": { +"lineItems": { +"description": "The list of line items. This list will be absent if empty.", +"items": { +"$ref": "LineItem" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListLineItems` method to retrieve the next page of results.", +"type": "string" +} +}, +"type": "object" +}, +"ListLocationListsResponse": { +"id": "ListLocationListsResponse", +"properties": { +"locationLists": { +"description": "The list of location lists. This list will be absent if empty.", +"items": { +"$ref": "LocationList" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListLocationLists` method to retrieve the next page of results.", +"type": "string" +} +}, +"type": "object" +}, +"ListNegativeKeywordListsResponse": { +"description": "Response message for NegativeKeywordListService.ListNegativeKeywordLists.", +"id": "ListNegativeKeywordListsResponse", +"properties": { +"negativeKeywordLists": { +"description": "The list of negative keyword lists. This list will be absent if empty.", +"items": { +"$ref": "NegativeKeywordList" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListNegativeKeywordLists` method to retrieve the next page of results.", +"type": "string" +} +}, +"type": "object" +}, +"ListNegativeKeywordsResponse": { +"description": "Response message for NegativeKeywordService.ListNegativeKeywords.", +"id": "ListNegativeKeywordsResponse", +"properties": { +"negativeKeywords": { +"description": "The list of negative keywords. This list will be absent if empty.", +"items": { +"$ref": "NegativeKeyword" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListNegativeKeywords` method to retrieve the next page of results.", +"type": "string" +} +}, +"type": "object" +}, +"ListPartnerAssignedTargetingOptionsResponse": { +"id": "ListPartnerAssignedTargetingOptionsResponse", +"properties": { +"assignedTargetingOptions": { +"description": "The list of assigned targeting options. This list will be absent if empty.", +"items": { +"$ref": "AssignedTargetingOption" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token identifying the next page of results. This value should be specified as the pageToken in a subsequent ListPartnerAssignedTargetingOptionsRequest to fetch the next page of results. This token will be absent if there are no more assigned_targeting_options to return.", +"type": "string" +} +}, +"type": "object" +}, +"ListPartnersResponse": { +"id": "ListPartnersResponse", +"properties": { +"nextPageToken": { +"description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListPartners` method to retrieve the next page of results.", +"type": "string" +}, +"partners": { +"description": "The list of partners. This list will be absent if empty.", +"items": { +"$ref": "Partner" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListSitesResponse": { +"description": "Response message for SiteService.ListSites.", +"id": "ListSitesResponse", +"properties": { +"nextPageToken": { +"description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListSites` method to retrieve the next page of results.", +"type": "string" +}, +"sites": { +"description": "The list of sites. This list will be absent if empty.", +"items": { +"$ref": "Site" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListTargetingOptionsResponse": { +"description": "Response message for ListTargetingOptions.", +"id": "ListTargetingOptionsResponse", +"properties": { +"nextPageToken": { +"description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListTargetingOptions` method to retrieve the next page of results.", +"type": "string" +}, +"targetingOptions": { +"description": "The list of targeting options. This list will be absent if empty.", +"items": { +"$ref": "TargetingOption" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListUsersResponse": { +"id": "ListUsersResponse", +"properties": { +"nextPageToken": { +"description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListUsers` method to retrieve the next page of results. This token will be absent if there are no more results to return.", +"type": "string" +}, +"users": { +"description": "The list of users. This list will be absent if empty.", +"items": { +"$ref": "User" +}, +"type": "array" +} +}, +"type": "object" +}, +"LocationList": { +"description": "A list of locations used for targeting.", +"id": "LocationList", +"properties": { +"advertiserId": { +"description": "Required. Immutable. The unique ID of the advertiser the location list belongs to.", +"format": "int64", +"type": "string" +}, +"displayName": { +"description": "Required. The display name of the location list. Must be UTF-8 encoded with a maximum size of 240 bytes.", +"type": "string" +}, +"locationListId": { +"description": "Output only. The unique ID of the location list. Assigned by the system.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"locationType": { +"description": "Required. Immutable. The type of location. All locations in the list will share this type.", +"enum": [ +"TARGETING_LOCATION_TYPE_UNSPECIFIED", +"TARGETING_LOCATION_TYPE_PROXIMITY", +"TARGETING_LOCATION_TYPE_REGIONAL" +], +"enumDescriptions": [ +"Default value when type is not specified or is unknown.", +"The type for proximity geo location.", +"The type for regional geo location." +], +"type": "string" +}, +"name": { +"description": "Output only. The resource name of the location list.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"LookbackWindow": { +"description": "Specifies how many days into the past to look when determining whether to record a conversion.", +"id": "LookbackWindow", +"properties": { +"clickDays": { +"description": "Lookback window, in days, from the last time a given user clicked on one of your ads.", +"format": "int32", +"type": "integer" +}, +"impressionDays": { +"description": "Lookback window, in days, from the last time a given user viewed one of your ads.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"LookupInvoiceCurrencyResponse": { +"id": "LookupInvoiceCurrencyResponse", +"properties": { +"currencyCode": { +"description": "Currency used by the advertiser in ISO 4217 format.", +"type": "string" +} +}, +"type": "object" +}, +"MastheadAd": { +"description": "Details for a Masthead Ad.", +"id": "MastheadAd", +"properties": { +"autoplayVideoDuration": { +"description": "The duration of time the video will autoplay.", +"format": "google-duration", +"type": "string" +}, +"autoplayVideoStartMillisecond": { +"description": "The amount of time in milliseconds after which the video will start to play.", +"format": "int64", +"type": "string" +}, +"callToActionButtonLabel": { +"description": "The text on the call-to-action button.", +"type": "string" +}, +"callToActionFinalUrl": { +"description": "The destination URL for the call-to-action button.", +"type": "string" +}, +"callToActionTrackingUrl": { +"description": "The tracking URL for the call-to-action button.", +"type": "string" +}, +"companionYoutubeVideos": { +"description": "The videos that appear next to the Masthead Ad on desktop. Can be no more than two.", +"items": { +"$ref": "YoutubeVideoDetails" +}, +"type": "array" +}, +"description": { +"description": "The description of the ad.", +"type": "string" +}, +"headline": { +"description": "The headline of the ad.", +"type": "string" +}, +"showChannelArt": { +"description": "Whether to show a background or banner that appears at the top of a YouTube page.", +"type": "boolean" +}, +"video": { +"$ref": "YoutubeVideoDetails", +"description": "The YouTube video used by the ad." +}, +"videoAspectRatio": { +"description": "The aspect ratio of the autoplaying YouTube video on the Masthead.", +"enum": [ +"VIDEO_ASPECT_RATIO_UNSPECIFIED", +"VIDEO_ASPECT_RATIO_WIDESCREEN", +"VIDEO_ASPECT_RATIO_FIXED_16_9" +], +"enumDescriptions": [ +"Not specified or unknown.", +"The video is stretched and the top and bottom are cropped.", +"The video uses a fixed 16:9 aspect ratio." +], +"type": "string" +} +}, +"type": "object" +}, +"MaximizeSpendBidStrategy": { +"description": "A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget.", +"id": "MaximizeSpendBidStrategy", +"properties": { +"customBiddingAlgorithmId": { +"description": "The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).", +"format": "int64", +"type": "string" +}, +"maxAverageCpmBidAmountMicros": { +"description": "The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.", +"format": "int64", +"type": "string" +}, +"performanceGoalType": { +"description": "Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.", +"enum": [ +"BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_UNSPECIFIED", +"BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA", +"BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC", +"BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM", +"BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO", +"BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA", +"BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN", +"BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED" +], +"enumDescriptions": [ +"Type value is not specified or is unknown in this version.", +"Cost per action.", +"Cost per click.", +"Viewable CPM.", +"Custom bidding algorithm.", +"Completed inview and audible views.", +"Inview time over 10 secs views.", +"Viewable impressions." +], +"type": "string" +}, +"raiseBidForDeals": { +"description": "Whether the strategy takes deal floor prices into account.", +"type": "boolean" +} +}, +"type": "object" +}, +"MeasurementConfig": { +"description": "Measurement settings of a partner.", +"id": "MeasurementConfig", +"properties": { +"dv360ToCmCostReportingEnabled": { +"description": "Whether or not to report DV360 cost to CM360.", +"type": "boolean" +}, +"dv360ToCmDataSharingEnabled": { +"description": "Whether or not to include DV360 data in CM360 data transfer reports.", +"type": "boolean" +} +}, +"type": "object" +}, +"MobileApp": { +"description": "A mobile app promoted by a mobile app install line item.", +"id": "MobileApp", +"properties": { +"appId": { +"description": "Required. The ID of the app provided by the platform store. Android apps are identified by the bundle ID used by Android's Play store, such as `com.google.android.gm`. iOS apps are identified by a nine-digit app ID used by Apple's App store, such as `422689480`.", +"type": "string" +}, +"displayName": { +"description": "Output only. The app name.", +"readOnly": true, +"type": "string" +}, +"platform": { +"description": "Output only. The app platform.", +"enum": [ +"PLATFORM_UNSPECIFIED", +"IOS", +"ANDROID" +], +"enumDescriptions": [ +"Platform is not specified.", +"iOS platform.", +"Android platform." +], +"readOnly": true, +"type": "string" +}, +"publisher": { +"description": "Output only. The app publisher.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"MobileDeviceIdList": { +"description": "Wrapper message for a list of mobile device IDs defining Customer Match audience members.", +"id": "MobileDeviceIdList", +"properties": { +"consent": { +"$ref": "Consent", +"description": "Input only. The consent setting for the users in mobile_device_ids. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error." +}, +"mobileDeviceIds": { +"description": "A list of mobile device IDs defining Customer Match audience members. The size of mobile_device_ids mustn't be greater than 500,000.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"Money": { +"description": "Represents an amount of money with its currency type.", +"id": "Money", +"properties": { +"currencyCode": { +"description": "The three-letter currency code defined in ISO 4217.", +"type": "string" +}, +"nanos": { +"description": "Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.", +"format": "int32", +"type": "integer" +}, +"units": { +"description": "The whole units of the amount. For example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"NativeContentPositionAssignedTargetingOptionDetails": { +"description": "Details for native content position assigned targeting option. This will be populated in the native_content_position_details field when targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`. Explicitly targeting all options is not supported. Remove all native content position targeting options to achieve this effect.", +"id": "NativeContentPositionAssignedTargetingOptionDetails", +"properties": { +"contentPosition": { +"description": "Required. The content position.", +"enum": [ +"NATIVE_CONTENT_POSITION_UNSPECIFIED", +"NATIVE_CONTENT_POSITION_UNKNOWN", +"NATIVE_CONTENT_POSITION_IN_ARTICLE", +"NATIVE_CONTENT_POSITION_IN_FEED", +"NATIVE_CONTENT_POSITION_PERIPHERAL", +"NATIVE_CONTENT_POSITION_RECOMMENDATION" +], +"enumDescriptions": [ +"Native content position is not specified in this version. This enum is a place holder for a default value and does not represent a real native content position.", +"The native content position is unknown.", +"Native content position is in-article, i.e., ads appear between the paragraphs of pages.", +"Native content position is in-feed, i.e., ads appear in a scrollable stream of content. A feed is typically editorial (e.g. a list of articles or news) or listings (e.g. a list of products or services).", +"Native content position is peripheral, i.e., ads appear outside of core content on pages, such as the right- or left-hand side of the page.", +"Native content position is recommendation, i.e., ads appear in sections for recommended content." +], +"type": "string" +} +}, +"type": "object" +}, +"NativeContentPositionTargetingOptionDetails": { +"description": "Represents a targetable native content position. This will be populated in the native_content_position_details field when targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`.", +"id": "NativeContentPositionTargetingOptionDetails", +"properties": { +"contentPosition": { +"description": "Output only. The content position.", +"enum": [ +"NATIVE_CONTENT_POSITION_UNSPECIFIED", +"NATIVE_CONTENT_POSITION_UNKNOWN", +"NATIVE_CONTENT_POSITION_IN_ARTICLE", +"NATIVE_CONTENT_POSITION_IN_FEED", +"NATIVE_CONTENT_POSITION_PERIPHERAL", +"NATIVE_CONTENT_POSITION_RECOMMENDATION" +], +"enumDescriptions": [ +"Native content position is not specified in this version. This enum is a place holder for a default value and does not represent a real native content position.", +"The native content position is unknown.", +"Native content position is in-article, i.e., ads appear between the paragraphs of pages.", +"Native content position is in-feed, i.e., ads appear in a scrollable stream of content. A feed is typically editorial (e.g. a list of articles or news) or listings (e.g. a list of products or services).", +"Native content position is peripheral, i.e., ads appear outside of core content on pages, such as the right- or left-hand side of the page.", +"Native content position is recommendation, i.e., ads appear in sections for recommended content." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"NegativeKeyword": { +"description": "A negatively targeted keyword that belongs to a negative keyword list.", +"id": "NegativeKeyword", +"properties": { +"keywordValue": { +"description": "Required. Immutable. The negatively targeted keyword, for example `car insurance`. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. Valid characters are restricted to ASCII characters only. The only URL-escaping permitted is for representing whitespace between words. Leading or trailing whitespace is ignored.", +"type": "string" +}, +"name": { +"description": "Output only. The resource name of the negative keyword.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"NegativeKeywordList": { +"description": "A list of negative keywords used for targeting.", +"id": "NegativeKeywordList", +"properties": { +"advertiserId": { +"description": "Output only. The unique ID of the advertiser the negative keyword list belongs to.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"displayName": { +"description": "Required. The display name of the negative keyword list. Must be UTF-8 encoded with a maximum size of 255 bytes.", +"type": "string" +}, +"name": { +"description": "Output only. The resource name of the negative keyword list.", +"readOnly": true, +"type": "string" +}, +"negativeKeywordListId": { +"description": "Output only. The unique ID of the negative keyword list. Assigned by the system.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"targetedLineItemCount": { +"description": "Output only. Number of line items that are directly targeting this negative keyword list.", +"format": "int64", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"NegativeKeywordListAssignedTargetingOptionDetails": { +"description": "Targeting details for negative keyword list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`.", +"id": "NegativeKeywordListAssignedTargetingOptionDetails", +"properties": { +"negativeKeywordListId": { +"description": "Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"NonSkippableAd": { +"description": "Details for a non-skippable ad.", +"id": "NonSkippableAd", +"properties": { +"commonInStreamAttribute": { +"$ref": "CommonInStreamAttribute", +"description": "Common ad attributes." +}, +"customParameters": { +"additionalProperties": { +"type": "string" +}, +"description": "The custom parameters to pass custom values to tracking URL template.", +"type": "object" +} +}, +"type": "object" +}, +"ObaIcon": { +"description": "OBA Icon for a Creative", +"id": "ObaIcon", +"properties": { +"clickTrackingUrl": { +"description": "Required. The click tracking URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com`", +"type": "string" +}, +"dimensions": { +"$ref": "Dimensions", +"description": "Optional. The dimensions of the OBA icon." +}, +"landingPageUrl": { +"description": "Required. The landing page URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com`", +"type": "string" +}, +"position": { +"description": "Optional. The position of the OBA icon on the creative.", +"enum": [ +"OBA_ICON_POSITION_UNSPECIFIED", +"OBA_ICON_POSITION_UPPER_RIGHT", +"OBA_ICON_POSITION_UPPER_LEFT", +"OBA_ICON_POSITION_LOWER_RIGHT", +"OBA_ICON_POSITION_LOWER_LEFT" +], +"enumDescriptions": [ +"The OBA icon position is not specified.", +"At the upper right side of the creative.", +"At the upper left side of the creative.", +"At the lower right side of the creative.", +"At the lower left side of the creative." +], +"type": "string" +}, +"program": { +"description": "Optional. The program of the OBA icon. For example: \u201cAdChoices\u201d.", +"type": "string" +}, +"resourceMimeType": { +"description": "Optional. The MIME type of the OBA icon resource.", +"type": "string" +}, +"resourceUrl": { +"description": "Optional. The URL of the OBA icon resource.", +"type": "string" +}, +"viewTrackingUrl": { +"description": "Required. The view tracking URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com`", +"type": "string" +} +}, +"type": "object" +}, +"OmidAssignedTargetingOptionDetails": { +"description": "Represents a targetable Open Measurement enabled inventory type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_OMID`.", +"id": "OmidAssignedTargetingOptionDetails", +"properties": { +"omid": { +"description": "Required. The type of Open Measurement enabled inventory.", +"enum": [ +"OMID_UNSPECIFIED", +"OMID_FOR_MOBILE_DISPLAY_ADS" +], +"enumDescriptions": [ +"Default value when omid targeting is not specified in this version.", +"Open Measurement enabled mobile display inventory." +], +"type": "string" +} +}, +"type": "object" +}, +"OmidTargetingOptionDetails": { +"description": "Represents a targetable Open Measurement enabled inventory type. This will be populated in the omid_details field when targeting_type is `TARGETING_TYPE_OMID`.", +"id": "OmidTargetingOptionDetails", +"properties": { +"omid": { +"description": "Output only. The type of Open Measurement enabled inventory.", +"enum": [ +"OMID_UNSPECIFIED", +"OMID_FOR_MOBILE_DISPLAY_ADS" +], +"enumDescriptions": [ +"Default value when omid targeting is not specified in this version.", +"Open Measurement enabled mobile display inventory." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"OnScreenPositionAssignedTargetingOptionDetails": { +"description": "On screen position targeting option details. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.", +"id": "OnScreenPositionAssignedTargetingOptionDetails", +"properties": { +"adType": { +"description": "Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.", +"enum": [ +"AD_TYPE_UNSPECIFIED", +"AD_TYPE_DISPLAY", +"AD_TYPE_VIDEO", +"AD_TYPE_AUDIO" +], +"enumDescriptions": [ +"Ad type is not specified or is unknown in this version.", +"Display creatives, e.g. image and HTML5.", +"Video creatives, e.g. video ads that play during streaming content in video players.", +"Audio creatives, e.g. audio ads that play during audio content." +], +"readOnly": true, +"type": "string" +}, +"onScreenPosition": { +"description": "Output only. The on screen position.", +"enum": [ +"ON_SCREEN_POSITION_UNSPECIFIED", +"ON_SCREEN_POSITION_UNKNOWN", +"ON_SCREEN_POSITION_ABOVE_THE_FOLD", +"ON_SCREEN_POSITION_BELOW_THE_FOLD" +], +"enumDescriptions": [ +"On screen position is not specified in this version. This enum is a place holder for a default value and does not represent a real on screen position.", +"The ad position is unknown on the screen.", +"The ad is located above the fold.", +"The ad is located below the fold." +], +"readOnly": true, +"type": "string" +}, +"targetingOptionId": { +"description": "Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.", +"type": "string" +} +}, +"type": "object" +}, +"OnScreenPositionTargetingOptionDetails": { +"description": "Represents a targetable on screen position, which could be used by display and video ads. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.", +"id": "OnScreenPositionTargetingOptionDetails", +"properties": { +"onScreenPosition": { +"description": "Output only. The on screen position.", +"enum": [ +"ON_SCREEN_POSITION_UNSPECIFIED", +"ON_SCREEN_POSITION_UNKNOWN", +"ON_SCREEN_POSITION_ABOVE_THE_FOLD", +"ON_SCREEN_POSITION_BELOW_THE_FOLD" +], +"enumDescriptions": [ +"On screen position is not specified in this version. This enum is a place holder for a default value and does not represent a real on screen position.", +"The ad position is unknown on the screen.", +"The ad is located above the fold.", +"The ad is located below the fold." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"OperatingSystemAssignedTargetingOptionDetails": { +"description": "Assigned operating system targeting option details. This will be populated in the operating_system_details field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.", +"id": "OperatingSystemAssignedTargetingOptionDetails", +"properties": { +"displayName": { +"description": "Output only. The display name of the operating system.", +"readOnly": true, +"type": "string" +}, +"negative": { +"description": "Indicates if this option is being negatively targeted.", +"type": "boolean" +}, +"targetingOptionId": { +"description": "Required. The targeting option ID populated in targeting_option_id field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.", +"type": "string" +} +}, +"type": "object" +}, +"OperatingSystemTargetingOptionDetails": { +"description": "Represents a targetable operating system. This will be populated in the operating_system_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.", +"id": "OperatingSystemTargetingOptionDetails", +"properties": { +"displayName": { +"description": "Output only. The display name of the operating system.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"Operation": { +"description": "This resource represents a long-running operation that is the result of a network API call.", +"id": "Operation", +"properties": { +"done": { +"description": "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.", +"type": "boolean" +}, +"error": { +"$ref": "Status", +"description": "The error result of the operation in case of failure or cancellation." +}, +"metadata": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"description": "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.", +"type": "object" +}, +"name": { +"description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", +"type": "string" +}, +"response": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"description": "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`.", +"type": "object" +} +}, +"type": "object" +}, +"Pacing": { +"description": "Settings that control the rate at which a budget is spent.", +"id": "Pacing", +"properties": { +"dailyMaxImpressions": { +"description": "Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0.", +"format": "int64", +"type": "string" +}, +"dailyMaxMicros": { +"description": "Maximum currency amount to spend every day in micros of advertiser's currency. Applicable when the budget is currency based. Must be greater than 0. For example, for 1.5 standard unit of the currency, set this field to 1500000. The value assigned will be rounded to whole billable units for the relevant currency by the following rules: any positive value less than a single billable unit will be rounded up to one billable unit and any value larger than a single billable unit will be rounded down to the nearest billable value. For example, if the currency's billable unit is 0.01, and this field is set to 10257770, it will round down to 10250000, a value of 10.25. If set to 505, it will round up to 10000, a value of 0.01.", +"format": "int64", +"type": "string" +}, +"pacingPeriod": { +"description": "Required. The time period in which the pacing budget will be spent. When automatic budget allocation is enabled at the insertion order via automationType, this field is output only and defaults to `PACING_PERIOD_FLIGHT`.", +"enum": [ +"PACING_PERIOD_UNSPECIFIED", +"PACING_PERIOD_DAILY", +"PACING_PERIOD_FLIGHT" +], +"enumDescriptions": [ +"Period value is not specified or is unknown in this version.", +"The pacing setting will be applied on daily basis.", +"The pacing setting will be applied to the whole flight duration." +], +"type": "string" +}, +"pacingType": { +"description": "Required. The type of pacing that defines how the budget amount will be spent across the pacing_period. `PACING_TYPE_ASAP` is not compatible with pacing_period `PACING_PERIOD_FLIGHT` for insertion orders.", +"enum": [ +"PACING_TYPE_UNSPECIFIED", +"PACING_TYPE_AHEAD", +"PACING_TYPE_ASAP", +"PACING_TYPE_EVEN" +], +"enumDescriptions": [ +"Pacing mode value is not specified or is unknown in this version.", +"Only applicable to `PACING_PERIOD_FLIGHT` pacing period. Ahead pacing attempts to spend faster than evenly, to make sure the entire budget is spent by the end of the flight.", +"Spend all of pacing budget amount as quick as possible.", +"Spend a consistent budget amount every period of time." +], +"type": "string" +} +}, +"type": "object" +}, +"ParentEntityFilter": { +"description": "A filtering option that filters on selected file types belonging to a chosen set of filter entities.", +"id": "ParentEntityFilter", +"properties": { +"fileType": { +"description": "Required. File types that will be returned.", +"items": { +"enum": [ +"FILE_TYPE_UNSPECIFIED", +"FILE_TYPE_CAMPAIGN", +"FILE_TYPE_MEDIA_PRODUCT", +"FILE_TYPE_INSERTION_ORDER", +"FILE_TYPE_LINE_ITEM", +"FILE_TYPE_AD_GROUP", +"FILE_TYPE_AD", +"FILE_TYPE_LINE_ITEM_QA", +"FILE_TYPE_AD_GROUP_QA" +], +"enumDescriptions": [ +"Default value when type is unspecified or is unknown in this version.", +"Campaign.", +"Media Product.", +"Insertion Order.", +"Line Item.", +"YouTube Ad Group.", +"YouTube Ad.", +"Line Item - QA format.", +"YouTube Ad Group - QA format." +], +"type": "string" +}, +"type": "array" +}, +"filterIds": { +"description": "The IDs of the specified filter type. This is used to filter entities to fetch. If filter type is not `FILTER_TYPE_NONE`, at least one ID must be specified.", +"items": { +"format": "int64", +"type": "string" +}, +"type": "array" +}, +"filterType": { +"description": "Required. Filter type used to filter fetched entities.", +"enum": [ +"FILTER_TYPE_UNSPECIFIED", +"FILTER_TYPE_NONE", +"FILTER_TYPE_ADVERTISER_ID", +"FILTER_TYPE_CAMPAIGN_ID", +"FILTER_TYPE_MEDIA_PRODUCT_ID", +"FILTER_TYPE_INSERTION_ORDER_ID", +"FILTER_TYPE_LINE_ITEM_ID" +], +"enumDescriptions": [ +"Default value when type is unspecified or is unknown in this version.", +"If selected, no filter will be applied to the download. Can only be used if an Advertiser is specified in CreateSdfDownloadTaskRequest.", +"Advertiser ID. If selected, all filter IDs must be Advertiser IDs that belong to the Partner specified in CreateSdfDownloadTaskRequest.", +"Campaign ID. If selected, all filter IDs must be Campaign IDs that belong to the Advertiser or Partner specified in CreateSdfDownloadTaskRequest.", +"Media Product ID. If selected, all filter IDs must be Media Product IDs that belong to the Advertiser or Partner specified in CreateSdfDownloadTaskRequest. Can only be used for downloading `FILE_TYPE_MEDIA_PRODUCT`.", +"Insertion Order ID. If selected, all filter IDs must be Insertion Order IDs that belong to the Advertiser or Partner specified in CreateSdfDownloadTaskRequest. Can only be used for downloading `FILE_TYPE_INSERTION_ORDER`, `FILE_TYPE_LINE_ITEM`, `FILE_TYPE_LINE_ITEM_QA`, `FILE_TYPE_AD_GROUP`, `FILE_TYPE_AD_GROUP_QA`, and `FILE_TYPE_AD`.", +"Line Item ID. If selected, all filter IDs must be Line Item IDs that belong to the Advertiser or Partner specified in CreateSdfDownloadTaskRequest. Can only be used for downloading `FILE_TYPE_LINE_ITEM`, `FILE_TYPE_LINE_ITEM_QA`,`FILE_TYPE_AD_GROUP`, `FILE_TYPE_AD_GROUP_QA`, and `FILE_TYPE_AD`." +], +"type": "string" +} +}, +"type": "object" +}, +"ParentalStatusAssignedTargetingOptionDetails": { +"description": "Details for assigned parental status targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`.", +"id": "ParentalStatusAssignedTargetingOptionDetails", +"properties": { +"parentalStatus": { +"description": "Required. The parental status of the audience.", +"enum": [ +"PARENTAL_STATUS_UNSPECIFIED", +"PARENTAL_STATUS_PARENT", +"PARENTAL_STATUS_NOT_A_PARENT", +"PARENTAL_STATUS_UNKNOWN" +], +"enumDescriptions": [ +"Default value when parental status is not specified in this version. This enum is a place holder for default value and does not represent a real parental status option.", +"The audience is a parent.", +"The audience is not a parent.", +"The parental status of the audience is unknown." +], +"type": "string" +} +}, +"type": "object" +}, +"ParentalStatusTargetingOptionDetails": { +"description": "Represents a targetable parental status. This will be populated in the parental_status_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`.", +"id": "ParentalStatusTargetingOptionDetails", +"properties": { +"parentalStatus": { +"description": "Output only. The parental status of an audience.", +"enum": [ +"PARENTAL_STATUS_UNSPECIFIED", +"PARENTAL_STATUS_PARENT", +"PARENTAL_STATUS_NOT_A_PARENT", +"PARENTAL_STATUS_UNKNOWN" +], +"enumDescriptions": [ +"Default value when parental status is not specified in this version. This enum is a place holder for default value and does not represent a real parental status option.", +"The audience is a parent.", +"The audience is not a parent.", +"The parental status of the audience is unknown." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"Partner": { +"description": "A single partner in Display & Video 360 (DV360).", +"id": "Partner", +"properties": { +"adServerConfig": { +"$ref": "PartnerAdServerConfig", +"description": "Ad server related settings of the partner." +}, +"billingConfig": { +"$ref": "PartnerBillingConfig", +"description": "Billing related settings of the partner." +}, +"dataAccessConfig": { +"$ref": "PartnerDataAccessConfig", +"description": "Settings that control how partner data may be accessed." +}, +"displayName": { +"description": "The display name of the partner. Must be UTF-8 encoded with a maximum size of 240 bytes.", +"type": "string" +}, +"entityStatus": { +"description": "Output only. The status of the partner.", +"enum": [ +"ENTITY_STATUS_UNSPECIFIED", +"ENTITY_STATUS_ACTIVE", +"ENTITY_STATUS_ARCHIVED", +"ENTITY_STATUS_DRAFT", +"ENTITY_STATUS_PAUSED", +"ENTITY_STATUS_SCHEDULED_FOR_DELETION" +], +"enumDescriptions": [ +"Default value when status is not specified or is unknown in this version.", +"The entity is enabled to bid and spend budget.", +"The entity is archived. Bidding and budget spending are disabled. An entity can be deleted after archived. Deleted entities cannot be retrieved.", +"The entity is under draft. Bidding and budget spending are disabled.", +"Bidding and budget spending are paused for the entity.", +"The entity is scheduled for deletion." +], +"readOnly": true, +"type": "string" +}, +"exchangeConfig": { +"$ref": "ExchangeConfig", +"description": "Settings that control which exchanges are enabled for the partner." +}, +"generalConfig": { +"$ref": "PartnerGeneralConfig", +"description": "General settings of the partner." +}, +"name": { +"description": "Output only. The resource name of the partner.", +"readOnly": true, +"type": "string" +}, +"partnerId": { +"description": "Output only. The unique ID of the partner. Assigned by the system.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. The timestamp when the partner was last updated. Assigned by the system.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"PartnerAdServerConfig": { +"description": "Ad server related settings of a partner.", +"id": "PartnerAdServerConfig", +"properties": { +"measurementConfig": { +"$ref": "MeasurementConfig", +"description": "Measurement settings of a partner." +} +}, +"type": "object" +}, +"PartnerBillingConfig": { +"description": "Billing related settings of a partner.", +"id": "PartnerBillingConfig", +"properties": { +"billingProfileId": { +"description": "The ID of a partner default billing profile.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"PartnerCost": { +"description": "Settings that control a partner cost. A partner cost is any type of expense involved in running a campaign, other than the costs of purchasing impressions (which is called the media cost) and using third-party audience segment data (data fee). Some examples of partner costs include the fees for using DV360, a third-party ad server, or a third-party ad serving verification service.", +"id": "PartnerCost", +"properties": { +"costType": { +"description": "Required. The type of the partner cost.", +"enum": [ +"PARTNER_COST_TYPE_UNSPECIFIED", +"PARTNER_COST_TYPE_ADLOOX", +"PARTNER_COST_TYPE_ADLOOX_PREBID", +"PARTNER_COST_TYPE_ADSAFE", +"PARTNER_COST_TYPE_ADXPOSE", +"PARTNER_COST_TYPE_AGGREGATE_KNOWLEDGE", +"PARTNER_COST_TYPE_AGENCY_TRADING_DESK", +"PARTNER_COST_TYPE_DV360_FEE", +"PARTNER_COST_TYPE_COMSCORE_VCE", +"PARTNER_COST_TYPE_DATA_MANAGEMENT_PLATFORM", +"PARTNER_COST_TYPE_DEFAULT", +"PARTNER_COST_TYPE_DOUBLE_VERIFY", +"PARTNER_COST_TYPE_DOUBLE_VERIFY_PREBID", +"PARTNER_COST_TYPE_EVIDON", +"PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE_VIDEO", +"PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE_PREBID", +"PARTNER_COST_TYPE_MEDIA_COST_DATA", +"PARTNER_COST_TYPE_MOAT_VIDEO", +"PARTNER_COST_TYPE_NIELSEN_DAR", +"PARTNER_COST_TYPE_SHOP_LOCAL", +"PARTNER_COST_TYPE_TERACENT", +"PARTNER_COST_TYPE_THIRD_PARTY_AD_SERVER", +"PARTNER_COST_TYPE_TRUST_METRICS", +"PARTNER_COST_TYPE_VIZU", +"PARTNER_COST_TYPE_ADLINGO_FEE", +"PARTNER_COST_TYPE_CUSTOM_FEE_1", +"PARTNER_COST_TYPE_CUSTOM_FEE_2", +"PARTNER_COST_TYPE_CUSTOM_FEE_3", +"PARTNER_COST_TYPE_CUSTOM_FEE_4", +"PARTNER_COST_TYPE_CUSTOM_FEE_5", +"PARTNER_COST_TYPE_SCIBIDS_FEE" +], +"enumDescriptions": [ +"Type value is not specified or is unknown in this version.", +"The cost is charged for using Adloox. Billed by the partner.", +"The cost is charged for using Adloox Pre-Bid. Billed through DV360.", +"The cost is charged for using AdSafe. Billed by the partner.", +"The cost is charged for using AdExpose. Billed by the partner.", +"The cost is charged for using Aggregate Knowledge. Billed by the partner.", +"The cost is charged for using an Agency Trading Desk. Billed by the partner.", +"The cost is charged for using DV360. Billed through DV360.", +"The cost is charged for using comScore vCE. Billed through DV360.", +"The cost is charged for using a Data Management Platform. Billed by the partner.", +"The default cost type. Billed by the partner.", +"The cost is charged for using DoubleVerify. Billed by the partner.", +"The cost is charged for using DoubleVerify Pre-Bid. Billed through DV360.", +"The cost is charged for using Evidon. Billed by the partner.", +"The cost is charged for using Integral Ad Science Video. Billed by the partner.", +"The cost is charged for using Integral Ad Science Pre-Bid. Billed through DV360.", +"The cost is charged for using media cost data. Billed by the partner.", +"The cost is charged for using MOAT Video. Billed by the partner.", +"The cost is charged for using Nielsen Digital Ad Ratings. Billed through DV360.", +"The cost is charged for using ShopLocal. Billed by the partner.", +"The cost is charged for using Teracent. Billed by the partner.", +"The cost is charged for using a third-party ad server. Billed by the partner.", +"The cost is charged for using TrustMetrics. Billed by the partner.", +"The cost is charged for using Vizu. Billed by the partner.", +"The cost is charged for using AdLingo. Billed through DV360.", +"The cost is charged as custom fee 1. Billed by the partner.", +"The cost is charged as custom fee 2. Billed by the partner.", +"The cost is charged as custom fee 3. Billed by the partner.", +"The cost is charged as custom fee 4. Billed by the partner.", +"The cost is charged as custom fee 5. Billed by the partner.", +"The cost is charged for using Scibids. Billed through DV360. This type is currently only available to certain customers. Other customers attempting to use this type will receive an error." +], +"type": "string" +}, +"feeAmount": { +"description": "The CPM fee amount in micros of advertiser's currency. Applicable when the fee_type is `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0. For example, for 1.5 standard unit of the advertiser's currency, set this field to 1500000.", +"format": "int64", +"type": "string" +}, +"feePercentageMillis": { +"description": "The media fee percentage in millis (1/1000 of a percent). Applicable when the fee_type is `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0. For example: 100 represents 0.1%.", +"format": "int64", +"type": "string" +}, +"feeType": { +"description": "Required. The fee type for this partner cost.", +"enum": [ +"PARTNER_COST_FEE_TYPE_UNSPECIFIED", +"PARTNER_COST_FEE_TYPE_CPM_FEE", +"PARTNER_COST_FEE_TYPE_MEDIA_FEE" +], +"enumDescriptions": [ +"Value is not specified or is unknown in this version.", +"The partner cost is a fixed CPM fee. Not applicable when the partner cost cost_type is one of: * `PARTNER_COST_TYPE_MEDIA_COST_DATA` * `PARTNER_COST_TYPE_DV360_FEE`.", +"The partner cost is a percentage surcharge based on the media cost. Not applicable when the partner cost_type is one of: * `PARTNER_COST_TYPE_SHOP_LOCAL` * `PARTNER_COST_TYPE_TRUST_METRICS` * `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE_VIDEO` * `PARTNER_COST_TYPE_MOAT_VIDEO`." +], +"type": "string" +}, +"invoiceType": { +"description": "The invoice type for this partner cost. * Required when cost_type is one of: - `PARTNER_COST_TYPE_ADLOOX` - `PARTNER_COST_TYPE_DOUBLE_VERIFY` - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`. * Output only for other types.", +"enum": [ +"PARTNER_COST_INVOICE_TYPE_UNSPECIFIED", +"PARTNER_COST_INVOICE_TYPE_DV360", +"PARTNER_COST_INVOICE_TYPE_PARTNER" +], +"enumDescriptions": [ +"Type value is not specified or is unknown in this version.", +"Partner cost is billed through DV360.", +"Partner cost is billed by the partner." +], +"type": "string" +} +}, +"type": "object" +}, +"PartnerDataAccessConfig": { +"description": "Settings that control how partner related data may be accessed.", +"id": "PartnerDataAccessConfig", +"properties": { +"sdfConfig": { +"$ref": "SdfConfig", +"description": "Structured Data Files (SDF) settings for the partner. The SDF configuration for the partner." +} +}, +"type": "object" +}, +"PartnerGeneralConfig": { +"description": "General settings of a partner.", +"id": "PartnerGeneralConfig", +"properties": { +"currencyCode": { +"description": "Immutable. Partner's currency in ISO 4217 format.", +"type": "string" +}, +"timeZone": { +"description": "Immutable. The standard TZ database name of the partner's time zone. For example, `America/New_York`. See more at: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones", +"type": "string" +} +}, +"type": "object" +}, +"PartnerRevenueModel": { +"description": "Settings that control how partner revenue is calculated.", +"id": "PartnerRevenueModel", +"properties": { +"markupAmount": { +"description": "Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001).", +"format": "int64", +"type": "string" +}, +"markupType": { +"description": "Required. The markup type of the partner revenue model.", +"enum": [ +"PARTNER_REVENUE_MODEL_MARKUP_TYPE_UNSPECIFIED", +"PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM", +"PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP", +"PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP" +], +"enumDeprecated": [ +false, +false, +true, +false +], +"enumDescriptions": [ +"Type value is not specified or is unknown in this version.", +"Calculate the partner revenue based on a fixed CPM.", +"Calculate the partner revenue based on a percentage surcharge of its media cost.", +"Calculate the partner revenue based on a percentage surcharge of its total media cost, which includes all partner costs and data costs." +], +"type": "string" +} +}, +"type": "object" +}, +"PerformanceGoal": { +"description": "Settings that control the performance goal of a campaign.", +"id": "PerformanceGoal", +"properties": { +"performanceGoalAmountMicros": { +"description": "The goal amount, in micros of the advertiser's currency. Applicable when performance_goal_type is one of: * `PERFORMANCE_GOAL_TYPE_CPM` * `PERFORMANCE_GOAL_TYPE_CPC` * `PERFORMANCE_GOAL_TYPE_CPA` * `PERFORMANCE_GOAL_TYPE_CPIAVC` * `PERFORMANCE_GOAL_TYPE_VCPM` For example 1500000 represents 1.5 standard units of the currency.", +"format": "int64", +"type": "string" +}, +"performanceGoalPercentageMicros": { +"description": "The decimal representation of the goal percentage in micros. Applicable when performance_goal_type is one of: * `PERFORMANCE_GOAL_TYPE_CTR` * `PERFORMANCE_GOAL_TYPE_VIEWABILITY` * `PERFORMANCE_GOAL_TYPE_CLICK_CVR` * `PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR` * `PERFORMANCE_GOAL_TYPE_VTR` * `PERFORMANCE_GOAL_TYPE_AUDIO_COMPLETION_RATE` * `PERFORMANCE_GOAL_TYPE_VIDEO_COMPLETION_RATE` For example, 70000 represents 7% (decimal 0.07).", +"format": "int64", +"type": "string" +}, +"performanceGoalString": { +"description": "A key performance indicator (KPI) string, which can be empty. Must be UTF-8 encoded with a length of no more than 100 characters. Applicable when performance_goal_type is set to `PERFORMANCE_GOAL_TYPE_OTHER`.", +"type": "string" +}, +"performanceGoalType": { +"description": "Required. The type of the performance goal.", +"enum": [ +"PERFORMANCE_GOAL_TYPE_UNSPECIFIED", +"PERFORMANCE_GOAL_TYPE_CPM", +"PERFORMANCE_GOAL_TYPE_CPC", +"PERFORMANCE_GOAL_TYPE_CPA", +"PERFORMANCE_GOAL_TYPE_CTR", +"PERFORMANCE_GOAL_TYPE_VIEWABILITY", +"PERFORMANCE_GOAL_TYPE_CPIAVC", +"PERFORMANCE_GOAL_TYPE_CPE", +"PERFORMANCE_GOAL_TYPE_CPV", +"PERFORMANCE_GOAL_TYPE_CLICK_CVR", +"PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR", +"PERFORMANCE_GOAL_TYPE_VCPM", +"PERFORMANCE_GOAL_TYPE_VTR", +"PERFORMANCE_GOAL_TYPE_AUDIO_COMPLETION_RATE", +"PERFORMANCE_GOAL_TYPE_VIDEO_COMPLETION_RATE", +"PERFORMANCE_GOAL_TYPE_OTHER" +], +"enumDescriptions": [ +"Performance goal type is not specified or is unknown in this version.", +"The performance goal is set in CPM (cost per mille).", +"The performance goal is set in CPC (cost per click).", +"The performance goal is set in CPA (cost per action).", +"The performance goal is set in CTR (click-through rate) percentage.", +"The performance goal is set in Viewability percentage.", +"The performance goal is set as CPIAVC (cost per impression audible and visible at completion).", +"The performance goal is set in CPE (cost per engagement).", +"The performance goal is set in CPV (cost per view).", +"The performance goal is set in click conversion rate (conversions per click) percentage.", +"The performance goal is set in impression conversion rate (conversions per impression) percentage.", +"The performance goal is set in VCPM (cost per thousand viewable impressions).", +"The performance goal is set in YouTube view rate (YouTube views per impression) percentage.", +"The performance goal is set in audio completion rate (complete audio listens per impression) percentage.", +"The performance goal is set in video completion rate (complete video views per impression) percentage.", +"The performance goal is set to Other." +], +"type": "string" +} +}, +"type": "object" +}, +"PerformanceGoalBidStrategy": { +"description": "A strategy that automatically adjusts the bid to meet or beat a specified performance goal.", +"id": "PerformanceGoalBidStrategy", +"properties": { +"customBiddingAlgorithmId": { +"description": "The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).", +"format": "int64", +"type": "string" +}, +"maxAverageCpmBidAmountMicros": { +"description": "The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency.", +"format": "int64", +"type": "string" +}, +"performanceGoalAmountMicros": { +"description": "Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value.", +"format": "int64", +"type": "string" +}, +"performanceGoalType": { +"description": "Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`.", +"enum": [ +"BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_UNSPECIFIED", +"BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA", +"BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC", +"BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM", +"BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO", +"BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA", +"BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN", +"BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED" +], +"enumDescriptions": [ +"Type value is not specified or is unknown in this version.", +"Cost per action.", +"Cost per click.", +"Viewable CPM.", +"Custom bidding algorithm.", +"Completed inview and audible views.", +"Inview time over 10 secs views.", +"Viewable impressions." +], +"type": "string" +} +}, +"type": "object" +}, +"PoiAssignedTargetingOptionDetails": { +"description": "Details for assigned POI targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_POI`.", +"id": "PoiAssignedTargetingOptionDetails", +"properties": { +"displayName": { +"description": "Output only. The display name of a POI, e.g. \"Times Square\", \"Space Needle\", followed by its full address if available.", +"readOnly": true, +"type": "string" +}, +"latitude": { +"description": "Output only. Latitude of the POI rounding to 6th decimal place.", +"format": "double", +"readOnly": true, +"type": "number" +}, +"longitude": { +"description": "Output only. Longitude of the POI rounding to 6th decimal place.", +"format": "double", +"readOnly": true, +"type": "number" +}, +"proximityRadiusAmount": { +"description": "Required. The radius of the area around the POI that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`.", +"format": "double", +"type": "number" +}, +"proximityRadiusUnit": { +"description": "Required. The unit of distance by which the targeting radius is measured.", +"enum": [ +"DISTANCE_UNIT_UNSPECIFIED", +"DISTANCE_UNIT_MILES", +"DISTANCE_UNIT_KILOMETERS" +], +"enumDescriptions": [ +"Type value is not specified or is unknown in this version.", +"Miles.", +"Kilometers." +], +"type": "string" +}, +"targetingOptionId": { +"description": "Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_POI`. Accepted POI targeting option IDs can be retrieved using `targetingTypes.targetingOptions.search`. If targeting a specific latitude/longitude coordinate removed from an address or POI name, you can generate the necessary targeting option ID by rounding the desired coordinate values to the 6th decimal place, removing the decimals, and concatenating the string values separated by a semicolon. For example, you can target the latitude/longitude pair of 40.7414691, -74.003387 using the targeting option ID \"40741469;-74003387\". **Upon** **creation, this field value will be updated to append a semicolon and** **alphanumerical hash value if only latitude/longitude coordinates are** **provided.**", +"type": "string" +} +}, +"type": "object" +}, +"PoiSearchTerms": { +"description": "Search terms for POI targeting options.", +"id": "PoiSearchTerms", +"properties": { +"poiQuery": { +"description": "The search query for the desired POI name, street address, or coordinate of the desired POI. The query can be a prefix, e.g. \"Times squar\", \"40.7505045,-73.99562\", \"315 W 44th St\", etc.", +"type": "string" +} +}, +"type": "object" +}, +"PoiTargetingOptionDetails": { +"description": "Represents a targetable point of interest(POI). This will be populated in the poi_details field when targeting_type is `TARGETING_TYPE_POI`.", +"id": "PoiTargetingOptionDetails", +"properties": { +"displayName": { +"description": "Output only. The display name of a POI(e.g. \"Times Square\", \"Space Needle\"), followed by its full address if available.", +"readOnly": true, +"type": "string" +}, +"latitude": { +"description": "Output only. Latitude of the POI rounding to 6th decimal place.", +"format": "double", +"readOnly": true, +"type": "number" +}, +"longitude": { +"description": "Output only. Longitude of the POI rounding to 6th decimal place.", +"format": "double", +"readOnly": true, +"type": "number" +} +}, +"type": "object" +}, +"PrismaConfig": { +"description": "Settings specific to the Mediaocean Prisma tool.", +"id": "PrismaConfig", +"properties": { +"prismaCpeCode": { +"$ref": "PrismaCpeCode", +"description": "Required. Relevant client, product, and estimate codes from the Mediaocean Prisma tool." +}, +"prismaType": { +"description": "Required. The Prisma type.", +"enum": [ +"PRISMA_TYPE_UNSPECIFIED", +"PRISMA_TYPE_DISPLAY", +"PRISMA_TYPE_SEARCH", +"PRISMA_TYPE_VIDEO", +"PRISMA_TYPE_AUDIO", +"PRISMA_TYPE_SOCIAL", +"PRISMA_TYPE_FEE" +], +"enumDescriptions": [ +"Type is not specified or unknown in this version.", +"Display type.", +"Search type.", +"Video type.", +"Audio type.", +"Social type.", +"Fee type." +], +"type": "string" +}, +"supplier": { +"description": "Required. The entity allocated this budget (DSP, site, etc.).", +"type": "string" +} +}, +"type": "object" +}, +"PrismaCpeCode": { +"description": "Google Payments Center supports searching and filtering on the component fields of this code.", +"id": "PrismaCpeCode", +"properties": { +"prismaClientCode": { +"description": "The Prisma client code.", +"type": "string" +}, +"prismaEstimateCode": { +"description": "The Prisma estimate code.", +"type": "string" +}, +"prismaProductCode": { +"description": "The Prisma product code.", +"type": "string" +} +}, +"type": "object" +}, +"ProductFeedData": { +"description": "The details of product feed.", +"id": "ProductFeedData", +"properties": { +"isFeedDisabled": { +"description": "Whether the product feed has opted-out of showing products.", +"type": "boolean" +}, +"productMatchDimensions": { +"description": "A list of dimensions used to match products.", +"items": { +"$ref": "ProductMatchDimension" +}, +"type": "array" +}, +"productMatchType": { +"description": "How products are selected by the product feed.", +"enum": [ +"PRODUCT_MATCH_TYPE_UNSPECIFIED", +"PRODUCT_MATCH_TYPE_ALL_PRODUCTS", +"PRODUCT_MATCH_TYPE_SPECIFIC_PRODUCTS", +"PRODUCT_MATCH_TYPE_CUSTOM_LABEL" +], +"enumDescriptions": [ +"Not specified or unknown.", +"All the products are matched.", +"Specific products are selected.", +"Match products by their custom labels." +], +"type": "string" +} +}, +"type": "object" +}, +"ProductMatchDimension": { +"description": "A dimension used to match products.", +"id": "ProductMatchDimension", +"properties": { +"customLabel": { +"$ref": "CustomLabel", +"description": "The custom label to match all the products with the label." +}, +"productOfferId": { +"description": "The ID of the product offer to match with a product with the same offer ID.", +"type": "string" +} +}, +"type": "object" +}, +"ProximityLocationListAssignedTargetingOptionDetails": { +"description": "Targeting details for proximity location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`.", +"id": "ProximityLocationListAssignedTargetingOptionDetails", +"properties": { +"proximityLocationListId": { +"description": "Required. ID of the proximity location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_PROXIMITY`.", +"format": "int64", +"type": "string" +}, +"proximityRadius": { +"description": "Required. Radius expressed in the distance units set in proximity_radius_unit. This represents the size of the area around a chosen location that will be targeted. Radius should be between 1 and 500 miles or 800 kilometers.", +"format": "double", +"type": "number" +}, +"proximityRadiusUnit": { +"description": "Required. Radius distance units.", +"enum": [ +"PROXIMITY_RADIUS_UNIT_UNSPECIFIED", +"PROXIMITY_RADIUS_UNIT_MILES", +"PROXIMITY_RADIUS_UNIT_KILOMETERS" +], +"enumDescriptions": [ +"Default value when distance units is not specified in this version. This enum is a place holder for default value and does not represent a real distance unit.", +"Radius distance unit in miles.", +"Radius distance unit in kilometeres" +], +"type": "string" +} +}, +"type": "object" +}, +"RateDetails": { +"description": "The rate related settings of the inventory source.", +"id": "RateDetails", +"properties": { +"inventorySourceRateType": { +"description": "The rate type. Acceptable values are `INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED`, `INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR`, and `INVENTORY_SOURCE_RATE_TYPE_CPD`.", +"enum": [ +"INVENTORY_SOURCE_RATE_TYPE_UNSPECIFIED", +"INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED", +"INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR", +"INVENTORY_SOURCE_RATE_TYPE_CPD", +"INVENTORY_SOURCE_RATE_TYPE_FLAT" +], +"enumDescriptions": [ +"The rate type is not specified or is unknown in this version.", +"The rate type is CPM (Fixed).", +"The rate type is CPM (Floor).", +"The rate type is Cost per Day.", +"The rate type is Flat." +], +"type": "string" +}, +"minimumSpend": { +"$ref": "Money", +"description": "Output only. The amount that the buyer has committed to spending on the inventory source up front. Only applicable for guaranteed inventory sources.", +"readOnly": true +}, +"rate": { +"$ref": "Money", +"description": "The rate for the inventory source." +}, +"unitsPurchased": { +"description": "Required for guaranteed inventory sources. The number of impressions guaranteed by the seller.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"RegionalLocationListAssignedTargetingOptionDetails": { +"description": "Targeting details for regional location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`.", +"id": "RegionalLocationListAssignedTargetingOptionDetails", +"properties": { +"negative": { +"description": "Indicates if this option is being negatively targeted.", +"type": "boolean" +}, +"regionalLocationListId": { +"description": "Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"RemarketingConfig": { +"description": "Settings that control the whether remarketing is enabled for the given identified advertiser.", +"id": "RemarketingConfig", +"properties": { +"advertiserId": { +"description": "Output only. The ID of the advertiser.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"remarketingEnabled": { +"description": "Output only. Whether the Floodlight activity remarketing user list is available to the identified advertiser.", +"readOnly": true, +"type": "boolean" +} +}, +"type": "object" +}, +"ReplaceNegativeKeywordsRequest": { +"description": "Request message for NegativeKeywordService.ReplaceNegativeKeywords.", +"id": "ReplaceNegativeKeywordsRequest", +"properties": { +"newNegativeKeywords": { +"description": "The negative keywords that will replace the existing keywords in the negative keyword list, specified as a list of NegativeKeywords.", +"items": { +"$ref": "NegativeKeyword" +}, +"type": "array" +} +}, +"type": "object" +}, +"ReplaceNegativeKeywordsResponse": { +"description": "Response message for NegativeKeywordService.ReplaceNegativeKeywords.", +"id": "ReplaceNegativeKeywordsResponse", +"properties": { +"negativeKeywords": { +"description": "The full list of negative keywords now present in the negative keyword list.", +"items": { +"$ref": "NegativeKeyword" +}, +"type": "array" +} +}, +"type": "object" +}, +"ReplaceSitesRequest": { +"description": "Request message for SiteService.ReplaceSites.", +"id": "ReplaceSitesRequest", +"properties": { +"advertiserId": { +"description": "The ID of the advertiser that owns the parent channel.", +"format": "int64", +"type": "string" +}, +"newSites": { +"description": "The sites that will replace the existing sites assigned to the channel, specified as a list of Sites.", +"items": { +"$ref": "Site" +}, +"type": "array" +}, +"partnerId": { +"description": "The ID of the partner that owns the parent channel.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"ReplaceSitesResponse": { +"description": "Response message for SiteService.ReplaceSites.", +"id": "ReplaceSitesResponse", +"properties": { +"sites": { +"description": "The list of sites in the channel after replacing.", +"items": { +"$ref": "Site" +}, +"type": "array" +} +}, +"type": "object" +}, +"ReviewStatusInfo": { +"description": "Review statuses for the creative.", +"id": "ReviewStatusInfo", +"properties": { +"approvalStatus": { +"description": "Represents the basic approval needed for a creative to begin serving. Summary of creative_and_landing_page_review_status and content_and_policy_review_status.", +"enum": [ +"APPROVAL_STATUS_UNSPECIFIED", +"APPROVAL_STATUS_PENDING_NOT_SERVABLE", +"APPROVAL_STATUS_PENDING_SERVABLE", +"APPROVAL_STATUS_APPROVED_SERVABLE", +"APPROVAL_STATUS_REJECTED_NOT_SERVABLE" +], +"enumDescriptions": [ +"Type value is not specified or is unknown in this version.", +"The creative is still under review and not servable.", +"The creative has passed creative & landing page review and is servable, but is awaiting additional content & policy review.", +"Both creative & landing page review and content & policy review are approved. The creative is servable.", +"There is an issue with the creative that must be fixed before it can serve." +], +"type": "string" +}, +"contentAndPolicyReviewStatus": { +"description": "Content and policy review status for the creative.", +"enum": [ +"REVIEW_STATUS_UNSPECIFIED", +"REVIEW_STATUS_APPROVED", +"REVIEW_STATUS_REJECTED", +"REVIEW_STATUS_PENDING" +], +"enumDescriptions": [ +"Type value is not specified or is unknown in this version.", +"The creative is approved.", +"The creative is rejected.", +"The creative is pending review." +], +"type": "string" +}, +"creativeAndLandingPageReviewStatus": { +"description": "Creative and landing page review status for the creative.", +"enum": [ +"REVIEW_STATUS_UNSPECIFIED", +"REVIEW_STATUS_APPROVED", +"REVIEW_STATUS_REJECTED", +"REVIEW_STATUS_PENDING" +], +"enumDescriptions": [ +"Type value is not specified or is unknown in this version.", +"The creative is approved.", +"The creative is rejected.", +"The creative is pending review." +], +"type": "string" +}, +"exchangeReviewStatuses": { +"description": "Exchange review statuses for the creative.", +"items": { +"$ref": "ExchangeReviewStatus" +}, +"type": "array" +} +}, +"type": "object" +}, +"ScriptError": { +"description": "An error message for a custom bidding script.", +"id": "ScriptError", +"properties": { +"column": { +"description": "The column number in the script where the error was thrown.", +"format": "int64", +"type": "string" +}, +"errorCode": { +"description": "The type of error.", +"enum": [ +"ERROR_CODE_UNSPECIFIED", +"SYNTAX_ERROR", +"DEPRECATED_SYNTAX", +"INTERNAL_ERROR" +], +"enumDescriptions": [ +"The script error is not specified or is unknown in this version.", +"The script has a syntax error.", +"The script uses deprecated syntax.", +"Internal errors were thrown while processing the script." +], +"type": "string" +}, +"errorMessage": { +"description": "The detailed error message.", +"type": "string" +}, +"line": { +"description": "The line number in the script where the error was thrown.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"SdfConfig": { +"description": "Structured Data File (SDF) related settings.", +"id": "SdfConfig", +"properties": { +"adminEmail": { +"description": "An administrator email address to which the SDF processing status reports will be sent.", +"type": "string" +}, +"version": { +"description": "Required. The version of SDF being used.", +"enum": [ +"SDF_VERSION_UNSPECIFIED", +"SDF_VERSION_3_1", +"SDF_VERSION_4", +"SDF_VERSION_4_1", +"SDF_VERSION_4_2", +"SDF_VERSION_5", +"SDF_VERSION_5_1", +"SDF_VERSION_5_2", +"SDF_VERSION_5_3", +"SDF_VERSION_5_4", +"SDF_VERSION_5_5", +"SDF_VERSION_6", +"SDF_VERSION_7", +"SDF_VERSION_7_1", +"SDF_VERSION_8" +], +"enumDeprecated": [ +false, +true, +true, +true, +true, +true, +true, +true, +true, +true, +true, +false, +false, +false, +false +], +"enumDescriptions": [ +"SDF version value is not specified or is unknown in this version.", +"SDF version 3.1", +"SDF version 4", +"SDF version 4.1", +"SDF version 4.2", +"SDF version 5.", +"SDF version 5.1", +"SDF version 5.2", +"SDF version 5.3", +"SDF version 5.4", +"SDF version 5.5", +"SDF version 6", +"SDF version 7. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version.", +"SDF version 7.1. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version.", +"SDF version 8. Read the [v8 migration guide](/display-video/api/structured-data-file/v8-migration-guide) before migrating to this version." +], +"type": "string" +} +}, +"type": "object" +}, +"SdfDownloadTask": { +"description": "Type for the response returned by [SdfDownloadTaskService.CreateSdfDownloadTask].", +"id": "SdfDownloadTask", +"properties": { +"resourceName": { +"description": "A resource name to be used in media.download to Download the prepared files. Resource names have the format `download/sdfdownloadtasks/media/{media_id}`. `media_id` will be made available by the long running operation service once the task status is done.", +"type": "string" +} +}, +"type": "object" +}, +"SdfDownloadTaskMetadata": { +"description": "Type for the metadata returned by [SdfDownloadTaskService.CreateSdfDownloadTask].", +"id": "SdfDownloadTaskMetadata", +"properties": { +"createTime": { +"description": "The time when the operation was created.", +"format": "google-datetime", +"type": "string" +}, +"endTime": { +"description": "The time when execution was completed.", +"format": "google-datetime", +"type": "string" +}, +"version": { +"description": "The SDF version used to execute this download task.", +"enum": [ +"SDF_VERSION_UNSPECIFIED", +"SDF_VERSION_3_1", +"SDF_VERSION_4", +"SDF_VERSION_4_1", +"SDF_VERSION_4_2", +"SDF_VERSION_5", +"SDF_VERSION_5_1", +"SDF_VERSION_5_2", +"SDF_VERSION_5_3", +"SDF_VERSION_5_4", +"SDF_VERSION_5_5", +"SDF_VERSION_6", +"SDF_VERSION_7", +"SDF_VERSION_7_1", +"SDF_VERSION_8" +], +"enumDeprecated": [ +false, +true, +true, +true, +true, +true, +true, +true, +true, +true, +true, +false, +false, +false, +false +], +"enumDescriptions": [ +"SDF version value is not specified or is unknown in this version.", +"SDF version 3.1", +"SDF version 4", +"SDF version 4.1", +"SDF version 4.2", +"SDF version 5.", +"SDF version 5.1", +"SDF version 5.2", +"SDF version 5.3", +"SDF version 5.4", +"SDF version 5.5", +"SDF version 6", +"SDF version 7. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version.", +"SDF version 7.1. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version.", +"SDF version 8. Read the [v8 migration guide](/display-video/api/structured-data-file/v8-migration-guide) before migrating to this version." +], +"type": "string" +} +}, +"type": "object" +}, +"SearchTargetingOptionsRequest": { +"description": "Request message for SearchTargetingOptions.", +"id": "SearchTargetingOptionsRequest", +"properties": { +"advertiserId": { +"description": "Required. The Advertiser this request is being made in the context of.", +"format": "int64", +"type": "string" +}, +"businessChainSearchTerms": { +"$ref": "BusinessChainSearchTerms", +"description": "Search terms for Business Chain targeting options. Can only be used when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`." +}, +"geoRegionSearchTerms": { +"$ref": "GeoRegionSearchTerms", +"description": "Search terms for geo region targeting options. Can only be used when targeting_type is `TARGETING_TYPE_GEO_REGION`." +}, +"pageSize": { +"description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", +"format": "int32", +"type": "integer" +}, +"pageToken": { +"description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `SearchTargetingOptions` method. If not specified, the first page of results will be returned.", +"type": "string" +}, +"poiSearchTerms": { +"$ref": "PoiSearchTerms", +"description": "Search terms for POI targeting options. Can only be used when targeting_type is `TARGETING_TYPE_POI`." +} +}, +"type": "object" +}, +"SearchTargetingOptionsResponse": { +"description": "Response message for SearchTargetingOptions.", +"id": "SearchTargetingOptionsResponse", +"properties": { +"nextPageToken": { +"description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `SearchTargetingOptions` method to retrieve the next page of results.", +"type": "string" +}, +"targetingOptions": { +"description": "The list of targeting options that match the search criteria. This list will be absent if empty.", +"items": { +"$ref": "TargetingOption" +}, +"type": "array" +} +}, +"type": "object" +}, +"SensitiveCategoryAssignedTargetingOptionDetails": { +"description": "Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`.", +"id": "SensitiveCategoryAssignedTargetingOptionDetails", +"properties": { +"excludedSensitiveCategory": { +"description": "Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED.", +"enum": [ +"SENSITIVE_CATEGORY_UNSPECIFIED", +"SENSITIVE_CATEGORY_ADULT", +"SENSITIVE_CATEGORY_DEROGATORY", +"SENSITIVE_CATEGORY_DOWNLOADS_SHARING", +"SENSITIVE_CATEGORY_WEAPONS", +"SENSITIVE_CATEGORY_GAMBLING", +"SENSITIVE_CATEGORY_VIOLENCE", +"SENSITIVE_CATEGORY_SUGGESTIVE", +"SENSITIVE_CATEGORY_PROFANITY", +"SENSITIVE_CATEGORY_ALCOHOL", +"SENSITIVE_CATEGORY_DRUGS", +"SENSITIVE_CATEGORY_TOBACCO", +"SENSITIVE_CATEGORY_POLITICS", +"SENSITIVE_CATEGORY_RELIGION", +"SENSITIVE_CATEGORY_TRAGEDY", +"SENSITIVE_CATEGORY_TRANSPORTATION_ACCIDENTS", +"SENSITIVE_CATEGORY_SENSITIVE_SOCIAL_ISSUES", +"SENSITIVE_CATEGORY_SHOCKING", +"SENSITIVE_CATEGORY_EMBEDDED_VIDEO", +"SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO" +], +"enumDescriptions": [ +"This enum is only a placeholder and doesn't specify a DV360 sensitive category.", +"Adult or pornographic text, image, or video content.", +"Content that may be construed as biased against individuals, groups, or organizations based on criteria such as race, religion, disability, sex, age, veteran status, sexual orientation, gender identity, or political affiliation. May also indicate discussion of such content, for instance, in an academic or journalistic context.", +"Content related to audio, video, or software downloads.", +"Contains content related to personal weapons, including knives, guns, small firearms, and ammunition. Selecting either \"weapons\" or \"sensitive social issues\" will result in selecting both.", +"Contains content related to betting or wagering in a real-world or online setting.", +"Content which may be considered graphically violent, gory, gruesome, or shocking, such as street fighting videos, accident photos, descriptions of torture, etc.", +"Adult content, as well as suggestive content that's not explicitly pornographic. This category includes all pages categorized as adult.", +"Prominent use of words considered indecent, such as curse words and sexual slang. Pages with only very occasional usage, such as news sites that might include such words in a quotation, are not included.", +"Contains content related to alcoholic beverages, alcohol brands, recipes, etc.", +"Contains content related to the recreational use of legal or illegal drugs, as well as to drug paraphernalia or cultivation.", +"Contains content related to tobacco and tobacco accessories, including lighters, humidors, ashtrays, etc.", +"Political news and media, including discussions of social, governmental, and public policy.", +"Content related to religious thought or beliefs.", +"Content related to death, disasters, accidents, war, etc.", +"Content related to motor vehicle, aviation or other transportation accidents.", +"Issues that evoke strong, opposing views and spark debate. These include issues that are controversial in most countries and markets (such as abortion), as well as those that are controversial in specific countries and markets (such as immigration reform in the United States).", +"Content which may be considered shocking or disturbing, such as violent news stories, stunts, or toilet humor.", +"YouTube videos embedded on websites outside of YouTube.com.", +"Video of live events streamed over the internet." +], +"type": "string" +} +}, +"type": "object" +}, +"SensitiveCategoryTargetingOptionDetails": { +"description": "Represents a targetable sensitive category. This will be populated in the sensitive_category_details field of the TargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`.", +"id": "SensitiveCategoryTargetingOptionDetails", +"properties": { +"sensitiveCategory": { +"description": "Output only. An enum for the DV360 Sensitive category content classifier.", +"enum": [ +"SENSITIVE_CATEGORY_UNSPECIFIED", +"SENSITIVE_CATEGORY_ADULT", +"SENSITIVE_CATEGORY_DEROGATORY", +"SENSITIVE_CATEGORY_DOWNLOADS_SHARING", +"SENSITIVE_CATEGORY_WEAPONS", +"SENSITIVE_CATEGORY_GAMBLING", +"SENSITIVE_CATEGORY_VIOLENCE", +"SENSITIVE_CATEGORY_SUGGESTIVE", +"SENSITIVE_CATEGORY_PROFANITY", +"SENSITIVE_CATEGORY_ALCOHOL", +"SENSITIVE_CATEGORY_DRUGS", +"SENSITIVE_CATEGORY_TOBACCO", +"SENSITIVE_CATEGORY_POLITICS", +"SENSITIVE_CATEGORY_RELIGION", +"SENSITIVE_CATEGORY_TRAGEDY", +"SENSITIVE_CATEGORY_TRANSPORTATION_ACCIDENTS", +"SENSITIVE_CATEGORY_SENSITIVE_SOCIAL_ISSUES", +"SENSITIVE_CATEGORY_SHOCKING", +"SENSITIVE_CATEGORY_EMBEDDED_VIDEO", +"SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO" +], +"enumDescriptions": [ +"This enum is only a placeholder and doesn't specify a DV360 sensitive category.", +"Adult or pornographic text, image, or video content.", +"Content that may be construed as biased against individuals, groups, or organizations based on criteria such as race, religion, disability, sex, age, veteran status, sexual orientation, gender identity, or political affiliation. May also indicate discussion of such content, for instance, in an academic or journalistic context.", +"Content related to audio, video, or software downloads.", +"Contains content related to personal weapons, including knives, guns, small firearms, and ammunition. Selecting either \"weapons\" or \"sensitive social issues\" will result in selecting both.", +"Contains content related to betting or wagering in a real-world or online setting.", +"Content which may be considered graphically violent, gory, gruesome, or shocking, such as street fighting videos, accident photos, descriptions of torture, etc.", +"Adult content, as well as suggestive content that's not explicitly pornographic. This category includes all pages categorized as adult.", +"Prominent use of words considered indecent, such as curse words and sexual slang. Pages with only very occasional usage, such as news sites that might include such words in a quotation, are not included.", +"Contains content related to alcoholic beverages, alcohol brands, recipes, etc.", +"Contains content related to the recreational use of legal or illegal drugs, as well as to drug paraphernalia or cultivation.", +"Contains content related to tobacco and tobacco accessories, including lighters, humidors, ashtrays, etc.", +"Political news and media, including discussions of social, governmental, and public policy.", +"Content related to religious thought or beliefs.", +"Content related to death, disasters, accidents, war, etc.", +"Content related to motor vehicle, aviation or other transportation accidents.", +"Issues that evoke strong, opposing views and spark debate. These include issues that are controversial in most countries and markets (such as abortion), as well as those that are controversial in specific countries and markets (such as immigration reform in the United States).", +"Content which may be considered shocking or disturbing, such as violent news stories, stunts, or toilet humor.", +"YouTube videos embedded on websites outside of YouTube.com.", +"Video of live events streamed over the internet." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"SessionPositionAssignedTargetingOptionDetails": { +"description": "Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`.", +"id": "SessionPositionAssignedTargetingOptionDetails", +"properties": { +"sessionPosition": { +"description": "The position where the ad will show in a session.", +"enum": [ +"SESSION_POSITION_UNSPECIFIED", +"SESSION_POSITION_FIRST_IMPRESSION" +], +"enumDescriptions": [ +"This is a placeholder, does not indicate any positions.", +"The first impression of the session." +], +"type": "string" +} +}, +"type": "object" +}, +"Site": { +"description": "A single site. Sites are apps or websites belonging to a channel.", +"id": "Site", +"properties": { +"name": { +"description": "Output only. The resource name of the site.", +"readOnly": true, +"type": "string" +}, +"urlOrAppId": { +"description": "Required. The app ID or URL of the site. Must be UTF-8 encoded with a maximum length of 240 bytes.", +"type": "string" +} +}, +"type": "object" +}, +"Status": { +"description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). 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).", +"id": "Status", +"properties": { +"code": { +"description": "The status code, which should be an enum value of google.rpc.Code.", +"format": "int32", +"type": "integer" +}, +"details": { +"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", +"items": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"type": "object" +}, +"type": "array" +}, +"message": { "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", "type": "string" } }, "type": "object" +}, +"SubExchangeAssignedTargetingOptionDetails": { +"description": "Details for assigned sub-exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`.", +"id": "SubExchangeAssignedTargetingOptionDetails", +"properties": { +"targetingOptionId": { +"description": "Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`.", +"type": "string" +} +}, +"type": "object" +}, +"SubExchangeTargetingOptionDetails": { +"description": "Represents a targetable sub-exchange. This will be populated in the sub_exchange_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`.", +"id": "SubExchangeTargetingOptionDetails", +"properties": { +"displayName": { +"description": "Output only. The display name of the sub-exchange.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"TargetFrequency": { +"description": "Setting that controls the average number of times the ads will show to the same person over a certain period of time.", +"id": "TargetFrequency", +"properties": { +"targetCount": { +"description": "The target number of times, on average, the ads will be shown to the same person in the timespan dictated by time_unit and time_unit_count.", +"format": "int64", +"type": "string" +}, +"timeUnit": { +"description": "The unit of time in which the target frequency will be applied. The following time unit is applicable: * `TIME_UNIT_WEEKS`", +"enum": [ +"TIME_UNIT_UNSPECIFIED", +"TIME_UNIT_LIFETIME", +"TIME_UNIT_MONTHS", +"TIME_UNIT_WEEKS", +"TIME_UNIT_DAYS", +"TIME_UNIT_HOURS", +"TIME_UNIT_MINUTES" +], +"enumDescriptions": [ +"Time unit value is not specified or is unknown in this version.", +"The frequency cap will be applied to the whole life time of the line item.", +"The frequency cap will be applied to a number of months.", +"The frequency cap will be applied to a number of weeks.", +"The frequency cap will be applied to a number of days.", +"The frequency cap will be applied to a number of hours.", +"The frequency cap will be applied to a number of minutes." +], +"type": "string" +}, +"timeUnitCount": { +"description": "The number of time_unit the target frequency will last. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_WEEKS` - must be 1", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"TargetingExpansionConfig": { +"description": "Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item.", +"id": "TargetingExpansionConfig", +"properties": { +"audienceExpansionLevel": { +"description": "Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources.", +"enum": [ +"UNKNOWN", +"NO_REACH", +"LEAST_REACH", +"MID_REACH", +"MOST_REACH" +], +"enumDescriptions": [ +"Audience expansion level is not specified or is unknown in this version.", +"Audience expansion off.", +"Conservative audience expansion.", +"Moderate audience expansion.", +"Aggressive audience expansion." +], +"readOnly": true, +"type": "string" +}, +"audienceExpansionSeedListExcluded": { +"description": "Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources.", +"readOnly": true, +"type": "boolean" +}, +"enableOptimizedTargeting": { +"description": "Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` *Warning*: Starting **March 6, 2025**, this field will stop being compatible when using the BiddingStrategy field fixed_bid. [Read more about this announced change](/display-video/api/deprecations#features.ot_fixed_bid)", +"type": "boolean" +} +}, +"type": "object" +}, +"TargetingOption": { +"description": "Represents a single targeting option, which is a targetable concept in DV360.", +"id": "TargetingOption", +"properties": { +"ageRangeDetails": { +"$ref": "AgeRangeTargetingOptionDetails", +"description": "Age range details." +}, +"appCategoryDetails": { +"$ref": "AppCategoryTargetingOptionDetails", +"description": "App category details." +}, +"audioContentTypeDetails": { +"$ref": "AudioContentTypeTargetingOptionDetails", +"description": "Audio content type details." +}, +"authorizedSellerStatusDetails": { +"$ref": "AuthorizedSellerStatusTargetingOptionDetails", +"description": "Authorized seller status resource details." +}, +"browserDetails": { +"$ref": "BrowserTargetingOptionDetails", +"description": "Browser details." +}, +"businessChainDetails": { +"$ref": "BusinessChainTargetingOptionDetails", +"description": "Business chain resource details." +}, +"carrierAndIspDetails": { +"$ref": "CarrierAndIspTargetingOptionDetails", +"description": "Carrier and ISP details." +}, +"categoryDetails": { +"$ref": "CategoryTargetingOptionDetails", +"description": "Category resource details." +}, +"contentDurationDetails": { +"$ref": "ContentDurationTargetingOptionDetails", +"description": "Content duration resource details." +}, +"contentGenreDetails": { +"$ref": "ContentGenreTargetingOptionDetails", +"description": "Content genre resource details." +}, +"contentInstreamPositionDetails": { +"$ref": "ContentInstreamPositionTargetingOptionDetails", +"description": "Content instream position details." +}, +"contentOutstreamPositionDetails": { +"$ref": "ContentOutstreamPositionTargetingOptionDetails", +"description": "Content outstream position details." +}, +"contentStreamTypeDetails": { +"$ref": "ContentStreamTypeTargetingOptionDetails", +"description": "Content stream type resource details." +}, +"deviceMakeModelDetails": { +"$ref": "DeviceMakeModelTargetingOptionDetails", +"description": "Device make and model resource details." +}, +"deviceTypeDetails": { +"$ref": "DeviceTypeTargetingOptionDetails", +"description": "Device type details." +}, +"digitalContentLabelDetails": { +"$ref": "DigitalContentLabelTargetingOptionDetails", +"description": "Digital content label details." +}, +"environmentDetails": { +"$ref": "EnvironmentTargetingOptionDetails", +"description": "Environment details." +}, +"exchangeDetails": { +"$ref": "ExchangeTargetingOptionDetails", +"description": "Exchange details." +}, +"genderDetails": { +"$ref": "GenderTargetingOptionDetails", +"description": "Gender details." +}, +"geoRegionDetails": { +"$ref": "GeoRegionTargetingOptionDetails", +"description": "Geographic region resource details." +}, +"householdIncomeDetails": { +"$ref": "HouseholdIncomeTargetingOptionDetails", +"description": "Household income details." +}, +"languageDetails": { +"$ref": "LanguageTargetingOptionDetails", +"description": "Language resource details." +}, +"name": { +"description": "Output only. The resource name for this targeting option.", +"readOnly": true, +"type": "string" +}, +"nativeContentPositionDetails": { +"$ref": "NativeContentPositionTargetingOptionDetails", +"description": "Native content position details." +}, +"omidDetails": { +"$ref": "OmidTargetingOptionDetails", +"description": "Open Measurement enabled inventory details." +}, +"onScreenPositionDetails": { +"$ref": "OnScreenPositionTargetingOptionDetails", +"description": "On screen position details." +}, +"operatingSystemDetails": { +"$ref": "OperatingSystemTargetingOptionDetails", +"description": "Operating system resources details." +}, +"parentalStatusDetails": { +"$ref": "ParentalStatusTargetingOptionDetails", +"description": "Parental status details." +}, +"poiDetails": { +"$ref": "PoiTargetingOptionDetails", +"description": "POI resource details." +}, +"sensitiveCategoryDetails": { +"$ref": "SensitiveCategoryTargetingOptionDetails", +"description": "Sensitive Category details." +}, +"subExchangeDetails": { +"$ref": "SubExchangeTargetingOptionDetails", +"description": "Sub-exchange details." +}, +"targetingOptionId": { +"description": "Output only. A unique identifier for this targeting option. The tuple {`targeting_type`, `targeting_option_id`} will be unique.", +"readOnly": true, +"type": "string" +}, +"targetingType": { +"description": "Output only. The type of this targeting option.", +"enum": [ +"TARGETING_TYPE_UNSPECIFIED", +"TARGETING_TYPE_CHANNEL", +"TARGETING_TYPE_APP_CATEGORY", +"TARGETING_TYPE_APP", +"TARGETING_TYPE_URL", +"TARGETING_TYPE_DAY_AND_TIME", +"TARGETING_TYPE_AGE_RANGE", +"TARGETING_TYPE_REGIONAL_LOCATION_LIST", +"TARGETING_TYPE_PROXIMITY_LOCATION_LIST", +"TARGETING_TYPE_GENDER", +"TARGETING_TYPE_VIDEO_PLAYER_SIZE", +"TARGETING_TYPE_USER_REWARDED_CONTENT", +"TARGETING_TYPE_PARENTAL_STATUS", +"TARGETING_TYPE_CONTENT_INSTREAM_POSITION", +"TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", +"TARGETING_TYPE_DEVICE_TYPE", +"TARGETING_TYPE_AUDIENCE_GROUP", +"TARGETING_TYPE_BROWSER", +"TARGETING_TYPE_HOUSEHOLD_INCOME", +"TARGETING_TYPE_ON_SCREEN_POSITION", +"TARGETING_TYPE_THIRD_PARTY_VERIFIER", +"TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", +"TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", +"TARGETING_TYPE_ENVIRONMENT", +"TARGETING_TYPE_CARRIER_AND_ISP", +"TARGETING_TYPE_OPERATING_SYSTEM", +"TARGETING_TYPE_DEVICE_MAKE_MODEL", +"TARGETING_TYPE_KEYWORD", +"TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", +"TARGETING_TYPE_VIEWABILITY", +"TARGETING_TYPE_CATEGORY", +"TARGETING_TYPE_INVENTORY_SOURCE", +"TARGETING_TYPE_LANGUAGE", +"TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", +"TARGETING_TYPE_GEO_REGION", +"TARGETING_TYPE_INVENTORY_SOURCE_GROUP", +"TARGETING_TYPE_EXCHANGE", +"TARGETING_TYPE_SUB_EXCHANGE", +"TARGETING_TYPE_POI", +"TARGETING_TYPE_BUSINESS_CHAIN", +"TARGETING_TYPE_CONTENT_DURATION", +"TARGETING_TYPE_CONTENT_STREAM_TYPE", +"TARGETING_TYPE_NATIVE_CONTENT_POSITION", +"TARGETING_TYPE_OMID", +"TARGETING_TYPE_AUDIO_CONTENT_TYPE", +"TARGETING_TYPE_CONTENT_GENRE", +"TARGETING_TYPE_YOUTUBE_VIDEO", +"TARGETING_TYPE_YOUTUBE_CHANNEL", +"TARGETING_TYPE_SESSION_POSITION" +], +"enumDescriptions": [ +"Default value when type is not specified or is unknown in this version.", +"Target a channel (a custom group of related websites or apps).", +"Target an app category (for example, education or puzzle games).", +"Target a specific app (for example, Angry Birds).", +"Target a specific url (for example, quora.com).", +"Target ads during a chosen time period on a specific day.", +"Target ads to a specific age range (for example, 18-24).", +"Target ads to the specified regions on a regional location list.", +"Target ads to the specified points of interest on a proximity location list.", +"Target ads to a specific gender (for example, female or male).", +"Target a specific video player size for video ads.", +"Target user rewarded content for video ads.", +"Target ads to a specific parental status (for example, parent or not a parent).", +"Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", +"Target ads in a specific content outstream position.", +"Target ads to a specific device type (for example, tablet or connected TV).", +"Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", +"Target ads to specific web browsers (for example, Chrome).", +"Target ads to a specific household income range (for example, top 10%).", +"Target ads in a specific on screen position.", +"Filter web sites through third party verification (for example, IAS or DoubleVerify).", +"Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", +"Filter website content by sensitive categories (for example, adult).", +"Target ads to a specific environment (for example, web or app).", +"Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", +"Target ads to a specific operating system (for example, macOS).", +"Target ads to a specific device make or model (for example, Roku or Samsung).", +"Target ads to a specific keyword (for example, dog or retriever).", +"Target ads to a specific negative keyword list.", +"Target ads to a specific viewability (for example, 80% viewable).", +"Target ads to a specific content category (for example, arts & entertainment).", +"Purchase impressions from specific deals and auction packages.", +"Target ads to a specific language (for example, English or Japanese).", +"Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", +"Target ads to a specific regional location (for example, a city or state).", +"Purchase impressions from a group of deals and auction packages.", +"Purchase impressions from specific exchanges.", +"Purchase impressions from specific sub-exchanges.", +"Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", +"Target ads around locations of a business chain within a specific geo region.", +"Target ads to a specific video content duration.", +"Target ads to a specific video content stream type.", +"Target ads to a specific native content position.", +"Target ads in an Open Measurement enabled inventory.", +"Target ads to a specific audio content type.", +"Target ads to a specific content genre.", +"Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", +"Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", +"Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." +], +"readOnly": true, +"type": "string" +}, +"userRewardedContentDetails": { +"$ref": "UserRewardedContentTargetingOptionDetails", +"description": "User rewarded content details." +}, +"videoPlayerSizeDetails": { +"$ref": "VideoPlayerSizeTargetingOptionDetails", +"description": "Video player size details." +}, +"viewabilityDetails": { +"$ref": "ViewabilityTargetingOptionDetails", +"description": "Viewability resource details." +} +}, +"type": "object" +}, +"ThirdPartyMeasurementConfigs": { +"description": "Settings that control what third-party vendors are measuring specific line item metrics.", +"id": "ThirdPartyMeasurementConfigs", +"properties": { +"brandLiftVendorConfigs": { +"description": "Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR`", +"items": { +"$ref": "ThirdPartyVendorConfig" +}, +"type": "array" +}, +"brandSafetyVendorConfigs": { +"description": "Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZERF` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE`", +"items": { +"$ref": "ThirdPartyVendorConfig" +}, +"type": "array" +}, +"reachVendorConfigs": { +"description": "Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR`", +"items": { +"$ref": "ThirdPartyVendorConfig" +}, +"type": "array" +}, +"viewabilityVendorConfigs": { +"description": "Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS`", +"items": { +"$ref": "ThirdPartyVendorConfig" +}, +"type": "array" +} +}, +"type": "object" +}, +"ThirdPartyOnlyConfig": { +"description": "Settings for advertisers that use third-party ad servers only.", +"id": "ThirdPartyOnlyConfig", +"properties": { +"pixelOrderIdReportingEnabled": { +"description": "Whether or not order ID reporting for pixels is enabled. This value cannot be changed once set to `true`.", +"type": "boolean" +} +}, +"type": "object" +}, +"ThirdPartyUrl": { +"description": "Tracking URLs from third parties to track interactions with an audio or a video creative.", +"id": "ThirdPartyUrl", +"properties": { +"type": { +"description": "Optional. The type of interaction needs to be tracked by the tracking URL", +"enum": [ +"THIRD_PARTY_URL_TYPE_UNSPECIFIED", +"THIRD_PARTY_URL_TYPE_IMPRESSION", +"THIRD_PARTY_URL_TYPE_CLICK_TRACKING", +"THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_START", +"THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_FIRST_QUARTILE", +"THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_MIDPOINT", +"THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_THIRD_QUARTILE", +"THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_COMPLETE", +"THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_MUTE", +"THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_PAUSE", +"THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_REWIND", +"THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_FULLSCREEN", +"THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_STOP", +"THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_CUSTOM", +"THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_SKIP", +"THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_PROGRESS" +], +"enumDescriptions": [ +"The type of third-party URL is unspecified or is unknown in this version.", +"Used to count impressions of the creative after the audio or video buffering is complete.", +"Used to track user clicks on the audio or video.", +"Used to track the number of times a user starts the audio or video.", +"Used to track the number of times the audio or video plays to 25% of its length.", +"Used to track the number of times the audio or video plays to 50% of its length.", +"Used to track the number of times the audio or video plays to 75% of its length.", +"Used to track the number of times the audio or video plays to the end.", +"Used to track the number of times a user mutes the audio or video.", +"Used to track the number of times a user pauses the audio or video.", +"Used to track the number of times a user replays the audio or video.", +"Used to track the number of times a user expands the player to full-screen size.", +"Used to track the number of times a user stops the audio or video.", +"Used to track the number of times a user performs a custom click, such as clicking on a video hot spot.", +"Used to track the number of times the audio or video was skipped.", +"Used to track the number of times the audio or video plays to an offset determined by the progress_offset." +], +"type": "string" +}, +"url": { +"description": "Optional. Tracking URL used to track the interaction. Provide a URL with optional path or query string, beginning with `https:`. For example, `https://www.example.com/path`", +"type": "string" +} +}, +"type": "object" +}, +"ThirdPartyVendorConfig": { +"description": "Settings that control how third-party measurement vendors are configured.", +"id": "ThirdPartyVendorConfig", +"properties": { +"placementId": { +"description": "The ID used by the platform of the third-party vendor to identify the line item.", +"type": "string" +}, +"vendor": { +"description": "The third-party measurement vendor.", +"enum": [ +"THIRD_PARTY_VENDOR_UNSPECIFIED", +"THIRD_PARTY_VENDOR_MOAT", +"THIRD_PARTY_VENDOR_DOUBLE_VERIFY", +"THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE", +"THIRD_PARTY_VENDOR_COMSCORE", +"THIRD_PARTY_VENDOR_TELEMETRY", +"THIRD_PARTY_VENDOR_MEETRICS", +"THIRD_PARTY_VENDOR_ZEFR", +"THIRD_PARTY_VENDOR_NIELSEN", +"THIRD_PARTY_VENDOR_KANTAR", +"THIRD_PARTY_VENDOR_DYNATA" +], +"enumDescriptions": [ +"Unknown third-party vendor.", +"Moat.", +"DoubleVerify.", +"Integral Ad Science.", +"Comscore.", +"Telemetry.", +"Meetrics.", +"ZEFR.", +"Nielsen.", +"Kantar.", +"Dynata." +], +"type": "string" +} +}, +"type": "object" +}, +"ThirdPartyVerifierAssignedTargetingOptionDetails": { +"description": "Assigned third party verifier targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`.", +"id": "ThirdPartyVerifierAssignedTargetingOptionDetails", +"properties": { +"adloox": { +"$ref": "Adloox", +"description": "Third party brand verifier -- Adloox." +}, +"doubleVerify": { +"$ref": "DoubleVerify", +"description": "Third party brand verifier -- DoubleVerify." +}, +"integralAdScience": { +"$ref": "IntegralAdScience", +"description": "Third party brand verifier -- Integral Ad Science." +} +}, +"type": "object" +}, +"TimeRange": { +"description": "A time range.", +"id": "TimeRange", +"properties": { +"endTime": { +"description": "Required. The upper bound of a time range, inclusive.", +"format": "google-datetime", +"type": "string" +}, +"startTime": { +"description": "Required. The lower bound of a time range, inclusive.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"TimerEvent": { +"description": "Timer event of the creative.", +"id": "TimerEvent", +"properties": { +"name": { +"description": "Required. The name of the timer event.", +"type": "string" +}, +"reportingName": { +"description": "Required. The name used to identify this timer event in reports.", +"type": "string" +} +}, +"type": "object" +}, +"TrackingFloodlightActivityConfig": { +"description": "Settings that control the behavior of a single Floodlight activity config.", +"id": "TrackingFloodlightActivityConfig", +"properties": { +"floodlightActivityId": { +"description": "Required. The ID of the Floodlight activity.", +"format": "int64", +"type": "string" +}, +"postClickLookbackWindowDays": { +"description": "Required. The number of days after an ad has been clicked in which a conversion may be counted. Must be between 0 and 90 inclusive.", +"format": "int32", +"type": "integer" +}, +"postViewLookbackWindowDays": { +"description": "Required. The number of days after an ad has been viewed in which a conversion may be counted. Must be between 0 and 90 inclusive.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"Transcode": { +"description": "Represents information about the transcoded audio or video file.", +"id": "Transcode", +"properties": { +"audioBitRateKbps": { +"description": "Optional. The bit rate for the audio stream of the transcoded video, or the bit rate for the transcoded audio, in kilobits per second.", +"format": "int64", +"type": "string" +}, +"audioSampleRateHz": { +"description": "Optional. The sample rate for the audio stream of the transcoded video, or the sample rate for the transcoded audio, in hertz.", +"format": "int64", +"type": "string" +}, +"bitRateKbps": { +"description": "Optional. The transcoding bit rate of the transcoded video, in kilobits per second.", +"format": "int64", +"type": "string" +}, +"dimensions": { +"$ref": "Dimensions", +"description": "Optional. The dimensions of the transcoded video." +}, +"fileSizeBytes": { +"description": "Optional. The size of the transcoded file, in bytes.", +"format": "int64", +"type": "string" +}, +"frameRate": { +"description": "Optional. The frame rate of the transcoded video, in frames per second.", +"format": "float", +"type": "number" +}, +"mimeType": { +"description": "Optional. The MIME type of the transcoded file.", +"type": "string" +}, +"name": { +"description": "Optional. The name of the transcoded file.", +"type": "string" +}, +"transcoded": { +"description": "Optional. Indicates if the transcoding was successful.", +"type": "boolean" +} +}, +"type": "object" +}, +"UniversalAdId": { +"description": "A creative identifier provided by a registry that is unique across all platforms. This is part of the VAST 4.0 standard.", +"id": "UniversalAdId", +"properties": { +"id": { +"description": "Optional. The unique creative identifier.", +"type": "string" +}, +"registry": { +"description": "Optional. The registry provides unique creative identifiers.", +"enum": [ +"UNIVERSAL_AD_REGISTRY_UNSPECIFIED", +"UNIVERSAL_AD_REGISTRY_OTHER", +"UNIVERSAL_AD_REGISTRY_AD_ID", +"UNIVERSAL_AD_REGISTRY_CLEARCAST", +"UNIVERSAL_AD_REGISTRY_DV360", +"UNIVERSAL_AD_REGISTRY_CM" +], +"enumDescriptions": [ +"The Universal Ad registry is unspecified or is unknown in this version.", +"Use a custom provider to provide the Universal Ad ID.", +"Use Ad-ID to provide the Universal Ad ID.", +"Use clearcast.co.uk to provide the Universal Ad ID.", +"Use Display & Video 360 to provide the Universal Ad ID.", +"Use Campaign Manager 360 to provide the Universal Ad ID." +], +"type": "string" +} +}, +"type": "object" +}, +"UrlAssignedTargetingOptionDetails": { +"description": "Details for assigned URL targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_URL`.", +"id": "UrlAssignedTargetingOptionDetails", +"properties": { +"negative": { +"description": "Indicates if this option is being negatively targeted.", +"type": "boolean" +}, +"url": { +"description": "Required. The URL, for example `example.com`. DV360 supports two levels of subdirectory targeting, for example `www.example.com/one-subdirectory-level/second-level`, and five levels of subdomain targeting, for example `five.four.three.two.one.example.com`.", +"type": "string" +} +}, +"type": "object" +}, +"User": { +"description": "A single user in Display & Video 360.", +"id": "User", +"properties": { +"assignedUserRoles": { +"description": "The assigned user roles. Required in CreateUser. Output only in UpdateUser. Can only be updated through BulkEditAssignedUserRoles.", +"items": { +"$ref": "AssignedUserRole" +}, +"type": "array" +}, +"displayName": { +"description": "Required. The display name of the user. Must be UTF-8 encoded with a maximum size of 240 bytes.", +"type": "string" +}, +"email": { +"description": "Required. Immutable. The email address used to identify the user.", +"type": "string" +}, +"lastLoginTime": { +"description": "Output only. The timestamp when the user last logged in DV360 UI.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Output only. The resource name of the user.", +"readOnly": true, +"type": "string" +}, +"userId": { +"description": "Output only. The unique ID of the user. Assigned by the system.", +"format": "int64", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"UserRewardedContentAssignedTargetingOptionDetails": { +"description": "User rewarded content targeting option details. This will be populated in the user_rewarded_content_details field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.", +"id": "UserRewardedContentAssignedTargetingOptionDetails", +"properties": { +"targetingOptionId": { +"description": "Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.", +"type": "string" +}, +"userRewardedContent": { +"description": "Output only. User rewarded content status for video ads.", +"enum": [ +"USER_REWARDED_CONTENT_UNSPECIFIED", +"USER_REWARDED_CONTENT_USER_REWARDED", +"USER_REWARDED_CONTENT_NOT_USER_REWARDED" +], +"enumDescriptions": [ +"User rewarded content is not specified or is unknown in this version.", +"Represents ads where the user will see a reward after viewing.", +"Represents all other ads besides user-rewarded." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"UserRewardedContentTargetingOptionDetails": { +"description": "Represents a targetable user rewarded content status for video ads only. This will be populated in the user_rewarded_content_details field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.", +"id": "UserRewardedContentTargetingOptionDetails", +"properties": { +"userRewardedContent": { +"description": "Output only. User rewarded content status for video ads.", +"enum": [ +"USER_REWARDED_CONTENT_UNSPECIFIED", +"USER_REWARDED_CONTENT_USER_REWARDED", +"USER_REWARDED_CONTENT_NOT_USER_REWARDED" +], +"enumDescriptions": [ +"User rewarded content is not specified or is unknown in this version.", +"Represents ads where the user will see a reward after viewing.", +"Represents all other ads besides user-rewarded." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"VideoAdSequenceSettings": { +"description": "Settings related to VideoAdSequence.", +"id": "VideoAdSequenceSettings", +"properties": { +"minimumDuration": { +"description": "The minimum time interval before the same user sees this sequence again.", +"enum": [ +"VIDEO_AD_SEQUENCE_MINIMUM_DURATION_UNSPECIFIED", +"VIDEO_AD_SEQUENCE_MINIMUM_DURATION_WEEK", +"VIDEO_AD_SEQUENCE_MINIMUM_DURATION_MONTH" +], +"enumDescriptions": [ +"Unspecified or unknown.", +"7 days.", +"30 days." +], +"type": "string" +}, +"steps": { +"description": "The steps of which the sequence consists.", +"items": { +"$ref": "VideoAdSequenceStep" +}, +"type": "array" +} +}, +"type": "object" +}, +"VideoAdSequenceStep": { +"description": "The detail of a single step in a VideoAdSequence.", +"id": "VideoAdSequenceStep", +"properties": { +"adGroupId": { +"description": "The ID of the corresponding ad group of the step.", +"format": "int64", +"type": "string" +}, +"interactionType": { +"description": "The interaction on the previous step that will lead the viewer to this step. The first step does not have interaction_type.", +"enum": [ +"INTERACTION_TYPE_UNSPECIFIED", +"INTERACTION_TYPE_PAID_VIEW", +"INTERACTION_TYPE_SKIP", +"INTERACTION_TYPE_IMPRESSION", +"INTERACTION_TYPE_ENGAGED_IMPRESSION" +], +"enumDescriptions": [ +"Unspecified or unknown", +"A paid view.", +"Skipped by the viewer.", +"A (viewed) ad impression.", +"An ad impression that was not immediately skipped by the viewer, but didn't reach the billable event either." +], +"type": "string" +}, +"previousStepId": { +"description": "The ID of the previous step. The first step does not have previous step.", +"format": "int64", +"type": "string" +}, +"stepId": { +"description": "The ID of the step.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"VideoDiscoveryAd": { +"description": "Details for a video discovery ad.", +"id": "VideoDiscoveryAd", +"properties": { +"description1": { +"description": "First text line for the ad.", +"type": "string" +}, +"description2": { +"description": "Second text line for the ad.", +"type": "string" +}, +"headline": { +"description": "The headline of ad.", +"type": "string" +}, +"thumbnail": { +"description": "Thumbnail image used in the ad.", +"enum": [ +"THUMBNAIL_UNSPECIFIED", +"THUMBNAIL_DEFAULT", +"THUMBNAIL_1", +"THUMBNAIL_2", +"THUMBNAIL_3" +], +"enumDescriptions": [ +"Unknown or unspecified.", +"The default thumbnail, can be auto-generated or user-uploaded.", +"Thumbnail 1, generated from the video.", +"Thumbnail 2, generated from the video.", +"Thumbnail 3, generated from the video." +], +"type": "string" +}, +"video": { +"$ref": "YoutubeVideoDetails", +"description": "The YouTube video the ad promotes." +} +}, +"type": "object" +}, +"VideoPerformanceAd": { +"description": "Details for a video performance ad.", +"id": "VideoPerformanceAd", +"properties": { +"actionButtonLabels": { +"description": "The list of text assets shown on the call-to-action button.", +"items": { +"type": "string" +}, +"type": "array" +}, +"companionBanners": { +"description": "The list of companion banners used by this ad.", +"items": { +"$ref": "ImageAsset" +}, +"type": "array" +}, +"customParameters": { +"additionalProperties": { +"type": "string" +}, +"description": "The custom parameters to pass custom values to tracking URL template.", +"type": "object" +}, +"descriptions": { +"description": "The list of descriptions shown on the call-to-action banner.", +"items": { +"type": "string" +}, +"type": "array" +}, +"displayUrlBreadcrumb1": { +"description": "The first piece after the domain in the display URL.", +"type": "string" +}, +"displayUrlBreadcrumb2": { +"description": "The second piece after the domain in the display URL.", +"type": "string" +}, +"domain": { +"description": "The domain of the display URL.", +"type": "string" +}, +"finalUrl": { +"description": "The URL address of the webpage that people reach after they click the ad.", +"type": "string" +}, +"headlines": { +"description": "The list of headlines shown on the call-to-action banner.", +"items": { +"type": "string" +}, +"type": "array" +}, +"longHeadlines": { +"description": "The list of lone headlines shown on the call-to-action banner.", +"items": { +"type": "string" +}, +"type": "array" +}, +"trackingUrl": { +"description": "The URL address loaded in the background for tracking purposes.", +"type": "string" +}, +"videos": { +"description": "The list of YouTube video assets used by this ad.", +"items": { +"$ref": "YoutubeVideoDetails" +}, +"type": "array" +} +}, +"type": "object" +}, +"VideoPlayerSizeAssignedTargetingOptionDetails": { +"description": "Video player size targeting option details. This will be populated in the video_player_size_details field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. Explicitly targeting all options is not supported. Remove all video player size targeting options to achieve this effect.", +"id": "VideoPlayerSizeAssignedTargetingOptionDetails", +"properties": { +"videoPlayerSize": { +"description": "Required. The video player size.", +"enum": [ +"VIDEO_PLAYER_SIZE_UNSPECIFIED", +"VIDEO_PLAYER_SIZE_SMALL", +"VIDEO_PLAYER_SIZE_LARGE", +"VIDEO_PLAYER_SIZE_HD", +"VIDEO_PLAYER_SIZE_UNKNOWN" +], +"enumDescriptions": [ +"Video player size is not specified in this version. This enum is a place holder for a default value and does not represent a real video player size.", +"The dimensions of the video player are less than 400\u00d7300 (desktop), or up to 20% of screen covered (mobile).", +"The dimensions of the video player are between 400x300 and 1280x720 pixels (desktop), or 20% to 90% of the screen covered (mobile).", +"The dimensions of the video player are 1280\u00d7720 or greater (desktop), or over 90% of the screen covered (mobile).", +"The dimensions of the video player are unknown." +], +"type": "string" +} +}, +"type": "object" +}, +"VideoPlayerSizeTargetingOptionDetails": { +"description": "Represents a targetable video player size. This will be populated in the video_player_size_details field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.", +"id": "VideoPlayerSizeTargetingOptionDetails", +"properties": { +"videoPlayerSize": { +"description": "Output only. The video player size.", +"enum": [ +"VIDEO_PLAYER_SIZE_UNSPECIFIED", +"VIDEO_PLAYER_SIZE_SMALL", +"VIDEO_PLAYER_SIZE_LARGE", +"VIDEO_PLAYER_SIZE_HD", +"VIDEO_PLAYER_SIZE_UNKNOWN" +], +"enumDescriptions": [ +"Video player size is not specified in this version. This enum is a place holder for a default value and does not represent a real video player size.", +"The dimensions of the video player are less than 400\u00d7300 (desktop), or up to 20% of screen covered (mobile).", +"The dimensions of the video player are between 400x300 and 1280x720 pixels (desktop), or 20% to 90% of the screen covered (mobile).", +"The dimensions of the video player are 1280\u00d7720 or greater (desktop), or over 90% of the screen covered (mobile).", +"The dimensions of the video player are unknown." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"ViewabilityAssignedTargetingOptionDetails": { +"description": "Assigned viewability targeting option details. This will be populated in the viewability_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`.", +"id": "ViewabilityAssignedTargetingOptionDetails", +"properties": { +"viewability": { +"description": "Required. The predicted viewability percentage.", +"enum": [ +"VIEWABILITY_UNSPECIFIED", +"VIEWABILITY_10_PERCENT_OR_MORE", +"VIEWABILITY_20_PERCENT_OR_MORE", +"VIEWABILITY_30_PERCENT_OR_MORE", +"VIEWABILITY_40_PERCENT_OR_MORE", +"VIEWABILITY_50_PERCENT_OR_MORE", +"VIEWABILITY_60_PERCENT_OR_MORE", +"VIEWABILITY_70_PERCENT_OR_MORE", +"VIEWABILITY_80_PERCENT_OR_MORE", +"VIEWABILITY_90_PERCENT_OR_MORE" +], +"enumDescriptions": [ +"Default value when viewability is not specified in this version. This enum is a placeholder for default value and does not represent a real viewability option.", +"Bid only on impressions that are at least 10% likely to be viewable.", +"Bid only on impressions that are at least 20% likely to be viewable.", +"Bid only on impressions that are at least 30% likely to be viewable.", +"Bid only on impressions that are at least 40% likely to be viewable.", +"Bid only on impressions that are at least 50% likely to be viewable.", +"Bid only on impressions that are at least 60% likely to be viewable.", +"Bid only on impressions that are at least 70% likely to be viewable.", +"Bid only on impressions that are at least 80% likely to be viewable.", +"Bid only on impressions that are at least 90% likely to be viewable." +], +"type": "string" +} +}, +"type": "object" +}, +"ViewabilityTargetingOptionDetails": { +"description": "Represents a targetable viewability. This will be populated in the viewability_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`.", +"id": "ViewabilityTargetingOptionDetails", +"properties": { +"viewability": { +"description": "Output only. The predicted viewability percentage.", +"enum": [ +"VIEWABILITY_UNSPECIFIED", +"VIEWABILITY_10_PERCENT_OR_MORE", +"VIEWABILITY_20_PERCENT_OR_MORE", +"VIEWABILITY_30_PERCENT_OR_MORE", +"VIEWABILITY_40_PERCENT_OR_MORE", +"VIEWABILITY_50_PERCENT_OR_MORE", +"VIEWABILITY_60_PERCENT_OR_MORE", +"VIEWABILITY_70_PERCENT_OR_MORE", +"VIEWABILITY_80_PERCENT_OR_MORE", +"VIEWABILITY_90_PERCENT_OR_MORE" +], +"enumDescriptions": [ +"Default value when viewability is not specified in this version. This enum is a placeholder for default value and does not represent a real viewability option.", +"Bid only on impressions that are at least 10% likely to be viewable.", +"Bid only on impressions that are at least 20% likely to be viewable.", +"Bid only on impressions that are at least 30% likely to be viewable.", +"Bid only on impressions that are at least 40% likely to be viewable.", +"Bid only on impressions that are at least 50% likely to be viewable.", +"Bid only on impressions that are at least 60% likely to be viewable.", +"Bid only on impressions that are at least 70% likely to be viewable.", +"Bid only on impressions that are at least 80% likely to be viewable.", +"Bid only on impressions that are at least 90% likely to be viewable." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"YoutubeAndPartnersBiddingStrategy": { +"description": "Settings that control the bid strategy for YouTube and Partners resources.", +"id": "YoutubeAndPartnersBiddingStrategy", +"properties": { +"adGroupEffectiveTargetCpaSource": { +"description": "Output only. Source of the effective target CPA value for ad group.", +"enum": [ +"BIDDING_SOURCE_UNSPECIFIED", +"BIDDING_SOURCE_LINE_ITEM", +"BIDDING_SOURCE_AD_GROUP" +], +"enumDescriptions": [ +"Bidding source is not specified or unknown.", +"Bidding value is inherited from the line item.", +"Bidding value is defined in the ad group." +], +"readOnly": true, +"type": "string" +}, +"adGroupEffectiveTargetCpaValue": { +"description": "Output only. The effective target CPA for ad group, in micros of advertiser's currency.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"type": { +"description": "The type of the bidding strategy.", +"enum": [ +"YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_UNSPECIFIED", +"YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPV", +"YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPM", +"YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA", +"YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPM", +"YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_CPM", +"YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MAXIMIZE_LIFT", +"YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MAXIMIZE_CONVERSIONS", +"YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPV", +"YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS", +"YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MAXIMIZE_CONVERSION_VALUE" +], +"enumDescriptions": [ +"Type is not specified or unknown.", +"A bidding strategy that pays a configurable amount per video view.", +"A bidding strategy that pays a configurable amount per impression.", +"A bidding strategy that automatically optimizes conversions per dollar.", +"A bidding strategy that pays a configurable amount per impression.", +"A bidding strategy for YouTube Instant Reserve line items that pays a fixed amount per impression.", +"An automated bidding strategy that sets bids to achieve maximum lift.", +"A bidding strategy that automatically maximizes number of conversions given a daily budget.", +"A bidding strategy that automatically optimizes cost per video view.", +"A bidding strategy that automatically maximizes revenue while averaging a specific target Return On Ad Spend (ROAS).", +"A bidding strategy that automatically sets bids to maximize revenue while spending your budget." +], +"type": "string" +}, +"value": { +"description": "The value used by the bidding strategy. When the bidding strategy is assigned at the line item level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` When the bidding strategy is assigned at the ad group level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPV` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` If not using an applicable strategy, the value of this field will be 0.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"YoutubeAndPartnersInventorySourceConfig": { +"description": "Settings that control what YouTube related inventories the YouTube and Partners line item will target.", +"id": "YoutubeAndPartnersInventorySourceConfig", +"properties": { +"includeGoogleTv": { +"description": "Optional. Whether to target inventory in video apps available with Google TV.", +"type": "boolean" +}, +"includeYoutube": { +"description": "Optional. Whether to target inventory on YouTube. This includes both search, channels and videos.", +"type": "boolean" +}, +"includeYoutubeVideoPartners": { +"description": "Whether to target inventory on a collection of partner sites and apps that follow the same brand safety standards as YouTube.", +"type": "boolean" +} +}, +"type": "object" +}, +"YoutubeAndPartnersSettings": { +"description": "Settings for YouTube and Partners line items.", +"id": "YoutubeAndPartnersSettings", +"properties": { +"contentCategory": { +"description": "The kind of content on which the YouTube and Partners ads will be shown.", +"enum": [ +"YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_UNSPECIFIED", +"YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_STANDARD", +"YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_EXPANDED", +"YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_LIMITED" +], +"enumDescriptions": [ +"Content category is not specified or is unknown in this version.", +"A category consisting of a wide range of content appropriate for most brands. The content is based off of YouTube's [advertiser-friendly content guidelines](https://support.google.com/youtube/answer/6162278).", +"A category including all content across YouTube and video partners that meets standards for monetization.", +"A category consisting of a reduced range of content that meets heightened requirements, especially regarding inappropriate language and sexual suggestiveness." +], +"type": "string" +}, +"effectiveContentCategory": { +"description": "Output only. The content category which takes effect when serving the line item. When content category is set in both line item and advertiser, the stricter one will take effect when serving the line item.", +"enum": [ +"YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_UNSPECIFIED", +"YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_STANDARD", +"YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_EXPANDED", +"YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_LIMITED" +], +"enumDescriptions": [ +"Content category is not specified or is unknown in this version.", +"A category consisting of a wide range of content appropriate for most brands. The content is based off of YouTube's [advertiser-friendly content guidelines](https://support.google.com/youtube/answer/6162278).", +"A category including all content across YouTube and video partners that meets standards for monetization.", +"A category consisting of a reduced range of content that meets heightened requirements, especially regarding inappropriate language and sexual suggestiveness." +], +"readOnly": true, +"type": "string" +}, +"inventorySourceSettings": { +"$ref": "YoutubeAndPartnersInventorySourceConfig", +"description": "Settings that control what YouTube and Partners inventories the line item will target." +}, +"leadFormId": { +"description": "Optional. The ID of the form to generate leads.", +"format": "int64", +"type": "string" +}, +"linkedMerchantId": { +"description": "Optional. The ID of the merchant which is linked to the line item for product feed.", +"format": "int64", +"type": "string" +}, +"relatedVideoIds": { +"description": "Optional. The IDs of the videos appear below the primary video ad when the ad is playing in the YouTube app on mobile devices.", +"items": { +"type": "string" +}, +"type": "array" +}, +"targetFrequency": { +"$ref": "TargetFrequency", +"description": "Optional. The average number of times you want ads from this line item to show to the same person over a certain period of time." +}, +"thirdPartyMeasurementConfigs": { +"$ref": "ThirdPartyMeasurementConfigs", +"description": "Optional. The third-party measurement configs of the line item." +}, +"videoAdSequenceSettings": { +"$ref": "VideoAdSequenceSettings", +"description": "Optional. The settings related to VideoAdSequence." +}, +"viewFrequencyCap": { +"$ref": "FrequencyCap", +"description": "The view frequency cap settings of the line item. The max_views field in this settings object must be used if assigning a limited cap. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap)" +} +}, +"type": "object" +}, +"YoutubeChannelAssignedTargetingOptionDetails": { +"description": "Details for YouTube channel assigned targeting option. This will be populated in the youtube_channel_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`.", +"id": "YoutubeChannelAssignedTargetingOptionDetails", +"properties": { +"channelId": { +"description": "The YouTube uploader channel id or the channel code of a YouTube channel.", +"type": "string" +}, +"negative": { +"description": "Indicates if this option is being negatively targeted.", +"type": "boolean" +} +}, +"type": "object" +}, +"YoutubeVideoAssignedTargetingOptionDetails": { +"description": "Details for YouTube video assigned targeting option. This will be populated in the youtube_video_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`.", +"id": "YoutubeVideoAssignedTargetingOptionDetails", +"properties": { +"negative": { +"description": "Indicates if this option is being negatively targeted.", +"type": "boolean" +}, +"videoId": { +"description": "YouTube video id as it appears on the YouTube watch page.", +"type": "string" +} +}, +"type": "object" +}, +"YoutubeVideoDetails": { +"description": "Details of a YouTube video.", +"id": "YoutubeVideoDetails", +"properties": { +"id": { +"description": "The YouTube video ID which can be searched on YouTube webpage.", +"type": "string" +}, +"unavailableReason": { +"description": "The reason why the video data is not available.", +"enum": [ +"VIDEO_UNAVAILABLE_REASON_UNSPECIFIED", +"VIDEO_UNAVAILABLE_REASON_PRIVATE", +"VIDEO_UNAVAILABLE_REASON_DELETED" +], +"enumDescriptions": [ +"Unknown or unspecified.", +"The video is private.", +"The video is deleted." +], +"type": "string" +} +}, +"type": "object" } }, "servicePath": "", From a6c51e7c757c69d68fae46856e5b929c2b5dc704 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 25 Feb 2025 07:08:19 +0000 Subject: [PATCH 14/36] feat(dlp): update the api #### dlp:v2 The following keys were added: - schemas.GooglePrivacyDlpV2DiscoveryConfig.properties.processingLocation.$ref (Total Keys: 1) - schemas.GooglePrivacyDlpV2DiscoveryTarget.properties.vertexDatasetTarget.$ref (Total Keys: 1) - schemas.GooglePrivacyDlpV2DiscoveryVertexDatasetConditions (Total Keys: 6) - schemas.GooglePrivacyDlpV2DiscoveryVertexDatasetFilter (Total Keys: 5) - schemas.GooglePrivacyDlpV2DiscoveryVertexDatasetGenerationCadence (Total Keys: 4) - schemas.GooglePrivacyDlpV2FileStoreDataProfile.properties.relatedResources (Total Keys: 2) - schemas.GooglePrivacyDlpV2GlobalProcessing (Total Keys: 2) - schemas.GooglePrivacyDlpV2ImageFallbackLocation (Total Keys: 4) - schemas.GooglePrivacyDlpV2MultiRegionProcessing (Total Keys: 2) - schemas.GooglePrivacyDlpV2ProcessingLocation (Total Keys: 3) - schemas.GooglePrivacyDlpV2RelatedResource (Total Keys: 3) - schemas.GooglePrivacyDlpV2TableDataProfile.properties.relatedResources (Total Keys: 2) - schemas.GooglePrivacyDlpV2VertexDatasetCollection (Total Keys: 3) - schemas.GooglePrivacyDlpV2VertexDatasetDiscoveryTarget (Total Keys: 6) - schemas.GooglePrivacyDlpV2VertexDatasetRegex (Total Keys: 7) - schemas.GooglePrivacyDlpV2VertexDatasetResourceReference (Total Keys: 3) --- ...anizations.locations.discoveryConfigs.html | 228 ++++++++++++++++++ ...tions.locations.fileStoreDataProfiles.html | 90 ++++++- ...nizations.locations.tableDataProfiles.html | 86 +++++++ ...2.projects.locations.discoveryConfigs.html | 228 ++++++++++++++++++ ...jects.locations.fileStoreDataProfiles.html | 90 ++++++- ....projects.locations.tableDataProfiles.html | 86 +++++++ .../discovery_cache/documents/dlp.v2.json | 214 +++++++++++++++- 7 files changed, 1014 insertions(+), 8 deletions(-) diff --git a/docs/dyn/dlp_v2.organizations.locations.discoveryConfigs.html b/docs/dyn/dlp_v2.organizations.locations.discoveryConfigs.html index 8f89e7f54c0..adf9fbe018e 100644 --- a/docs/dyn/dlp_v2.organizations.locations.discoveryConfigs.html +++ b/docs/dyn/dlp_v2.organizations.locations.discoveryConfigs.html @@ -197,6 +197,14 @@

Method Details

"allAssetInventoryAssets": True or False, # All AWS assets stored in Asset Inventory that didn't match other AWS discovery configs. }, }, + "processingLocation": { # Configure processing location for discovery and inspection. For example, image OCR is only provided in limited regions but configuring ProcessingLocation will redirect OCR to a location where OCR is provided. # Optional. Processing location configuration. Vertex AI dataset scanning will set processing_location.image_fallback_type to MultiRegionProcessing by default. + "imageFallbackLocation": { # Configure image processing to fall back to the configured processing option below if unavailable in the request location. # Image processing will fall back using this configuration. + "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. + }, + "multiRegionProcessing": { # Processing will happen in a multi-region that contains the current region if available. # Processing will happen in a multi-region that contains the current region if available. + }, + }, + }, "status": "A String", # Required. A status for this configuration. "targets": [ # Target to match against for determining what to scan and how frequently. { # Target used to match against for Discovery. @@ -394,6 +402,36 @@

Method Details

}, "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. }, + "vertexDatasetTarget": { # Target used to match against for discovery with Vertex AI datasets. # Vertex AI dataset target for Discovery. The first target to match a dataset will be the one applied. Note that discovery for Vertex AI can incur Cloud Storage Class B operation charges for storage.objects.get operations and retrieval fees. For more information, see [Cloud Storage pricing](https://cloud.google.com/storage/pricing#price-tables). Note that discovery for Vertex AI dataset will not be able to scan images unless DiscoveryConfig.processing_location.image_fallback_location has multi_region_processing or global_processing configured. + "conditions": { # Requirements that must be true before a dataset is profiled for the first time. # In addition to matching the filter, these conditions must be true before a profile is generated. + "createdAfter": "A String", # Vertex AI dataset must have been created after this date. Used to avoid backfilling. + "minAge": "A String", # Minimum age a Vertex AI dataset must have. If set, the value must be 1 hour or greater. + }, + "disabled": { # Do not profile the tables. # Disable profiling for datasets that match this filter. + }, + "filter": { # Determines what datasets will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID or dataset regex. # Required. The datasets the discovery cadence applies to. The first target with a matching filter will be the one to apply to a dataset. + "collection": { # Match dataset resources using regex filters. # A specific set of Vertex AI datasets for this filter to apply to. + "vertexDatasetRegexes": { # A collection of regular expressions to determine what datasets to match against. # The regex used to filter dataset resources. + "patterns": [ # Required. The group of regular expression patterns to match against one or more datasets. Maximum of 100 entries. The sum of the lengths of all regular expressions can't exceed 10 KiB. + { # A pattern to match against one or more dataset resources. + "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for configurations created within a project. + }, + ], + }, + }, + "others": { # Match discovery resources not covered by any other filter. # Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically. + }, + "vertexDatasetResourceReference": { # Identifies a single Vertex AI dataset. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). + "datasetResourceName": "A String", # Required. The name of the dataset resource. If set within a project-level configuration, the specified resource must be within the project. + }, + }, + "generationCadence": { # How often existing datasets should have their profiles refreshed. New datasets are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New datasets that match both the filter and conditions are scanned as quickly as possible depending on system capacity. + "inspectTemplateModifiedCadence": { # The cadence at which to update data profiles when the inspection rules defined by the `InspectTemplate` change. # Governs when to update data profiles when the inspection rules defined by the `InspectTemplate` change. If not set, changing the template will not cause a data profile to be updated. + "frequency": "A String", # How frequently data profiles can be updated when the template is modified. Defaults to never. + }, + "refreshFrequency": "A String", # If you set this field, profiles are refreshed at this frequency regardless of whether the underlying datasets have changed. Defaults to never. + }, + }, }, ], "updateTime": "A String", # Output only. The last update timestamp of a DiscoveryConfig. @@ -493,6 +531,14 @@

Method Details

"allAssetInventoryAssets": True or False, # All AWS assets stored in Asset Inventory that didn't match other AWS discovery configs. }, }, + "processingLocation": { # Configure processing location for discovery and inspection. For example, image OCR is only provided in limited regions but configuring ProcessingLocation will redirect OCR to a location where OCR is provided. # Optional. Processing location configuration. Vertex AI dataset scanning will set processing_location.image_fallback_type to MultiRegionProcessing by default. + "imageFallbackLocation": { # Configure image processing to fall back to the configured processing option below if unavailable in the request location. # Image processing will fall back using this configuration. + "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. + }, + "multiRegionProcessing": { # Processing will happen in a multi-region that contains the current region if available. # Processing will happen in a multi-region that contains the current region if available. + }, + }, + }, "status": "A String", # Required. A status for this configuration. "targets": [ # Target to match against for determining what to scan and how frequently. { # Target used to match against for Discovery. @@ -690,6 +736,36 @@

Method Details

}, "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. }, + "vertexDatasetTarget": { # Target used to match against for discovery with Vertex AI datasets. # Vertex AI dataset target for Discovery. The first target to match a dataset will be the one applied. Note that discovery for Vertex AI can incur Cloud Storage Class B operation charges for storage.objects.get operations and retrieval fees. For more information, see [Cloud Storage pricing](https://cloud.google.com/storage/pricing#price-tables). Note that discovery for Vertex AI dataset will not be able to scan images unless DiscoveryConfig.processing_location.image_fallback_location has multi_region_processing or global_processing configured. + "conditions": { # Requirements that must be true before a dataset is profiled for the first time. # In addition to matching the filter, these conditions must be true before a profile is generated. + "createdAfter": "A String", # Vertex AI dataset must have been created after this date. Used to avoid backfilling. + "minAge": "A String", # Minimum age a Vertex AI dataset must have. If set, the value must be 1 hour or greater. + }, + "disabled": { # Do not profile the tables. # Disable profiling for datasets that match this filter. + }, + "filter": { # Determines what datasets will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID or dataset regex. # Required. The datasets the discovery cadence applies to. The first target with a matching filter will be the one to apply to a dataset. + "collection": { # Match dataset resources using regex filters. # A specific set of Vertex AI datasets for this filter to apply to. + "vertexDatasetRegexes": { # A collection of regular expressions to determine what datasets to match against. # The regex used to filter dataset resources. + "patterns": [ # Required. The group of regular expression patterns to match against one or more datasets. Maximum of 100 entries. The sum of the lengths of all regular expressions can't exceed 10 KiB. + { # A pattern to match against one or more dataset resources. + "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for configurations created within a project. + }, + ], + }, + }, + "others": { # Match discovery resources not covered by any other filter. # Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically. + }, + "vertexDatasetResourceReference": { # Identifies a single Vertex AI dataset. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). + "datasetResourceName": "A String", # Required. The name of the dataset resource. If set within a project-level configuration, the specified resource must be within the project. + }, + }, + "generationCadence": { # How often existing datasets should have their profiles refreshed. New datasets are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New datasets that match both the filter and conditions are scanned as quickly as possible depending on system capacity. + "inspectTemplateModifiedCadence": { # The cadence at which to update data profiles when the inspection rules defined by the `InspectTemplate` change. # Governs when to update data profiles when the inspection rules defined by the `InspectTemplate` change. If not set, changing the template will not cause a data profile to be updated. + "frequency": "A String", # How frequently data profiles can be updated when the template is modified. Defaults to never. + }, + "refreshFrequency": "A String", # If you set this field, profiles are refreshed at this frequency regardless of whether the underlying datasets have changed. Defaults to never. + }, + }, }, ], "updateTime": "A String", # Output only. The last update timestamp of a DiscoveryConfig. @@ -813,6 +889,14 @@

Method Details

"allAssetInventoryAssets": True or False, # All AWS assets stored in Asset Inventory that didn't match other AWS discovery configs. }, }, + "processingLocation": { # Configure processing location for discovery and inspection. For example, image OCR is only provided in limited regions but configuring ProcessingLocation will redirect OCR to a location where OCR is provided. # Optional. Processing location configuration. Vertex AI dataset scanning will set processing_location.image_fallback_type to MultiRegionProcessing by default. + "imageFallbackLocation": { # Configure image processing to fall back to the configured processing option below if unavailable in the request location. # Image processing will fall back using this configuration. + "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. + }, + "multiRegionProcessing": { # Processing will happen in a multi-region that contains the current region if available. # Processing will happen in a multi-region that contains the current region if available. + }, + }, + }, "status": "A String", # Required. A status for this configuration. "targets": [ # Target to match against for determining what to scan and how frequently. { # Target used to match against for Discovery. @@ -1010,6 +1094,36 @@

Method Details

}, "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. }, + "vertexDatasetTarget": { # Target used to match against for discovery with Vertex AI datasets. # Vertex AI dataset target for Discovery. The first target to match a dataset will be the one applied. Note that discovery for Vertex AI can incur Cloud Storage Class B operation charges for storage.objects.get operations and retrieval fees. For more information, see [Cloud Storage pricing](https://cloud.google.com/storage/pricing#price-tables). Note that discovery for Vertex AI dataset will not be able to scan images unless DiscoveryConfig.processing_location.image_fallback_location has multi_region_processing or global_processing configured. + "conditions": { # Requirements that must be true before a dataset is profiled for the first time. # In addition to matching the filter, these conditions must be true before a profile is generated. + "createdAfter": "A String", # Vertex AI dataset must have been created after this date. Used to avoid backfilling. + "minAge": "A String", # Minimum age a Vertex AI dataset must have. If set, the value must be 1 hour or greater. + }, + "disabled": { # Do not profile the tables. # Disable profiling for datasets that match this filter. + }, + "filter": { # Determines what datasets will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID or dataset regex. # Required. The datasets the discovery cadence applies to. The first target with a matching filter will be the one to apply to a dataset. + "collection": { # Match dataset resources using regex filters. # A specific set of Vertex AI datasets for this filter to apply to. + "vertexDatasetRegexes": { # A collection of regular expressions to determine what datasets to match against. # The regex used to filter dataset resources. + "patterns": [ # Required. The group of regular expression patterns to match against one or more datasets. Maximum of 100 entries. The sum of the lengths of all regular expressions can't exceed 10 KiB. + { # A pattern to match against one or more dataset resources. + "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for configurations created within a project. + }, + ], + }, + }, + "others": { # Match discovery resources not covered by any other filter. # Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically. + }, + "vertexDatasetResourceReference": { # Identifies a single Vertex AI dataset. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). + "datasetResourceName": "A String", # Required. The name of the dataset resource. If set within a project-level configuration, the specified resource must be within the project. + }, + }, + "generationCadence": { # How often existing datasets should have their profiles refreshed. New datasets are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New datasets that match both the filter and conditions are scanned as quickly as possible depending on system capacity. + "inspectTemplateModifiedCadence": { # The cadence at which to update data profiles when the inspection rules defined by the `InspectTemplate` change. # Governs when to update data profiles when the inspection rules defined by the `InspectTemplate` change. If not set, changing the template will not cause a data profile to be updated. + "frequency": "A String", # How frequently data profiles can be updated when the template is modified. Defaults to never. + }, + "refreshFrequency": "A String", # If you set this field, profiles are refreshed at this frequency regardless of whether the underlying datasets have changed. Defaults to never. + }, + }, }, ], "updateTime": "A String", # Output only. The last update timestamp of a DiscoveryConfig. @@ -1120,6 +1234,14 @@

Method Details

"allAssetInventoryAssets": True or False, # All AWS assets stored in Asset Inventory that didn't match other AWS discovery configs. }, }, + "processingLocation": { # Configure processing location for discovery and inspection. For example, image OCR is only provided in limited regions but configuring ProcessingLocation will redirect OCR to a location where OCR is provided. # Optional. Processing location configuration. Vertex AI dataset scanning will set processing_location.image_fallback_type to MultiRegionProcessing by default. + "imageFallbackLocation": { # Configure image processing to fall back to the configured processing option below if unavailable in the request location. # Image processing will fall back using this configuration. + "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. + }, + "multiRegionProcessing": { # Processing will happen in a multi-region that contains the current region if available. # Processing will happen in a multi-region that contains the current region if available. + }, + }, + }, "status": "A String", # Required. A status for this configuration. "targets": [ # Target to match against for determining what to scan and how frequently. { # Target used to match against for Discovery. @@ -1317,6 +1439,36 @@

Method Details

}, "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. }, + "vertexDatasetTarget": { # Target used to match against for discovery with Vertex AI datasets. # Vertex AI dataset target for Discovery. The first target to match a dataset will be the one applied. Note that discovery for Vertex AI can incur Cloud Storage Class B operation charges for storage.objects.get operations and retrieval fees. For more information, see [Cloud Storage pricing](https://cloud.google.com/storage/pricing#price-tables). Note that discovery for Vertex AI dataset will not be able to scan images unless DiscoveryConfig.processing_location.image_fallback_location has multi_region_processing or global_processing configured. + "conditions": { # Requirements that must be true before a dataset is profiled for the first time. # In addition to matching the filter, these conditions must be true before a profile is generated. + "createdAfter": "A String", # Vertex AI dataset must have been created after this date. Used to avoid backfilling. + "minAge": "A String", # Minimum age a Vertex AI dataset must have. If set, the value must be 1 hour or greater. + }, + "disabled": { # Do not profile the tables. # Disable profiling for datasets that match this filter. + }, + "filter": { # Determines what datasets will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID or dataset regex. # Required. The datasets the discovery cadence applies to. The first target with a matching filter will be the one to apply to a dataset. + "collection": { # Match dataset resources using regex filters. # A specific set of Vertex AI datasets for this filter to apply to. + "vertexDatasetRegexes": { # A collection of regular expressions to determine what datasets to match against. # The regex used to filter dataset resources. + "patterns": [ # Required. The group of regular expression patterns to match against one or more datasets. Maximum of 100 entries. The sum of the lengths of all regular expressions can't exceed 10 KiB. + { # A pattern to match against one or more dataset resources. + "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for configurations created within a project. + }, + ], + }, + }, + "others": { # Match discovery resources not covered by any other filter. # Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically. + }, + "vertexDatasetResourceReference": { # Identifies a single Vertex AI dataset. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). + "datasetResourceName": "A String", # Required. The name of the dataset resource. If set within a project-level configuration, the specified resource must be within the project. + }, + }, + "generationCadence": { # How often existing datasets should have their profiles refreshed. New datasets are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New datasets that match both the filter and conditions are scanned as quickly as possible depending on system capacity. + "inspectTemplateModifiedCadence": { # The cadence at which to update data profiles when the inspection rules defined by the `InspectTemplate` change. # Governs when to update data profiles when the inspection rules defined by the `InspectTemplate` change. If not set, changing the template will not cause a data profile to be updated. + "frequency": "A String", # How frequently data profiles can be updated when the template is modified. Defaults to never. + }, + "refreshFrequency": "A String", # If you set this field, profiles are refreshed at this frequency regardless of whether the underlying datasets have changed. Defaults to never. + }, + }, }, ], "updateTime": "A String", # Output only. The last update timestamp of a DiscoveryConfig. @@ -1435,6 +1587,14 @@

Method Details

"allAssetInventoryAssets": True or False, # All AWS assets stored in Asset Inventory that didn't match other AWS discovery configs. }, }, + "processingLocation": { # Configure processing location for discovery and inspection. For example, image OCR is only provided in limited regions but configuring ProcessingLocation will redirect OCR to a location where OCR is provided. # Optional. Processing location configuration. Vertex AI dataset scanning will set processing_location.image_fallback_type to MultiRegionProcessing by default. + "imageFallbackLocation": { # Configure image processing to fall back to the configured processing option below if unavailable in the request location. # Image processing will fall back using this configuration. + "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. + }, + "multiRegionProcessing": { # Processing will happen in a multi-region that contains the current region if available. # Processing will happen in a multi-region that contains the current region if available. + }, + }, + }, "status": "A String", # Required. A status for this configuration. "targets": [ # Target to match against for determining what to scan and how frequently. { # Target used to match against for Discovery. @@ -1632,6 +1792,36 @@

Method Details

}, "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. }, + "vertexDatasetTarget": { # Target used to match against for discovery with Vertex AI datasets. # Vertex AI dataset target for Discovery. The first target to match a dataset will be the one applied. Note that discovery for Vertex AI can incur Cloud Storage Class B operation charges for storage.objects.get operations and retrieval fees. For more information, see [Cloud Storage pricing](https://cloud.google.com/storage/pricing#price-tables). Note that discovery for Vertex AI dataset will not be able to scan images unless DiscoveryConfig.processing_location.image_fallback_location has multi_region_processing or global_processing configured. + "conditions": { # Requirements that must be true before a dataset is profiled for the first time. # In addition to matching the filter, these conditions must be true before a profile is generated. + "createdAfter": "A String", # Vertex AI dataset must have been created after this date. Used to avoid backfilling. + "minAge": "A String", # Minimum age a Vertex AI dataset must have. If set, the value must be 1 hour or greater. + }, + "disabled": { # Do not profile the tables. # Disable profiling for datasets that match this filter. + }, + "filter": { # Determines what datasets will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID or dataset regex. # Required. The datasets the discovery cadence applies to. The first target with a matching filter will be the one to apply to a dataset. + "collection": { # Match dataset resources using regex filters. # A specific set of Vertex AI datasets for this filter to apply to. + "vertexDatasetRegexes": { # A collection of regular expressions to determine what datasets to match against. # The regex used to filter dataset resources. + "patterns": [ # Required. The group of regular expression patterns to match against one or more datasets. Maximum of 100 entries. The sum of the lengths of all regular expressions can't exceed 10 KiB. + { # A pattern to match against one or more dataset resources. + "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for configurations created within a project. + }, + ], + }, + }, + "others": { # Match discovery resources not covered by any other filter. # Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically. + }, + "vertexDatasetResourceReference": { # Identifies a single Vertex AI dataset. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). + "datasetResourceName": "A String", # Required. The name of the dataset resource. If set within a project-level configuration, the specified resource must be within the project. + }, + }, + "generationCadence": { # How often existing datasets should have their profiles refreshed. New datasets are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New datasets that match both the filter and conditions are scanned as quickly as possible depending on system capacity. + "inspectTemplateModifiedCadence": { # The cadence at which to update data profiles when the inspection rules defined by the `InspectTemplate` change. # Governs when to update data profiles when the inspection rules defined by the `InspectTemplate` change. If not set, changing the template will not cause a data profile to be updated. + "frequency": "A String", # How frequently data profiles can be updated when the template is modified. Defaults to never. + }, + "refreshFrequency": "A String", # If you set this field, profiles are refreshed at this frequency regardless of whether the underlying datasets have changed. Defaults to never. + }, + }, }, ], "updateTime": "A String", # Output only. The last update timestamp of a DiscoveryConfig. @@ -1732,6 +1922,14 @@

Method Details

"allAssetInventoryAssets": True or False, # All AWS assets stored in Asset Inventory that didn't match other AWS discovery configs. }, }, + "processingLocation": { # Configure processing location for discovery and inspection. For example, image OCR is only provided in limited regions but configuring ProcessingLocation will redirect OCR to a location where OCR is provided. # Optional. Processing location configuration. Vertex AI dataset scanning will set processing_location.image_fallback_type to MultiRegionProcessing by default. + "imageFallbackLocation": { # Configure image processing to fall back to the configured processing option below if unavailable in the request location. # Image processing will fall back using this configuration. + "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. + }, + "multiRegionProcessing": { # Processing will happen in a multi-region that contains the current region if available. # Processing will happen in a multi-region that contains the current region if available. + }, + }, + }, "status": "A String", # Required. A status for this configuration. "targets": [ # Target to match against for determining what to scan and how frequently. { # Target used to match against for Discovery. @@ -1929,6 +2127,36 @@

Method Details

}, "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. }, + "vertexDatasetTarget": { # Target used to match against for discovery with Vertex AI datasets. # Vertex AI dataset target for Discovery. The first target to match a dataset will be the one applied. Note that discovery for Vertex AI can incur Cloud Storage Class B operation charges for storage.objects.get operations and retrieval fees. For more information, see [Cloud Storage pricing](https://cloud.google.com/storage/pricing#price-tables). Note that discovery for Vertex AI dataset will not be able to scan images unless DiscoveryConfig.processing_location.image_fallback_location has multi_region_processing or global_processing configured. + "conditions": { # Requirements that must be true before a dataset is profiled for the first time. # In addition to matching the filter, these conditions must be true before a profile is generated. + "createdAfter": "A String", # Vertex AI dataset must have been created after this date. Used to avoid backfilling. + "minAge": "A String", # Minimum age a Vertex AI dataset must have. If set, the value must be 1 hour or greater. + }, + "disabled": { # Do not profile the tables. # Disable profiling for datasets that match this filter. + }, + "filter": { # Determines what datasets will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID or dataset regex. # Required. The datasets the discovery cadence applies to. The first target with a matching filter will be the one to apply to a dataset. + "collection": { # Match dataset resources using regex filters. # A specific set of Vertex AI datasets for this filter to apply to. + "vertexDatasetRegexes": { # A collection of regular expressions to determine what datasets to match against. # The regex used to filter dataset resources. + "patterns": [ # Required. The group of regular expression patterns to match against one or more datasets. Maximum of 100 entries. The sum of the lengths of all regular expressions can't exceed 10 KiB. + { # A pattern to match against one or more dataset resources. + "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for configurations created within a project. + }, + ], + }, + }, + "others": { # Match discovery resources not covered by any other filter. # Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically. + }, + "vertexDatasetResourceReference": { # Identifies a single Vertex AI dataset. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). + "datasetResourceName": "A String", # Required. The name of the dataset resource. If set within a project-level configuration, the specified resource must be within the project. + }, + }, + "generationCadence": { # How often existing datasets should have their profiles refreshed. New datasets are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New datasets that match both the filter and conditions are scanned as quickly as possible depending on system capacity. + "inspectTemplateModifiedCadence": { # The cadence at which to update data profiles when the inspection rules defined by the `InspectTemplate` change. # Governs when to update data profiles when the inspection rules defined by the `InspectTemplate` change. If not set, changing the template will not cause a data profile to be updated. + "frequency": "A String", # How frequently data profiles can be updated when the template is modified. Defaults to never. + }, + "refreshFrequency": "A String", # If you set this field, profiles are refreshed at this frequency regardless of whether the underlying datasets have changed. Defaults to never. + }, + }, }, ], "updateTime": "A String", # Output only. The last update timestamp of a DiscoveryConfig. diff --git a/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html b/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html index e7a7b12e09e..1974b5e6516 100644 --- a/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html +++ b/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html @@ -277,6 +277,14 @@

Method Details

"allAssetInventoryAssets": True or False, # All AWS assets stored in Asset Inventory that didn't match other AWS discovery configs. }, }, + "processingLocation": { # Configure processing location for discovery and inspection. For example, image OCR is only provided in limited regions but configuring ProcessingLocation will redirect OCR to a location where OCR is provided. # Optional. Processing location configuration. Vertex AI dataset scanning will set processing_location.image_fallback_type to MultiRegionProcessing by default. + "imageFallbackLocation": { # Configure image processing to fall back to the configured processing option below if unavailable in the request location. # Image processing will fall back using this configuration. + "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. + }, + "multiRegionProcessing": { # Processing will happen in a multi-region that contains the current region if available. # Processing will happen in a multi-region that contains the current region if available. + }, + }, + }, "status": "A String", # Required. A status for this configuration. "targets": [ # Target to match against for determining what to scan and how frequently. { # Target used to match against for Discovery. @@ -474,6 +482,36 @@

Method Details

}, "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. }, + "vertexDatasetTarget": { # Target used to match against for discovery with Vertex AI datasets. # Vertex AI dataset target for Discovery. The first target to match a dataset will be the one applied. Note that discovery for Vertex AI can incur Cloud Storage Class B operation charges for storage.objects.get operations and retrieval fees. For more information, see [Cloud Storage pricing](https://cloud.google.com/storage/pricing#price-tables). Note that discovery for Vertex AI dataset will not be able to scan images unless DiscoveryConfig.processing_location.image_fallback_location has multi_region_processing or global_processing configured. + "conditions": { # Requirements that must be true before a dataset is profiled for the first time. # In addition to matching the filter, these conditions must be true before a profile is generated. + "createdAfter": "A String", # Vertex AI dataset must have been created after this date. Used to avoid backfilling. + "minAge": "A String", # Minimum age a Vertex AI dataset must have. If set, the value must be 1 hour or greater. + }, + "disabled": { # Do not profile the tables. # Disable profiling for datasets that match this filter. + }, + "filter": { # Determines what datasets will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID or dataset regex. # Required. The datasets the discovery cadence applies to. The first target with a matching filter will be the one to apply to a dataset. + "collection": { # Match dataset resources using regex filters. # A specific set of Vertex AI datasets for this filter to apply to. + "vertexDatasetRegexes": { # A collection of regular expressions to determine what datasets to match against. # The regex used to filter dataset resources. + "patterns": [ # Required. The group of regular expression patterns to match against one or more datasets. Maximum of 100 entries. The sum of the lengths of all regular expressions can't exceed 10 KiB. + { # A pattern to match against one or more dataset resources. + "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for configurations created within a project. + }, + ], + }, + }, + "others": { # Match discovery resources not covered by any other filter. # Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically. + }, + "vertexDatasetResourceReference": { # Identifies a single Vertex AI dataset. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). + "datasetResourceName": "A String", # Required. The name of the dataset resource. If set within a project-level configuration, the specified resource must be within the project. + }, + }, + "generationCadence": { # How often existing datasets should have their profiles refreshed. New datasets are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New datasets that match both the filter and conditions are scanned as quickly as possible depending on system capacity. + "inspectTemplateModifiedCadence": { # The cadence at which to update data profiles when the inspection rules defined by the `InspectTemplate` change. # Governs when to update data profiles when the inspection rules defined by the `InspectTemplate` change. If not set, changing the template will not cause a data profile to be updated. + "frequency": "A String", # How frequently data profiles can be updated when the template is modified. Defaults to never. + }, + "refreshFrequency": "A String", # If you set this field, profiles are refreshed at this frequency regardless of whether the underlying datasets have changed. Defaults to never. + }, + }, }, ], "updateTime": "A String", # Output only. The last update timestamp of a DiscoveryConfig. @@ -734,7 +772,7 @@

Method Details

], "fileStoreIsEmpty": True or False, # The file store does not have any files. "fileStoreLocation": "A String", # The location of the file store. * Cloud Storage: https://cloud.google.com/storage/docs/locations#available-locations * Amazon S3: https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints - "fileStorePath": "A String", # The file store path. * Cloud Storage: `gs://{bucket}` * Amazon S3: `s3://{bucket}` + "fileStorePath": "A String", # The file store path. * Cloud Storage: `gs://{bucket}` * Amazon S3: `s3://{bucket}` * Vertex AI dataset: `projects/{project_number}/locations/{location}/datasets/{dataset_id}` "fullResource": "A String", # The resource name of the resource profiled. https://cloud.google.com/apis/design/resource_names#full_resource_name Example format of an S3 bucket full resource name: `//cloudasset.googleapis.com/organizations/{org_id}/otherCloudConnections/aws/arn:aws:s3:::{bucket_name}` "lastModifiedTime": "A String", # The time the file store was last modified. "locationType": "A String", # The location type of the file store (region, dual-region, multi-region, etc). If dual-region, expect data_storage_locations to be populated. @@ -754,6 +792,11 @@

Method Details

}, "projectDataProfile": "A String", # The resource name of the project data profile for this file store. "projectId": "A String", # The Google Cloud project ID that owns the resource. For Amazon S3 buckets, this is the AWS Account Id. + "relatedResources": [ # Resources related to this profile. + { # A related resource. Examples: * The source BigQuery table for a Vertex AI dataset. * The source Cloud Storage bucket for a Vertex AI dataset. + "fullResource": "A String", # The full resource name of the related resource. + }, + ], "resourceAttributes": { # Attributes of the resource being profiled. Currently used attributes: * customer_managed_encryption: boolean - true: the resource is encrypted with a customer-managed key. - false: the resource is encrypted with a provider-managed key. "a_key": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. "booleanValue": True or False, # boolean @@ -956,6 +999,14 @@

Method Details

"allAssetInventoryAssets": True or False, # All AWS assets stored in Asset Inventory that didn't match other AWS discovery configs. }, }, + "processingLocation": { # Configure processing location for discovery and inspection. For example, image OCR is only provided in limited regions but configuring ProcessingLocation will redirect OCR to a location where OCR is provided. # Optional. Processing location configuration. Vertex AI dataset scanning will set processing_location.image_fallback_type to MultiRegionProcessing by default. + "imageFallbackLocation": { # Configure image processing to fall back to the configured processing option below if unavailable in the request location. # Image processing will fall back using this configuration. + "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. + }, + "multiRegionProcessing": { # Processing will happen in a multi-region that contains the current region if available. # Processing will happen in a multi-region that contains the current region if available. + }, + }, + }, "status": "A String", # Required. A status for this configuration. "targets": [ # Target to match against for determining what to scan and how frequently. { # Target used to match against for Discovery. @@ -1153,6 +1204,36 @@

Method Details

}, "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. }, + "vertexDatasetTarget": { # Target used to match against for discovery with Vertex AI datasets. # Vertex AI dataset target for Discovery. The first target to match a dataset will be the one applied. Note that discovery for Vertex AI can incur Cloud Storage Class B operation charges for storage.objects.get operations and retrieval fees. For more information, see [Cloud Storage pricing](https://cloud.google.com/storage/pricing#price-tables). Note that discovery for Vertex AI dataset will not be able to scan images unless DiscoveryConfig.processing_location.image_fallback_location has multi_region_processing or global_processing configured. + "conditions": { # Requirements that must be true before a dataset is profiled for the first time. # In addition to matching the filter, these conditions must be true before a profile is generated. + "createdAfter": "A String", # Vertex AI dataset must have been created after this date. Used to avoid backfilling. + "minAge": "A String", # Minimum age a Vertex AI dataset must have. If set, the value must be 1 hour or greater. + }, + "disabled": { # Do not profile the tables. # Disable profiling for datasets that match this filter. + }, + "filter": { # Determines what datasets will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID or dataset regex. # Required. The datasets the discovery cadence applies to. The first target with a matching filter will be the one to apply to a dataset. + "collection": { # Match dataset resources using regex filters. # A specific set of Vertex AI datasets for this filter to apply to. + "vertexDatasetRegexes": { # A collection of regular expressions to determine what datasets to match against. # The regex used to filter dataset resources. + "patterns": [ # Required. The group of regular expression patterns to match against one or more datasets. Maximum of 100 entries. The sum of the lengths of all regular expressions can't exceed 10 KiB. + { # A pattern to match against one or more dataset resources. + "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for configurations created within a project. + }, + ], + }, + }, + "others": { # Match discovery resources not covered by any other filter. # Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically. + }, + "vertexDatasetResourceReference": { # Identifies a single Vertex AI dataset. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). + "datasetResourceName": "A String", # Required. The name of the dataset resource. If set within a project-level configuration, the specified resource must be within the project. + }, + }, + "generationCadence": { # How often existing datasets should have their profiles refreshed. New datasets are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New datasets that match both the filter and conditions are scanned as quickly as possible depending on system capacity. + "inspectTemplateModifiedCadence": { # The cadence at which to update data profiles when the inspection rules defined by the `InspectTemplate` change. # Governs when to update data profiles when the inspection rules defined by the `InspectTemplate` change. If not set, changing the template will not cause a data profile to be updated. + "frequency": "A String", # How frequently data profiles can be updated when the template is modified. Defaults to never. + }, + "refreshFrequency": "A String", # If you set this field, profiles are refreshed at this frequency regardless of whether the underlying datasets have changed. Defaults to never. + }, + }, }, ], "updateTime": "A String", # Output only. The last update timestamp of a DiscoveryConfig. @@ -1413,7 +1494,7 @@

Method Details

], "fileStoreIsEmpty": True or False, # The file store does not have any files. "fileStoreLocation": "A String", # The location of the file store. * Cloud Storage: https://cloud.google.com/storage/docs/locations#available-locations * Amazon S3: https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints - "fileStorePath": "A String", # The file store path. * Cloud Storage: `gs://{bucket}` * Amazon S3: `s3://{bucket}` + "fileStorePath": "A String", # The file store path. * Cloud Storage: `gs://{bucket}` * Amazon S3: `s3://{bucket}` * Vertex AI dataset: `projects/{project_number}/locations/{location}/datasets/{dataset_id}` "fullResource": "A String", # The resource name of the resource profiled. https://cloud.google.com/apis/design/resource_names#full_resource_name Example format of an S3 bucket full resource name: `//cloudasset.googleapis.com/organizations/{org_id}/otherCloudConnections/aws/arn:aws:s3:::{bucket_name}` "lastModifiedTime": "A String", # The time the file store was last modified. "locationType": "A String", # The location type of the file store (region, dual-region, multi-region, etc). If dual-region, expect data_storage_locations to be populated. @@ -1433,6 +1514,11 @@

Method Details

}, "projectDataProfile": "A String", # The resource name of the project data profile for this file store. "projectId": "A String", # The Google Cloud project ID that owns the resource. For Amazon S3 buckets, this is the AWS Account Id. + "relatedResources": [ # Resources related to this profile. + { # A related resource. Examples: * The source BigQuery table for a Vertex AI dataset. * The source Cloud Storage bucket for a Vertex AI dataset. + "fullResource": "A String", # The full resource name of the related resource. + }, + ], "resourceAttributes": { # Attributes of the resource being profiled. Currently used attributes: * customer_managed_encryption: boolean - true: the resource is encrypted with a customer-managed key. - false: the resource is encrypted with a provider-managed key. "a_key": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. "booleanValue": True or False, # boolean diff --git a/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html b/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html index 896fe8926b4..db21de60ec5 100644 --- a/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html +++ b/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html @@ -277,6 +277,14 @@

Method Details

"allAssetInventoryAssets": True or False, # All AWS assets stored in Asset Inventory that didn't match other AWS discovery configs. }, }, + "processingLocation": { # Configure processing location for discovery and inspection. For example, image OCR is only provided in limited regions but configuring ProcessingLocation will redirect OCR to a location where OCR is provided. # Optional. Processing location configuration. Vertex AI dataset scanning will set processing_location.image_fallback_type to MultiRegionProcessing by default. + "imageFallbackLocation": { # Configure image processing to fall back to the configured processing option below if unavailable in the request location. # Image processing will fall back using this configuration. + "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. + }, + "multiRegionProcessing": { # Processing will happen in a multi-region that contains the current region if available. # Processing will happen in a multi-region that contains the current region if available. + }, + }, + }, "status": "A String", # Required. A status for this configuration. "targets": [ # Target to match against for determining what to scan and how frequently. { # Target used to match against for Discovery. @@ -474,6 +482,36 @@

Method Details

}, "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. }, + "vertexDatasetTarget": { # Target used to match against for discovery with Vertex AI datasets. # Vertex AI dataset target for Discovery. The first target to match a dataset will be the one applied. Note that discovery for Vertex AI can incur Cloud Storage Class B operation charges for storage.objects.get operations and retrieval fees. For more information, see [Cloud Storage pricing](https://cloud.google.com/storage/pricing#price-tables). Note that discovery for Vertex AI dataset will not be able to scan images unless DiscoveryConfig.processing_location.image_fallback_location has multi_region_processing or global_processing configured. + "conditions": { # Requirements that must be true before a dataset is profiled for the first time. # In addition to matching the filter, these conditions must be true before a profile is generated. + "createdAfter": "A String", # Vertex AI dataset must have been created after this date. Used to avoid backfilling. + "minAge": "A String", # Minimum age a Vertex AI dataset must have. If set, the value must be 1 hour or greater. + }, + "disabled": { # Do not profile the tables. # Disable profiling for datasets that match this filter. + }, + "filter": { # Determines what datasets will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID or dataset regex. # Required. The datasets the discovery cadence applies to. The first target with a matching filter will be the one to apply to a dataset. + "collection": { # Match dataset resources using regex filters. # A specific set of Vertex AI datasets for this filter to apply to. + "vertexDatasetRegexes": { # A collection of regular expressions to determine what datasets to match against. # The regex used to filter dataset resources. + "patterns": [ # Required. The group of regular expression patterns to match against one or more datasets. Maximum of 100 entries. The sum of the lengths of all regular expressions can't exceed 10 KiB. + { # A pattern to match against one or more dataset resources. + "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for configurations created within a project. + }, + ], + }, + }, + "others": { # Match discovery resources not covered by any other filter. # Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically. + }, + "vertexDatasetResourceReference": { # Identifies a single Vertex AI dataset. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). + "datasetResourceName": "A String", # Required. The name of the dataset resource. If set within a project-level configuration, the specified resource must be within the project. + }, + }, + "generationCadence": { # How often existing datasets should have their profiles refreshed. New datasets are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New datasets that match both the filter and conditions are scanned as quickly as possible depending on system capacity. + "inspectTemplateModifiedCadence": { # The cadence at which to update data profiles when the inspection rules defined by the `InspectTemplate` change. # Governs when to update data profiles when the inspection rules defined by the `InspectTemplate` change. If not set, changing the template will not cause a data profile to be updated. + "frequency": "A String", # How frequently data profiles can be updated when the template is modified. Defaults to never. + }, + "refreshFrequency": "A String", # If you set this field, profiles are refreshed at this frequency regardless of whether the underlying datasets have changed. Defaults to never. + }, + }, }, ], "updateTime": "A String", # Output only. The last update timestamp of a DiscoveryConfig. @@ -714,6 +752,11 @@

Method Details

"timestamp": "A String", # Time when the profile generation status was updated }, "projectDataProfile": "A String", # The resource name of the project data profile for this table. + "relatedResources": [ # Resources related to this profile. + { # A related resource. Examples: * The source BigQuery table for a Vertex AI dataset. * The source Cloud Storage bucket for a Vertex AI dataset. + "fullResource": "A String", # The full resource name of the related resource. + }, + ], "resourceLabels": { # The labels applied to the resource at the time the profile was generated. "a_key": "A String", }, @@ -900,6 +943,14 @@

Method Details

"allAssetInventoryAssets": True or False, # All AWS assets stored in Asset Inventory that didn't match other AWS discovery configs. }, }, + "processingLocation": { # Configure processing location for discovery and inspection. For example, image OCR is only provided in limited regions but configuring ProcessingLocation will redirect OCR to a location where OCR is provided. # Optional. Processing location configuration. Vertex AI dataset scanning will set processing_location.image_fallback_type to MultiRegionProcessing by default. + "imageFallbackLocation": { # Configure image processing to fall back to the configured processing option below if unavailable in the request location. # Image processing will fall back using this configuration. + "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. + }, + "multiRegionProcessing": { # Processing will happen in a multi-region that contains the current region if available. # Processing will happen in a multi-region that contains the current region if available. + }, + }, + }, "status": "A String", # Required. A status for this configuration. "targets": [ # Target to match against for determining what to scan and how frequently. { # Target used to match against for Discovery. @@ -1097,6 +1148,36 @@

Method Details

}, "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. }, + "vertexDatasetTarget": { # Target used to match against for discovery with Vertex AI datasets. # Vertex AI dataset target for Discovery. The first target to match a dataset will be the one applied. Note that discovery for Vertex AI can incur Cloud Storage Class B operation charges for storage.objects.get operations and retrieval fees. For more information, see [Cloud Storage pricing](https://cloud.google.com/storage/pricing#price-tables). Note that discovery for Vertex AI dataset will not be able to scan images unless DiscoveryConfig.processing_location.image_fallback_location has multi_region_processing or global_processing configured. + "conditions": { # Requirements that must be true before a dataset is profiled for the first time. # In addition to matching the filter, these conditions must be true before a profile is generated. + "createdAfter": "A String", # Vertex AI dataset must have been created after this date. Used to avoid backfilling. + "minAge": "A String", # Minimum age a Vertex AI dataset must have. If set, the value must be 1 hour or greater. + }, + "disabled": { # Do not profile the tables. # Disable profiling for datasets that match this filter. + }, + "filter": { # Determines what datasets will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID or dataset regex. # Required. The datasets the discovery cadence applies to. The first target with a matching filter will be the one to apply to a dataset. + "collection": { # Match dataset resources using regex filters. # A specific set of Vertex AI datasets for this filter to apply to. + "vertexDatasetRegexes": { # A collection of regular expressions to determine what datasets to match against. # The regex used to filter dataset resources. + "patterns": [ # Required. The group of regular expression patterns to match against one or more datasets. Maximum of 100 entries. The sum of the lengths of all regular expressions can't exceed 10 KiB. + { # A pattern to match against one or more dataset resources. + "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for configurations created within a project. + }, + ], + }, + }, + "others": { # Match discovery resources not covered by any other filter. # Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically. + }, + "vertexDatasetResourceReference": { # Identifies a single Vertex AI dataset. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). + "datasetResourceName": "A String", # Required. The name of the dataset resource. If set within a project-level configuration, the specified resource must be within the project. + }, + }, + "generationCadence": { # How often existing datasets should have their profiles refreshed. New datasets are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New datasets that match both the filter and conditions are scanned as quickly as possible depending on system capacity. + "inspectTemplateModifiedCadence": { # The cadence at which to update data profiles when the inspection rules defined by the `InspectTemplate` change. # Governs when to update data profiles when the inspection rules defined by the `InspectTemplate` change. If not set, changing the template will not cause a data profile to be updated. + "frequency": "A String", # How frequently data profiles can be updated when the template is modified. Defaults to never. + }, + "refreshFrequency": "A String", # If you set this field, profiles are refreshed at this frequency regardless of whether the underlying datasets have changed. Defaults to never. + }, + }, }, ], "updateTime": "A String", # Output only. The last update timestamp of a DiscoveryConfig. @@ -1337,6 +1418,11 @@

Method Details

"timestamp": "A String", # Time when the profile generation status was updated }, "projectDataProfile": "A String", # The resource name of the project data profile for this table. + "relatedResources": [ # Resources related to this profile. + { # A related resource. Examples: * The source BigQuery table for a Vertex AI dataset. * The source Cloud Storage bucket for a Vertex AI dataset. + "fullResource": "A String", # The full resource name of the related resource. + }, + ], "resourceLabels": { # The labels applied to the resource at the time the profile was generated. "a_key": "A String", }, diff --git a/docs/dyn/dlp_v2.projects.locations.discoveryConfigs.html b/docs/dyn/dlp_v2.projects.locations.discoveryConfigs.html index b035b780c77..09f7990fce8 100644 --- a/docs/dyn/dlp_v2.projects.locations.discoveryConfigs.html +++ b/docs/dyn/dlp_v2.projects.locations.discoveryConfigs.html @@ -197,6 +197,14 @@

Method Details

"allAssetInventoryAssets": True or False, # All AWS assets stored in Asset Inventory that didn't match other AWS discovery configs. }, }, + "processingLocation": { # Configure processing location for discovery and inspection. For example, image OCR is only provided in limited regions but configuring ProcessingLocation will redirect OCR to a location where OCR is provided. # Optional. Processing location configuration. Vertex AI dataset scanning will set processing_location.image_fallback_type to MultiRegionProcessing by default. + "imageFallbackLocation": { # Configure image processing to fall back to the configured processing option below if unavailable in the request location. # Image processing will fall back using this configuration. + "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. + }, + "multiRegionProcessing": { # Processing will happen in a multi-region that contains the current region if available. # Processing will happen in a multi-region that contains the current region if available. + }, + }, + }, "status": "A String", # Required. A status for this configuration. "targets": [ # Target to match against for determining what to scan and how frequently. { # Target used to match against for Discovery. @@ -394,6 +402,36 @@

Method Details

}, "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. }, + "vertexDatasetTarget": { # Target used to match against for discovery with Vertex AI datasets. # Vertex AI dataset target for Discovery. The first target to match a dataset will be the one applied. Note that discovery for Vertex AI can incur Cloud Storage Class B operation charges for storage.objects.get operations and retrieval fees. For more information, see [Cloud Storage pricing](https://cloud.google.com/storage/pricing#price-tables). Note that discovery for Vertex AI dataset will not be able to scan images unless DiscoveryConfig.processing_location.image_fallback_location has multi_region_processing or global_processing configured. + "conditions": { # Requirements that must be true before a dataset is profiled for the first time. # In addition to matching the filter, these conditions must be true before a profile is generated. + "createdAfter": "A String", # Vertex AI dataset must have been created after this date. Used to avoid backfilling. + "minAge": "A String", # Minimum age a Vertex AI dataset must have. If set, the value must be 1 hour or greater. + }, + "disabled": { # Do not profile the tables. # Disable profiling for datasets that match this filter. + }, + "filter": { # Determines what datasets will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID or dataset regex. # Required. The datasets the discovery cadence applies to. The first target with a matching filter will be the one to apply to a dataset. + "collection": { # Match dataset resources using regex filters. # A specific set of Vertex AI datasets for this filter to apply to. + "vertexDatasetRegexes": { # A collection of regular expressions to determine what datasets to match against. # The regex used to filter dataset resources. + "patterns": [ # Required. The group of regular expression patterns to match against one or more datasets. Maximum of 100 entries. The sum of the lengths of all regular expressions can't exceed 10 KiB. + { # A pattern to match against one or more dataset resources. + "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for configurations created within a project. + }, + ], + }, + }, + "others": { # Match discovery resources not covered by any other filter. # Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically. + }, + "vertexDatasetResourceReference": { # Identifies a single Vertex AI dataset. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). + "datasetResourceName": "A String", # Required. The name of the dataset resource. If set within a project-level configuration, the specified resource must be within the project. + }, + }, + "generationCadence": { # How often existing datasets should have their profiles refreshed. New datasets are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New datasets that match both the filter and conditions are scanned as quickly as possible depending on system capacity. + "inspectTemplateModifiedCadence": { # The cadence at which to update data profiles when the inspection rules defined by the `InspectTemplate` change. # Governs when to update data profiles when the inspection rules defined by the `InspectTemplate` change. If not set, changing the template will not cause a data profile to be updated. + "frequency": "A String", # How frequently data profiles can be updated when the template is modified. Defaults to never. + }, + "refreshFrequency": "A String", # If you set this field, profiles are refreshed at this frequency regardless of whether the underlying datasets have changed. Defaults to never. + }, + }, }, ], "updateTime": "A String", # Output only. The last update timestamp of a DiscoveryConfig. @@ -493,6 +531,14 @@

Method Details

"allAssetInventoryAssets": True or False, # All AWS assets stored in Asset Inventory that didn't match other AWS discovery configs. }, }, + "processingLocation": { # Configure processing location for discovery and inspection. For example, image OCR is only provided in limited regions but configuring ProcessingLocation will redirect OCR to a location where OCR is provided. # Optional. Processing location configuration. Vertex AI dataset scanning will set processing_location.image_fallback_type to MultiRegionProcessing by default. + "imageFallbackLocation": { # Configure image processing to fall back to the configured processing option below if unavailable in the request location. # Image processing will fall back using this configuration. + "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. + }, + "multiRegionProcessing": { # Processing will happen in a multi-region that contains the current region if available. # Processing will happen in a multi-region that contains the current region if available. + }, + }, + }, "status": "A String", # Required. A status for this configuration. "targets": [ # Target to match against for determining what to scan and how frequently. { # Target used to match against for Discovery. @@ -690,6 +736,36 @@

Method Details

}, "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. }, + "vertexDatasetTarget": { # Target used to match against for discovery with Vertex AI datasets. # Vertex AI dataset target for Discovery. The first target to match a dataset will be the one applied. Note that discovery for Vertex AI can incur Cloud Storage Class B operation charges for storage.objects.get operations and retrieval fees. For more information, see [Cloud Storage pricing](https://cloud.google.com/storage/pricing#price-tables). Note that discovery for Vertex AI dataset will not be able to scan images unless DiscoveryConfig.processing_location.image_fallback_location has multi_region_processing or global_processing configured. + "conditions": { # Requirements that must be true before a dataset is profiled for the first time. # In addition to matching the filter, these conditions must be true before a profile is generated. + "createdAfter": "A String", # Vertex AI dataset must have been created after this date. Used to avoid backfilling. + "minAge": "A String", # Minimum age a Vertex AI dataset must have. If set, the value must be 1 hour or greater. + }, + "disabled": { # Do not profile the tables. # Disable profiling for datasets that match this filter. + }, + "filter": { # Determines what datasets will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID or dataset regex. # Required. The datasets the discovery cadence applies to. The first target with a matching filter will be the one to apply to a dataset. + "collection": { # Match dataset resources using regex filters. # A specific set of Vertex AI datasets for this filter to apply to. + "vertexDatasetRegexes": { # A collection of regular expressions to determine what datasets to match against. # The regex used to filter dataset resources. + "patterns": [ # Required. The group of regular expression patterns to match against one or more datasets. Maximum of 100 entries. The sum of the lengths of all regular expressions can't exceed 10 KiB. + { # A pattern to match against one or more dataset resources. + "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for configurations created within a project. + }, + ], + }, + }, + "others": { # Match discovery resources not covered by any other filter. # Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically. + }, + "vertexDatasetResourceReference": { # Identifies a single Vertex AI dataset. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). + "datasetResourceName": "A String", # Required. The name of the dataset resource. If set within a project-level configuration, the specified resource must be within the project. + }, + }, + "generationCadence": { # How often existing datasets should have their profiles refreshed. New datasets are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New datasets that match both the filter and conditions are scanned as quickly as possible depending on system capacity. + "inspectTemplateModifiedCadence": { # The cadence at which to update data profiles when the inspection rules defined by the `InspectTemplate` change. # Governs when to update data profiles when the inspection rules defined by the `InspectTemplate` change. If not set, changing the template will not cause a data profile to be updated. + "frequency": "A String", # How frequently data profiles can be updated when the template is modified. Defaults to never. + }, + "refreshFrequency": "A String", # If you set this field, profiles are refreshed at this frequency regardless of whether the underlying datasets have changed. Defaults to never. + }, + }, }, ], "updateTime": "A String", # Output only. The last update timestamp of a DiscoveryConfig. @@ -813,6 +889,14 @@

Method Details

"allAssetInventoryAssets": True or False, # All AWS assets stored in Asset Inventory that didn't match other AWS discovery configs. }, }, + "processingLocation": { # Configure processing location for discovery and inspection. For example, image OCR is only provided in limited regions but configuring ProcessingLocation will redirect OCR to a location where OCR is provided. # Optional. Processing location configuration. Vertex AI dataset scanning will set processing_location.image_fallback_type to MultiRegionProcessing by default. + "imageFallbackLocation": { # Configure image processing to fall back to the configured processing option below if unavailable in the request location. # Image processing will fall back using this configuration. + "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. + }, + "multiRegionProcessing": { # Processing will happen in a multi-region that contains the current region if available. # Processing will happen in a multi-region that contains the current region if available. + }, + }, + }, "status": "A String", # Required. A status for this configuration. "targets": [ # Target to match against for determining what to scan and how frequently. { # Target used to match against for Discovery. @@ -1010,6 +1094,36 @@

Method Details

}, "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. }, + "vertexDatasetTarget": { # Target used to match against for discovery with Vertex AI datasets. # Vertex AI dataset target for Discovery. The first target to match a dataset will be the one applied. Note that discovery for Vertex AI can incur Cloud Storage Class B operation charges for storage.objects.get operations and retrieval fees. For more information, see [Cloud Storage pricing](https://cloud.google.com/storage/pricing#price-tables). Note that discovery for Vertex AI dataset will not be able to scan images unless DiscoveryConfig.processing_location.image_fallback_location has multi_region_processing or global_processing configured. + "conditions": { # Requirements that must be true before a dataset is profiled for the first time. # In addition to matching the filter, these conditions must be true before a profile is generated. + "createdAfter": "A String", # Vertex AI dataset must have been created after this date. Used to avoid backfilling. + "minAge": "A String", # Minimum age a Vertex AI dataset must have. If set, the value must be 1 hour or greater. + }, + "disabled": { # Do not profile the tables. # Disable profiling for datasets that match this filter. + }, + "filter": { # Determines what datasets will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID or dataset regex. # Required. The datasets the discovery cadence applies to. The first target with a matching filter will be the one to apply to a dataset. + "collection": { # Match dataset resources using regex filters. # A specific set of Vertex AI datasets for this filter to apply to. + "vertexDatasetRegexes": { # A collection of regular expressions to determine what datasets to match against. # The regex used to filter dataset resources. + "patterns": [ # Required. The group of regular expression patterns to match against one or more datasets. Maximum of 100 entries. The sum of the lengths of all regular expressions can't exceed 10 KiB. + { # A pattern to match against one or more dataset resources. + "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for configurations created within a project. + }, + ], + }, + }, + "others": { # Match discovery resources not covered by any other filter. # Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically. + }, + "vertexDatasetResourceReference": { # Identifies a single Vertex AI dataset. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). + "datasetResourceName": "A String", # Required. The name of the dataset resource. If set within a project-level configuration, the specified resource must be within the project. + }, + }, + "generationCadence": { # How often existing datasets should have their profiles refreshed. New datasets are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New datasets that match both the filter and conditions are scanned as quickly as possible depending on system capacity. + "inspectTemplateModifiedCadence": { # The cadence at which to update data profiles when the inspection rules defined by the `InspectTemplate` change. # Governs when to update data profiles when the inspection rules defined by the `InspectTemplate` change. If not set, changing the template will not cause a data profile to be updated. + "frequency": "A String", # How frequently data profiles can be updated when the template is modified. Defaults to never. + }, + "refreshFrequency": "A String", # If you set this field, profiles are refreshed at this frequency regardless of whether the underlying datasets have changed. Defaults to never. + }, + }, }, ], "updateTime": "A String", # Output only. The last update timestamp of a DiscoveryConfig. @@ -1120,6 +1234,14 @@

Method Details

"allAssetInventoryAssets": True or False, # All AWS assets stored in Asset Inventory that didn't match other AWS discovery configs. }, }, + "processingLocation": { # Configure processing location for discovery and inspection. For example, image OCR is only provided in limited regions but configuring ProcessingLocation will redirect OCR to a location where OCR is provided. # Optional. Processing location configuration. Vertex AI dataset scanning will set processing_location.image_fallback_type to MultiRegionProcessing by default. + "imageFallbackLocation": { # Configure image processing to fall back to the configured processing option below if unavailable in the request location. # Image processing will fall back using this configuration. + "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. + }, + "multiRegionProcessing": { # Processing will happen in a multi-region that contains the current region if available. # Processing will happen in a multi-region that contains the current region if available. + }, + }, + }, "status": "A String", # Required. A status for this configuration. "targets": [ # Target to match against for determining what to scan and how frequently. { # Target used to match against for Discovery. @@ -1317,6 +1439,36 @@

Method Details

}, "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. }, + "vertexDatasetTarget": { # Target used to match against for discovery with Vertex AI datasets. # Vertex AI dataset target for Discovery. The first target to match a dataset will be the one applied. Note that discovery for Vertex AI can incur Cloud Storage Class B operation charges for storage.objects.get operations and retrieval fees. For more information, see [Cloud Storage pricing](https://cloud.google.com/storage/pricing#price-tables). Note that discovery for Vertex AI dataset will not be able to scan images unless DiscoveryConfig.processing_location.image_fallback_location has multi_region_processing or global_processing configured. + "conditions": { # Requirements that must be true before a dataset is profiled for the first time. # In addition to matching the filter, these conditions must be true before a profile is generated. + "createdAfter": "A String", # Vertex AI dataset must have been created after this date. Used to avoid backfilling. + "minAge": "A String", # Minimum age a Vertex AI dataset must have. If set, the value must be 1 hour or greater. + }, + "disabled": { # Do not profile the tables. # Disable profiling for datasets that match this filter. + }, + "filter": { # Determines what datasets will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID or dataset regex. # Required. The datasets the discovery cadence applies to. The first target with a matching filter will be the one to apply to a dataset. + "collection": { # Match dataset resources using regex filters. # A specific set of Vertex AI datasets for this filter to apply to. + "vertexDatasetRegexes": { # A collection of regular expressions to determine what datasets to match against. # The regex used to filter dataset resources. + "patterns": [ # Required. The group of regular expression patterns to match against one or more datasets. Maximum of 100 entries. The sum of the lengths of all regular expressions can't exceed 10 KiB. + { # A pattern to match against one or more dataset resources. + "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for configurations created within a project. + }, + ], + }, + }, + "others": { # Match discovery resources not covered by any other filter. # Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically. + }, + "vertexDatasetResourceReference": { # Identifies a single Vertex AI dataset. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). + "datasetResourceName": "A String", # Required. The name of the dataset resource. If set within a project-level configuration, the specified resource must be within the project. + }, + }, + "generationCadence": { # How often existing datasets should have their profiles refreshed. New datasets are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New datasets that match both the filter and conditions are scanned as quickly as possible depending on system capacity. + "inspectTemplateModifiedCadence": { # The cadence at which to update data profiles when the inspection rules defined by the `InspectTemplate` change. # Governs when to update data profiles when the inspection rules defined by the `InspectTemplate` change. If not set, changing the template will not cause a data profile to be updated. + "frequency": "A String", # How frequently data profiles can be updated when the template is modified. Defaults to never. + }, + "refreshFrequency": "A String", # If you set this field, profiles are refreshed at this frequency regardless of whether the underlying datasets have changed. Defaults to never. + }, + }, }, ], "updateTime": "A String", # Output only. The last update timestamp of a DiscoveryConfig. @@ -1435,6 +1587,14 @@

Method Details

"allAssetInventoryAssets": True or False, # All AWS assets stored in Asset Inventory that didn't match other AWS discovery configs. }, }, + "processingLocation": { # Configure processing location for discovery and inspection. For example, image OCR is only provided in limited regions but configuring ProcessingLocation will redirect OCR to a location where OCR is provided. # Optional. Processing location configuration. Vertex AI dataset scanning will set processing_location.image_fallback_type to MultiRegionProcessing by default. + "imageFallbackLocation": { # Configure image processing to fall back to the configured processing option below if unavailable in the request location. # Image processing will fall back using this configuration. + "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. + }, + "multiRegionProcessing": { # Processing will happen in a multi-region that contains the current region if available. # Processing will happen in a multi-region that contains the current region if available. + }, + }, + }, "status": "A String", # Required. A status for this configuration. "targets": [ # Target to match against for determining what to scan and how frequently. { # Target used to match against for Discovery. @@ -1632,6 +1792,36 @@

Method Details

}, "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. }, + "vertexDatasetTarget": { # Target used to match against for discovery with Vertex AI datasets. # Vertex AI dataset target for Discovery. The first target to match a dataset will be the one applied. Note that discovery for Vertex AI can incur Cloud Storage Class B operation charges for storage.objects.get operations and retrieval fees. For more information, see [Cloud Storage pricing](https://cloud.google.com/storage/pricing#price-tables). Note that discovery for Vertex AI dataset will not be able to scan images unless DiscoveryConfig.processing_location.image_fallback_location has multi_region_processing or global_processing configured. + "conditions": { # Requirements that must be true before a dataset is profiled for the first time. # In addition to matching the filter, these conditions must be true before a profile is generated. + "createdAfter": "A String", # Vertex AI dataset must have been created after this date. Used to avoid backfilling. + "minAge": "A String", # Minimum age a Vertex AI dataset must have. If set, the value must be 1 hour or greater. + }, + "disabled": { # Do not profile the tables. # Disable profiling for datasets that match this filter. + }, + "filter": { # Determines what datasets will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID or dataset regex. # Required. The datasets the discovery cadence applies to. The first target with a matching filter will be the one to apply to a dataset. + "collection": { # Match dataset resources using regex filters. # A specific set of Vertex AI datasets for this filter to apply to. + "vertexDatasetRegexes": { # A collection of regular expressions to determine what datasets to match against. # The regex used to filter dataset resources. + "patterns": [ # Required. The group of regular expression patterns to match against one or more datasets. Maximum of 100 entries. The sum of the lengths of all regular expressions can't exceed 10 KiB. + { # A pattern to match against one or more dataset resources. + "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for configurations created within a project. + }, + ], + }, + }, + "others": { # Match discovery resources not covered by any other filter. # Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically. + }, + "vertexDatasetResourceReference": { # Identifies a single Vertex AI dataset. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). + "datasetResourceName": "A String", # Required. The name of the dataset resource. If set within a project-level configuration, the specified resource must be within the project. + }, + }, + "generationCadence": { # How often existing datasets should have their profiles refreshed. New datasets are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New datasets that match both the filter and conditions are scanned as quickly as possible depending on system capacity. + "inspectTemplateModifiedCadence": { # The cadence at which to update data profiles when the inspection rules defined by the `InspectTemplate` change. # Governs when to update data profiles when the inspection rules defined by the `InspectTemplate` change. If not set, changing the template will not cause a data profile to be updated. + "frequency": "A String", # How frequently data profiles can be updated when the template is modified. Defaults to never. + }, + "refreshFrequency": "A String", # If you set this field, profiles are refreshed at this frequency regardless of whether the underlying datasets have changed. Defaults to never. + }, + }, }, ], "updateTime": "A String", # Output only. The last update timestamp of a DiscoveryConfig. @@ -1732,6 +1922,14 @@

Method Details

"allAssetInventoryAssets": True or False, # All AWS assets stored in Asset Inventory that didn't match other AWS discovery configs. }, }, + "processingLocation": { # Configure processing location for discovery and inspection. For example, image OCR is only provided in limited regions but configuring ProcessingLocation will redirect OCR to a location where OCR is provided. # Optional. Processing location configuration. Vertex AI dataset scanning will set processing_location.image_fallback_type to MultiRegionProcessing by default. + "imageFallbackLocation": { # Configure image processing to fall back to the configured processing option below if unavailable in the request location. # Image processing will fall back using this configuration. + "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. + }, + "multiRegionProcessing": { # Processing will happen in a multi-region that contains the current region if available. # Processing will happen in a multi-region that contains the current region if available. + }, + }, + }, "status": "A String", # Required. A status for this configuration. "targets": [ # Target to match against for determining what to scan and how frequently. { # Target used to match against for Discovery. @@ -1929,6 +2127,36 @@

Method Details

}, "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. }, + "vertexDatasetTarget": { # Target used to match against for discovery with Vertex AI datasets. # Vertex AI dataset target for Discovery. The first target to match a dataset will be the one applied. Note that discovery for Vertex AI can incur Cloud Storage Class B operation charges for storage.objects.get operations and retrieval fees. For more information, see [Cloud Storage pricing](https://cloud.google.com/storage/pricing#price-tables). Note that discovery for Vertex AI dataset will not be able to scan images unless DiscoveryConfig.processing_location.image_fallback_location has multi_region_processing or global_processing configured. + "conditions": { # Requirements that must be true before a dataset is profiled for the first time. # In addition to matching the filter, these conditions must be true before a profile is generated. + "createdAfter": "A String", # Vertex AI dataset must have been created after this date. Used to avoid backfilling. + "minAge": "A String", # Minimum age a Vertex AI dataset must have. If set, the value must be 1 hour or greater. + }, + "disabled": { # Do not profile the tables. # Disable profiling for datasets that match this filter. + }, + "filter": { # Determines what datasets will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID or dataset regex. # Required. The datasets the discovery cadence applies to. The first target with a matching filter will be the one to apply to a dataset. + "collection": { # Match dataset resources using regex filters. # A specific set of Vertex AI datasets for this filter to apply to. + "vertexDatasetRegexes": { # A collection of regular expressions to determine what datasets to match against. # The regex used to filter dataset resources. + "patterns": [ # Required. The group of regular expression patterns to match against one or more datasets. Maximum of 100 entries. The sum of the lengths of all regular expressions can't exceed 10 KiB. + { # A pattern to match against one or more dataset resources. + "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for configurations created within a project. + }, + ], + }, + }, + "others": { # Match discovery resources not covered by any other filter. # Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically. + }, + "vertexDatasetResourceReference": { # Identifies a single Vertex AI dataset. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). + "datasetResourceName": "A String", # Required. The name of the dataset resource. If set within a project-level configuration, the specified resource must be within the project. + }, + }, + "generationCadence": { # How often existing datasets should have their profiles refreshed. New datasets are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New datasets that match both the filter and conditions are scanned as quickly as possible depending on system capacity. + "inspectTemplateModifiedCadence": { # The cadence at which to update data profiles when the inspection rules defined by the `InspectTemplate` change. # Governs when to update data profiles when the inspection rules defined by the `InspectTemplate` change. If not set, changing the template will not cause a data profile to be updated. + "frequency": "A String", # How frequently data profiles can be updated when the template is modified. Defaults to never. + }, + "refreshFrequency": "A String", # If you set this field, profiles are refreshed at this frequency regardless of whether the underlying datasets have changed. Defaults to never. + }, + }, }, ], "updateTime": "A String", # Output only. The last update timestamp of a DiscoveryConfig. diff --git a/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html b/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html index ff58bc869f4..dd05a805851 100644 --- a/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html +++ b/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html @@ -277,6 +277,14 @@

Method Details

"allAssetInventoryAssets": True or False, # All AWS assets stored in Asset Inventory that didn't match other AWS discovery configs. }, }, + "processingLocation": { # Configure processing location for discovery and inspection. For example, image OCR is only provided in limited regions but configuring ProcessingLocation will redirect OCR to a location where OCR is provided. # Optional. Processing location configuration. Vertex AI dataset scanning will set processing_location.image_fallback_type to MultiRegionProcessing by default. + "imageFallbackLocation": { # Configure image processing to fall back to the configured processing option below if unavailable in the request location. # Image processing will fall back using this configuration. + "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. + }, + "multiRegionProcessing": { # Processing will happen in a multi-region that contains the current region if available. # Processing will happen in a multi-region that contains the current region if available. + }, + }, + }, "status": "A String", # Required. A status for this configuration. "targets": [ # Target to match against for determining what to scan and how frequently. { # Target used to match against for Discovery. @@ -474,6 +482,36 @@

Method Details

}, "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. }, + "vertexDatasetTarget": { # Target used to match against for discovery with Vertex AI datasets. # Vertex AI dataset target for Discovery. The first target to match a dataset will be the one applied. Note that discovery for Vertex AI can incur Cloud Storage Class B operation charges for storage.objects.get operations and retrieval fees. For more information, see [Cloud Storage pricing](https://cloud.google.com/storage/pricing#price-tables). Note that discovery for Vertex AI dataset will not be able to scan images unless DiscoveryConfig.processing_location.image_fallback_location has multi_region_processing or global_processing configured. + "conditions": { # Requirements that must be true before a dataset is profiled for the first time. # In addition to matching the filter, these conditions must be true before a profile is generated. + "createdAfter": "A String", # Vertex AI dataset must have been created after this date. Used to avoid backfilling. + "minAge": "A String", # Minimum age a Vertex AI dataset must have. If set, the value must be 1 hour or greater. + }, + "disabled": { # Do not profile the tables. # Disable profiling for datasets that match this filter. + }, + "filter": { # Determines what datasets will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID or dataset regex. # Required. The datasets the discovery cadence applies to. The first target with a matching filter will be the one to apply to a dataset. + "collection": { # Match dataset resources using regex filters. # A specific set of Vertex AI datasets for this filter to apply to. + "vertexDatasetRegexes": { # A collection of regular expressions to determine what datasets to match against. # The regex used to filter dataset resources. + "patterns": [ # Required. The group of regular expression patterns to match against one or more datasets. Maximum of 100 entries. The sum of the lengths of all regular expressions can't exceed 10 KiB. + { # A pattern to match against one or more dataset resources. + "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for configurations created within a project. + }, + ], + }, + }, + "others": { # Match discovery resources not covered by any other filter. # Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically. + }, + "vertexDatasetResourceReference": { # Identifies a single Vertex AI dataset. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). + "datasetResourceName": "A String", # Required. The name of the dataset resource. If set within a project-level configuration, the specified resource must be within the project. + }, + }, + "generationCadence": { # How often existing datasets should have their profiles refreshed. New datasets are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New datasets that match both the filter and conditions are scanned as quickly as possible depending on system capacity. + "inspectTemplateModifiedCadence": { # The cadence at which to update data profiles when the inspection rules defined by the `InspectTemplate` change. # Governs when to update data profiles when the inspection rules defined by the `InspectTemplate` change. If not set, changing the template will not cause a data profile to be updated. + "frequency": "A String", # How frequently data profiles can be updated when the template is modified. Defaults to never. + }, + "refreshFrequency": "A String", # If you set this field, profiles are refreshed at this frequency regardless of whether the underlying datasets have changed. Defaults to never. + }, + }, }, ], "updateTime": "A String", # Output only. The last update timestamp of a DiscoveryConfig. @@ -734,7 +772,7 @@

Method Details

], "fileStoreIsEmpty": True or False, # The file store does not have any files. "fileStoreLocation": "A String", # The location of the file store. * Cloud Storage: https://cloud.google.com/storage/docs/locations#available-locations * Amazon S3: https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints - "fileStorePath": "A String", # The file store path. * Cloud Storage: `gs://{bucket}` * Amazon S3: `s3://{bucket}` + "fileStorePath": "A String", # The file store path. * Cloud Storage: `gs://{bucket}` * Amazon S3: `s3://{bucket}` * Vertex AI dataset: `projects/{project_number}/locations/{location}/datasets/{dataset_id}` "fullResource": "A String", # The resource name of the resource profiled. https://cloud.google.com/apis/design/resource_names#full_resource_name Example format of an S3 bucket full resource name: `//cloudasset.googleapis.com/organizations/{org_id}/otherCloudConnections/aws/arn:aws:s3:::{bucket_name}` "lastModifiedTime": "A String", # The time the file store was last modified. "locationType": "A String", # The location type of the file store (region, dual-region, multi-region, etc). If dual-region, expect data_storage_locations to be populated. @@ -754,6 +792,11 @@

Method Details

}, "projectDataProfile": "A String", # The resource name of the project data profile for this file store. "projectId": "A String", # The Google Cloud project ID that owns the resource. For Amazon S3 buckets, this is the AWS Account Id. + "relatedResources": [ # Resources related to this profile. + { # A related resource. Examples: * The source BigQuery table for a Vertex AI dataset. * The source Cloud Storage bucket for a Vertex AI dataset. + "fullResource": "A String", # The full resource name of the related resource. + }, + ], "resourceAttributes": { # Attributes of the resource being profiled. Currently used attributes: * customer_managed_encryption: boolean - true: the resource is encrypted with a customer-managed key. - false: the resource is encrypted with a provider-managed key. "a_key": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. "booleanValue": True or False, # boolean @@ -956,6 +999,14 @@

Method Details

"allAssetInventoryAssets": True or False, # All AWS assets stored in Asset Inventory that didn't match other AWS discovery configs. }, }, + "processingLocation": { # Configure processing location for discovery and inspection. For example, image OCR is only provided in limited regions but configuring ProcessingLocation will redirect OCR to a location where OCR is provided. # Optional. Processing location configuration. Vertex AI dataset scanning will set processing_location.image_fallback_type to MultiRegionProcessing by default. + "imageFallbackLocation": { # Configure image processing to fall back to the configured processing option below if unavailable in the request location. # Image processing will fall back using this configuration. + "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. + }, + "multiRegionProcessing": { # Processing will happen in a multi-region that contains the current region if available. # Processing will happen in a multi-region that contains the current region if available. + }, + }, + }, "status": "A String", # Required. A status for this configuration. "targets": [ # Target to match against for determining what to scan and how frequently. { # Target used to match against for Discovery. @@ -1153,6 +1204,36 @@

Method Details

}, "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. }, + "vertexDatasetTarget": { # Target used to match against for discovery with Vertex AI datasets. # Vertex AI dataset target for Discovery. The first target to match a dataset will be the one applied. Note that discovery for Vertex AI can incur Cloud Storage Class B operation charges for storage.objects.get operations and retrieval fees. For more information, see [Cloud Storage pricing](https://cloud.google.com/storage/pricing#price-tables). Note that discovery for Vertex AI dataset will not be able to scan images unless DiscoveryConfig.processing_location.image_fallback_location has multi_region_processing or global_processing configured. + "conditions": { # Requirements that must be true before a dataset is profiled for the first time. # In addition to matching the filter, these conditions must be true before a profile is generated. + "createdAfter": "A String", # Vertex AI dataset must have been created after this date. Used to avoid backfilling. + "minAge": "A String", # Minimum age a Vertex AI dataset must have. If set, the value must be 1 hour or greater. + }, + "disabled": { # Do not profile the tables. # Disable profiling for datasets that match this filter. + }, + "filter": { # Determines what datasets will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID or dataset regex. # Required. The datasets the discovery cadence applies to. The first target with a matching filter will be the one to apply to a dataset. + "collection": { # Match dataset resources using regex filters. # A specific set of Vertex AI datasets for this filter to apply to. + "vertexDatasetRegexes": { # A collection of regular expressions to determine what datasets to match against. # The regex used to filter dataset resources. + "patterns": [ # Required. The group of regular expression patterns to match against one or more datasets. Maximum of 100 entries. The sum of the lengths of all regular expressions can't exceed 10 KiB. + { # A pattern to match against one or more dataset resources. + "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for configurations created within a project. + }, + ], + }, + }, + "others": { # Match discovery resources not covered by any other filter. # Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically. + }, + "vertexDatasetResourceReference": { # Identifies a single Vertex AI dataset. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). + "datasetResourceName": "A String", # Required. The name of the dataset resource. If set within a project-level configuration, the specified resource must be within the project. + }, + }, + "generationCadence": { # How often existing datasets should have their profiles refreshed. New datasets are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New datasets that match both the filter and conditions are scanned as quickly as possible depending on system capacity. + "inspectTemplateModifiedCadence": { # The cadence at which to update data profiles when the inspection rules defined by the `InspectTemplate` change. # Governs when to update data profiles when the inspection rules defined by the `InspectTemplate` change. If not set, changing the template will not cause a data profile to be updated. + "frequency": "A String", # How frequently data profiles can be updated when the template is modified. Defaults to never. + }, + "refreshFrequency": "A String", # If you set this field, profiles are refreshed at this frequency regardless of whether the underlying datasets have changed. Defaults to never. + }, + }, }, ], "updateTime": "A String", # Output only. The last update timestamp of a DiscoveryConfig. @@ -1413,7 +1494,7 @@

Method Details

], "fileStoreIsEmpty": True or False, # The file store does not have any files. "fileStoreLocation": "A String", # The location of the file store. * Cloud Storage: https://cloud.google.com/storage/docs/locations#available-locations * Amazon S3: https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints - "fileStorePath": "A String", # The file store path. * Cloud Storage: `gs://{bucket}` * Amazon S3: `s3://{bucket}` + "fileStorePath": "A String", # The file store path. * Cloud Storage: `gs://{bucket}` * Amazon S3: `s3://{bucket}` * Vertex AI dataset: `projects/{project_number}/locations/{location}/datasets/{dataset_id}` "fullResource": "A String", # The resource name of the resource profiled. https://cloud.google.com/apis/design/resource_names#full_resource_name Example format of an S3 bucket full resource name: `//cloudasset.googleapis.com/organizations/{org_id}/otherCloudConnections/aws/arn:aws:s3:::{bucket_name}` "lastModifiedTime": "A String", # The time the file store was last modified. "locationType": "A String", # The location type of the file store (region, dual-region, multi-region, etc). If dual-region, expect data_storage_locations to be populated. @@ -1433,6 +1514,11 @@

Method Details

}, "projectDataProfile": "A String", # The resource name of the project data profile for this file store. "projectId": "A String", # The Google Cloud project ID that owns the resource. For Amazon S3 buckets, this is the AWS Account Id. + "relatedResources": [ # Resources related to this profile. + { # A related resource. Examples: * The source BigQuery table for a Vertex AI dataset. * The source Cloud Storage bucket for a Vertex AI dataset. + "fullResource": "A String", # The full resource name of the related resource. + }, + ], "resourceAttributes": { # Attributes of the resource being profiled. Currently used attributes: * customer_managed_encryption: boolean - true: the resource is encrypted with a customer-managed key. - false: the resource is encrypted with a provider-managed key. "a_key": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. "booleanValue": True or False, # boolean diff --git a/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html b/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html index 14b4ec2d912..7dcf6927465 100644 --- a/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html +++ b/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html @@ -277,6 +277,14 @@

Method Details

"allAssetInventoryAssets": True or False, # All AWS assets stored in Asset Inventory that didn't match other AWS discovery configs. }, }, + "processingLocation": { # Configure processing location for discovery and inspection. For example, image OCR is only provided in limited regions but configuring ProcessingLocation will redirect OCR to a location where OCR is provided. # Optional. Processing location configuration. Vertex AI dataset scanning will set processing_location.image_fallback_type to MultiRegionProcessing by default. + "imageFallbackLocation": { # Configure image processing to fall back to the configured processing option below if unavailable in the request location. # Image processing will fall back using this configuration. + "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. + }, + "multiRegionProcessing": { # Processing will happen in a multi-region that contains the current region if available. # Processing will happen in a multi-region that contains the current region if available. + }, + }, + }, "status": "A String", # Required. A status for this configuration. "targets": [ # Target to match against for determining what to scan and how frequently. { # Target used to match against for Discovery. @@ -474,6 +482,36 @@

Method Details

}, "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. }, + "vertexDatasetTarget": { # Target used to match against for discovery with Vertex AI datasets. # Vertex AI dataset target for Discovery. The first target to match a dataset will be the one applied. Note that discovery for Vertex AI can incur Cloud Storage Class B operation charges for storage.objects.get operations and retrieval fees. For more information, see [Cloud Storage pricing](https://cloud.google.com/storage/pricing#price-tables). Note that discovery for Vertex AI dataset will not be able to scan images unless DiscoveryConfig.processing_location.image_fallback_location has multi_region_processing or global_processing configured. + "conditions": { # Requirements that must be true before a dataset is profiled for the first time. # In addition to matching the filter, these conditions must be true before a profile is generated. + "createdAfter": "A String", # Vertex AI dataset must have been created after this date. Used to avoid backfilling. + "minAge": "A String", # Minimum age a Vertex AI dataset must have. If set, the value must be 1 hour or greater. + }, + "disabled": { # Do not profile the tables. # Disable profiling for datasets that match this filter. + }, + "filter": { # Determines what datasets will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID or dataset regex. # Required. The datasets the discovery cadence applies to. The first target with a matching filter will be the one to apply to a dataset. + "collection": { # Match dataset resources using regex filters. # A specific set of Vertex AI datasets for this filter to apply to. + "vertexDatasetRegexes": { # A collection of regular expressions to determine what datasets to match against. # The regex used to filter dataset resources. + "patterns": [ # Required. The group of regular expression patterns to match against one or more datasets. Maximum of 100 entries. The sum of the lengths of all regular expressions can't exceed 10 KiB. + { # A pattern to match against one or more dataset resources. + "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for configurations created within a project. + }, + ], + }, + }, + "others": { # Match discovery resources not covered by any other filter. # Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically. + }, + "vertexDatasetResourceReference": { # Identifies a single Vertex AI dataset. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). + "datasetResourceName": "A String", # Required. The name of the dataset resource. If set within a project-level configuration, the specified resource must be within the project. + }, + }, + "generationCadence": { # How often existing datasets should have their profiles refreshed. New datasets are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New datasets that match both the filter and conditions are scanned as quickly as possible depending on system capacity. + "inspectTemplateModifiedCadence": { # The cadence at which to update data profiles when the inspection rules defined by the `InspectTemplate` change. # Governs when to update data profiles when the inspection rules defined by the `InspectTemplate` change. If not set, changing the template will not cause a data profile to be updated. + "frequency": "A String", # How frequently data profiles can be updated when the template is modified. Defaults to never. + }, + "refreshFrequency": "A String", # If you set this field, profiles are refreshed at this frequency regardless of whether the underlying datasets have changed. Defaults to never. + }, + }, }, ], "updateTime": "A String", # Output only. The last update timestamp of a DiscoveryConfig. @@ -714,6 +752,11 @@

Method Details

"timestamp": "A String", # Time when the profile generation status was updated }, "projectDataProfile": "A String", # The resource name of the project data profile for this table. + "relatedResources": [ # Resources related to this profile. + { # A related resource. Examples: * The source BigQuery table for a Vertex AI dataset. * The source Cloud Storage bucket for a Vertex AI dataset. + "fullResource": "A String", # The full resource name of the related resource. + }, + ], "resourceLabels": { # The labels applied to the resource at the time the profile was generated. "a_key": "A String", }, @@ -900,6 +943,14 @@

Method Details

"allAssetInventoryAssets": True or False, # All AWS assets stored in Asset Inventory that didn't match other AWS discovery configs. }, }, + "processingLocation": { # Configure processing location for discovery and inspection. For example, image OCR is only provided in limited regions but configuring ProcessingLocation will redirect OCR to a location where OCR is provided. # Optional. Processing location configuration. Vertex AI dataset scanning will set processing_location.image_fallback_type to MultiRegionProcessing by default. + "imageFallbackLocation": { # Configure image processing to fall back to the configured processing option below if unavailable in the request location. # Image processing will fall back using this configuration. + "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. + }, + "multiRegionProcessing": { # Processing will happen in a multi-region that contains the current region if available. # Processing will happen in a multi-region that contains the current region if available. + }, + }, + }, "status": "A String", # Required. A status for this configuration. "targets": [ # Target to match against for determining what to scan and how frequently. { # Target used to match against for Discovery. @@ -1097,6 +1148,36 @@

Method Details

}, "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. }, + "vertexDatasetTarget": { # Target used to match against for discovery with Vertex AI datasets. # Vertex AI dataset target for Discovery. The first target to match a dataset will be the one applied. Note that discovery for Vertex AI can incur Cloud Storage Class B operation charges for storage.objects.get operations and retrieval fees. For more information, see [Cloud Storage pricing](https://cloud.google.com/storage/pricing#price-tables). Note that discovery for Vertex AI dataset will not be able to scan images unless DiscoveryConfig.processing_location.image_fallback_location has multi_region_processing or global_processing configured. + "conditions": { # Requirements that must be true before a dataset is profiled for the first time. # In addition to matching the filter, these conditions must be true before a profile is generated. + "createdAfter": "A String", # Vertex AI dataset must have been created after this date. Used to avoid backfilling. + "minAge": "A String", # Minimum age a Vertex AI dataset must have. If set, the value must be 1 hour or greater. + }, + "disabled": { # Do not profile the tables. # Disable profiling for datasets that match this filter. + }, + "filter": { # Determines what datasets will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID or dataset regex. # Required. The datasets the discovery cadence applies to. The first target with a matching filter will be the one to apply to a dataset. + "collection": { # Match dataset resources using regex filters. # A specific set of Vertex AI datasets for this filter to apply to. + "vertexDatasetRegexes": { # A collection of regular expressions to determine what datasets to match against. # The regex used to filter dataset resources. + "patterns": [ # Required. The group of regular expression patterns to match against one or more datasets. Maximum of 100 entries. The sum of the lengths of all regular expressions can't exceed 10 KiB. + { # A pattern to match against one or more dataset resources. + "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for configurations created within a project. + }, + ], + }, + }, + "others": { # Match discovery resources not covered by any other filter. # Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically. + }, + "vertexDatasetResourceReference": { # Identifies a single Vertex AI dataset. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). + "datasetResourceName": "A String", # Required. The name of the dataset resource. If set within a project-level configuration, the specified resource must be within the project. + }, + }, + "generationCadence": { # How often existing datasets should have their profiles refreshed. New datasets are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New datasets that match both the filter and conditions are scanned as quickly as possible depending on system capacity. + "inspectTemplateModifiedCadence": { # The cadence at which to update data profiles when the inspection rules defined by the `InspectTemplate` change. # Governs when to update data profiles when the inspection rules defined by the `InspectTemplate` change. If not set, changing the template will not cause a data profile to be updated. + "frequency": "A String", # How frequently data profiles can be updated when the template is modified. Defaults to never. + }, + "refreshFrequency": "A String", # If you set this field, profiles are refreshed at this frequency regardless of whether the underlying datasets have changed. Defaults to never. + }, + }, }, ], "updateTime": "A String", # Output only. The last update timestamp of a DiscoveryConfig. @@ -1337,6 +1418,11 @@

Method Details

"timestamp": "A String", # Time when the profile generation status was updated }, "projectDataProfile": "A String", # The resource name of the project data profile for this table. + "relatedResources": [ # Resources related to this profile. + { # A related resource. Examples: * The source BigQuery table for a Vertex AI dataset. * The source Cloud Storage bucket for a Vertex AI dataset. + "fullResource": "A String", # The full resource name of the related resource. + }, + ], "resourceLabels": { # The labels applied to the resource at the time the profile was generated. "a_key": "A String", }, diff --git a/googleapiclient/discovery_cache/documents/dlp.v2.json b/googleapiclient/discovery_cache/documents/dlp.v2.json index ed3db5cc124..577f0b40a28 100644 --- a/googleapiclient/discovery_cache/documents/dlp.v2.json +++ b/googleapiclient/discovery_cache/documents/dlp.v2.json @@ -5025,7 +5025,7 @@ } } }, -"revision": "20250126", +"revision": "20250216", "rootUrl": "https://dlp.googleapis.com/", "schemas": { "GooglePrivacyDlpV2Action": { @@ -7631,6 +7631,10 @@ "$ref": "GooglePrivacyDlpV2OtherCloudDiscoveryStartingLocation", "description": "Must be set only when scanning other clouds." }, +"processingLocation": { +"$ref": "GooglePrivacyDlpV2ProcessingLocation", +"description": "Optional. Processing location configuration. Vertex AI dataset scanning will set processing_location.image_fallback_type to MultiRegionProcessing by default." +}, "status": { "description": "Required. A status for this configuration.", "enum": [ @@ -7920,6 +7924,73 @@ "secretsTarget": { "$ref": "GooglePrivacyDlpV2SecretsDiscoveryTarget", "description": "Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed." +}, +"vertexDatasetTarget": { +"$ref": "GooglePrivacyDlpV2VertexDatasetDiscoveryTarget", +"description": "Vertex AI dataset target for Discovery. The first target to match a dataset will be the one applied. Note that discovery for Vertex AI can incur Cloud Storage Class B operation charges for storage.objects.get operations and retrieval fees. For more information, see [Cloud Storage pricing](https://cloud.google.com/storage/pricing#price-tables). Note that discovery for Vertex AI dataset will not be able to scan images unless DiscoveryConfig.processing_location.image_fallback_location has multi_region_processing or global_processing configured." +} +}, +"type": "object" +}, +"GooglePrivacyDlpV2DiscoveryVertexDatasetConditions": { +"description": "Requirements that must be true before a dataset is profiled for the first time.", +"id": "GooglePrivacyDlpV2DiscoveryVertexDatasetConditions", +"properties": { +"createdAfter": { +"description": "Vertex AI dataset must have been created after this date. Used to avoid backfilling.", +"format": "google-datetime", +"type": "string" +}, +"minAge": { +"description": "Minimum age a Vertex AI dataset must have. If set, the value must be 1 hour or greater.", +"format": "google-duration", +"type": "string" +} +}, +"type": "object" +}, +"GooglePrivacyDlpV2DiscoveryVertexDatasetFilter": { +"description": "Determines what datasets will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID or dataset regex.", +"id": "GooglePrivacyDlpV2DiscoveryVertexDatasetFilter", +"properties": { +"collection": { +"$ref": "GooglePrivacyDlpV2VertexDatasetCollection", +"description": "A specific set of Vertex AI datasets for this filter to apply to." +}, +"others": { +"$ref": "GooglePrivacyDlpV2AllOtherResources", +"description": "Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically." +}, +"vertexDatasetResourceReference": { +"$ref": "GooglePrivacyDlpV2VertexDatasetResourceReference", +"description": "The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference)." +} +}, +"type": "object" +}, +"GooglePrivacyDlpV2DiscoveryVertexDatasetGenerationCadence": { +"description": "How often existing datasets should have their profiles refreshed. New datasets are scanned as quickly as possible depending on system capacity.", +"id": "GooglePrivacyDlpV2DiscoveryVertexDatasetGenerationCadence", +"properties": { +"inspectTemplateModifiedCadence": { +"$ref": "GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence", +"description": "Governs when to update data profiles when the inspection rules defined by the `InspectTemplate` change. If not set, changing the template will not cause a data profile to be updated." +}, +"refreshFrequency": { +"description": "If you set this field, profiles are refreshed at this frequency regardless of whether the underlying datasets have changed. Defaults to never.", +"enum": [ +"UPDATE_FREQUENCY_UNSPECIFIED", +"UPDATE_FREQUENCY_NEVER", +"UPDATE_FREQUENCY_DAILY", +"UPDATE_FREQUENCY_MONTHLY" +], +"enumDescriptions": [ +"Unspecified.", +"After the data profile is created, it will never be updated.", +"The data profile can be updated up to once every 24 hours.", +"The data profile can be updated up to once every 30 days. Default." +], +"type": "string" } }, "type": "object" @@ -8388,7 +8459,7 @@ "type": "string" }, "fileStorePath": { -"description": "The file store path. * Cloud Storage: `gs://{bucket}` * Amazon S3: `s3://{bucket}`", +"description": "The file store path. * Cloud Storage: `gs://{bucket}` * Amazon S3: `s3://{bucket}` * Vertex AI dataset: `projects/{project_number}/locations/{location}/datasets/{dataset_id}`", "type": "string" }, "fullResource": { @@ -8425,6 +8496,13 @@ "description": "The Google Cloud project ID that owns the resource. For Amazon S3 buckets, this is the AWS Account Id.", "type": "string" }, +"relatedResources": { +"description": "Resources related to this profile.", +"items": { +"$ref": "GooglePrivacyDlpV2RelatedResource" +}, +"type": "array" +}, "resourceAttributes": { "additionalProperties": { "$ref": "GooglePrivacyDlpV2Value" @@ -8642,6 +8720,12 @@ }, "type": "object" }, +"GooglePrivacyDlpV2GlobalProcessing": { +"description": "Processing will happen in the global region.", +"id": "GooglePrivacyDlpV2GlobalProcessing", +"properties": {}, +"type": "object" +}, "GooglePrivacyDlpV2HotwordRule": { "description": "The rule that adjusts the likelihood of findings within a certain proximity of hotwords.", "id": "GooglePrivacyDlpV2HotwordRule", @@ -8787,6 +8871,21 @@ }, "type": "object" }, +"GooglePrivacyDlpV2ImageFallbackLocation": { +"description": "Configure image processing to fall back to the configured processing option below if unavailable in the request location.", +"id": "GooglePrivacyDlpV2ImageFallbackLocation", +"properties": { +"globalProcessing": { +"$ref": "GooglePrivacyDlpV2GlobalProcessing", +"description": "Processing will happen in the global region." +}, +"multiRegionProcessing": { +"$ref": "GooglePrivacyDlpV2MultiRegionProcessing", +"description": "Processing will happen in a multi-region that contains the current region if available." +} +}, +"type": "object" +}, "GooglePrivacyDlpV2ImageLocation": { "description": "Location of the finding within an image.", "id": "GooglePrivacyDlpV2ImageLocation", @@ -9016,7 +9115,8 @@ "CREDENTIAL", "GOVERNMENT_ID", "DOCUMENT", -"CONTEXTUAL_INFORMATION" +"CONTEXTUAL_INFORMATION", +"CUSTOM" ], "enumDescriptions": [ "Unused type", @@ -9026,7 +9126,8 @@ "Confidential or secret information, for example, a password.", "An identification document issued by a government.", "A document, for example, a resume or source code.", -"Information that is not sensitive on its own, but provides details about the circumstances surrounding an entity or an event." +"Information that is not sensitive on its own, but provides details about the circumstances surrounding an entity or an event.", +"Category for `CustomInfoType` types." ], "type": "string" } @@ -10185,6 +10286,12 @@ }, "type": "object" }, +"GooglePrivacyDlpV2MultiRegionProcessing": { +"description": "Processing will happen in a multi-region that contains the current region if available.", +"id": "GooglePrivacyDlpV2MultiRegionProcessing", +"properties": {}, +"type": "object" +}, "GooglePrivacyDlpV2NumericalStatsConfig": { "description": "Compute numerical stats over an individual column, including min, max, and quantiles.", "id": "GooglePrivacyDlpV2NumericalStatsConfig", @@ -10507,6 +10614,17 @@ }, "type": "object" }, +"GooglePrivacyDlpV2ProcessingLocation": { +"description": "Configure processing location for discovery and inspection. For example, image OCR is only provided in limited regions but configuring ProcessingLocation will redirect OCR to a location where OCR is provided.", +"id": "GooglePrivacyDlpV2ProcessingLocation", +"properties": { +"imageFallbackLocation": { +"$ref": "GooglePrivacyDlpV2ImageFallbackLocation", +"description": "Image processing will fall back using this configuration." +} +}, +"type": "object" +}, "GooglePrivacyDlpV2ProfileStatus": { "description": "Success or errors for the profile generation.", "id": "GooglePrivacyDlpV2ProfileStatus", @@ -11041,6 +11159,17 @@ }, "type": "object" }, +"GooglePrivacyDlpV2RelatedResource": { +"description": "A related resource. Examples: * The source BigQuery table for a Vertex AI dataset. * The source Cloud Storage bucket for a Vertex AI dataset.", +"id": "GooglePrivacyDlpV2RelatedResource", +"properties": { +"fullResource": { +"description": "The full resource name of the related resource.", +"type": "string" +} +}, +"type": "object" +}, "GooglePrivacyDlpV2ReplaceDictionaryConfig": { "description": "Replace each input value with a value randomly selected from the dictionary.", "id": "GooglePrivacyDlpV2ReplaceDictionaryConfig", @@ -11659,6 +11788,13 @@ "description": "The resource name of the project data profile for this table.", "type": "string" }, +"relatedResources": { +"description": "Resources related to this profile.", +"items": { +"$ref": "GooglePrivacyDlpV2RelatedResource" +}, +"type": "array" +}, "resourceLabels": { "additionalProperties": { "type": "string" @@ -12404,6 +12540,76 @@ }, "type": "object" }, +"GooglePrivacyDlpV2VertexDatasetCollection": { +"description": "Match dataset resources using regex filters.", +"id": "GooglePrivacyDlpV2VertexDatasetCollection", +"properties": { +"vertexDatasetRegexes": { +"$ref": "GooglePrivacyDlpV2VertexDatasetRegexes", +"description": "The regex used to filter dataset resources." +} +}, +"type": "object" +}, +"GooglePrivacyDlpV2VertexDatasetDiscoveryTarget": { +"description": "Target used to match against for discovery with Vertex AI datasets.", +"id": "GooglePrivacyDlpV2VertexDatasetDiscoveryTarget", +"properties": { +"conditions": { +"$ref": "GooglePrivacyDlpV2DiscoveryVertexDatasetConditions", +"description": "In addition to matching the filter, these conditions must be true before a profile is generated." +}, +"disabled": { +"$ref": "GooglePrivacyDlpV2Disabled", +"description": "Disable profiling for datasets that match this filter." +}, +"filter": { +"$ref": "GooglePrivacyDlpV2DiscoveryVertexDatasetFilter", +"description": "Required. The datasets the discovery cadence applies to. The first target with a matching filter will be the one to apply to a dataset." +}, +"generationCadence": { +"$ref": "GooglePrivacyDlpV2DiscoveryVertexDatasetGenerationCadence", +"description": "How often and when to update profiles. New datasets that match both the filter and conditions are scanned as quickly as possible depending on system capacity." +} +}, +"type": "object" +}, +"GooglePrivacyDlpV2VertexDatasetRegex": { +"description": "A pattern to match against one or more dataset resources.", +"id": "GooglePrivacyDlpV2VertexDatasetRegex", +"properties": { +"projectIdRegex": { +"description": "For organizations, if unset, will match all projects. Has no effect for configurations created within a project.", +"type": "string" +} +}, +"type": "object" +}, +"GooglePrivacyDlpV2VertexDatasetRegexes": { +"description": "A collection of regular expressions to determine what datasets to match against.", +"id": "GooglePrivacyDlpV2VertexDatasetRegexes", +"properties": { +"patterns": { +"description": "Required. The group of regular expression patterns to match against one or more datasets. Maximum of 100 entries. The sum of the lengths of all regular expressions can't exceed 10 KiB.", +"items": { +"$ref": "GooglePrivacyDlpV2VertexDatasetRegex" +}, +"type": "array" +} +}, +"type": "object" +}, +"GooglePrivacyDlpV2VertexDatasetResourceReference": { +"description": "Identifies a single Vertex AI dataset.", +"id": "GooglePrivacyDlpV2VertexDatasetResourceReference", +"properties": { +"datasetResourceName": { +"description": "Required. The name of the dataset resource. If set within a project-level configuration, the specified resource must be within the project.", +"type": "string" +} +}, +"type": "object" +}, "GooglePrivacyDlpV2WordList": { "description": "Message defining a list of words or phrases to search for in the data.", "id": "GooglePrivacyDlpV2WordList", From 3b427c651c2b740feec80c1d51630de307c4acf4 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 25 Feb 2025 07:08:19 +0000 Subject: [PATCH 15/36] feat(drive): update the api #### drive:v2 The following keys were added: - resources.permissions.methods.delete.parameters.enforceExpansiveAccess (Total Keys: 3) - resources.permissions.methods.patch.parameters.enforceExpansiveAccess (Total Keys: 3) - resources.permissions.methods.update.parameters.enforceExpansiveAccess (Total Keys: 3) - schemas.File.properties.capabilities.properties.canDisableInheritedPermissions (Total Keys: 2) - schemas.File.properties.capabilities.properties.canEnableInheritedPermissions (Total Keys: 2) - schemas.File.properties.inheritedPermissionsDisabled.type (Total Keys: 1) - schemas.Permission.properties.inheritedPermissionsDisabled.type (Total Keys: 1) #### drive:v3 The following keys were added: - resources.permissions.methods.delete.parameters.enforceExpansiveAccess (Total Keys: 3) - resources.permissions.methods.update.parameters.enforceExpansiveAccess (Total Keys: 3) - schemas.File.properties.capabilities.properties.canDisableInheritedPermissions.type (Total Keys: 1) - schemas.File.properties.capabilities.properties.canEnableInheritedPermissions.type (Total Keys: 1) - schemas.File.properties.inheritedPermissionsDisabled.type (Total Keys: 1) - schemas.Permission.properties.inheritedPermissionsDisabled.type (Total Keys: 1) --- docs/dyn/drive_v2.changes.html | 42 ++- docs/dyn/drive_v2.files.html | 273 +++++++++++------- docs/dyn/drive_v2.permissions.html | 87 +++--- docs/dyn/drive_v3.changes.html | 10 +- docs/dyn/drive_v3.files.html | 80 +++-- docs/dyn/drive_v3.permissions.html | 52 ++-- .../discovery_cache/documents/drive.v2.json | 46 ++- .../discovery_cache/documents/drive.v3.json | 36 ++- 8 files changed, 410 insertions(+), 216 deletions(-) diff --git a/docs/dyn/drive_v2.changes.html b/docs/dyn/drive_v2.changes.html index f5a5b31a27c..af4cc65efef 100644 --- a/docs/dyn/drive_v2.changes.html +++ b/docs/dyn/drive_v2.changes.html @@ -183,8 +183,10 @@

Method Details

"canCopy": True or False, # Output only. Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. "canDelete": True or False, # Output only. Whether the current user can delete this file. "canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canDisableInheritedPermissions": True or False, # Output only. Whether a user can disable inherited permissions. "canDownload": True or False, # Output only. Whether the current user can download this file. "canEdit": True or False, # Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`. + "canEnableInheritedPermissions": True or False, # Output only. Whether a user can re-enable inherited permissions. "canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder. "canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file. "canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction` or `canRemoveContentRestriction`. @@ -287,6 +289,7 @@

Method Details

"indexableText": { # Indexable text attributes for the file (can only be written) "text": "A String", # The text to be indexed for this file. }, + "inheritedPermissionsDisabled": True or False, # Whether this file has inherited permissions disabled. Inherited permissions are enabled by default. "isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app. "kind": "drive#file", # Output only. The type of file. This is always `drive#file`. "labelInfo": { # Output only. An overview of the labels on the file. @@ -402,16 +405,17 @@

Method Details

"etag": "A String", # Output only. The ETag of the permission. "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. This is always `drive#permission`. "name": "A String", # Output only. The name for this permission. "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. { "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, @@ -432,7 +436,7 @@

Method Details

], "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. "withLink": True or False, # Whether the link is required for this permission. }, ], @@ -502,16 +506,17 @@

Method Details

"etag": "A String", # Output only. The ETag of the permission. "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. This is always `drive#permission`. "name": "A String", # Output only. The name for this permission. "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. { "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, @@ -532,7 +537,7 @@

Method Details

], "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. "withLink": True or False, # Whether the link is required for this permission. }, "version": "A String", # Output only. A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the requesting user. @@ -722,8 +727,10 @@

Method Details

"canCopy": True or False, # Output only. Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. "canDelete": True or False, # Output only. Whether the current user can delete this file. "canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canDisableInheritedPermissions": True or False, # Output only. Whether a user can disable inherited permissions. "canDownload": True or False, # Output only. Whether the current user can download this file. "canEdit": True or False, # Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`. + "canEnableInheritedPermissions": True or False, # Output only. Whether a user can re-enable inherited permissions. "canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder. "canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file. "canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction` or `canRemoveContentRestriction`. @@ -826,6 +833,7 @@

Method Details

"indexableText": { # Indexable text attributes for the file (can only be written) "text": "A String", # The text to be indexed for this file. }, + "inheritedPermissionsDisabled": True or False, # Whether this file has inherited permissions disabled. Inherited permissions are enabled by default. "isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app. "kind": "drive#file", # Output only. The type of file. This is always `drive#file`. "labelInfo": { # Output only. An overview of the labels on the file. @@ -941,16 +949,17 @@

Method Details

"etag": "A String", # Output only. The ETag of the permission. "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. This is always `drive#permission`. "name": "A String", # Output only. The name for this permission. "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. { "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, @@ -971,7 +980,7 @@

Method Details

], "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. "withLink": True or False, # Whether the link is required for this permission. }, ], @@ -1041,16 +1050,17 @@

Method Details

"etag": "A String", # Output only. The ETag of the permission. "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. This is always `drive#permission`. "name": "A String", # Output only. The name for this permission. "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. { "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, @@ -1071,7 +1081,7 @@

Method Details

], "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. "withLink": True or False, # Whether the link is required for this permission. }, "version": "A String", # Output only. A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the requesting user. diff --git a/docs/dyn/drive_v2.files.html b/docs/dyn/drive_v2.files.html index f1fc00915bc..6a0f7f80696 100644 --- a/docs/dyn/drive_v2.files.html +++ b/docs/dyn/drive_v2.files.html @@ -169,8 +169,10 @@

Method Details

"canCopy": True or False, # Output only. Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. "canDelete": True or False, # Output only. Whether the current user can delete this file. "canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canDisableInheritedPermissions": True or False, # Output only. Whether a user can disable inherited permissions. "canDownload": True or False, # Output only. Whether the current user can download this file. "canEdit": True or False, # Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`. + "canEnableInheritedPermissions": True or False, # Output only. Whether a user can re-enable inherited permissions. "canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder. "canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file. "canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction` or `canRemoveContentRestriction`. @@ -273,6 +275,7 @@

Method Details

"indexableText": { # Indexable text attributes for the file (can only be written) "text": "A String", # The text to be indexed for this file. }, + "inheritedPermissionsDisabled": True or False, # Whether this file has inherited permissions disabled. Inherited permissions are enabled by default. "isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app. "kind": "drive#file", # Output only. The type of file. This is always `drive#file`. "labelInfo": { # Output only. An overview of the labels on the file. @@ -388,16 +391,17 @@

Method Details

"etag": "A String", # Output only. The ETag of the permission. "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. This is always `drive#permission`. "name": "A String", # Output only. The name for this permission. "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. { "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, @@ -418,7 +422,7 @@

Method Details

], "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. "withLink": True or False, # Whether the link is required for this permission. }, ], @@ -488,16 +492,17 @@

Method Details

"etag": "A String", # Output only. The ETag of the permission. "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. This is always `drive#permission`. "name": "A String", # Output only. The name for this permission. "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. { "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, @@ -518,7 +523,7 @@

Method Details

], "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. "withLink": True or False, # Whether the link is required for this permission. }, "version": "A String", # Output only. A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the requesting user. @@ -572,8 +577,10 @@

Method Details

"canCopy": True or False, # Output only. Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. "canDelete": True or False, # Output only. Whether the current user can delete this file. "canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canDisableInheritedPermissions": True or False, # Output only. Whether a user can disable inherited permissions. "canDownload": True or False, # Output only. Whether the current user can download this file. "canEdit": True or False, # Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`. + "canEnableInheritedPermissions": True or False, # Output only. Whether a user can re-enable inherited permissions. "canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder. "canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file. "canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction` or `canRemoveContentRestriction`. @@ -676,6 +683,7 @@

Method Details

"indexableText": { # Indexable text attributes for the file (can only be written) "text": "A String", # The text to be indexed for this file. }, + "inheritedPermissionsDisabled": True or False, # Whether this file has inherited permissions disabled. Inherited permissions are enabled by default. "isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app. "kind": "drive#file", # Output only. The type of file. This is always `drive#file`. "labelInfo": { # Output only. An overview of the labels on the file. @@ -791,16 +799,17 @@

Method Details

"etag": "A String", # Output only. The ETag of the permission. "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. This is always `drive#permission`. "name": "A String", # Output only. The name for this permission. "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. { "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, @@ -821,7 +830,7 @@

Method Details

], "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. "withLink": True or False, # Whether the link is required for this permission. }, ], @@ -891,16 +900,17 @@

Method Details

"etag": "A String", # Output only. The ETag of the permission. "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. This is always `drive#permission`. "name": "A String", # Output only. The name for this permission. "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. { "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, @@ -921,7 +931,7 @@

Method Details

], "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. "withLink": True or False, # Whether the link is required for this permission. }, "version": "A String", # Output only. A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the requesting user. @@ -1061,8 +1071,10 @@

Method Details

"canCopy": True or False, # Output only. Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. "canDelete": True or False, # Output only. Whether the current user can delete this file. "canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canDisableInheritedPermissions": True or False, # Output only. Whether a user can disable inherited permissions. "canDownload": True or False, # Output only. Whether the current user can download this file. "canEdit": True or False, # Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`. + "canEnableInheritedPermissions": True or False, # Output only. Whether a user can re-enable inherited permissions. "canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder. "canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file. "canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction` or `canRemoveContentRestriction`. @@ -1165,6 +1177,7 @@

Method Details

"indexableText": { # Indexable text attributes for the file (can only be written) "text": "A String", # The text to be indexed for this file. }, + "inheritedPermissionsDisabled": True or False, # Whether this file has inherited permissions disabled. Inherited permissions are enabled by default. "isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app. "kind": "drive#file", # Output only. The type of file. This is always `drive#file`. "labelInfo": { # Output only. An overview of the labels on the file. @@ -1280,16 +1293,17 @@

Method Details

"etag": "A String", # Output only. The ETag of the permission. "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. This is always `drive#permission`. "name": "A String", # Output only. The name for this permission. "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. { "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, @@ -1310,7 +1324,7 @@

Method Details

], "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. "withLink": True or False, # Whether the link is required for this permission. }, ], @@ -1380,16 +1394,17 @@

Method Details

"etag": "A String", # Output only. The ETag of the permission. "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. This is always `drive#permission`. "name": "A String", # Output only. The name for this permission. "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. { "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, @@ -1410,7 +1425,7 @@

Method Details

], "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. "withLink": True or False, # Whether the link is required for this permission. }, "version": "A String", # Output only. A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the requesting user. @@ -1478,8 +1493,10 @@

Method Details

"canCopy": True or False, # Output only. Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. "canDelete": True or False, # Output only. Whether the current user can delete this file. "canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canDisableInheritedPermissions": True or False, # Output only. Whether a user can disable inherited permissions. "canDownload": True or False, # Output only. Whether the current user can download this file. "canEdit": True or False, # Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`. + "canEnableInheritedPermissions": True or False, # Output only. Whether a user can re-enable inherited permissions. "canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder. "canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file. "canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction` or `canRemoveContentRestriction`. @@ -1582,6 +1599,7 @@

Method Details

"indexableText": { # Indexable text attributes for the file (can only be written) "text": "A String", # The text to be indexed for this file. }, + "inheritedPermissionsDisabled": True or False, # Whether this file has inherited permissions disabled. Inherited permissions are enabled by default. "isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app. "kind": "drive#file", # Output only. The type of file. This is always `drive#file`. "labelInfo": { # Output only. An overview of the labels on the file. @@ -1697,16 +1715,17 @@

Method Details

"etag": "A String", # Output only. The ETag of the permission. "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. This is always `drive#permission`. "name": "A String", # Output only. The name for this permission. "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. { "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, @@ -1727,7 +1746,7 @@

Method Details

], "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. "withLink": True or False, # Whether the link is required for this permission. }, ], @@ -1797,16 +1816,17 @@

Method Details

"etag": "A String", # Output only. The ETag of the permission. "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. This is always `drive#permission`. "name": "A String", # Output only. The name for this permission. "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. { "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, @@ -1827,7 +1847,7 @@

Method Details

], "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. "withLink": True or False, # Whether the link is required for this permission. }, "version": "A String", # Output only. A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the requesting user. @@ -1884,8 +1904,10 @@

Method Details

"canCopy": True or False, # Output only. Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. "canDelete": True or False, # Output only. Whether the current user can delete this file. "canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canDisableInheritedPermissions": True or False, # Output only. Whether a user can disable inherited permissions. "canDownload": True or False, # Output only. Whether the current user can download this file. "canEdit": True or False, # Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`. + "canEnableInheritedPermissions": True or False, # Output only. Whether a user can re-enable inherited permissions. "canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder. "canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file. "canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction` or `canRemoveContentRestriction`. @@ -1988,6 +2010,7 @@

Method Details

"indexableText": { # Indexable text attributes for the file (can only be written) "text": "A String", # The text to be indexed for this file. }, + "inheritedPermissionsDisabled": True or False, # Whether this file has inherited permissions disabled. Inherited permissions are enabled by default. "isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app. "kind": "drive#file", # Output only. The type of file. This is always `drive#file`. "labelInfo": { # Output only. An overview of the labels on the file. @@ -2103,16 +2126,17 @@

Method Details

"etag": "A String", # Output only. The ETag of the permission. "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. This is always `drive#permission`. "name": "A String", # Output only. The name for this permission. "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. { "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, @@ -2133,7 +2157,7 @@

Method Details

], "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. "withLink": True or False, # Whether the link is required for this permission. }, ], @@ -2203,16 +2227,17 @@

Method Details

"etag": "A String", # Output only. The ETag of the permission. "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. This is always `drive#permission`. "name": "A String", # Output only. The name for this permission. "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. { "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, @@ -2233,7 +2258,7 @@

Method Details

], "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. "withLink": True or False, # Whether the link is required for this permission. }, "version": "A String", # Output only. A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the requesting user. @@ -2304,8 +2329,10 @@

Method Details

"canCopy": True or False, # Output only. Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. "canDelete": True or False, # Output only. Whether the current user can delete this file. "canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canDisableInheritedPermissions": True or False, # Output only. Whether a user can disable inherited permissions. "canDownload": True or False, # Output only. Whether the current user can download this file. "canEdit": True or False, # Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`. + "canEnableInheritedPermissions": True or False, # Output only. Whether a user can re-enable inherited permissions. "canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder. "canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file. "canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction` or `canRemoveContentRestriction`. @@ -2408,6 +2435,7 @@

Method Details

"indexableText": { # Indexable text attributes for the file (can only be written) "text": "A String", # The text to be indexed for this file. }, + "inheritedPermissionsDisabled": True or False, # Whether this file has inherited permissions disabled. Inherited permissions are enabled by default. "isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app. "kind": "drive#file", # Output only. The type of file. This is always `drive#file`. "labelInfo": { # Output only. An overview of the labels on the file. @@ -2523,16 +2551,17 @@

Method Details

"etag": "A String", # Output only. The ETag of the permission. "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. This is always `drive#permission`. "name": "A String", # Output only. The name for this permission. "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. { "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, @@ -2553,7 +2582,7 @@

Method Details

], "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. "withLink": True or False, # Whether the link is required for this permission. }, ], @@ -2623,16 +2652,17 @@

Method Details

"etag": "A String", # Output only. The ETag of the permission. "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. This is always `drive#permission`. "name": "A String", # Output only. The name for this permission. "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. { "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, @@ -2653,7 +2683,7 @@

Method Details

], "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. "withLink": True or False, # Whether the link is required for this permission. }, "version": "A String", # Output only. A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the requesting user. @@ -2881,8 +2911,10 @@

Method Details

"canCopy": True or False, # Output only. Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. "canDelete": True or False, # Output only. Whether the current user can delete this file. "canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canDisableInheritedPermissions": True or False, # Output only. Whether a user can disable inherited permissions. "canDownload": True or False, # Output only. Whether the current user can download this file. "canEdit": True or False, # Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`. + "canEnableInheritedPermissions": True or False, # Output only. Whether a user can re-enable inherited permissions. "canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder. "canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file. "canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction` or `canRemoveContentRestriction`. @@ -2985,6 +3017,7 @@

Method Details

"indexableText": { # Indexable text attributes for the file (can only be written) "text": "A String", # The text to be indexed for this file. }, + "inheritedPermissionsDisabled": True or False, # Whether this file has inherited permissions disabled. Inherited permissions are enabled by default. "isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app. "kind": "drive#file", # Output only. The type of file. This is always `drive#file`. "labelInfo": { # Output only. An overview of the labels on the file. @@ -3100,16 +3133,17 @@

Method Details

"etag": "A String", # Output only. The ETag of the permission. "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. This is always `drive#permission`. "name": "A String", # Output only. The name for this permission. "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. { "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, @@ -3130,7 +3164,7 @@

Method Details

], "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. "withLink": True or False, # Whether the link is required for this permission. }, ], @@ -3200,16 +3234,17 @@

Method Details

"etag": "A String", # Output only. The ETag of the permission. "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. This is always `drive#permission`. "name": "A String", # Output only. The name for this permission. "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. { "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, @@ -3230,7 +3265,7 @@

Method Details

], "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. "withLink": True or False, # Whether the link is required for this permission. }, "version": "A String", # Output only. A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the requesting user. @@ -3294,8 +3329,10 @@

Method Details

"canCopy": True or False, # Output only. Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. "canDelete": True or False, # Output only. Whether the current user can delete this file. "canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canDisableInheritedPermissions": True or False, # Output only. Whether a user can disable inherited permissions. "canDownload": True or False, # Output only. Whether the current user can download this file. "canEdit": True or False, # Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`. + "canEnableInheritedPermissions": True or False, # Output only. Whether a user can re-enable inherited permissions. "canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder. "canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file. "canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction` or `canRemoveContentRestriction`. @@ -3398,6 +3435,7 @@

Method Details

"indexableText": { # Indexable text attributes for the file (can only be written) "text": "A String", # The text to be indexed for this file. }, + "inheritedPermissionsDisabled": True or False, # Whether this file has inherited permissions disabled. Inherited permissions are enabled by default. "isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app. "kind": "drive#file", # Output only. The type of file. This is always `drive#file`. "labelInfo": { # Output only. An overview of the labels on the file. @@ -3513,16 +3551,17 @@

Method Details

"etag": "A String", # Output only. The ETag of the permission. "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. This is always `drive#permission`. "name": "A String", # Output only. The name for this permission. "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. { "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, @@ -3543,7 +3582,7 @@

Method Details

], "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. "withLink": True or False, # Whether the link is required for this permission. }, ], @@ -3613,16 +3652,17 @@

Method Details

"etag": "A String", # Output only. The ETag of the permission. "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. This is always `drive#permission`. "name": "A String", # Output only. The name for this permission. "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. { "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, @@ -3643,7 +3683,7 @@

Method Details

], "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. "withLink": True or False, # Whether the link is required for this permission. }, "version": "A String", # Output only. A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the requesting user. @@ -3693,8 +3733,10 @@

Method Details

"canCopy": True or False, # Output only. Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. "canDelete": True or False, # Output only. Whether the current user can delete this file. "canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canDisableInheritedPermissions": True or False, # Output only. Whether a user can disable inherited permissions. "canDownload": True or False, # Output only. Whether the current user can download this file. "canEdit": True or False, # Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`. + "canEnableInheritedPermissions": True or False, # Output only. Whether a user can re-enable inherited permissions. "canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder. "canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file. "canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction` or `canRemoveContentRestriction`. @@ -3797,6 +3839,7 @@

Method Details

"indexableText": { # Indexable text attributes for the file (can only be written) "text": "A String", # The text to be indexed for this file. }, + "inheritedPermissionsDisabled": True or False, # Whether this file has inherited permissions disabled. Inherited permissions are enabled by default. "isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app. "kind": "drive#file", # Output only. The type of file. This is always `drive#file`. "labelInfo": { # Output only. An overview of the labels on the file. @@ -3912,16 +3955,17 @@

Method Details

"etag": "A String", # Output only. The ETag of the permission. "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. This is always `drive#permission`. "name": "A String", # Output only. The name for this permission. "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. { "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, @@ -3942,7 +3986,7 @@

Method Details

], "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. "withLink": True or False, # Whether the link is required for this permission. }, ], @@ -4012,16 +4056,17 @@

Method Details

"etag": "A String", # Output only. The ETag of the permission. "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. This is always `drive#permission`. "name": "A String", # Output only. The name for this permission. "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. { "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, @@ -4042,7 +4087,7 @@

Method Details

], "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. "withLink": True or False, # Whether the link is required for this permission. }, "version": "A String", # Output only. A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the requesting user. @@ -4092,8 +4137,10 @@

Method Details

"canCopy": True or False, # Output only. Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. "canDelete": True or False, # Output only. Whether the current user can delete this file. "canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canDisableInheritedPermissions": True or False, # Output only. Whether a user can disable inherited permissions. "canDownload": True or False, # Output only. Whether the current user can download this file. "canEdit": True or False, # Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`. + "canEnableInheritedPermissions": True or False, # Output only. Whether a user can re-enable inherited permissions. "canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder. "canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file. "canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction` or `canRemoveContentRestriction`. @@ -4196,6 +4243,7 @@

Method Details

"indexableText": { # Indexable text attributes for the file (can only be written) "text": "A String", # The text to be indexed for this file. }, + "inheritedPermissionsDisabled": True or False, # Whether this file has inherited permissions disabled. Inherited permissions are enabled by default. "isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app. "kind": "drive#file", # Output only. The type of file. This is always `drive#file`. "labelInfo": { # Output only. An overview of the labels on the file. @@ -4311,16 +4359,17 @@

Method Details

"etag": "A String", # Output only. The ETag of the permission. "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. This is always `drive#permission`. "name": "A String", # Output only. The name for this permission. "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. { "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, @@ -4341,7 +4390,7 @@

Method Details

], "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. "withLink": True or False, # Whether the link is required for this permission. }, ], @@ -4411,16 +4460,17 @@

Method Details

"etag": "A String", # Output only. The ETag of the permission. "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. This is always `drive#permission`. "name": "A String", # Output only. The name for this permission. "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. { "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, @@ -4441,7 +4491,7 @@

Method Details

], "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. "withLink": True or False, # Whether the link is required for this permission. }, "version": "A String", # Output only. A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the requesting user. @@ -4491,8 +4541,10 @@

Method Details

"canCopy": True or False, # Output only. Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. "canDelete": True or False, # Output only. Whether the current user can delete this file. "canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canDisableInheritedPermissions": True or False, # Output only. Whether a user can disable inherited permissions. "canDownload": True or False, # Output only. Whether the current user can download this file. "canEdit": True or False, # Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`. + "canEnableInheritedPermissions": True or False, # Output only. Whether a user can re-enable inherited permissions. "canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder. "canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file. "canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction` or `canRemoveContentRestriction`. @@ -4595,6 +4647,7 @@

Method Details

"indexableText": { # Indexable text attributes for the file (can only be written) "text": "A String", # The text to be indexed for this file. }, + "inheritedPermissionsDisabled": True or False, # Whether this file has inherited permissions disabled. Inherited permissions are enabled by default. "isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app. "kind": "drive#file", # Output only. The type of file. This is always `drive#file`. "labelInfo": { # Output only. An overview of the labels on the file. @@ -4710,16 +4763,17 @@

Method Details

"etag": "A String", # Output only. The ETag of the permission. "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. This is always `drive#permission`. "name": "A String", # Output only. The name for this permission. "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. { "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, @@ -4740,7 +4794,7 @@

Method Details

], "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. "withLink": True or False, # Whether the link is required for this permission. }, ], @@ -4810,16 +4864,17 @@

Method Details

"etag": "A String", # Output only. The ETag of the permission. "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. This is always `drive#permission`. "name": "A String", # Output only. The name for this permission. "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. { "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, @@ -4840,7 +4895,7 @@

Method Details

], "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. "withLink": True or False, # Whether the link is required for this permission. }, "version": "A String", # Output only. A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the requesting user. @@ -4881,8 +4936,10 @@

Method Details

"canCopy": True or False, # Output only. Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. "canDelete": True or False, # Output only. Whether the current user can delete this file. "canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canDisableInheritedPermissions": True or False, # Output only. Whether a user can disable inherited permissions. "canDownload": True or False, # Output only. Whether the current user can download this file. "canEdit": True or False, # Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`. + "canEnableInheritedPermissions": True or False, # Output only. Whether a user can re-enable inherited permissions. "canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder. "canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file. "canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction` or `canRemoveContentRestriction`. @@ -4985,6 +5042,7 @@

Method Details

"indexableText": { # Indexable text attributes for the file (can only be written) "text": "A String", # The text to be indexed for this file. }, + "inheritedPermissionsDisabled": True or False, # Whether this file has inherited permissions disabled. Inherited permissions are enabled by default. "isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app. "kind": "drive#file", # Output only. The type of file. This is always `drive#file`. "labelInfo": { # Output only. An overview of the labels on the file. @@ -5100,16 +5158,17 @@

Method Details

"etag": "A String", # Output only. The ETag of the permission. "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. This is always `drive#permission`. "name": "A String", # Output only. The name for this permission. "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. { "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, @@ -5130,7 +5189,7 @@

Method Details

], "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. "withLink": True or False, # Whether the link is required for this permission. }, ], @@ -5200,16 +5259,17 @@

Method Details

"etag": "A String", # Output only. The ETag of the permission. "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. This is always `drive#permission`. "name": "A String", # Output only. The name for this permission. "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. { "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, @@ -5230,7 +5290,7 @@

Method Details

], "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. "withLink": True or False, # Whether the link is required for this permission. }, "version": "A String", # Output only. A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the requesting user. @@ -5296,8 +5356,10 @@

Method Details

"canCopy": True or False, # Output only. Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. "canDelete": True or False, # Output only. Whether the current user can delete this file. "canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canDisableInheritedPermissions": True or False, # Output only. Whether a user can disable inherited permissions. "canDownload": True or False, # Output only. Whether the current user can download this file. "canEdit": True or False, # Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`. + "canEnableInheritedPermissions": True or False, # Output only. Whether a user can re-enable inherited permissions. "canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder. "canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file. "canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction` or `canRemoveContentRestriction`. @@ -5400,6 +5462,7 @@

Method Details

"indexableText": { # Indexable text attributes for the file (can only be written) "text": "A String", # The text to be indexed for this file. }, + "inheritedPermissionsDisabled": True or False, # Whether this file has inherited permissions disabled. Inherited permissions are enabled by default. "isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app. "kind": "drive#file", # Output only. The type of file. This is always `drive#file`. "labelInfo": { # Output only. An overview of the labels on the file. @@ -5515,16 +5578,17 @@

Method Details

"etag": "A String", # Output only. The ETag of the permission. "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. This is always `drive#permission`. "name": "A String", # Output only. The name for this permission. "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. { "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, @@ -5545,7 +5609,7 @@

Method Details

], "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. "withLink": True or False, # Whether the link is required for this permission. }, ], @@ -5615,16 +5679,17 @@

Method Details

"etag": "A String", # Output only. The ETag of the permission. "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. This is always `drive#permission`. "name": "A String", # Output only. The name for this permission. "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. { "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, @@ -5645,7 +5710,7 @@

Method Details

], "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. "withLink": True or False, # Whether the link is required for this permission. }, "version": "A String", # Output only. A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the requesting user. diff --git a/docs/dyn/drive_v2.permissions.html b/docs/dyn/drive_v2.permissions.html index a7a9acd90e1..e4094946e00 100644 --- a/docs/dyn/drive_v2.permissions.html +++ b/docs/dyn/drive_v2.permissions.html @@ -78,7 +78,7 @@

Instance Methods

close()

Close httplib2 connections.

- delete(fileId, permissionId, supportsAllDrives=None, supportsTeamDrives=None, useDomainAdminAccess=None, x__xgafv=None)

+ delete(fileId, permissionId, enforceExpansiveAccess=None, supportsAllDrives=None, supportsTeamDrives=None, useDomainAdminAccess=None, x__xgafv=None)

Deletes a permission from a file or shared drive. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied.

get(fileId, permissionId, supportsAllDrives=None, supportsTeamDrives=None, useDomainAdminAccess=None, x__xgafv=None)

@@ -96,10 +96,10 @@

Instance Methods

list_next()

Retrieves the next page of results.

- patch(fileId, permissionId, body=None, removeExpiration=None, supportsAllDrives=None, supportsTeamDrives=None, transferOwnership=None, useDomainAdminAccess=None, x__xgafv=None)

+ patch(fileId, permissionId, body=None, enforceExpansiveAccess=None, removeExpiration=None, supportsAllDrives=None, supportsTeamDrives=None, transferOwnership=None, useDomainAdminAccess=None, x__xgafv=None)

Updates a permission using patch semantics. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied.

- update(fileId, permissionId, body=None, removeExpiration=None, supportsAllDrives=None, supportsTeamDrives=None, transferOwnership=None, useDomainAdminAccess=None, x__xgafv=None)

+ update(fileId, permissionId, body=None, enforceExpansiveAccess=None, removeExpiration=None, supportsAllDrives=None, supportsTeamDrives=None, transferOwnership=None, useDomainAdminAccess=None, x__xgafv=None)

Updates a permission. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied.

Method Details

@@ -108,12 +108,13 @@

Method Details

- delete(fileId, permissionId, supportsAllDrives=None, supportsTeamDrives=None, useDomainAdminAccess=None, x__xgafv=None) + delete(fileId, permissionId, enforceExpansiveAccess=None, supportsAllDrives=None, supportsTeamDrives=None, useDomainAdminAccess=None, x__xgafv=None)
Deletes a permission from a file or shared drive. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied.
 
 Args:
   fileId: string, The ID for the file or shared drive. (required)
   permissionId: string, The ID for the permission. (required)
+  enforceExpansiveAccess: boolean, Whether the request should enforce expansive access rules.
   supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
   supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead.
   useDomainAdminAccess: boolean, Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.
@@ -153,16 +154,17 @@ 

Method Details

"etag": "A String", # Output only. The ETag of the permission. "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. This is always `drive#permission`. "name": "A String", # Output only. The name for this permission. "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. { "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, @@ -183,7 +185,7 @@

Method Details

], "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. "withLink": True or False, # Whether the link is required for this permission. }
@@ -228,16 +230,17 @@

Method Details

"etag": "A String", # Output only. The ETag of the permission. "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. This is always `drive#permission`. "name": "A String", # Output only. The name for this permission. "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. { "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, @@ -258,7 +261,7 @@

Method Details

], "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. "withLink": True or False, # Whether the link is required for this permission. } @@ -288,16 +291,17 @@

Method Details

"etag": "A String", # Output only. The ETag of the permission. "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. This is always `drive#permission`. "name": "A String", # Output only. The name for this permission. "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. { "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, @@ -318,7 +322,7 @@

Method Details

], "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. "withLink": True or False, # Whether the link is required for this permission. }
@@ -357,16 +361,17 @@

Method Details

"etag": "A String", # Output only. The ETag of the permission. "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. This is always `drive#permission`. "name": "A String", # Output only. The name for this permission. "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. { "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, @@ -387,7 +392,7 @@

Method Details

], "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. "withLink": True or False, # Whether the link is required for this permission. }, ], @@ -412,7 +417,7 @@

Method Details

- patch(fileId, permissionId, body=None, removeExpiration=None, supportsAllDrives=None, supportsTeamDrives=None, transferOwnership=None, useDomainAdminAccess=None, x__xgafv=None) + patch(fileId, permissionId, body=None, enforceExpansiveAccess=None, removeExpiration=None, supportsAllDrives=None, supportsTeamDrives=None, transferOwnership=None, useDomainAdminAccess=None, x__xgafv=None)
Updates a permission using patch semantics. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied.
 
 Args:
@@ -432,16 +437,17 @@ 

Method Details

"etag": "A String", # Output only. The ETag of the permission. "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. This is always `drive#permission`. "name": "A String", # Output only. The name for this permission. "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. { "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, @@ -462,10 +468,11 @@

Method Details

], "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. "withLink": True or False, # Whether the link is required for this permission. } + enforceExpansiveAccess: boolean, Whether the request should enforce expansive access rules. removeExpiration: boolean, Whether to remove the expiration date. supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives. supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead. @@ -490,16 +497,17 @@

Method Details

"etag": "A String", # Output only. The ETag of the permission. "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. This is always `drive#permission`. "name": "A String", # Output only. The name for this permission. "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. { "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, @@ -520,13 +528,13 @@

Method Details

], "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. "withLink": True or False, # Whether the link is required for this permission. }
- update(fileId, permissionId, body=None, removeExpiration=None, supportsAllDrives=None, supportsTeamDrives=None, transferOwnership=None, useDomainAdminAccess=None, x__xgafv=None) + update(fileId, permissionId, body=None, enforceExpansiveAccess=None, removeExpiration=None, supportsAllDrives=None, supportsTeamDrives=None, transferOwnership=None, useDomainAdminAccess=None, x__xgafv=None)
Updates a permission. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied.
 
 Args:
@@ -546,16 +554,17 @@ 

Method Details

"etag": "A String", # Output only. The ETag of the permission. "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. This is always `drive#permission`. "name": "A String", # Output only. The name for this permission. "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. { "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, @@ -576,10 +585,11 @@

Method Details

], "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. "withLink": True or False, # Whether the link is required for this permission. } + enforceExpansiveAccess: boolean, Whether the request should enforce expansive access rules. removeExpiration: boolean, Whether to remove the expiration date. supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives. supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead. @@ -604,16 +614,17 @@

Method Details

"etag": "A String", # Output only. The ETag of the permission. "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. This is always `drive#permission`. "name": "A String", # Output only. The name for this permission. "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. { "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, @@ -634,7 +645,7 @@

Method Details

], "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. "withLink": True or False, # Whether the link is required for this permission. }
diff --git a/docs/dyn/drive_v3.changes.html b/docs/dyn/drive_v3.changes.html index c9ceaf3af31..8253e4fe02c 100644 --- a/docs/dyn/drive_v3.changes.html +++ b/docs/dyn/drive_v3.changes.html @@ -213,8 +213,10 @@

Method Details

"canCopy": True or False, # Output only. Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. "canDelete": True or False, # Output only. Whether the current user can delete this file. "canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canDisableInheritedPermissions": True or False, # Whether a user can disable inherited permissions. "canDownload": True or False, # Output only. Whether the current user can download this file. "canEdit": True or False, # Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`. + "canEnableInheritedPermissions": True or False, # Whether a user can re-enable inherited permissions. "canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder. "canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file. "canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction` or `canRemoveContentRestriction`. @@ -312,6 +314,7 @@

Method Details

"whiteBalance": "A String", # Output only. The white balance mode used to create the photo. "width": 42, # Output only. The width of the image in pixels. }, + "inheritedPermissionsDisabled": True or False, # Whether this file has inherited permissions disabled. Inherited permissions are enabled by default. "isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app. "kind": "drive#file", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#file"`. "labelInfo": { # Output only. An overview of the labels on the file. @@ -397,12 +400,13 @@

Method Details

"emailAddress": "A String", # The email address of the user or group to which this permission refers. "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They can only be set on user and group permissions - The time must be in the future - The time cannot be more than a year in the future "id": "A String", # Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as `permissionId`. IDs should be treated as opaque values. + "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#permission"`. "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. { "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` }, @@ -418,7 +422,7 @@

Method Details

}, ], "type": "A String", # The type of the grantee. Valid values are: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. When `type` is `domain`, you must provide a `domain`. There isn't extra information required for an `anyone` type. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. 'published' is the only supported value. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. }, ], "properties": { # A collection of arbitrary key-value pairs which are visible to all apps. diff --git a/docs/dyn/drive_v3.files.html b/docs/dyn/drive_v3.files.html index d9b078f0dd8..75360f82ecd 100644 --- a/docs/dyn/drive_v3.files.html +++ b/docs/dyn/drive_v3.files.html @@ -160,8 +160,10 @@

Method Details

"canCopy": True or False, # Output only. Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. "canDelete": True or False, # Output only. Whether the current user can delete this file. "canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canDisableInheritedPermissions": True or False, # Whether a user can disable inherited permissions. "canDownload": True or False, # Output only. Whether the current user can download this file. "canEdit": True or False, # Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`. + "canEnableInheritedPermissions": True or False, # Whether a user can re-enable inherited permissions. "canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder. "canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file. "canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction` or `canRemoveContentRestriction`. @@ -259,6 +261,7 @@

Method Details

"whiteBalance": "A String", # Output only. The white balance mode used to create the photo. "width": 42, # Output only. The width of the image in pixels. }, + "inheritedPermissionsDisabled": True or False, # Whether this file has inherited permissions disabled. Inherited permissions are enabled by default. "isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app. "kind": "drive#file", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#file"`. "labelInfo": { # Output only. An overview of the labels on the file. @@ -344,12 +347,13 @@

Method Details

"emailAddress": "A String", # The email address of the user or group to which this permission refers. "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They can only be set on user and group permissions - The time must be in the future - The time cannot be more than a year in the future "id": "A String", # Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as `permissionId`. IDs should be treated as opaque values. + "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#permission"`. "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. { "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` }, @@ -365,7 +369,7 @@

Method Details

}, ], "type": "A String", # The type of the grantee. Valid values are: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. When `type` is `domain`, you must provide a `domain`. There isn't extra information required for an `anyone` type. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. 'published' is the only supported value. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. }, ], "properties": { # A collection of arbitrary key-value pairs which are visible to all apps. @@ -456,8 +460,10 @@

Method Details

"canCopy": True or False, # Output only. Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. "canDelete": True or False, # Output only. Whether the current user can delete this file. "canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canDisableInheritedPermissions": True or False, # Whether a user can disable inherited permissions. "canDownload": True or False, # Output only. Whether the current user can download this file. "canEdit": True or False, # Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`. + "canEnableInheritedPermissions": True or False, # Whether a user can re-enable inherited permissions. "canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder. "canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file. "canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction` or `canRemoveContentRestriction`. @@ -555,6 +561,7 @@

Method Details

"whiteBalance": "A String", # Output only. The white balance mode used to create the photo. "width": 42, # Output only. The width of the image in pixels. }, + "inheritedPermissionsDisabled": True or False, # Whether this file has inherited permissions disabled. Inherited permissions are enabled by default. "isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app. "kind": "drive#file", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#file"`. "labelInfo": { # Output only. An overview of the labels on the file. @@ -640,12 +647,13 @@

Method Details

"emailAddress": "A String", # The email address of the user or group to which this permission refers. "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They can only be set on user and group permissions - The time must be in the future - The time cannot be more than a year in the future "id": "A String", # Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as `permissionId`. IDs should be treated as opaque values. + "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#permission"`. "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. { "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` }, @@ -661,7 +669,7 @@

Method Details

}, ], "type": "A String", # The type of the grantee. Valid values are: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. When `type` is `domain`, you must provide a `domain`. There isn't extra information required for an `anyone` type. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. 'published' is the only supported value. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. }, ], "properties": { # A collection of arbitrary key-value pairs which are visible to all apps. @@ -745,8 +753,10 @@

Method Details

"canCopy": True or False, # Output only. Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. "canDelete": True or False, # Output only. Whether the current user can delete this file. "canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canDisableInheritedPermissions": True or False, # Whether a user can disable inherited permissions. "canDownload": True or False, # Output only. Whether the current user can download this file. "canEdit": True or False, # Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`. + "canEnableInheritedPermissions": True or False, # Whether a user can re-enable inherited permissions. "canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder. "canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file. "canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction` or `canRemoveContentRestriction`. @@ -844,6 +854,7 @@

Method Details

"whiteBalance": "A String", # Output only. The white balance mode used to create the photo. "width": 42, # Output only. The width of the image in pixels. }, + "inheritedPermissionsDisabled": True or False, # Whether this file has inherited permissions disabled. Inherited permissions are enabled by default. "isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app. "kind": "drive#file", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#file"`. "labelInfo": { # Output only. An overview of the labels on the file. @@ -929,12 +940,13 @@

Method Details

"emailAddress": "A String", # The email address of the user or group to which this permission refers. "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They can only be set on user and group permissions - The time must be in the future - The time cannot be more than a year in the future "id": "A String", # Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as `permissionId`. IDs should be treated as opaque values. + "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#permission"`. "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. { "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` }, @@ -950,7 +962,7 @@

Method Details

}, ], "type": "A String", # The type of the grantee. Valid values are: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. When `type` is `domain`, you must provide a `domain`. There isn't extra information required for an `anyone` type. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. 'published' is the only supported value. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. }, ], "properties": { # A collection of arbitrary key-value pairs which are visible to all apps. @@ -1044,8 +1056,10 @@

Method Details

"canCopy": True or False, # Output only. Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. "canDelete": True or False, # Output only. Whether the current user can delete this file. "canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canDisableInheritedPermissions": True or False, # Whether a user can disable inherited permissions. "canDownload": True or False, # Output only. Whether the current user can download this file. "canEdit": True or False, # Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`. + "canEnableInheritedPermissions": True or False, # Whether a user can re-enable inherited permissions. "canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder. "canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file. "canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction` or `canRemoveContentRestriction`. @@ -1143,6 +1157,7 @@

Method Details

"whiteBalance": "A String", # Output only. The white balance mode used to create the photo. "width": 42, # Output only. The width of the image in pixels. }, + "inheritedPermissionsDisabled": True or False, # Whether this file has inherited permissions disabled. Inherited permissions are enabled by default. "isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app. "kind": "drive#file", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#file"`. "labelInfo": { # Output only. An overview of the labels on the file. @@ -1228,12 +1243,13 @@

Method Details

"emailAddress": "A String", # The email address of the user or group to which this permission refers. "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They can only be set on user and group permissions - The time must be in the future - The time cannot be more than a year in the future "id": "A String", # Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as `permissionId`. IDs should be treated as opaque values. + "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#permission"`. "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. { "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` }, @@ -1249,7 +1265,7 @@

Method Details

}, ], "type": "A String", # The type of the grantee. Valid values are: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. When `type` is `domain`, you must provide a `domain`. There isn't extra information required for an `anyone` type. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. 'published' is the only supported value. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. }, ], "properties": { # A collection of arbitrary key-value pairs which are visible to all apps. @@ -1464,8 +1480,10 @@

Method Details

"canCopy": True or False, # Output only. Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. "canDelete": True or False, # Output only. Whether the current user can delete this file. "canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canDisableInheritedPermissions": True or False, # Whether a user can disable inherited permissions. "canDownload": True or False, # Output only. Whether the current user can download this file. "canEdit": True or False, # Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`. + "canEnableInheritedPermissions": True or False, # Whether a user can re-enable inherited permissions. "canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder. "canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file. "canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction` or `canRemoveContentRestriction`. @@ -1563,6 +1581,7 @@

Method Details

"whiteBalance": "A String", # Output only. The white balance mode used to create the photo. "width": 42, # Output only. The width of the image in pixels. }, + "inheritedPermissionsDisabled": True or False, # Whether this file has inherited permissions disabled. Inherited permissions are enabled by default. "isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app. "kind": "drive#file", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#file"`. "labelInfo": { # Output only. An overview of the labels on the file. @@ -1648,12 +1667,13 @@

Method Details

"emailAddress": "A String", # The email address of the user or group to which this permission refers. "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They can only be set on user and group permissions - The time must be in the future - The time cannot be more than a year in the future "id": "A String", # Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as `permissionId`. IDs should be treated as opaque values. + "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#permission"`. "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. { "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` }, @@ -1669,7 +1689,7 @@

Method Details

}, ], "type": "A String", # The type of the grantee. Valid values are: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. When `type` is `domain`, you must provide a `domain`. There isn't extra information required for an `anyone` type. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. 'published' is the only supported value. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. }, ], "properties": { # A collection of arbitrary key-value pairs which are visible to all apps. @@ -1800,8 +1820,10 @@

Method Details

"canCopy": True or False, # Output only. Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. "canDelete": True or False, # Output only. Whether the current user can delete this file. "canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canDisableInheritedPermissions": True or False, # Whether a user can disable inherited permissions. "canDownload": True or False, # Output only. Whether the current user can download this file. "canEdit": True or False, # Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`. + "canEnableInheritedPermissions": True or False, # Whether a user can re-enable inherited permissions. "canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder. "canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file. "canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction` or `canRemoveContentRestriction`. @@ -1899,6 +1921,7 @@

Method Details

"whiteBalance": "A String", # Output only. The white balance mode used to create the photo. "width": 42, # Output only. The width of the image in pixels. }, + "inheritedPermissionsDisabled": True or False, # Whether this file has inherited permissions disabled. Inherited permissions are enabled by default. "isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app. "kind": "drive#file", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#file"`. "labelInfo": { # Output only. An overview of the labels on the file. @@ -1984,12 +2007,13 @@

Method Details

"emailAddress": "A String", # The email address of the user or group to which this permission refers. "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They can only be set on user and group permissions - The time must be in the future - The time cannot be more than a year in the future "id": "A String", # Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as `permissionId`. IDs should be treated as opaque values. + "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#permission"`. "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. { "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` }, @@ -2005,7 +2029,7 @@

Method Details

}, ], "type": "A String", # The type of the grantee. Valid values are: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. When `type` is `domain`, you must provide a `domain`. There isn't extra information required for an `anyone` type. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. 'published' is the only supported value. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. }, ], "properties": { # A collection of arbitrary key-value pairs which are visible to all apps. @@ -2272,8 +2296,10 @@

Method Details

"canCopy": True or False, # Output only. Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. "canDelete": True or False, # Output only. Whether the current user can delete this file. "canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canDisableInheritedPermissions": True or False, # Whether a user can disable inherited permissions. "canDownload": True or False, # Output only. Whether the current user can download this file. "canEdit": True or False, # Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`. + "canEnableInheritedPermissions": True or False, # Whether a user can re-enable inherited permissions. "canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder. "canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file. "canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction` or `canRemoveContentRestriction`. @@ -2371,6 +2397,7 @@

Method Details

"whiteBalance": "A String", # Output only. The white balance mode used to create the photo. "width": 42, # Output only. The width of the image in pixels. }, + "inheritedPermissionsDisabled": True or False, # Whether this file has inherited permissions disabled. Inherited permissions are enabled by default. "isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app. "kind": "drive#file", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#file"`. "labelInfo": { # Output only. An overview of the labels on the file. @@ -2456,12 +2483,13 @@

Method Details

"emailAddress": "A String", # The email address of the user or group to which this permission refers. "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They can only be set on user and group permissions - The time must be in the future - The time cannot be more than a year in the future "id": "A String", # Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as `permissionId`. IDs should be treated as opaque values. + "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#permission"`. "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. { "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` }, @@ -2477,7 +2505,7 @@

Method Details

}, ], "type": "A String", # The type of the grantee. Valid values are: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. When `type` is `domain`, you must provide a `domain`. There isn't extra information required for an `anyone` type. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. 'published' is the only supported value. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. }, ], "properties": { # A collection of arbitrary key-value pairs which are visible to all apps. @@ -2572,8 +2600,10 @@

Method Details

"canCopy": True or False, # Output only. Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. "canDelete": True or False, # Output only. Whether the current user can delete this file. "canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canDisableInheritedPermissions": True or False, # Whether a user can disable inherited permissions. "canDownload": True or False, # Output only. Whether the current user can download this file. "canEdit": True or False, # Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`. + "canEnableInheritedPermissions": True or False, # Whether a user can re-enable inherited permissions. "canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder. "canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file. "canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction` or `canRemoveContentRestriction`. @@ -2671,6 +2701,7 @@

Method Details

"whiteBalance": "A String", # Output only. The white balance mode used to create the photo. "width": 42, # Output only. The width of the image in pixels. }, + "inheritedPermissionsDisabled": True or False, # Whether this file has inherited permissions disabled. Inherited permissions are enabled by default. "isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app. "kind": "drive#file", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#file"`. "labelInfo": { # Output only. An overview of the labels on the file. @@ -2756,12 +2787,13 @@

Method Details

"emailAddress": "A String", # The email address of the user or group to which this permission refers. "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They can only be set on user and group permissions - The time must be in the future - The time cannot be more than a year in the future "id": "A String", # Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as `permissionId`. IDs should be treated as opaque values. + "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#permission"`. "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. { "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` }, @@ -2777,7 +2809,7 @@

Method Details

}, ], "type": "A String", # The type of the grantee. Valid values are: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. When `type` is `domain`, you must provide a `domain`. There isn't extra information required for an `anyone` type. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. 'published' is the only supported value. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. }, ], "properties": { # A collection of arbitrary key-value pairs which are visible to all apps. diff --git a/docs/dyn/drive_v3.permissions.html b/docs/dyn/drive_v3.permissions.html index b50a669aa72..7b18c81ce9f 100644 --- a/docs/dyn/drive_v3.permissions.html +++ b/docs/dyn/drive_v3.permissions.html @@ -81,7 +81,7 @@

Instance Methods

create(fileId, body=None, emailMessage=None, enforceSingleParent=None, moveToNewOwnersRoot=None, sendNotificationEmail=None, supportsAllDrives=None, supportsTeamDrives=None, transferOwnership=None, useDomainAdminAccess=None, x__xgafv=None)

Creates a permission for a file or shared drive. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied.

- delete(fileId, permissionId, supportsAllDrives=None, supportsTeamDrives=None, useDomainAdminAccess=None, x__xgafv=None)

+ delete(fileId, permissionId, enforceExpansiveAccess=None, supportsAllDrives=None, supportsTeamDrives=None, useDomainAdminAccess=None, x__xgafv=None)

Deletes a permission. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied.

get(fileId, permissionId, supportsAllDrives=None, supportsTeamDrives=None, useDomainAdminAccess=None, x__xgafv=None)

@@ -93,7 +93,7 @@

Instance Methods

list_next()

Retrieves the next page of results.

- update(fileId, permissionId, body=None, removeExpiration=None, supportsAllDrives=None, supportsTeamDrives=None, transferOwnership=None, useDomainAdminAccess=None, x__xgafv=None)

+ update(fileId, permissionId, body=None, enforceExpansiveAccess=None, removeExpiration=None, supportsAllDrives=None, supportsTeamDrives=None, transferOwnership=None, useDomainAdminAccess=None, x__xgafv=None)

Updates a permission with patch semantics. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied.

Method Details

@@ -118,12 +118,13 @@

Method Details

"emailAddress": "A String", # The email address of the user or group to which this permission refers. "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They can only be set on user and group permissions - The time must be in the future - The time cannot be more than a year in the future "id": "A String", # Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as `permissionId`. IDs should be treated as opaque values. + "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#permission"`. "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. { "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` }, @@ -139,7 +140,7 @@

Method Details

}, ], "type": "A String", # The type of the grantee. Valid values are: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. When `type` is `domain`, you must provide a `domain`. There isn't extra information required for an `anyone` type. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. 'published' is the only supported value. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. } emailMessage: string, A plain text custom message to include in the notification email. @@ -166,12 +167,13 @@

Method Details

"emailAddress": "A String", # The email address of the user or group to which this permission refers. "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They can only be set on user and group permissions - The time must be in the future - The time cannot be more than a year in the future "id": "A String", # Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as `permissionId`. IDs should be treated as opaque values. + "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#permission"`. "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. { "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` }, @@ -187,17 +189,18 @@

Method Details

}, ], "type": "A String", # The type of the grantee. Valid values are: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. When `type` is `domain`, you must provide a `domain`. There isn't extra information required for an `anyone` type. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. 'published' is the only supported value. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. }
- delete(fileId, permissionId, supportsAllDrives=None, supportsTeamDrives=None, useDomainAdminAccess=None, x__xgafv=None) + delete(fileId, permissionId, enforceExpansiveAccess=None, supportsAllDrives=None, supportsTeamDrives=None, useDomainAdminAccess=None, x__xgafv=None)
Deletes a permission. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied.
 
 Args:
   fileId: string, The ID of the file or shared drive. (required)
   permissionId: string, The ID of the permission. (required)
+  enforceExpansiveAccess: boolean, Whether the request should enforce expansive access rules.
   supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
   supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead.
   useDomainAdminAccess: boolean, Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.
@@ -234,12 +237,13 @@ 

Method Details

"emailAddress": "A String", # The email address of the user or group to which this permission refers. "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They can only be set on user and group permissions - The time must be in the future - The time cannot be more than a year in the future "id": "A String", # Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as `permissionId`. IDs should be treated as opaque values. + "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#permission"`. "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. { "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` }, @@ -255,7 +259,7 @@

Method Details

}, ], "type": "A String", # The type of the grantee. Valid values are: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. When `type` is `domain`, you must provide a `domain`. There isn't extra information required for an `anyone` type. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. 'published' is the only supported value. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. }
@@ -291,12 +295,13 @@

Method Details

"emailAddress": "A String", # The email address of the user or group to which this permission refers. "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They can only be set on user and group permissions - The time must be in the future - The time cannot be more than a year in the future "id": "A String", # Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as `permissionId`. IDs should be treated as opaque values. + "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#permission"`. "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. { "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` }, @@ -312,7 +317,7 @@

Method Details

}, ], "type": "A String", # The type of the grantee. Valid values are: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. When `type` is `domain`, you must provide a `domain`. There isn't extra information required for an `anyone` type. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. 'published' is the only supported value. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. }, ], }
@@ -333,7 +338,7 @@

Method Details

- update(fileId, permissionId, body=None, removeExpiration=None, supportsAllDrives=None, supportsTeamDrives=None, transferOwnership=None, useDomainAdminAccess=None, x__xgafv=None) + update(fileId, permissionId, body=None, enforceExpansiveAccess=None, removeExpiration=None, supportsAllDrives=None, supportsTeamDrives=None, transferOwnership=None, useDomainAdminAccess=None, x__xgafv=None)
Updates a permission with patch semantics. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied.
 
 Args:
@@ -350,12 +355,13 @@ 

Method Details

"emailAddress": "A String", # The email address of the user or group to which this permission refers. "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They can only be set on user and group permissions - The time must be in the future - The time cannot be more than a year in the future "id": "A String", # Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as `permissionId`. IDs should be treated as opaque values. + "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#permission"`. "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. { "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` }, @@ -371,9 +377,10 @@

Method Details

}, ], "type": "A String", # The type of the grantee. Valid values are: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. When `type` is `domain`, you must provide a `domain`. There isn't extra information required for an `anyone` type. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. 'published' is the only supported value. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. } + enforceExpansiveAccess: boolean, Whether the request should enforce expansive access rules. removeExpiration: boolean, Whether to remove the expiration date. supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives. supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead. @@ -395,12 +402,13 @@

Method Details

"emailAddress": "A String", # The email address of the user or group to which this permission refers. "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They can only be set on user and group permissions - The time must be in the future - The time cannot be more than a year in the future "id": "A String", # Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as `permissionId`. IDs should be treated as opaque values. + "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#permission"`. "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. { "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` }, @@ -416,7 +424,7 @@

Method Details

}, ], "type": "A String", # The type of the grantee. Valid values are: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. When `type` is `domain`, you must provide a `domain`. There isn't extra information required for an `anyone` type. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. 'published' is the only supported value. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. }
diff --git a/googleapiclient/discovery_cache/documents/drive.v2.json b/googleapiclient/discovery_cache/documents/drive.v2.json index 77d00c819e7..90a677bf836 100644 --- a/googleapiclient/discovery_cache/documents/drive.v2.json +++ b/googleapiclient/discovery_cache/documents/drive.v2.json @@ -2632,6 +2632,12 @@ "permissionId" ], "parameters": { +"enforceExpansiveAccess": { +"default": "false", +"description": "Whether the request should enforce expansive access rules.", +"location": "query", +"type": "boolean" +}, "fileId": { "description": "The ID for the file or shared drive.", "location": "path", @@ -2905,6 +2911,12 @@ "permissionId" ], "parameters": { +"enforceExpansiveAccess": { +"default": "false", +"description": "Whether the request should enforce expansive access rules.", +"location": "query", +"type": "boolean" +}, "fileId": { "description": "The ID for the file or shared drive.", "location": "path", @@ -2971,6 +2983,12 @@ "permissionId" ], "parameters": { +"enforceExpansiveAccess": { +"default": "false", +"description": "Whether the request should enforce expansive access rules.", +"location": "query", +"type": "boolean" +}, "fileId": { "description": "The ID for the file or shared drive.", "location": "path", @@ -3869,7 +3887,7 @@ } } }, -"revision": "20250122", +"revision": "20250216", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { @@ -5056,6 +5074,11 @@ "description": "Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.", "type": "boolean" }, +"canDisableInheritedPermissions": { +"description": "Output only. Whether a user can disable inherited permissions.", +"readOnly": true, +"type": "boolean" +}, "canDownload": { "description": "Output only. Whether the current user can download this file.", "type": "boolean" @@ -5064,6 +5087,11 @@ "description": "Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`.", "type": "boolean" }, +"canEnableInheritedPermissions": { +"description": "Output only. Whether a user can re-enable inherited permissions.", +"readOnly": true, +"type": "boolean" +}, "canListChildren": { "description": "Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder.", "type": "boolean" @@ -5413,6 +5441,10 @@ }, "type": "object" }, +"inheritedPermissionsDisabled": { +"description": "Whether this file has inherited permissions disabled. Inherited permissions are enabled by default.", +"type": "boolean" +}, "isAppAuthorized": { "description": "Output only. Whether the file was created or opened by the requesting app.", "type": "boolean" @@ -6122,6 +6154,10 @@ "description": "The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.", "type": "string" }, +"inheritedPermissionsDisabled": { +"description": "When true, only organizers, owners, and users with permissions added directly on the item can access it.", +"type": "boolean" +}, "kind": { "default": "drive#permission", "description": "Output only. This is always `drive#permission`.", @@ -6136,7 +6172,7 @@ "type": "boolean" }, "permissionDetails": { -"description": "Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.", +"description": "Output only. Details of whether the permissions on this item are inherited or directly on this item.", "items": { "properties": { "additionalRoles": { @@ -6147,11 +6183,11 @@ "type": "array" }, "inherited": { -"description": "Output only. Whether this permission is inherited. This field is always populated. This is an output-only field.", +"description": "Output only. Whether this permission is inherited. This field is always populated.", "type": "boolean" }, "inheritedFrom": { -"description": "Output only. The ID of the item from which this permission is inherited. This is an output-only field.", +"description": "Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives.", "type": "string" }, "permissionType": { @@ -6238,7 +6274,7 @@ "type": "string" }, "view": { -"description": "Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value.", +"description": "Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. ", "type": "string" }, "withLink": { diff --git a/googleapiclient/discovery_cache/documents/drive.v3.json b/googleapiclient/discovery_cache/documents/drive.v3.json index 6f71d2771c3..93d213397d6 100644 --- a/googleapiclient/discovery_cache/documents/drive.v3.json +++ b/googleapiclient/discovery_cache/documents/drive.v3.json @@ -2021,6 +2021,12 @@ "permissionId" ], "parameters": { +"enforceExpansiveAccess": { +"default": "false", +"description": "Whether the request should enforce expansive access rules.", +"location": "query", +"type": "boolean" +}, "fileId": { "description": "The ID of the file or shared drive.", "location": "path", @@ -2192,6 +2198,12 @@ "permissionId" ], "parameters": { +"enforceExpansiveAccess": { +"default": "false", +"description": "Whether the request should enforce expansive access rules.", +"location": "query", +"type": "boolean" +}, "fileId": { "description": "The ID of the file or shared drive.", "location": "path", @@ -2788,7 +2800,7 @@ } } }, -"revision": "20250210", +"revision": "20250216", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { @@ -3689,6 +3701,10 @@ "description": "Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.", "type": "boolean" }, +"canDisableInheritedPermissions": { +"description": "Whether a user can disable inherited permissions.", +"type": "boolean" +}, "canDownload": { "description": "Output only. Whether the current user can download this file.", "type": "boolean" @@ -3697,6 +3713,10 @@ "description": "Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`.", "type": "boolean" }, +"canEnableInheritedPermissions": { +"description": "Whether a user can re-enable inherited permissions.", +"type": "boolean" +}, "canListChildren": { "description": "Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder.", "type": "boolean" @@ -4030,6 +4050,10 @@ }, "type": "object" }, +"inheritedPermissionsDisabled": { +"description": "Whether this file has inherited permissions disabled. Inherited permissions are enabled by default.", +"type": "boolean" +}, "isAppAuthorized": { "description": "Output only. Whether the file was created or opened by the requesting app.", "type": "boolean" @@ -4666,6 +4690,10 @@ "description": "Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as `permissionId`. IDs should be treated as opaque values.", "type": "string" }, +"inheritedPermissionsDisabled": { +"description": "When true, only organizers, owners, and users with permissions added directly on the item can access it.", +"type": "boolean" +}, "kind": { "default": "drive#permission", "description": "Output only. Identifies what kind of resource this is. Value: the fixed string `\"drive#permission\"`.", @@ -4676,7 +4704,7 @@ "type": "boolean" }, "permissionDetails": { -"description": "Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.", +"description": "Output only. Details of whether the permissions on this item are inherited or directly on this item.", "items": { "properties": { "inherited": { @@ -4684,7 +4712,7 @@ "type": "boolean" }, "inheritedFrom": { -"description": "Output only. The ID of the item from which this permission is inherited. This is an output-only field.", +"description": "Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives.", "type": "string" }, "permissionType": { @@ -4755,7 +4783,7 @@ "type": "string" }, "view": { -"description": "Indicates the view for this permission. Only populated for permissions that belong to a view. 'published' is the only supported value.", +"description": "Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. ", "type": "string" } }, From f407c70f131ca1bb8808a9aca2bb107b3741baac Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 25 Feb 2025 07:08:19 +0000 Subject: [PATCH 16/36] feat(firebaseappdistribution): update the api #### firebaseappdistribution:v1alpha The following keys were added: - resources.projects.methods.getTestQuota (Total Keys: 11) - schemas.GoogleFirebaseAppdistroV1alphaTestQuota (Total Keys: 9) --- ...ebaseappdistribution_v1alpha.projects.html | 24 +++++++++ .../firebaseappdistribution.v1alpha.json | 52 ++++++++++++++++++- 2 files changed, 75 insertions(+), 1 deletion(-) diff --git a/docs/dyn/firebaseappdistribution_v1alpha.projects.html b/docs/dyn/firebaseappdistribution_v1alpha.projects.html index ff58521d7d9..c1552008672 100644 --- a/docs/dyn/firebaseappdistribution_v1alpha.projects.html +++ b/docs/dyn/firebaseappdistribution_v1alpha.projects.html @@ -87,10 +87,34 @@

Instance Methods

close()

Close httplib2 connections.

+

+ getTestQuota(name, x__xgafv=None)

+

Get information about the quota for `ReleaseTests`.

Method Details

close()
Close httplib2 connections.
+
+ getTestQuota(name, x__xgafv=None) +
Get information about the quota for `ReleaseTests`.
+
+Args:
+  name: string, Required. The name of the `TestQuota` resource to retrieve. Format: `projects/{project_number}/testQuota` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Customer quota information for `ReleaseTests`. Note: This quota only applies to tests with `AiInstructions` and is separate from the quota which might apply to the device time used by any tests.
+  "limit": "A String", # Output only. Maximum number of `ReleaseTests` allotted for the current month.
+  "name": "A String", # Identifier. The name of the `TestQuota` resource. Format: `projects/{project_number}/testQuota`
+  "usage": "A String", # Output only. Number of `ReleaseTests` run in the current month
+}
+
+ \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json b/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json index 50168548be2..4fda91973e8 100644 --- a/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json @@ -380,6 +380,33 @@ } }, "projects": { +"methods": { +"getTestQuota": { +"description": "Get information about the quota for `ReleaseTests`.", +"flatPath": "v1alpha/projects/{projectsId}/testQuota", +"httpMethod": "GET", +"id": "firebaseappdistribution.projects.getTestQuota", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the `TestQuota` resource to retrieve. Format: `projects/{project_number}/testQuota`", +"location": "path", +"pattern": "^projects/[^/]+/testQuota$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "GoogleFirebaseAppdistroV1alphaTestQuota" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, "resources": { "apps": { "methods": { @@ -776,7 +803,7 @@ } } }, -"revision": "20250207", +"revision": "20250219", "rootUrl": "https://firebaseappdistribution.googleapis.com/", "schemas": { "AndroidxCrawlerOutputPoint": { @@ -1904,6 +1931,29 @@ }, "type": "object" }, +"GoogleFirebaseAppdistroV1alphaTestQuota": { +"description": "Customer quota information for `ReleaseTests`. Note: This quota only applies to tests with `AiInstructions` and is separate from the quota which might apply to the device time used by any tests.", +"id": "GoogleFirebaseAppdistroV1alphaTestQuota", +"properties": { +"limit": { +"description": "Output only. Maximum number of `ReleaseTests` allotted for the current month.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Identifier. The name of the `TestQuota` resource. Format: `projects/{project_number}/testQuota`", +"type": "string" +}, +"usage": { +"description": "Output only. Number of `ReleaseTests` run in the current month", +"format": "int64", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleFirebaseAppdistroV1alphaTesterUdid": { "description": "The UDIDs of a tester's iOS device", "id": "GoogleFirebaseAppdistroV1alphaTesterUdid", From 6871ed6bb132c96fab44e5d0df4859c4518727d7 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 25 Feb 2025 07:08:19 +0000 Subject: [PATCH 17/36] feat(gkebackup): update the api #### gkebackup:v1 The following keys were deleted: - resources.projects.resources.locations.resources.backupPlans.resources.backups.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - schemas.ListBackupsResponse.properties.unreachable (Total Keys: 2) --- ...1.projects.locations.backupPlans.backups.html | 8 ++------ ...projects.locations.restorePlans.restores.html | 8 ++++---- .../discovery_cache/documents/gkebackup.v1.json | 16 ++-------------- 3 files changed, 8 insertions(+), 24 deletions(-) diff --git a/docs/dyn/gkebackup_v1.projects.locations.backupPlans.backups.html b/docs/dyn/gkebackup_v1.projects.locations.backupPlans.backups.html index 6db1691fa96..6f257c2ed63 100644 --- a/docs/dyn/gkebackup_v1.projects.locations.backupPlans.backups.html +++ b/docs/dyn/gkebackup_v1.projects.locations.backupPlans.backups.html @@ -98,7 +98,7 @@

Instance Methods

getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

- list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists the Backups for a given BackupPlan.

list_next()

@@ -385,7 +385,7 @@

Method Details

- list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists the Backups for a given BackupPlan.
 
 Args:
@@ -394,7 +394,6 @@ 

Method Details

orderBy: string, Optional. Field by which to sort the results. pageSize: integer, Optional. The target number of results to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may include a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried. pageToken: string, Optional. The value of next_page_token received from a previous `ListBackups` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to `ListBackups` must match the call that provided the page token. - returnPartialSuccess: boolean, Optional. If set to true, the response will return partial results when some regions are unreachable and the unreachable field will be populated. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -460,9 +459,6 @@

Method Details

}, ], "nextPageToken": "A String", # A token which may be sent as page_token in a subsequent `ListBackups` call to retrieve the next page of results. If this field is omitted or empty, then there are no more results to return. - "unreachable": [ # Locations that could not be reached. - "A String", - ], }
diff --git a/docs/dyn/gkebackup_v1.projects.locations.restorePlans.restores.html b/docs/dyn/gkebackup_v1.projects.locations.restorePlans.restores.html index f960fa3834e..ccd29471525 100644 --- a/docs/dyn/gkebackup_v1.projects.locations.restorePlans.restores.html +++ b/docs/dyn/gkebackup_v1.projects.locations.restorePlans.restores.html @@ -131,7 +131,7 @@

Method Details

"createTime": "A String", # Output only. The timestamp when this Restore resource was created. "description": "A String", # User specified descriptive string for this Restore. "etag": "A String", # Output only. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a restore from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform restore updates in order to avoid race conditions: An `etag` is returned in the response to `GetRestore`, and systems are expected to put that etag in the request to `UpdateRestore` or `DeleteRestore` to ensure that their change will be applied to the same version of the resource. - "filter": { # Defines the filter for `Restore`. This filter can be used to further refine the resource selection of the `Restore` beyond the coarse-grained scope defined in the `RestorePlan`. `exclusion_filters` take precedence over `inclusion_filters`. If a resource matches both `inclusion_filters` and `exclusion_filters`, it will not be restored. # Optional. Immutable. Filters resources for `Restore`. If not specified, the scope of the restore will remain the same as defined in the `RestorePlan`. If this is specified and no resources are matched by the `inclusion_filters` or everyting is excluded by the `exclusion_filters`, nothing will be restored. This filter can only be specified if the value of namespaced_resource_restore_mode is set to `MERGE_SKIP_ON_CONFLICT`, `MERGE_REPLACE_VOLUME_ON_CONFLICT` or `MERGE_REPLACE_ON_CONFLICT`. + "filter": { # Defines the filter for `Restore`. This filter can be used to further refine the resource selection of the `Restore` beyond the coarse-grained scope defined in the `RestorePlan`. `exclusion_filters` take precedence over `inclusion_filters`. If a resource matches both `inclusion_filters` and `exclusion_filters`, it will not be restored. # Optional. Immutable. Filters resources for `Restore`. If not specified, the scope of the restore will remain the same as defined in the `RestorePlan`. If this is specified and no resources are matched by the `inclusion_filters` or everything is excluded by the `exclusion_filters`, nothing will be restored. This filter can only be specified if the value of namespaced_resource_restore_mode is set to `MERGE_SKIP_ON_CONFLICT`, `MERGE_REPLACE_VOLUME_ON_CONFLICT` or `MERGE_REPLACE_ON_CONFLICT`. "exclusionFilters": [ # Optional. Excludes resources from restoration. If specified, a resource will not be restored if it matches any `ResourceSelector` of the `exclusion_filters`. { # Defines a selector to identify a single or a group of resources. Conditions in the selector are optional, but at least one field should be set to a non-empty value. If a condition is not specified, no restrictions will be applied on that dimension. If more than one condition is specified, a resource will be selected if and only if all conditions are met. "groupKind": { # This is a direct map to the Kubernetes GroupKind type [GroupKind](https://godoc.org/k8s.io/apimachinery/pkg/runtime/schema#GroupKind) and is used for identifying specific "types" of resources to restore. # Optional. Selects resources using their Kubernetes GroupKinds. If specified, only resources of provided GroupKind will be selected. @@ -376,7 +376,7 @@

Method Details

"createTime": "A String", # Output only. The timestamp when this Restore resource was created. "description": "A String", # User specified descriptive string for this Restore. "etag": "A String", # Output only. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a restore from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform restore updates in order to avoid race conditions: An `etag` is returned in the response to `GetRestore`, and systems are expected to put that etag in the request to `UpdateRestore` or `DeleteRestore` to ensure that their change will be applied to the same version of the resource. - "filter": { # Defines the filter for `Restore`. This filter can be used to further refine the resource selection of the `Restore` beyond the coarse-grained scope defined in the `RestorePlan`. `exclusion_filters` take precedence over `inclusion_filters`. If a resource matches both `inclusion_filters` and `exclusion_filters`, it will not be restored. # Optional. Immutable. Filters resources for `Restore`. If not specified, the scope of the restore will remain the same as defined in the `RestorePlan`. If this is specified and no resources are matched by the `inclusion_filters` or everyting is excluded by the `exclusion_filters`, nothing will be restored. This filter can only be specified if the value of namespaced_resource_restore_mode is set to `MERGE_SKIP_ON_CONFLICT`, `MERGE_REPLACE_VOLUME_ON_CONFLICT` or `MERGE_REPLACE_ON_CONFLICT`. + "filter": { # Defines the filter for `Restore`. This filter can be used to further refine the resource selection of the `Restore` beyond the coarse-grained scope defined in the `RestorePlan`. `exclusion_filters` take precedence over `inclusion_filters`. If a resource matches both `inclusion_filters` and `exclusion_filters`, it will not be restored. # Optional. Immutable. Filters resources for `Restore`. If not specified, the scope of the restore will remain the same as defined in the `RestorePlan`. If this is specified and no resources are matched by the `inclusion_filters` or everything is excluded by the `exclusion_filters`, nothing will be restored. This filter can only be specified if the value of namespaced_resource_restore_mode is set to `MERGE_SKIP_ON_CONFLICT`, `MERGE_REPLACE_VOLUME_ON_CONFLICT` or `MERGE_REPLACE_ON_CONFLICT`. "exclusionFilters": [ # Optional. Excludes resources from restoration. If specified, a resource will not be restored if it matches any `ResourceSelector` of the `exclusion_filters`. { # Defines a selector to identify a single or a group of resources. Conditions in the selector are optional, but at least one field should be set to a non-empty value. If a condition is not specified, no restrictions will be applied on that dimension. If more than one condition is specified, a resource will be selected if and only if all conditions are met. "groupKind": { # This is a direct map to the Kubernetes GroupKind type [GroupKind](https://godoc.org/k8s.io/apimachinery/pkg/runtime/schema#GroupKind) and is used for identifying specific "types" of resources to restore. # Optional. Selects resources using their Kubernetes GroupKinds. If specified, only resources of provided GroupKind will be selected. @@ -610,7 +610,7 @@

Method Details

"createTime": "A String", # Output only. The timestamp when this Restore resource was created. "description": "A String", # User specified descriptive string for this Restore. "etag": "A String", # Output only. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a restore from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform restore updates in order to avoid race conditions: An `etag` is returned in the response to `GetRestore`, and systems are expected to put that etag in the request to `UpdateRestore` or `DeleteRestore` to ensure that their change will be applied to the same version of the resource. - "filter": { # Defines the filter for `Restore`. This filter can be used to further refine the resource selection of the `Restore` beyond the coarse-grained scope defined in the `RestorePlan`. `exclusion_filters` take precedence over `inclusion_filters`. If a resource matches both `inclusion_filters` and `exclusion_filters`, it will not be restored. # Optional. Immutable. Filters resources for `Restore`. If not specified, the scope of the restore will remain the same as defined in the `RestorePlan`. If this is specified and no resources are matched by the `inclusion_filters` or everyting is excluded by the `exclusion_filters`, nothing will be restored. This filter can only be specified if the value of namespaced_resource_restore_mode is set to `MERGE_SKIP_ON_CONFLICT`, `MERGE_REPLACE_VOLUME_ON_CONFLICT` or `MERGE_REPLACE_ON_CONFLICT`. + "filter": { # Defines the filter for `Restore`. This filter can be used to further refine the resource selection of the `Restore` beyond the coarse-grained scope defined in the `RestorePlan`. `exclusion_filters` take precedence over `inclusion_filters`. If a resource matches both `inclusion_filters` and `exclusion_filters`, it will not be restored. # Optional. Immutable. Filters resources for `Restore`. If not specified, the scope of the restore will remain the same as defined in the `RestorePlan`. If this is specified and no resources are matched by the `inclusion_filters` or everything is excluded by the `exclusion_filters`, nothing will be restored. This filter can only be specified if the value of namespaced_resource_restore_mode is set to `MERGE_SKIP_ON_CONFLICT`, `MERGE_REPLACE_VOLUME_ON_CONFLICT` or `MERGE_REPLACE_ON_CONFLICT`. "exclusionFilters": [ # Optional. Excludes resources from restoration. If specified, a resource will not be restored if it matches any `ResourceSelector` of the `exclusion_filters`. { # Defines a selector to identify a single or a group of resources. Conditions in the selector are optional, but at least one field should be set to a non-empty value. If a condition is not specified, no restrictions will be applied on that dimension. If more than one condition is specified, a resource will be selected if and only if all conditions are met. "groupKind": { # This is a direct map to the Kubernetes GroupKind type [GroupKind](https://godoc.org/k8s.io/apimachinery/pkg/runtime/schema#GroupKind) and is used for identifying specific "types" of resources to restore. # Optional. Selects resources using their Kubernetes GroupKinds. If specified, only resources of provided GroupKind will be selected. @@ -803,7 +803,7 @@

Method Details

"createTime": "A String", # Output only. The timestamp when this Restore resource was created. "description": "A String", # User specified descriptive string for this Restore. "etag": "A String", # Output only. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a restore from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform restore updates in order to avoid race conditions: An `etag` is returned in the response to `GetRestore`, and systems are expected to put that etag in the request to `UpdateRestore` or `DeleteRestore` to ensure that their change will be applied to the same version of the resource. - "filter": { # Defines the filter for `Restore`. This filter can be used to further refine the resource selection of the `Restore` beyond the coarse-grained scope defined in the `RestorePlan`. `exclusion_filters` take precedence over `inclusion_filters`. If a resource matches both `inclusion_filters` and `exclusion_filters`, it will not be restored. # Optional. Immutable. Filters resources for `Restore`. If not specified, the scope of the restore will remain the same as defined in the `RestorePlan`. If this is specified and no resources are matched by the `inclusion_filters` or everyting is excluded by the `exclusion_filters`, nothing will be restored. This filter can only be specified if the value of namespaced_resource_restore_mode is set to `MERGE_SKIP_ON_CONFLICT`, `MERGE_REPLACE_VOLUME_ON_CONFLICT` or `MERGE_REPLACE_ON_CONFLICT`. + "filter": { # Defines the filter for `Restore`. This filter can be used to further refine the resource selection of the `Restore` beyond the coarse-grained scope defined in the `RestorePlan`. `exclusion_filters` take precedence over `inclusion_filters`. If a resource matches both `inclusion_filters` and `exclusion_filters`, it will not be restored. # Optional. Immutable. Filters resources for `Restore`. If not specified, the scope of the restore will remain the same as defined in the `RestorePlan`. If this is specified and no resources are matched by the `inclusion_filters` or everything is excluded by the `exclusion_filters`, nothing will be restored. This filter can only be specified if the value of namespaced_resource_restore_mode is set to `MERGE_SKIP_ON_CONFLICT`, `MERGE_REPLACE_VOLUME_ON_CONFLICT` or `MERGE_REPLACE_ON_CONFLICT`. "exclusionFilters": [ # Optional. Excludes resources from restoration. If specified, a resource will not be restored if it matches any `ResourceSelector` of the `exclusion_filters`. { # Defines a selector to identify a single or a group of resources. Conditions in the selector are optional, but at least one field should be set to a non-empty value. If a condition is not specified, no restrictions will be applied on that dimension. If more than one condition is specified, a resource will be selected if and only if all conditions are met. "groupKind": { # This is a direct map to the Kubernetes GroupKind type [GroupKind](https://godoc.org/k8s.io/apimachinery/pkg/runtime/schema#GroupKind) and is used for identifying specific "types" of resources to restore. # Optional. Selects resources using their Kubernetes GroupKinds. If specified, only resources of provided GroupKind will be selected. diff --git a/googleapiclient/discovery_cache/documents/gkebackup.v1.json b/googleapiclient/discovery_cache/documents/gkebackup.v1.json index 164e4fafc05..3d15b0b190e 100644 --- a/googleapiclient/discovery_cache/documents/gkebackup.v1.json +++ b/googleapiclient/discovery_cache/documents/gkebackup.v1.json @@ -623,11 +623,6 @@ "pattern": "^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+$", "required": true, "type": "string" -}, -"returnPartialSuccess": { -"description": "Optional. If set to true, the response will return partial results when some regions are unreachable and the unreachable field will be populated.", -"location": "query", -"type": "boolean" } }, "path": "v1/{+parent}/backups", @@ -1718,7 +1713,7 @@ } } }, -"revision": "20250205", +"revision": "20250217", "rootUrl": "https://gkebackup.googleapis.com/", "schemas": { "AuditConfig": { @@ -2484,13 +2479,6 @@ "nextPageToken": { "description": "A token which may be sent as page_token in a subsequent `ListBackups` call to retrieve the next page of results. If this field is omitted or empty, then there are no more results to return.", "type": "string" -}, -"unreachable": { -"description": "Locations that could not be reached.", -"items": { -"type": "string" -}, -"type": "array" } }, "type": "object" @@ -2838,7 +2826,7 @@ }, "filter": { "$ref": "Filter", -"description": "Optional. Immutable. Filters resources for `Restore`. If not specified, the scope of the restore will remain the same as defined in the `RestorePlan`. If this is specified and no resources are matched by the `inclusion_filters` or everyting is excluded by the `exclusion_filters`, nothing will be restored. This filter can only be specified if the value of namespaced_resource_restore_mode is set to `MERGE_SKIP_ON_CONFLICT`, `MERGE_REPLACE_VOLUME_ON_CONFLICT` or `MERGE_REPLACE_ON_CONFLICT`." +"description": "Optional. Immutable. Filters resources for `Restore`. If not specified, the scope of the restore will remain the same as defined in the `RestorePlan`. If this is specified and no resources are matched by the `inclusion_filters` or everything is excluded by the `exclusion_filters`, nothing will be restored. This filter can only be specified if the value of namespaced_resource_restore_mode is set to `MERGE_SKIP_ON_CONFLICT`, `MERGE_REPLACE_VOLUME_ON_CONFLICT` or `MERGE_REPLACE_ON_CONFLICT`." }, "labels": { "additionalProperties": { From d88f1131149b315deb028177400f73df81e1b700 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 25 Feb 2025 07:08:19 +0000 Subject: [PATCH 18/36] feat(healthcare): update the api #### healthcare:v1 The following keys were added: - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.bulk-export-group (Total Keys: 19) - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.bulk-export (Total Keys: 17) - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.operations.methods.delete-fhir-operation (Total Keys: 11) - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.operations.methods.get-fhir-operation-status (Total Keys: 11) - schemas.BulkExportGcsDestination (Total Keys: 3) - schemas.FhirStore.properties.bulkExportGcsDestination.$ref (Total Keys: 1) #### healthcare:v1beta1 The following keys were added: - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.bulk-export-group (Total Keys: 19) - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.bulk-export (Total Keys: 17) - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.operations.methods.delete-fhir-operation (Total Keys: 11) - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.operations.methods.get-fhir-operation-status (Total Keys: 11) - schemas.BulkExportGcsDestination (Total Keys: 3) - schemas.FhirStore.properties.bulkExportGcsDestination.$ref (Total Keys: 1) --- ...ts.locations.datasets.fhirStores.fhir.html | 31 ++++ ...rojects.locations.datasets.fhirStores.html | 55 ++++++ ...ations.datasets.fhirStores.operations.html | 142 ++++++++++++++++ ...ts.locations.datasets.fhirStores.fhir.html | 31 ++++ ...rojects.locations.datasets.fhirStores.html | 55 ++++++ ...ations.datasets.fhirStores.operations.html | 142 ++++++++++++++++ .../documents/healthcare.v1.json | 160 +++++++++++++++++- .../documents/healthcare.v1beta1.json | 160 +++++++++++++++++- 8 files changed, 774 insertions(+), 2 deletions(-) create mode 100644 docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.operations.html create mode 100644 docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.operations.html diff --git a/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.fhir.html b/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.fhir.html index 983dbea7ab3..1fc0a1f7e9c 100644 --- a/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.fhir.html +++ b/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.fhir.html @@ -101,6 +101,9 @@

Instance Methods

Resource_validate(parent, type, body=None, profile=None, x__xgafv=None)

Validates an input FHIR resource's conformance to its profiles and the profiles configured on the FHIR store. Implements the FHIR extended operation $validate ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resource-operations.html#validate), [STU3](http://hl7.org/implement/standards/fhir/STU3/resource-operations.html#validate), or [R4](http://hl7.org/implement/standards/fhir/R4/resource-operation-validate.html)). The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The `Parameters` input syntax is not supported. The `profile` query parameter can be used to request that the resource only be validated against a specific profile. If a profile with the given URL cannot be found in the FHIR store then an error is returned. Errors generated by validation contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead.

+

+ bulk_export(name, outputFormat=None, x__xgafv=None, x_since=None, x_type=None)

+

Bulk exports all resources from the FHIR store to the specified destination. Implements the FHIR implementation guide [system level $export](https://build.fhir.org/ig/HL7/bulk-data/export.html#endpoint---system-level-export. The following headers must be set in the request: * `Accept`: specifies the format of the `OperationOutcome` response. Only `application/fhir+json` is supported. * `Prefer`: specifies whether the response is immediate or asynchronous. Must be to `respond-async` because only asynchronous responses are supported. Specify the destination for the server to write result files by setting the Cloud Storage location bulk_export_gcs_destination on the FHIR store. URI of an existing Cloud Storage directory where the server writes result files, in the format gs://{bucket-id}/{path/to/destination/dir}. If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced. Supports the following query parameters: * `_type`: string of comma-delimited FHIR resource types. If provided, only the resources of the specified type(s) are exported. * `_since`: if provided, only the resources that are updated after the specified time are exported. * `_outputFormat`: optional, specify ndjson to export data in NDJSON format. Exported file names use the format: {export_id}_{resource_type}.ndjson. On success, the `Content-Location` header of the response is set to a URL that the user can use to query the status of the export. The URL is in the format: `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/operations/{export_id}`. See get-fhir-operation-status for more information. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error.

capabilities(name, x__xgafv=None)

Gets the FHIR capability statement ([STU3](http://hl7.org/implement/standards/fhir/STU3/capabilitystatement.html), [R4](http://hl7.org/implement/standards/fhir/R4/capabilitystatement.html)), or the [conformance statement](http://hl7.org/implement/standards/fhir/DSTU2/conformance.html) in the DSTU2 case for the store, which contains a description of functionality supported by the server. Implements the FHIR standard capabilities interaction ([STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#capabilities), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#capabilities)), or the [conformance interaction](http://hl7.org/implement/standards/fhir/DSTU2/http.html#conformance) in the DSTU2 case. On success, the response body contains a JSON-encoded representation of a `CapabilityStatement` resource.

@@ -414,6 +417,34 @@

Method Details

} +
+ bulk_export(name, outputFormat=None, x__xgafv=None, x_since=None, x_type=None) +
Bulk exports all resources from the FHIR store to the specified destination. Implements the FHIR implementation guide [system level $export](https://build.fhir.org/ig/HL7/bulk-data/export.html#endpoint---system-level-export. The following headers must be set in the request: * `Accept`: specifies the format of the `OperationOutcome` response. Only `application/fhir+json` is supported. * `Prefer`: specifies whether the response is immediate or asynchronous. Must be to `respond-async` because only asynchronous responses are supported. Specify the destination for the server to write result files by setting the Cloud Storage location bulk_export_gcs_destination on the FHIR store. URI of an existing Cloud Storage directory where the server writes result files, in the format gs://{bucket-id}/{path/to/destination/dir}. If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced. Supports the following query parameters: * `_type`: string of comma-delimited FHIR resource types. If provided, only the resources of the specified type(s) are exported. * `_since`: if provided, only the resources that are updated after the specified time are exported. * `_outputFormat`: optional, specify ndjson to export data in NDJSON format. Exported file names use the format: {export_id}_{resource_type}.ndjson. On success, the `Content-Location` header of the response is set to a URL that the user can use to query the status of the export. The URL is in the format: `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/operations/{export_id}`. See get-fhir-operation-status for more information. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error.
+
+Args:
+  name: string, Required. The name of the FHIR store to export resources from, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. (required)
+  outputFormat: string, Optional. Output format of the export. This field is optional and only `application/fhir+ndjson` is supported.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+  x_since: string, Optional. If provided, only resources updated after this time are exported. The time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. For example, `2015-02-07T13:28:17.239+02:00` or `2017-01-01T00:00:00Z`. The time must be specified to the second and include a time zone.
+  x_type: string, Optional. String of comma-delimited FHIR resource types. If provided, only resources of the specified resource type(s) are exported.
+
+Returns:
+  An object of the form:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+
capabilities(name, x__xgafv=None)
Gets the FHIR capability statement ([STU3](http://hl7.org/implement/standards/fhir/STU3/capabilitystatement.html), [R4](http://hl7.org/implement/standards/fhir/R4/capabilitystatement.html)), or the [conformance statement](http://hl7.org/implement/standards/fhir/DSTU2/conformance.html) in the DSTU2 case for the store, which contains a description of functionality supported by the server. Implements the FHIR standard capabilities interaction ([STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#capabilities), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#capabilities)), or the [conformance interaction](http://hl7.org/implement/standards/fhir/DSTU2/http.html#conformance) in the DSTU2 case. On success, the response body contains a JSON-encoded representation of a `CapabilityStatement` resource.
diff --git a/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.html b/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.html
index 22a8460f4c0..0b352321110 100644
--- a/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.html
+++ b/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.html
@@ -79,12 +79,20 @@ 

Instance Methods

Returns the fhir Resource.

+

+ operations() +

+

Returns the operations Resource.

+

applyAdminConsents(name, body=None, x__xgafv=None)

Applies the admin Consent resources for the FHIR store and reindexes the underlying resources in the FHIR store according to the aggregate consents. This method also updates the `consent_config.enforced_admin_consents` field of the FhirStore unless `validate_only=true` in ApplyAdminConsentsRequest. Any admin Consent resource change after this operation execution (including deletion) requires you to call ApplyAdminConsents again for the change to take effect. This method returns an Operation that can be used to track the progress of the resources that were reindexed, by calling GetOperation. Upon completion, the ApplyAdminConsentsResponse additionally contains the number of resources that were reindexed. If at least one Consent resource contains an error or fails be be enforced for any reason, the method returns an error instead of an Operation. No resources will be reindexed and the `consent_config.enforced_admin_consents` field will be unchanged. To enforce a consent check for data access, `consent_config.access_enforced` must be set to true for the FhirStore.

applyConsents(name, body=None, x__xgafv=None)

Apply the Consent resources for the FHIR store and reindex the underlying resources in the FHIR store according to the aggregate consent. The aggregate consent of the patient in scope in this request replaces any previous call of this method. Any Consent resource change after this operation execution (including deletion) requires you to call ApplyConsents again to have effect. This method returns an Operation that can be used to track the progress of the consent resources that were processed by calling GetOperation. Upon completion, the ApplyConsentsResponse additionally contains the number of resources that was reindexed. Errors are logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). To enforce consent check for data access, `consent_config.access_enforced` must be set to true for the FhirStore.

+

+ bulk_export_group(name, organizeOutputBy=None, outputFormat=None, x__xgafv=None, x_since=None, x_type=None)

+

Bulk exports a Group resource and resources in the member field, including related resources for each Patient member. The export for each Patient is identical to a GetPatientEverything request. Implements the FHIR implementation guide [$export group of patients](https://build.fhir.org/ig/HL7/bulk-data/export.html#endpoint---group-of-patients). The following headers must be set in the request: * `Accept`: specifies the format of the `OperationOutcome` response. Only `application/fhir+json` is supported. * `Prefer`: specifies whether the response is immediate or asynchronous. Must be to `respond-async` because only asynchronous responses are supported. Specify the destination for the server to write result files by setting the Cloud Storage location bulk_export_gcs_destination on the FHIR store. URI of an existing Cloud Storage directory where the server writes result files, in the format gs://{bucket-id}/{path/to/destination/dir}. If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced. Supports the following query parameters: * `_type`: string of comma-delimited FHIR resource types. If provided, only resources of the specified type(s) are exported. * `_since`: if provided, only resources updated after the specified time are exported. * `_outputFormat`: optional, specify ndjson to export data in NDJSON format. Exported file names use the format: {export_id}_{resource_type}.ndjson. * `organizeOutputBy`: resource type to organize the output by. Required and must be set to `Patient`. When specified, output files are organized by instances of the specified resource type, including the resource, referenced resources, and resources that contain references to that resource. On success, the `Content-Location` header of response is set to a URL that you can use to query the status of the export. The URL is in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/operations/{export_id}`. See get-fhir-operation-status for more information. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error.

close()

Close httplib2 connections.

@@ -232,6 +240,35 @@

Method Details

}
+
+ bulk_export_group(name, organizeOutputBy=None, outputFormat=None, x__xgafv=None, x_since=None, x_type=None) +
Bulk exports a Group resource and resources in the member field, including related resources for each Patient member. The export for each Patient is identical to a GetPatientEverything request. Implements the FHIR implementation guide [$export group of patients](https://build.fhir.org/ig/HL7/bulk-data/export.html#endpoint---group-of-patients). The following headers must be set in the request: * `Accept`: specifies the format of the `OperationOutcome` response. Only `application/fhir+json` is supported. * `Prefer`: specifies whether the response is immediate or asynchronous. Must be to `respond-async` because only asynchronous responses are supported. Specify the destination for the server to write result files by setting the Cloud Storage location bulk_export_gcs_destination on the FHIR store. URI of an existing Cloud Storage directory where the server writes result files, in the format gs://{bucket-id}/{path/to/destination/dir}. If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced. Supports the following query parameters: * `_type`: string of comma-delimited FHIR resource types. If provided, only resources of the specified type(s) are exported. * `_since`: if provided, only resources updated after the specified time are exported. * `_outputFormat`: optional, specify ndjson to export data in NDJSON format. Exported file names use the format: {export_id}_{resource_type}.ndjson. * `organizeOutputBy`: resource type to organize the output by. Required and must be set to `Patient`. When specified, output files are organized by instances of the specified resource type, including the resource, referenced resources, and resources that contain references to that resource. On success, the `Content-Location` header of response is set to a URL that you can use to query the status of the export. The URL is in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/operations/{export_id}`. See get-fhir-operation-status for more information. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error.
+
+Args:
+  name: string, Required. Name of the Group resource that is exported, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. (required)
+  organizeOutputBy: string, Optional. Required. The FHIR resource type used to organize exported resources. Only supports "Patient". When organized by Patient resource, output files are grouped as follows: * Patient file(s) containing the Patient resources. Each Patient is sequentially followed by all resources the Patient references, and all resources that reference the Patient (equivalent to a GetPatientEverything request). * Individual files grouped by resource type for resources in the Group's member field and the Group resource itself. Resources may be duplicated across multiple Patients. For example, if two Patient resources reference the same Organization resource, it will appear twice, once after each Patient. The Group resource from the request does not appear in the Patient files.
+  outputFormat: string, Optional. Output format of the export. This field is optional and only `application/fhir+ndjson` is supported.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+  x_since: string, Optional. If provided, only resources updated after this time are exported. The time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. For example, `2015-02-07T13:28:17.239+02:00` or `2017-01-01T00:00:00Z`. The time must be specified to the second and include a time zone.
+  x_type: string, Optional. String of comma-delimited FHIR resource types. If provided, only resources of the specified resource type(s) are exported.
+
+Returns:
+  An object of the form:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+
close()
Close httplib2 connections.
@@ -247,6 +284,9 @@

Method Details

The object takes the form of: { # Represents a FHIR store. + "bulkExportGcsDestination": { # The configuration for exporting to Cloud Storage using the bulk export API. # Optional. FHIR bulk export exports resources to the specified Cloud Storage destination. A Cloud Storage destination is a URI for a Cloud Storage directory where result files will be written. Only used in the spec-defined bulk $export methods. The Cloud Healthcare Service Agent requires the `roles/storage.objectAdmin` Cloud IAM role on the destination. + "uriPrefix": "A String", # Optional. URI for a Cloud Storage directory where the server writes result files, in the format `gs://{bucket-id}/{path/to/destination/dir}`. If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced in `uri_prefix`. + }, "complexDataTypeReferenceParsing": "A String", # Optional. Enable parsing of references within complex FHIR data types such as Extensions. If this value is set to ENABLED, then features like referential integrity and Bundle reference rewriting apply to all references. If this flag has not been specified the behavior of the FHIR store will not change, references in complex data types will not be parsed. New stores will have this value set to ENABLED after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources. "consentConfig": { # Configures whether to enforce consent for the FHIR store and which consent enforcement version is being used. # Optional. Specifies whether this store has consent enforcement. Not available for DSTU2 FHIR version due to absence of Consent resources. "accessDeterminationLogConfig": { # Configures consent audit log config for FHIR create, read, update, and delete (CRUD) operations. Cloud audit log for healthcare API must be [enabled](https://cloud.google.com/logging/docs/audit/configure-data-access#config-console-enable). The consent-related logs are included as part of `protoPayload.metadata`. # Optional. Specifies how the server logs the consent-aware requests. If not specified, the `AccessDeterminationLogConfig.LogLevel.MINIMUM` option is used. @@ -417,6 +457,9 @@

Method Details

An object of the form: { # Represents a FHIR store. + "bulkExportGcsDestination": { # The configuration for exporting to Cloud Storage using the bulk export API. # Optional. FHIR bulk export exports resources to the specified Cloud Storage destination. A Cloud Storage destination is a URI for a Cloud Storage directory where result files will be written. Only used in the spec-defined bulk $export methods. The Cloud Healthcare Service Agent requires the `roles/storage.objectAdmin` Cloud IAM role on the destination. + "uriPrefix": "A String", # Optional. URI for a Cloud Storage directory where the server writes result files, in the format `gs://{bucket-id}/{path/to/destination/dir}`. If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced in `uri_prefix`. + }, "complexDataTypeReferenceParsing": "A String", # Optional. Enable parsing of references within complex FHIR data types such as Extensions. If this value is set to ENABLED, then features like referential integrity and Bundle reference rewriting apply to all references. If this flag has not been specified the behavior of the FHIR store will not change, references in complex data types will not be parsed. New stores will have this value set to ENABLED after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources. "consentConfig": { # Configures whether to enforce consent for the FHIR store and which consent enforcement version is being used. # Optional. Specifies whether this store has consent enforcement. Not available for DSTU2 FHIR version due to absence of Consent resources. "accessDeterminationLogConfig": { # Configures consent audit log config for FHIR create, read, update, and delete (CRUD) operations. Cloud audit log for healthcare API must be [enabled](https://cloud.google.com/logging/docs/audit/configure-data-access#config-console-enable). The consent-related logs are included as part of `protoPayload.metadata`. # Optional. Specifies how the server logs the consent-aware requests. If not specified, the `AccessDeterminationLogConfig.LogLevel.MINIMUM` option is used. @@ -867,6 +910,9 @@

Method Details

An object of the form: { # Represents a FHIR store. + "bulkExportGcsDestination": { # The configuration for exporting to Cloud Storage using the bulk export API. # Optional. FHIR bulk export exports resources to the specified Cloud Storage destination. A Cloud Storage destination is a URI for a Cloud Storage directory where result files will be written. Only used in the spec-defined bulk $export methods. The Cloud Healthcare Service Agent requires the `roles/storage.objectAdmin` Cloud IAM role on the destination. + "uriPrefix": "A String", # Optional. URI for a Cloud Storage directory where the server writes result files, in the format `gs://{bucket-id}/{path/to/destination/dir}`. If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced in `uri_prefix`. + }, "complexDataTypeReferenceParsing": "A String", # Optional. Enable parsing of references within complex FHIR data types such as Extensions. If this value is set to ENABLED, then features like referential integrity and Bundle reference rewriting apply to all references. If this flag has not been specified the behavior of the FHIR store will not change, references in complex data types will not be parsed. New stores will have this value set to ENABLED after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources. "consentConfig": { # Configures whether to enforce consent for the FHIR store and which consent enforcement version is being used. # Optional. Specifies whether this store has consent enforcement. Not available for DSTU2 FHIR version due to absence of Consent resources. "accessDeterminationLogConfig": { # Configures consent audit log config for FHIR create, read, update, and delete (CRUD) operations. Cloud audit log for healthcare API must be [enabled](https://cloud.google.com/logging/docs/audit/configure-data-access#config-console-enable). The consent-related logs are included as part of `protoPayload.metadata`. # Optional. Specifies how the server logs the consent-aware requests. If not specified, the `AccessDeterminationLogConfig.LogLevel.MINIMUM` option is used. @@ -1167,6 +1213,9 @@

Method Details

{ # Lists the FHIR stores in the given dataset. "fhirStores": [ # The returned FHIR stores. Won't be more FHIR stores than the value of page_size in the request. { # Represents a FHIR store. + "bulkExportGcsDestination": { # The configuration for exporting to Cloud Storage using the bulk export API. # Optional. FHIR bulk export exports resources to the specified Cloud Storage destination. A Cloud Storage destination is a URI for a Cloud Storage directory where result files will be written. Only used in the spec-defined bulk $export methods. The Cloud Healthcare Service Agent requires the `roles/storage.objectAdmin` Cloud IAM role on the destination. + "uriPrefix": "A String", # Optional. URI for a Cloud Storage directory where the server writes result files, in the format `gs://{bucket-id}/{path/to/destination/dir}`. If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced in `uri_prefix`. + }, "complexDataTypeReferenceParsing": "A String", # Optional. Enable parsing of references within complex FHIR data types such as Extensions. If this value is set to ENABLED, then features like referential integrity and Bundle reference rewriting apply to all references. If this flag has not been specified the behavior of the FHIR store will not change, references in complex data types will not be parsed. New stores will have this value set to ENABLED after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources. "consentConfig": { # Configures whether to enforce consent for the FHIR store and which consent enforcement version is being used. # Optional. Specifies whether this store has consent enforcement. Not available for DSTU2 FHIR version due to absence of Consent resources. "accessDeterminationLogConfig": { # Configures consent audit log config for FHIR create, read, update, and delete (CRUD) operations. Cloud audit log for healthcare API must be [enabled](https://cloud.google.com/logging/docs/audit/configure-data-access#config-console-enable). The consent-related logs are included as part of `protoPayload.metadata`. # Optional. Specifies how the server logs the consent-aware requests. If not specified, the `AccessDeterminationLogConfig.LogLevel.MINIMUM` option is used. @@ -1355,6 +1404,9 @@

Method Details

The object takes the form of: { # Represents a FHIR store. + "bulkExportGcsDestination": { # The configuration for exporting to Cloud Storage using the bulk export API. # Optional. FHIR bulk export exports resources to the specified Cloud Storage destination. A Cloud Storage destination is a URI for a Cloud Storage directory where result files will be written. Only used in the spec-defined bulk $export methods. The Cloud Healthcare Service Agent requires the `roles/storage.objectAdmin` Cloud IAM role on the destination. + "uriPrefix": "A String", # Optional. URI for a Cloud Storage directory where the server writes result files, in the format `gs://{bucket-id}/{path/to/destination/dir}`. If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced in `uri_prefix`. + }, "complexDataTypeReferenceParsing": "A String", # Optional. Enable parsing of references within complex FHIR data types such as Extensions. If this value is set to ENABLED, then features like referential integrity and Bundle reference rewriting apply to all references. If this flag has not been specified the behavior of the FHIR store will not change, references in complex data types will not be parsed. New stores will have this value set to ENABLED after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources. "consentConfig": { # Configures whether to enforce consent for the FHIR store and which consent enforcement version is being used. # Optional. Specifies whether this store has consent enforcement. Not available for DSTU2 FHIR version due to absence of Consent resources. "accessDeterminationLogConfig": { # Configures consent audit log config for FHIR create, read, update, and delete (CRUD) operations. Cloud audit log for healthcare API must be [enabled](https://cloud.google.com/logging/docs/audit/configure-data-access#config-console-enable). The consent-related logs are included as part of `protoPayload.metadata`. # Optional. Specifies how the server logs the consent-aware requests. If not specified, the `AccessDeterminationLogConfig.LogLevel.MINIMUM` option is used. @@ -1525,6 +1577,9 @@

Method Details

An object of the form: { # Represents a FHIR store. + "bulkExportGcsDestination": { # The configuration for exporting to Cloud Storage using the bulk export API. # Optional. FHIR bulk export exports resources to the specified Cloud Storage destination. A Cloud Storage destination is a URI for a Cloud Storage directory where result files will be written. Only used in the spec-defined bulk $export methods. The Cloud Healthcare Service Agent requires the `roles/storage.objectAdmin` Cloud IAM role on the destination. + "uriPrefix": "A String", # Optional. URI for a Cloud Storage directory where the server writes result files, in the format `gs://{bucket-id}/{path/to/destination/dir}`. If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced in `uri_prefix`. + }, "complexDataTypeReferenceParsing": "A String", # Optional. Enable parsing of references within complex FHIR data types such as Extensions. If this value is set to ENABLED, then features like referential integrity and Bundle reference rewriting apply to all references. If this flag has not been specified the behavior of the FHIR store will not change, references in complex data types will not be parsed. New stores will have this value set to ENABLED after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources. "consentConfig": { # Configures whether to enforce consent for the FHIR store and which consent enforcement version is being used. # Optional. Specifies whether this store has consent enforcement. Not available for DSTU2 FHIR version due to absence of Consent resources. "accessDeterminationLogConfig": { # Configures consent audit log config for FHIR create, read, update, and delete (CRUD) operations. Cloud audit log for healthcare API must be [enabled](https://cloud.google.com/logging/docs/audit/configure-data-access#config-console-enable). The consent-related logs are included as part of `protoPayload.metadata`. # Optional. Specifies how the server logs the consent-aware requests. If not specified, the `AccessDeterminationLogConfig.LogLevel.MINIMUM` option is used. diff --git a/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.operations.html b/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.operations.html new file mode 100644 index 00000000000..a6f7481df31 --- /dev/null +++ b/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.operations.html @@ -0,0 +1,142 @@ + + + +

Cloud Healthcare API . projects . locations . datasets . fhirStores . operations

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ delete_fhir_operation(name, x__xgafv=None)

+

Deletes operations as defined in the FHIR specification. Implements the FHIR implementation guide [bulk data delete request](https://build.fhir.org/ig/HL7/bulk-data/export.html#bulk-data-delete-request). Returns success if the operation was successfully cancelled. If the operation is complete, or has already been cancelled, returns an error response.

+

+ get_fhir_operation_status(name, x__xgafv=None)

+

Gets the status of operations as defined in the FHIR specification. Implements the FHIR implementation guide [bulk data status request](https://build.fhir.org/ig/HL7/bulk-data/export.html#bulk-data-status-request). Operations can have one of these states: * in-progress: response status code is `202` and `X-Progress` header is set to `in progress`. * complete: response status code is `200` and the body is a JSON-encoded operation response as defined by the spec. For a bulk export, this response is defined in https://build.fhir.org/ig/HL7/bulk-data/export.html#response---complete-status. * error: response status code is `5XX`, and the body is a JSON-encoded `OperationOutcome` resource describing the reason for the error.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ delete_fhir_operation(name, x__xgafv=None) +
Deletes operations as defined in the FHIR specification. Implements the FHIR implementation guide [bulk data delete request](https://build.fhir.org/ig/HL7/bulk-data/export.html#bulk-data-delete-request). Returns success if the operation was successfully cancelled. If the operation is complete, or has already been cancelled, returns an error response.
+
+Args:
+  name: string, Required. Name of the operation to be deleted, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/operations/{operation_id}`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+ +
+ get_fhir_operation_status(name, x__xgafv=None) +
Gets the status of operations as defined in the FHIR specification. Implements the FHIR implementation guide [bulk data status request](https://build.fhir.org/ig/HL7/bulk-data/export.html#bulk-data-status-request). Operations can have one of these states: * in-progress: response status code is `202` and `X-Progress` header is set to `in progress`. * complete: response status code is `200` and the body is a JSON-encoded operation response as defined by the spec. For a bulk export, this response is defined in https://build.fhir.org/ig/HL7/bulk-data/export.html#response---complete-status. * error: response status code is `5XX`, and the body is a JSON-encoded `OperationOutcome` resource describing the reason for the error.
+
+Args:
+  name: string, Required. Name of the operation to query, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/operations/{operation_id}`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.fhir.html b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.fhir.html index cb139dc2cdf..c5fb6ba2e40 100644 --- a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.fhir.html +++ b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.fhir.html @@ -116,6 +116,9 @@

Instance Methods

Resource_validate(parent, type, body=None, profile=None, x__xgafv=None)

Validates an input FHIR resource's conformance to its profiles and the profiles configured on the FHIR store. Implements the FHIR extended operation $validate ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resource-operations.html#validate), [STU3](http://hl7.org/implement/standards/fhir/STU3/resource-operations.html#validate), or [R4](http://hl7.org/implement/standards/fhir/R4/resource-operation-validate.html)). The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The `Parameters` input syntax is not supported. The `profile` query parameter can be used to request that the resource only be validated against a specific profile. If a profile with the given URL cannot be found in the FHIR store then an error is returned. Errors generated by validation contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead.

+

+ bulk_export(name, outputFormat=None, x__xgafv=None, x_since=None, x_type=None)

+

Bulk exports all resources from the FHIR store to the specified destination. Implements the FHIR implementation guide [system level $export](https://build.fhir.org/ig/HL7/bulk-data/export.html#endpoint---system-level-export. The following headers must be set in the request: * `Accept`: specifies the format of the `OperationOutcome` response. Only `application/fhir+json` is supported. * `Prefer`: specifies whether the response is immediate or asynchronous. Must be to `respond-async` because only asynchronous responses are supported. Specify the destination for the server to write result files by setting the Cloud Storage location bulk_export_gcs_destination on the FHIR store. URI of an existing Cloud Storage directory where the server writes result files, in the format gs://{bucket-id}/{path/to/destination/dir}. If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced. Supports the following query parameters: * `_type`: string of comma-delimited FHIR resource types. If provided, only the resources of the specified type(s) are exported. * `_since`: if provided, only the resources that are updated after the specified time are exported. * `_outputFormat`: optional, specify ndjson to export data in NDJSON format. Exported file names use the format: {export_id}_{resource_type}.ndjson. On success, the `Content-Location` header of the response is set to a URL that the user can use to query the status of the export. The URL is in the format: `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/operations/{export_id}`. See get-fhir-operation-status for more information. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error.

capabilities(name, x__xgafv=None)

Gets the FHIR capability statement ([STU3](https://hl7.org/implement/standards/fhir/STU3/capabilitystatement.html), [R4](https://hl7.org/implement/standards/fhir/R4/capabilitystatement.html)), or the [conformance statement](https://hl7.org/implement/standards/fhir/DSTU2/conformance.html) in the DSTU2 case for the store, which contains a description of functionality supported by the server. Implements the FHIR standard capabilities interaction ([STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#capabilities), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#capabilities)), or the [conformance interaction](https://hl7.org/implement/standards/fhir/DSTU2/http.html#conformance) in the DSTU2 case. On success, the response body contains a JSON-encoded representation of a `CapabilityStatement` resource.

@@ -572,6 +575,34 @@

Method Details

}
+
+ bulk_export(name, outputFormat=None, x__xgafv=None, x_since=None, x_type=None) +
Bulk exports all resources from the FHIR store to the specified destination. Implements the FHIR implementation guide [system level $export](https://build.fhir.org/ig/HL7/bulk-data/export.html#endpoint---system-level-export. The following headers must be set in the request: * `Accept`: specifies the format of the `OperationOutcome` response. Only `application/fhir+json` is supported. * `Prefer`: specifies whether the response is immediate or asynchronous. Must be to `respond-async` because only asynchronous responses are supported. Specify the destination for the server to write result files by setting the Cloud Storage location bulk_export_gcs_destination on the FHIR store. URI of an existing Cloud Storage directory where the server writes result files, in the format gs://{bucket-id}/{path/to/destination/dir}. If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced. Supports the following query parameters: * `_type`: string of comma-delimited FHIR resource types. If provided, only the resources of the specified type(s) are exported. * `_since`: if provided, only the resources that are updated after the specified time are exported. * `_outputFormat`: optional, specify ndjson to export data in NDJSON format. Exported file names use the format: {export_id}_{resource_type}.ndjson. On success, the `Content-Location` header of the response is set to a URL that the user can use to query the status of the export. The URL is in the format: `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/operations/{export_id}`. See get-fhir-operation-status for more information. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error.
+
+Args:
+  name: string, Required. The name of the FHIR store to export resources from, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. (required)
+  outputFormat: string, Optional. Output format of the export. This field is optional and only `application/fhir+ndjson` is supported.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+  x_since: string, Optional. If provided, only resources updated after this time are exported. The time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. For example, `2015-02-07T13:28:17.239+02:00` or `2017-01-01T00:00:00Z`. The time must be specified to the second and include a time zone.
+  x_type: string, Optional. String of comma-delimited FHIR resource types. If provided, only resources of the specified resource type(s) are exported.
+
+Returns:
+  An object of the form:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+
capabilities(name, x__xgafv=None)
Gets the FHIR capability statement ([STU3](https://hl7.org/implement/standards/fhir/STU3/capabilitystatement.html), [R4](https://hl7.org/implement/standards/fhir/R4/capabilitystatement.html)), or the [conformance statement](https://hl7.org/implement/standards/fhir/DSTU2/conformance.html) in the DSTU2 case for the store, which contains a description of functionality supported by the server. Implements the FHIR standard capabilities interaction ([STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#capabilities), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#capabilities)), or the [conformance interaction](https://hl7.org/implement/standards/fhir/DSTU2/http.html#conformance) in the DSTU2 case. On success, the response body contains a JSON-encoded representation of a `CapabilityStatement` resource.
diff --git a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.html b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.html
index d2a1edecaa3..6189f4c5e05 100644
--- a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.html
+++ b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.html
@@ -79,12 +79,20 @@ 

Instance Methods

Returns the fhir Resource.

+

+ operations() +

+

Returns the operations Resource.

+

applyAdminConsents(name, body=None, x__xgafv=None)

Applies the admin Consent resources for the FHIR store and reindexes the underlying resources in the FHIR store according to the aggregate consents. This method also updates the `consent_config.enforced_admin_consents` field of the FhirStore unless `validate_only=true` in ApplyAdminConsentsRequest. Any admin Consent resource change after this operation execution (including deletion) requires you to call ApplyAdminConsents again for the change to take effect. This method returns an Operation that can be used to track the progress of the resources that were reindexed, by calling GetOperation. Upon completion, the ApplyAdminConsentsResponse additionally contains the number of resources that were reindexed. If at least one Consent resource contains an error or fails be be enforced for any reason, the method returns an error instead of an Operation. No resources will be reindexed and the `consent_config.enforced_admin_consents` field will be unchanged. To enforce a consent check for data access, `consent_config.access_enforced` must be set to true for the FhirStore.

applyConsents(name, body=None, x__xgafv=None)

Apply the Consent resources for the FHIR store and reindex the underlying resources in the FHIR store according to the aggregate consent. The aggregate consent of the patient in scope in this request replaces any previous call of this method. Any Consent resource change after this operation execution (including deletion) requires you to call ApplyConsents again to have effect. This method returns an Operation that can be used to track the progress of the consent resources that were processed by calling GetOperation. Upon completion, the ApplyConsentsResponse additionally contains the number of resources that was reindexed. Errors are logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). To enforce consent check for data access, `consent_config.access_enforced` must be set to true for the FhirStore.

+

+ bulk_export_group(name, organizeOutputBy=None, outputFormat=None, x__xgafv=None, x_since=None, x_type=None)

+

Bulk exports a Group resource and resources in the member field, including related resources for each Patient member. The export for each Patient is identical to a GetPatientEverything request. Implements the FHIR implementation guide [$export group of patients](https://build.fhir.org/ig/HL7/bulk-data/export.html#endpoint---group-of-patients). The following headers must be set in the request: * `Accept`: specifies the format of the `OperationOutcome` response. Only `application/fhir+json` is supported. * `Prefer`: specifies whether the response is immediate or asynchronous. Must be to `respond-async` because only asynchronous responses are supported. Specify the destination for the server to write result files by setting the Cloud Storage location bulk_export_gcs_destination on the FHIR store. URI of an existing Cloud Storage directory where the server writes result files, in the format gs://{bucket-id}/{path/to/destination/dir}. If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced. Supports the following query parameters: * `_type`: string of comma-delimited FHIR resource types. If provided, only resources of the specified type(s) are exported. * `_since`: if provided, only resources updated after the specified time are exported. * `_outputFormat`: optional, specify ndjson to export data in NDJSON format. Exported file names use the format: {export_id}_{resource_type}.ndjson. * `organizeOutputBy`: resource type to organize the output by. Required and must be set to `Patient`. When specified, output files are organized by instances of the specified resource type, including the resource, referenced resources, and resources that contain references to that resource. On success, the `Content-Location` header of response is set to a URL that you can use to query the status of the export. The URL is in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/operations/{export_id}`. See get-fhir-operation-status for more information. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error.

close()

Close httplib2 connections.

@@ -241,6 +249,35 @@

Method Details

}
+
+ bulk_export_group(name, organizeOutputBy=None, outputFormat=None, x__xgafv=None, x_since=None, x_type=None) +
Bulk exports a Group resource and resources in the member field, including related resources for each Patient member. The export for each Patient is identical to a GetPatientEverything request. Implements the FHIR implementation guide [$export group of patients](https://build.fhir.org/ig/HL7/bulk-data/export.html#endpoint---group-of-patients). The following headers must be set in the request: * `Accept`: specifies the format of the `OperationOutcome` response. Only `application/fhir+json` is supported. * `Prefer`: specifies whether the response is immediate or asynchronous. Must be to `respond-async` because only asynchronous responses are supported. Specify the destination for the server to write result files by setting the Cloud Storage location bulk_export_gcs_destination on the FHIR store. URI of an existing Cloud Storage directory where the server writes result files, in the format gs://{bucket-id}/{path/to/destination/dir}. If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced. Supports the following query parameters: * `_type`: string of comma-delimited FHIR resource types. If provided, only resources of the specified type(s) are exported. * `_since`: if provided, only resources updated after the specified time are exported. * `_outputFormat`: optional, specify ndjson to export data in NDJSON format. Exported file names use the format: {export_id}_{resource_type}.ndjson. * `organizeOutputBy`: resource type to organize the output by. Required and must be set to `Patient`. When specified, output files are organized by instances of the specified resource type, including the resource, referenced resources, and resources that contain references to that resource. On success, the `Content-Location` header of response is set to a URL that you can use to query the status of the export. The URL is in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/operations/{export_id}`. See get-fhir-operation-status for more information. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error.
+
+Args:
+  name: string, Required. Name of the `Group` resource that is exported, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. (required)
+  organizeOutputBy: string, Optional. Required. The FHIR resource type used to organize exported resources. Only supports "Patient". When organized by Patient resource, output files are grouped as follows: * Patient file(s) containing the Patient resources. Each Patient is sequentially followed by all resources the Patient references, and all resources that reference the Patient (equivalent to a GetPatientEverything request). * Individual files grouped by resource type for resources in the Group's member field and the Group resource itself. Resources may be duplicated across multiple Patients. For example, if two Patient resources reference the same Organization resource, it will appear twice, once after each Patient. The Group resource from the request does not appear in the Patient files.
+  outputFormat: string, Optional. Output format of the export. This field is optional and only `application/fhir+ndjson` is supported.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+  x_since: string, Optional. If provided, only resources updated after this time are exported. The time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. For example, `2015-02-07T13:28:17.239+02:00` or `2017-01-01T00:00:00Z`. The time must be specified to the second and include a time zone.
+  x_type: string, Optional. String of comma-delimited FHIR resource types. If provided, only resources of the specified resource type(s) are exported.
+
+Returns:
+  An object of the form:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+
close()
Close httplib2 connections.
@@ -301,6 +338,9 @@

Method Details

The object takes the form of: { # Represents a FHIR store. + "bulkExportGcsDestination": { # The configuration for exporting to Cloud Storage using the bulk export API. # Optional. FHIR bulk export exports resources to the specified Cloud Storage destination. A Cloud Storage destination is a URI for a Cloud Storage directory where result files will be written. Only used in the spec-defined bulk $export methods. The Cloud Healthcare Service Agent requires the `roles/storage.objectAdmin` Cloud IAM role on the destination. + "uriPrefix": "A String", # Optional. URI for a Cloud Storage directory where the server writes result files, in the format `gs://{bucket-id}/{path/to/destination/dir}`. If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced in `uri_prefix`. + }, "complexDataTypeReferenceParsing": "A String", # Enable parsing of references within complex FHIR data types such as Extensions. If this value is set to ENABLED, then features like referential integrity and Bundle reference rewriting apply to all references. If this flag has not been specified the behavior of the FHIR store will not change, references in complex data types will not be parsed. New stores will have this value set to ENABLED after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources. "consentConfig": { # Configures whether to enforce consent for the FHIR store and which consent enforcement version is being used. # Optional. Specifies whether this store has consent enforcement. Not available for DSTU2 FHIR version due to absence of Consent resources. "accessDeterminationLogConfig": { # Configures consent audit log config for FHIR create, read, update, and delete (CRUD) operations. Cloud audit log for healthcare API must be [enabled](https://cloud.google.com/logging/docs/audit/configure-data-access#config-console-enable). The consent-related logs are included as part of `protoPayload.metadata`. # Optional. Specifies how the server logs the consent-aware requests. If not specified, the `AccessDeterminationLogConfig.LogLevel.MINIMUM` option is used. @@ -591,6 +631,9 @@

Method Details

An object of the form: { # Represents a FHIR store. + "bulkExportGcsDestination": { # The configuration for exporting to Cloud Storage using the bulk export API. # Optional. FHIR bulk export exports resources to the specified Cloud Storage destination. A Cloud Storage destination is a URI for a Cloud Storage directory where result files will be written. Only used in the spec-defined bulk $export methods. The Cloud Healthcare Service Agent requires the `roles/storage.objectAdmin` Cloud IAM role on the destination. + "uriPrefix": "A String", # Optional. URI for a Cloud Storage directory where the server writes result files, in the format `gs://{bucket-id}/{path/to/destination/dir}`. If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced in `uri_prefix`. + }, "complexDataTypeReferenceParsing": "A String", # Enable parsing of references within complex FHIR data types such as Extensions. If this value is set to ENABLED, then features like referential integrity and Bundle reference rewriting apply to all references. If this flag has not been specified the behavior of the FHIR store will not change, references in complex data types will not be parsed. New stores will have this value set to ENABLED after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources. "consentConfig": { # Configures whether to enforce consent for the FHIR store and which consent enforcement version is being used. # Optional. Specifies whether this store has consent enforcement. Not available for DSTU2 FHIR version due to absence of Consent resources. "accessDeterminationLogConfig": { # Configures consent audit log config for FHIR create, read, update, and delete (CRUD) operations. Cloud audit log for healthcare API must be [enabled](https://cloud.google.com/logging/docs/audit/configure-data-access#config-console-enable). The consent-related logs are included as part of `protoPayload.metadata`. # Optional. Specifies how the server logs the consent-aware requests. If not specified, the `AccessDeterminationLogConfig.LogLevel.MINIMUM` option is used. @@ -1319,6 +1362,9 @@

Method Details

An object of the form: { # Represents a FHIR store. + "bulkExportGcsDestination": { # The configuration for exporting to Cloud Storage using the bulk export API. # Optional. FHIR bulk export exports resources to the specified Cloud Storage destination. A Cloud Storage destination is a URI for a Cloud Storage directory where result files will be written. Only used in the spec-defined bulk $export methods. The Cloud Healthcare Service Agent requires the `roles/storage.objectAdmin` Cloud IAM role on the destination. + "uriPrefix": "A String", # Optional. URI for a Cloud Storage directory where the server writes result files, in the format `gs://{bucket-id}/{path/to/destination/dir}`. If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced in `uri_prefix`. + }, "complexDataTypeReferenceParsing": "A String", # Enable parsing of references within complex FHIR data types such as Extensions. If this value is set to ENABLED, then features like referential integrity and Bundle reference rewriting apply to all references. If this flag has not been specified the behavior of the FHIR store will not change, references in complex data types will not be parsed. New stores will have this value set to ENABLED after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources. "consentConfig": { # Configures whether to enforce consent for the FHIR store and which consent enforcement version is being used. # Optional. Specifies whether this store has consent enforcement. Not available for DSTU2 FHIR version due to absence of Consent resources. "accessDeterminationLogConfig": { # Configures consent audit log config for FHIR create, read, update, and delete (CRUD) operations. Cloud audit log for healthcare API must be [enabled](https://cloud.google.com/logging/docs/audit/configure-data-access#config-console-enable). The consent-related logs are included as part of `protoPayload.metadata`. # Optional. Specifies how the server logs the consent-aware requests. If not specified, the `AccessDeterminationLogConfig.LogLevel.MINIMUM` option is used. @@ -1785,6 +1831,9 @@

Method Details

{ # Lists the FHIR stores in the given dataset. "fhirStores": [ # The returned FHIR stores. Won't be more FHIR stores than the value of page_size in the request. { # Represents a FHIR store. + "bulkExportGcsDestination": { # The configuration for exporting to Cloud Storage using the bulk export API. # Optional. FHIR bulk export exports resources to the specified Cloud Storage destination. A Cloud Storage destination is a URI for a Cloud Storage directory where result files will be written. Only used in the spec-defined bulk $export methods. The Cloud Healthcare Service Agent requires the `roles/storage.objectAdmin` Cloud IAM role on the destination. + "uriPrefix": "A String", # Optional. URI for a Cloud Storage directory where the server writes result files, in the format `gs://{bucket-id}/{path/to/destination/dir}`. If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced in `uri_prefix`. + }, "complexDataTypeReferenceParsing": "A String", # Enable parsing of references within complex FHIR data types such as Extensions. If this value is set to ENABLED, then features like referential integrity and Bundle reference rewriting apply to all references. If this flag has not been specified the behavior of the FHIR store will not change, references in complex data types will not be parsed. New stores will have this value set to ENABLED after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources. "consentConfig": { # Configures whether to enforce consent for the FHIR store and which consent enforcement version is being used. # Optional. Specifies whether this store has consent enforcement. Not available for DSTU2 FHIR version due to absence of Consent resources. "accessDeterminationLogConfig": { # Configures consent audit log config for FHIR create, read, update, and delete (CRUD) operations. Cloud audit log for healthcare API must be [enabled](https://cloud.google.com/logging/docs/audit/configure-data-access#config-console-enable). The consent-related logs are included as part of `protoPayload.metadata`. # Optional. Specifies how the server logs the consent-aware requests. If not specified, the `AccessDeterminationLogConfig.LogLevel.MINIMUM` option is used. @@ -2093,6 +2142,9 @@

Method Details

The object takes the form of: { # Represents a FHIR store. + "bulkExportGcsDestination": { # The configuration for exporting to Cloud Storage using the bulk export API. # Optional. FHIR bulk export exports resources to the specified Cloud Storage destination. A Cloud Storage destination is a URI for a Cloud Storage directory where result files will be written. Only used in the spec-defined bulk $export methods. The Cloud Healthcare Service Agent requires the `roles/storage.objectAdmin` Cloud IAM role on the destination. + "uriPrefix": "A String", # Optional. URI for a Cloud Storage directory where the server writes result files, in the format `gs://{bucket-id}/{path/to/destination/dir}`. If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced in `uri_prefix`. + }, "complexDataTypeReferenceParsing": "A String", # Enable parsing of references within complex FHIR data types such as Extensions. If this value is set to ENABLED, then features like referential integrity and Bundle reference rewriting apply to all references. If this flag has not been specified the behavior of the FHIR store will not change, references in complex data types will not be parsed. New stores will have this value set to ENABLED after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources. "consentConfig": { # Configures whether to enforce consent for the FHIR store and which consent enforcement version is being used. # Optional. Specifies whether this store has consent enforcement. Not available for DSTU2 FHIR version due to absence of Consent resources. "accessDeterminationLogConfig": { # Configures consent audit log config for FHIR create, read, update, and delete (CRUD) operations. Cloud audit log for healthcare API must be [enabled](https://cloud.google.com/logging/docs/audit/configure-data-access#config-console-enable). The consent-related logs are included as part of `protoPayload.metadata`. # Optional. Specifies how the server logs the consent-aware requests. If not specified, the `AccessDeterminationLogConfig.LogLevel.MINIMUM` option is used. @@ -2383,6 +2435,9 @@

Method Details

An object of the form: { # Represents a FHIR store. + "bulkExportGcsDestination": { # The configuration for exporting to Cloud Storage using the bulk export API. # Optional. FHIR bulk export exports resources to the specified Cloud Storage destination. A Cloud Storage destination is a URI for a Cloud Storage directory where result files will be written. Only used in the spec-defined bulk $export methods. The Cloud Healthcare Service Agent requires the `roles/storage.objectAdmin` Cloud IAM role on the destination. + "uriPrefix": "A String", # Optional. URI for a Cloud Storage directory where the server writes result files, in the format `gs://{bucket-id}/{path/to/destination/dir}`. If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced in `uri_prefix`. + }, "complexDataTypeReferenceParsing": "A String", # Enable parsing of references within complex FHIR data types such as Extensions. If this value is set to ENABLED, then features like referential integrity and Bundle reference rewriting apply to all references. If this flag has not been specified the behavior of the FHIR store will not change, references in complex data types will not be parsed. New stores will have this value set to ENABLED after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources. "consentConfig": { # Configures whether to enforce consent for the FHIR store and which consent enforcement version is being used. # Optional. Specifies whether this store has consent enforcement. Not available for DSTU2 FHIR version due to absence of Consent resources. "accessDeterminationLogConfig": { # Configures consent audit log config for FHIR create, read, update, and delete (CRUD) operations. Cloud audit log for healthcare API must be [enabled](https://cloud.google.com/logging/docs/audit/configure-data-access#config-console-enable). The consent-related logs are included as part of `protoPayload.metadata`. # Optional. Specifies how the server logs the consent-aware requests. If not specified, the `AccessDeterminationLogConfig.LogLevel.MINIMUM` option is used. diff --git a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.operations.html b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.operations.html new file mode 100644 index 00000000000..283b9fa93ea --- /dev/null +++ b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.operations.html @@ -0,0 +1,142 @@ + + + +

Cloud Healthcare API . projects . locations . datasets . fhirStores . operations

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ delete_fhir_operation(name, x__xgafv=None)

+

Deletes operations as defined in the FHIR specification. Implements the FHIR implementation guide [bulk data delete request](https://build.fhir.org/ig/HL7/bulk-data/export.html#bulk-data-delete-request). Returns success if the operation was successfully cancelled. If the operation is complete, or has already been cancelled, returns an error response.

+

+ get_fhir_operation_status(name, x__xgafv=None)

+

Gets the status of operations as defined in the FHIR specification. Implements the FHIR implementation guide [bulk data status request](https://build.fhir.org/ig/HL7/bulk-data/export.html#bulk-data-status-request). Operations can have one of these states: * in-progress: response status code is `202` and `X-Progress` header is set to `in progress`. * complete: response status code is `200` and the body is a JSON-encoded operation response as defined by the spec. For a bulk export, this response is defined in https://build.fhir.org/ig/HL7/bulk-data/export.html#response---complete-status. * error: response status code is `5XX`, and the body is a JSON-encoded `OperationOutcome` resource describing the reason for the error.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ delete_fhir_operation(name, x__xgafv=None) +
Deletes operations as defined in the FHIR specification. Implements the FHIR implementation guide [bulk data delete request](https://build.fhir.org/ig/HL7/bulk-data/export.html#bulk-data-delete-request). Returns success if the operation was successfully cancelled. If the operation is complete, or has already been cancelled, returns an error response.
+
+Args:
+  name: string, Required. Name of the operation to be deleted, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/operations/{operation_id}`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+ +
+ get_fhir_operation_status(name, x__xgafv=None) +
Gets the status of operations as defined in the FHIR specification. Implements the FHIR implementation guide [bulk data status request](https://build.fhir.org/ig/HL7/bulk-data/export.html#bulk-data-status-request). Operations can have one of these states: * in-progress: response status code is `202` and `X-Progress` header is set to `in progress`. * complete: response status code is `200` and the body is a JSON-encoded operation response as defined by the spec. For a bulk export, this response is defined in https://build.fhir.org/ig/HL7/bulk-data/export.html#response---complete-status. * error: response status code is `5XX`, and the body is a JSON-encoded `OperationOutcome` resource describing the reason for the error.
+
+Args:
+  name: string, Required. Name of the operation to query, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/operations/{operation_id}`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+ + \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/healthcare.v1.json b/googleapiclient/discovery_cache/documents/healthcare.v1.json index 098639c6b25..d6f6fe32d48 100644 --- a/googleapiclient/discovery_cache/documents/healthcare.v1.json +++ b/googleapiclient/discovery_cache/documents/healthcare.v1.json @@ -3010,6 +3010,52 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"bulk-export-group": { +"description": "Bulk exports a Group resource and resources in the member field, including related resources for each Patient member. The export for each Patient is identical to a GetPatientEverything request. Implements the FHIR implementation guide [$export group of patients](https://build.fhir.org/ig/HL7/bulk-data/export.html#endpoint---group-of-patients). The following headers must be set in the request: * `Accept`: specifies the format of the `OperationOutcome` response. Only `application/fhir+json` is supported. * `Prefer`: specifies whether the response is immediate or asynchronous. Must be to `respond-async` because only asynchronous responses are supported. Specify the destination for the server to write result files by setting the Cloud Storage location bulk_export_gcs_destination on the FHIR store. URI of an existing Cloud Storage directory where the server writes result files, in the format gs://{bucket-id}/{path/to/destination/dir}. If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced. Supports the following query parameters: * `_type`: string of comma-delimited FHIR resource types. If provided, only resources of the specified type(s) are exported. * `_since`: if provided, only resources updated after the specified time are exported. * `_outputFormat`: optional, specify ndjson to export data in NDJSON format. Exported file names use the format: {export_id}_{resource_type}.ndjson. * `organizeOutputBy`: resource type to organize the output by. Required and must be set to `Patient`. When specified, output files are organized by instances of the specified resource type, including the resource, referenced resources, and resources that contain references to that resource. On success, the `Content-Location` header of response is set to a URL that you can use to query the status of the export. The URL is in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/operations/{export_id}`. See get-fhir-operation-status for more information. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Group/{GroupId}/$export", +"httpMethod": "GET", +"id": "healthcare.projects.locations.datasets.fhirStores.bulk-export-group", +"parameterOrder": [ +"name" +], +"parameters": { +"_since": { +"description": "Optional. If provided, only resources updated after this time are exported. The time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. For example, `2015-02-07T13:28:17.239+02:00` or `2017-01-01T00:00:00Z`. The time must be specified to the second and include a time zone.", +"location": "query", +"type": "string" +}, +"_type": { +"description": "Optional. String of comma-delimited FHIR resource types. If provided, only resources of the specified resource type(s) are exported.", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. Name of the Group resource that is exported, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/fhirStores/[^/]+/fhir/Group/[^/]+$", +"required": true, +"type": "string" +}, +"organizeOutputBy": { +"description": "Optional. Required. The FHIR resource type used to organize exported resources. Only supports \"Patient\". When organized by Patient resource, output files are grouped as follows: * Patient file(s) containing the Patient resources. Each Patient is sequentially followed by all resources the Patient references, and all resources that reference the Patient (equivalent to a GetPatientEverything request). * Individual files grouped by resource type for resources in the Group's member field and the Group resource itself. Resources may be duplicated across multiple Patients. For example, if two Patient resources reference the same Organization resource, it will appear twice, once after each Patient. The Group resource from the request does not appear in the Patient files.", +"location": "query", +"type": "string" +}, +"outputFormat": { +"description": "Optional. Output format of the export. This field is optional and only `application/fhir+ndjson` is supported.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}/$export", +"response": { +"$ref": "HttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-healthcare", +"https://www.googleapis.com/auth/cloud-platform" +] +}, "create": { "description": "Creates a new FHIR store within the parent dataset.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores", @@ -3738,6 +3784,47 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"bulk-export": { +"description": "Bulk exports all resources from the FHIR store to the specified destination. Implements the FHIR implementation guide [system level $export](https://build.fhir.org/ig/HL7/bulk-data/export.html#endpoint---system-level-export. The following headers must be set in the request: * `Accept`: specifies the format of the `OperationOutcome` response. Only `application/fhir+json` is supported. * `Prefer`: specifies whether the response is immediate or asynchronous. Must be to `respond-async` because only asynchronous responses are supported. Specify the destination for the server to write result files by setting the Cloud Storage location bulk_export_gcs_destination on the FHIR store. URI of an existing Cloud Storage directory where the server writes result files, in the format gs://{bucket-id}/{path/to/destination/dir}. If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced. Supports the following query parameters: * `_type`: string of comma-delimited FHIR resource types. If provided, only the resources of the specified type(s) are exported. * `_since`: if provided, only the resources that are updated after the specified time are exported. * `_outputFormat`: optional, specify ndjson to export data in NDJSON format. Exported file names use the format: {export_id}_{resource_type}.ndjson. On success, the `Content-Location` header of the response is set to a URL that the user can use to query the status of the export. The URL is in the format: `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/operations/{export_id}`. See get-fhir-operation-status for more information. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/$export", +"httpMethod": "GET", +"id": "healthcare.projects.locations.datasets.fhirStores.fhir.bulk-export", +"parameterOrder": [ +"name" +], +"parameters": { +"_since": { +"description": "Optional. If provided, only resources updated after this time are exported. The time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. For example, `2015-02-07T13:28:17.239+02:00` or `2017-01-01T00:00:00Z`. The time must be specified to the second and include a time zone.", +"location": "query", +"type": "string" +}, +"_type": { +"description": "Optional. String of comma-delimited FHIR resource types. If provided, only resources of the specified resource type(s) are exported.", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. The name of the FHIR store to export resources from, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/fhirStores/[^/]+$", +"required": true, +"type": "string" +}, +"outputFormat": { +"description": "Optional. Output format of the export. This field is optional and only `application/fhir+ndjson` is supported.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}/fhir/$export", +"response": { +"$ref": "HttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-healthcare", +"https://www.googleapis.com/auth/cloud-platform" +] +}, "capabilities": { "description": "Gets the FHIR capability statement ([STU3](http://hl7.org/implement/standards/fhir/STU3/capabilitystatement.html), [R4](http://hl7.org/implement/standards/fhir/R4/capabilitystatement.html)), or the [conformance statement](http://hl7.org/implement/standards/fhir/DSTU2/conformance.html) in the DSTU2 case for the store, which contains a description of functionality supported by the server. Implements the FHIR standard capabilities interaction ([STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#capabilities), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#capabilities)), or the [conformance interaction](http://hl7.org/implement/standards/fhir/DSTU2/http.html#conformance) in the DSTU2 case. On success, the response body contains a JSON-encoded representation of a `CapabilityStatement` resource.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/metadata", @@ -4187,6 +4274,62 @@ ] } } +}, +"operations": { +"methods": { +"delete-fhir-operation": { +"description": "Deletes operations as defined in the FHIR specification. Implements the FHIR implementation guide [bulk data delete request](https://build.fhir.org/ig/HL7/bulk-data/export.html#bulk-data-delete-request). Returns success if the operation was successfully cancelled. If the operation is complete, or has already been cancelled, returns an error response.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "healthcare.projects.locations.datasets.fhirStores.operations.delete-fhir-operation", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the operation to be deleted, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/operations/{operation_id}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/fhirStores/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "HttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-healthcare", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get-fhir-operation-status": { +"description": "Gets the status of operations as defined in the FHIR specification. Implements the FHIR implementation guide [bulk data status request](https://build.fhir.org/ig/HL7/bulk-data/export.html#bulk-data-status-request). Operations can have one of these states: * in-progress: response status code is `202` and `X-Progress` header is set to `in progress`. * complete: response status code is `200` and the body is a JSON-encoded operation response as defined by the spec. For a bulk export, this response is defined in https://build.fhir.org/ig/HL7/bulk-data/export.html#response---complete-status. * error: response status code is `5XX`, and the body is a JSON-encoded `OperationOutcome` resource describing the reason for the error.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "healthcare.projects.locations.datasets.fhirStores.operations.get-fhir-operation-status", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the operation to query, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/operations/{operation_id}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/fhirStores/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "HttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-healthcare", +"https://www.googleapis.com/auth/cloud-platform" +] +} +} } } }, @@ -4945,7 +5088,7 @@ } } }, -"revision": "20250129", +"revision": "20250206", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "AccessDeterminationLogConfig": { @@ -5387,6 +5530,17 @@ }, "type": "object" }, +"BulkExportGcsDestination": { +"description": "The configuration for exporting to Cloud Storage using the bulk export API.", +"id": "BulkExportGcsDestination", +"properties": { +"uriPrefix": { +"description": "Optional. URI for a Cloud Storage directory where the server writes result files, in the format `gs://{bucket-id}/{path/to/destination/dir}`. If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced in `uri_prefix`.", +"type": "string" +} +}, +"type": "object" +}, "CancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "CancelOperationRequest", @@ -6498,6 +6652,10 @@ "description": "Represents a FHIR store.", "id": "FhirStore", "properties": { +"bulkExportGcsDestination": { +"$ref": "BulkExportGcsDestination", +"description": "Optional. FHIR bulk export exports resources to the specified Cloud Storage destination. A Cloud Storage destination is a URI for a Cloud Storage directory where result files will be written. Only used in the spec-defined bulk $export methods. The Cloud Healthcare Service Agent requires the `roles/storage.objectAdmin` Cloud IAM role on the destination." +}, "complexDataTypeReferenceParsing": { "description": "Optional. Enable parsing of references within complex FHIR data types such as Extensions. If this value is set to ENABLED, then features like referential integrity and Bundle reference rewriting apply to all references. If this flag has not been specified the behavior of the FHIR store will not change, references in complex data types will not be parsed. New stores will have this value set to ENABLED after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources.", "enum": [ diff --git a/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json b/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json index b26d81e946f..45fb430936e 100644 --- a/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json @@ -3571,6 +3571,52 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"bulk-export-group": { +"description": "Bulk exports a Group resource and resources in the member field, including related resources for each Patient member. The export for each Patient is identical to a GetPatientEverything request. Implements the FHIR implementation guide [$export group of patients](https://build.fhir.org/ig/HL7/bulk-data/export.html#endpoint---group-of-patients). The following headers must be set in the request: * `Accept`: specifies the format of the `OperationOutcome` response. Only `application/fhir+json` is supported. * `Prefer`: specifies whether the response is immediate or asynchronous. Must be to `respond-async` because only asynchronous responses are supported. Specify the destination for the server to write result files by setting the Cloud Storage location bulk_export_gcs_destination on the FHIR store. URI of an existing Cloud Storage directory where the server writes result files, in the format gs://{bucket-id}/{path/to/destination/dir}. If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced. Supports the following query parameters: * `_type`: string of comma-delimited FHIR resource types. If provided, only resources of the specified type(s) are exported. * `_since`: if provided, only resources updated after the specified time are exported. * `_outputFormat`: optional, specify ndjson to export data in NDJSON format. Exported file names use the format: {export_id}_{resource_type}.ndjson. * `organizeOutputBy`: resource type to organize the output by. Required and must be set to `Patient`. When specified, output files are organized by instances of the specified resource type, including the resource, referenced resources, and resources that contain references to that resource. On success, the `Content-Location` header of response is set to a URL that you can use to query the status of the export. The URL is in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/operations/{export_id}`. See get-fhir-operation-status for more information. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Group/{GroupId}/$export", +"httpMethod": "GET", +"id": "healthcare.projects.locations.datasets.fhirStores.bulk-export-group", +"parameterOrder": [ +"name" +], +"parameters": { +"_since": { +"description": "Optional. If provided, only resources updated after this time are exported. The time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. For example, `2015-02-07T13:28:17.239+02:00` or `2017-01-01T00:00:00Z`. The time must be specified to the second and include a time zone.", +"location": "query", +"type": "string" +}, +"_type": { +"description": "Optional. String of comma-delimited FHIR resource types. If provided, only resources of the specified resource type(s) are exported.", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. Name of the `Group` resource that is exported, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/fhirStores/[^/]+/fhir/Group/[^/]+$", +"required": true, +"type": "string" +}, +"organizeOutputBy": { +"description": "Optional. Required. The FHIR resource type used to organize exported resources. Only supports \"Patient\". When organized by Patient resource, output files are grouped as follows: * Patient file(s) containing the Patient resources. Each Patient is sequentially followed by all resources the Patient references, and all resources that reference the Patient (equivalent to a GetPatientEverything request). * Individual files grouped by resource type for resources in the Group's member field and the Group resource itself. Resources may be duplicated across multiple Patients. For example, if two Patient resources reference the same Organization resource, it will appear twice, once after each Patient. The Group resource from the request does not appear in the Patient files.", +"location": "query", +"type": "string" +}, +"outputFormat": { +"description": "Optional. Output format of the export. This field is optional and only `application/fhir+ndjson` is supported.", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}/$export", +"response": { +"$ref": "HttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-healthcare", +"https://www.googleapis.com/auth/cloud-platform" +] +}, "configureSearch": { "description": "Configure the search parameters for the FHIR store and reindex resources in the FHIR store according to the defined search parameters. The search parameters provided in this request will replace any previous search configuration. The target SearchParameter resources need to exist in the store before calling ConfigureSearch, otherwise an error will occur. This method returns an Operation that can be used to track the progress of the reindexing by calling GetOperation.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:configureSearch", @@ -4608,6 +4654,47 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"bulk-export": { +"description": "Bulk exports all resources from the FHIR store to the specified destination. Implements the FHIR implementation guide [system level $export](https://build.fhir.org/ig/HL7/bulk-data/export.html#endpoint---system-level-export. The following headers must be set in the request: * `Accept`: specifies the format of the `OperationOutcome` response. Only `application/fhir+json` is supported. * `Prefer`: specifies whether the response is immediate or asynchronous. Must be to `respond-async` because only asynchronous responses are supported. Specify the destination for the server to write result files by setting the Cloud Storage location bulk_export_gcs_destination on the FHIR store. URI of an existing Cloud Storage directory where the server writes result files, in the format gs://{bucket-id}/{path/to/destination/dir}. If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced. Supports the following query parameters: * `_type`: string of comma-delimited FHIR resource types. If provided, only the resources of the specified type(s) are exported. * `_since`: if provided, only the resources that are updated after the specified time are exported. * `_outputFormat`: optional, specify ndjson to export data in NDJSON format. Exported file names use the format: {export_id}_{resource_type}.ndjson. On success, the `Content-Location` header of the response is set to a URL that the user can use to query the status of the export. The URL is in the format: `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/operations/{export_id}`. See get-fhir-operation-status for more information. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/$export", +"httpMethod": "GET", +"id": "healthcare.projects.locations.datasets.fhirStores.fhir.bulk-export", +"parameterOrder": [ +"name" +], +"parameters": { +"_since": { +"description": "Optional. If provided, only resources updated after this time are exported. The time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. For example, `2015-02-07T13:28:17.239+02:00` or `2017-01-01T00:00:00Z`. The time must be specified to the second and include a time zone.", +"location": "query", +"type": "string" +}, +"_type": { +"description": "Optional. String of comma-delimited FHIR resource types. If provided, only resources of the specified resource type(s) are exported.", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. The name of the FHIR store to export resources from, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/fhirStores/[^/]+$", +"required": true, +"type": "string" +}, +"outputFormat": { +"description": "Optional. Output format of the export. This field is optional and only `application/fhir+ndjson` is supported.", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}/fhir/$export", +"response": { +"$ref": "HttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-healthcare", +"https://www.googleapis.com/auth/cloud-platform" +] +}, "capabilities": { "description": "Gets the FHIR capability statement ([STU3](https://hl7.org/implement/standards/fhir/STU3/capabilitystatement.html), [R4](https://hl7.org/implement/standards/fhir/R4/capabilitystatement.html)), or the [conformance statement](https://hl7.org/implement/standards/fhir/DSTU2/conformance.html) in the DSTU2 case for the store, which contains a description of functionality supported by the server. Implements the FHIR standard capabilities interaction ([STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#capabilities), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#capabilities)), or the [conformance interaction](https://hl7.org/implement/standards/fhir/DSTU2/http.html#conformance) in the DSTU2 case. On success, the response body contains a JSON-encoded representation of a `CapabilityStatement` resource.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/metadata", @@ -5057,6 +5144,62 @@ ] } } +}, +"operations": { +"methods": { +"delete-fhir-operation": { +"description": "Deletes operations as defined in the FHIR specification. Implements the FHIR implementation guide [bulk data delete request](https://build.fhir.org/ig/HL7/bulk-data/export.html#bulk-data-delete-request). Returns success if the operation was successfully cancelled. If the operation is complete, or has already been cancelled, returns an error response.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "healthcare.projects.locations.datasets.fhirStores.operations.delete-fhir-operation", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the operation to be deleted, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/operations/{operation_id}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/fhirStores/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "HttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-healthcare", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get-fhir-operation-status": { +"description": "Gets the status of operations as defined in the FHIR specification. Implements the FHIR implementation guide [bulk data status request](https://build.fhir.org/ig/HL7/bulk-data/export.html#bulk-data-status-request). Operations can have one of these states: * in-progress: response status code is `202` and `X-Progress` header is set to `in progress`. * complete: response status code is `200` and the body is a JSON-encoded operation response as defined by the spec. For a bulk export, this response is defined in https://build.fhir.org/ig/HL7/bulk-data/export.html#response---complete-status. * error: response status code is `5XX`, and the body is a JSON-encoded `OperationOutcome` resource describing the reason for the error.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "healthcare.projects.locations.datasets.fhirStores.operations.get-fhir-operation-status", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the operation to query, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/operations/{operation_id}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/fhirStores/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "HttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-healthcare", +"https://www.googleapis.com/auth/cloud-platform" +] +} +} } } }, @@ -5868,7 +6011,7 @@ } } }, -"revision": "20250129", +"revision": "20250206", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "AccessDeterminationLogConfig": { @@ -6466,6 +6609,17 @@ }, "type": "object" }, +"BulkExportGcsDestination": { +"description": "The configuration for exporting to Cloud Storage using the bulk export API.", +"id": "BulkExportGcsDestination", +"properties": { +"uriPrefix": { +"description": "Optional. URI for a Cloud Storage directory where the server writes result files, in the format `gs://{bucket-id}/{path/to/destination/dir}`. If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced in `uri_prefix`.", +"type": "string" +} +}, +"type": "object" +}, "CancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "CancelOperationRequest", @@ -7866,6 +8020,10 @@ "description": "Represents a FHIR store.", "id": "FhirStore", "properties": { +"bulkExportGcsDestination": { +"$ref": "BulkExportGcsDestination", +"description": "Optional. FHIR bulk export exports resources to the specified Cloud Storage destination. A Cloud Storage destination is a URI for a Cloud Storage directory where result files will be written. Only used in the spec-defined bulk $export methods. The Cloud Healthcare Service Agent requires the `roles/storage.objectAdmin` Cloud IAM role on the destination." +}, "complexDataTypeReferenceParsing": { "description": "Enable parsing of references within complex FHIR data types such as Extensions. If this value is set to ENABLED, then features like referential integrity and Bundle reference rewriting apply to all references. If this flag has not been specified the behavior of the FHIR store will not change, references in complex data types will not be parsed. New stores will have this value set to ENABLED after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources.", "enum": [ From 07452561b2e2b5436a815899383510ee782d11b1 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 25 Feb 2025 07:08:19 +0000 Subject: [PATCH 19/36] feat(memcache): update the api #### memcache:v1beta2 The following keys were deleted: - schemas.AssetLocation (Total Keys: 10) - schemas.BlobstoreLocation (Total Keys: 4) - schemas.CloudAsset (Total Keys: 8) - schemas.DirectLocationAssignment (Total Keys: 4) - schemas.ExtraParameter (Total Keys: 3) - schemas.IsolationExpectations (Total Keys: 12) - schemas.LocationAssignment (Total Keys: 4) - schemas.LocationData (Total Keys: 8) - schemas.PlacerLocation (Total Keys: 3) - schemas.RegionalMigDistributionPolicy (Total Keys: 6) - schemas.RequirementOverride (Total Keys: 4) - schemas.SpannerLocation (Total Keys: 6) - schemas.TenantProjectProxy (Total Keys: 4) - schemas.ZoneConfiguration (Total Keys: 3) --- ...ache_v1.projects.locations.operations.html | 4 +- ...v1beta2.projects.locations.operations.html | 4 +- .../documents/memcache.v1.json | 4 +- .../documents/memcache.v1beta2.json | 392 +----------------- 4 files changed, 8 insertions(+), 396 deletions(-) diff --git a/docs/dyn/memcache_v1.projects.locations.operations.html b/docs/dyn/memcache_v1.projects.locations.operations.html index 8660e724ec9..09e74fd8697 100644 --- a/docs/dyn/memcache_v1.projects.locations.operations.html +++ b/docs/dyn/memcache_v1.projects.locations.operations.html @@ -76,7 +76,7 @@

Cloud Memorystore for Memcached API . Instance Methods

cancel(name, body=None, 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`.

+

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.

@@ -95,7 +95,7 @@

Instance Methods

Method Details

cancel(name, body=None, 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`.
+  
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)
diff --git a/docs/dyn/memcache_v1beta2.projects.locations.operations.html b/docs/dyn/memcache_v1beta2.projects.locations.operations.html
index bf24839113d..2dd1bcfe985 100644
--- a/docs/dyn/memcache_v1beta2.projects.locations.operations.html
+++ b/docs/dyn/memcache_v1beta2.projects.locations.operations.html
@@ -76,7 +76,7 @@ 

Cloud Memorystore for Memcached API . Instance Methods

cancel(name, body=None, 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`.

+

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.

@@ -95,7 +95,7 @@

Instance Methods

Method Details

cancel(name, body=None, 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`.
+  
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)
diff --git a/googleapiclient/discovery_cache/documents/memcache.v1.json b/googleapiclient/discovery_cache/documents/memcache.v1.json
index b875e6929aa..dd7df4f88de 100644
--- a/googleapiclient/discovery_cache/documents/memcache.v1.json
+++ b/googleapiclient/discovery_cache/documents/memcache.v1.json
@@ -459,7 +459,7 @@
 "operations": {
 "methods": {
 "cancel": {
-"description": "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`.",
+"description": "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`.",
 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
 "id": "memcache.projects.locations.operations.cancel",
@@ -584,7 +584,7 @@
 }
 }
 },
-"revision": "20241106",
+"revision": "20250206",
 "rootUrl": "https://memcache.googleapis.com/",
 "schemas": {
 "ApplyParametersRequest": {
diff --git a/googleapiclient/discovery_cache/documents/memcache.v1beta2.json b/googleapiclient/discovery_cache/documents/memcache.v1beta2.json
index 16e7fcaefc1..40456f7bfba 100644
--- a/googleapiclient/discovery_cache/documents/memcache.v1beta2.json
+++ b/googleapiclient/discovery_cache/documents/memcache.v1beta2.json
@@ -487,7 +487,7 @@
 "operations": {
 "methods": {
 "cancel": {
-"description": "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`.",
+"description": "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`.",
 "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
 "id": "memcache.projects.locations.operations.cancel",
@@ -612,7 +612,7 @@
 }
 }
 },
-"revision": "20241010",
+"revision": "20250206",
 "rootUrl": "https://memcache.googleapis.com/",
 "schemas": {
 "ApplyParametersRequest": {
@@ -651,85 +651,12 @@
 },
 "type": "object"
 },
-"AssetLocation": {
-"description": "Provides the mapping of a cloud asset to a direct physical location or to a proxy that defines the location on its behalf.",
-"id": "AssetLocation",
-"properties": {
-"ccfeRmsPath": {
-"description": "Spanner path of the CCFE RMS database. It is only applicable for CCFE tenants that use CCFE RMS for storing resource metadata.",
-"type": "string"
-},
-"expected": {
-"$ref": "IsolationExpectations",
-"description": "Defines the customer expectation around ZI/ZS for this asset and ZI/ZS state of the region at the time of asset creation."
-},
-"extraParameters": {
-"description": "Defines extra parameters required for specific asset types.",
-"items": {
-"$ref": "ExtraParameter"
-},
-"type": "array"
-},
-"locationData": {
-"description": "Contains all kinds of physical location definitions for this asset.",
-"items": {
-"$ref": "LocationData"
-},
-"type": "array"
-},
-"parentAsset": {
-"description": "Defines parents assets if any in order to allow later generation of child_asset_location data via child assets.",
-"items": {
-"$ref": "CloudAsset"
-},
-"type": "array"
-}
-},
-"type": "object"
-},
-"BlobstoreLocation": {
-"description": "Policy ID that identified data placement in Blobstore as per go/blobstore-user-guide#data-metadata-placement-and-failure-domains",
-"id": "BlobstoreLocation",
-"properties": {
-"policyId": {
-"items": {
-"type": "string"
-},
-"type": "array"
-}
-},
-"type": "object"
-},
 "CancelOperationRequest": {
 "description": "The request message for Operations.CancelOperation.",
 "id": "CancelOperationRequest",
 "properties": {},
 "type": "object"
 },
-"CloudAsset": {
-"id": "CloudAsset",
-"properties": {
-"assetName": {
-"type": "string"
-},
-"assetType": {
-"type": "string"
-}
-},
-"type": "object"
-},
-"CloudAssetComposition": {
-"id": "CloudAssetComposition",
-"properties": {
-"childAsset": {
-"items": {
-"$ref": "CloudAsset"
-},
-"type": "array"
-}
-},
-"type": "object"
-},
 "DailyCycle": {
 "description": "Time window specified for daily operations.",
 "id": "DailyCycle",
@@ -787,35 +714,12 @@
 },
 "type": "object"
 },
-"DirectLocationAssignment": {
-"id": "DirectLocationAssignment",
-"properties": {
-"location": {
-"items": {
-"$ref": "LocationAssignment"
-},
-"type": "array"
-}
-},
-"type": "object"
-},
 "Empty": {
 "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }",
 "id": "Empty",
 "properties": {},
 "type": "object"
 },
-"ExtraParameter": {
-"description": "Defines parameters that should only be used for specific asset types.",
-"id": "ExtraParameter",
-"properties": {
-"regionalMigDistributionPolicy": {
-"$ref": "RegionalMigDistributionPolicy",
-"description": "Details about zones used by regional compute.googleapis.com/InstanceGroupManager to create instances."
-}
-},
-"type": "object"
-},
 "GoogleCloudMemcacheV1beta2LocationMetadata": {
 "description": "Metadata for the given google.cloud.location.Location.",
 "id": "GoogleCloudMemcacheV1beta2LocationMetadata",
@@ -1379,131 +1283,6 @@
 },
 "type": "object"
 },
-"IsolationExpectations": {
-"id": "IsolationExpectations",
-"properties": {
-"requirementOverride": {
-"$ref": "RequirementOverride",
-"description": "Explicit overrides for ZI and ZS requirements to be used for resources that should be excluded from ZI/ZS verification logic."
-},
-"ziOrgPolicy": {
-"enum": [
-"ZI_UNSPECIFIED",
-"ZI_UNKNOWN",
-"ZI_NOT_REQUIRED",
-"ZI_PREFERRED",
-"ZI_REQUIRED"
-],
-"enumDescriptions": [
-"",
-"To be used if tracking is not available",
-"",
-"",
-""
-],
-"type": "string"
-},
-"ziRegionPolicy": {
-"enum": [
-"ZI_REGION_POLICY_UNSPECIFIED",
-"ZI_REGION_POLICY_UNKNOWN",
-"ZI_REGION_POLICY_NOT_SET",
-"ZI_REGION_POLICY_FAIL_OPEN",
-"ZI_REGION_POLICY_FAIL_CLOSED"
-],
-"enumDescriptions": [
-"",
-"To be used if tracking is not available",
-"",
-"",
-""
-],
-"type": "string"
-},
-"ziRegionState": {
-"enum": [
-"ZI_REGION_UNSPECIFIED",
-"ZI_REGION_UNKNOWN",
-"ZI_REGION_NOT_ENABLED",
-"ZI_REGION_ENABLED"
-],
-"enumDescriptions": [
-"",
-"To be used if tracking is not available",
-"",
-""
-],
-"type": "string"
-},
-"zoneIsolation": {
-"deprecated": true,
-"description": "Deprecated: use zi_org_policy, zi_region_policy and zi_region_state instead for setting ZI expectations as per go/zicy-publish-physical-location.",
-"enum": [
-"ZI_UNSPECIFIED",
-"ZI_UNKNOWN",
-"ZI_NOT_REQUIRED",
-"ZI_PREFERRED",
-"ZI_REQUIRED"
-],
-"enumDescriptions": [
-"",
-"To be used if tracking is not available",
-"",
-"",
-""
-],
-"type": "string"
-},
-"zoneSeparation": {
-"deprecated": true,
-"description": "Deprecated: use zs_org_policy, and zs_region_stateinstead for setting Zs expectations as per go/zicy-publish-physical-location.",
-"enum": [
-"ZS_UNSPECIFIED",
-"ZS_UNKNOWN",
-"ZS_NOT_REQUIRED",
-"ZS_REQUIRED"
-],
-"enumDescriptions": [
-"",
-"To be used if tracking is not available",
-"",
-""
-],
-"type": "string"
-},
-"zsOrgPolicy": {
-"enum": [
-"ZS_UNSPECIFIED",
-"ZS_UNKNOWN",
-"ZS_NOT_REQUIRED",
-"ZS_REQUIRED"
-],
-"enumDescriptions": [
-"",
-"To be used if tracking is not available",
-"",
-""
-],
-"type": "string"
-},
-"zsRegionState": {
-"enum": [
-"ZS_REGION_UNSPECIFIED",
-"ZS_REGION_UNKNOWN",
-"ZS_REGION_NOT_ENABLED",
-"ZS_REGION_ENABLED"
-],
-"enumDescriptions": [
-"",
-"To be used if tracking of the asset ZS-bit is not available",
-"",
-""
-],
-"type": "string"
-}
-},
-"type": "object"
-},
 "ListInstancesResponse": {
 "description": "Response for ListInstances.",
 "id": "ListInstancesResponse",
@@ -1599,64 +1378,6 @@
 },
 "type": "object"
 },
-"LocationAssignment": {
-"id": "LocationAssignment",
-"properties": {
-"location": {
-"type": "string"
-},
-"locationType": {
-"enum": [
-"UNSPECIFIED",
-"CLUSTER",
-"POP",
-"CLOUD_ZONE",
-"CLOUD_REGION",
-"MULTI_REGION_GEO",
-"MULTI_REGION_JURISDICTION",
-"GLOBAL",
-"OTHER"
-],
-"enumDescriptions": [
-"",
-"1-10: Physical failure domains.",
-"",
-"11-20: Logical failure domains.",
-"",
-"",
-"",
-"",
-""
-],
-"type": "string"
-}
-},
-"type": "object"
-},
-"LocationData": {
-"id": "LocationData",
-"properties": {
-"blobstoreLocation": {
-"$ref": "BlobstoreLocation"
-},
-"childAssetLocation": {
-"$ref": "CloudAssetComposition"
-},
-"directLocation": {
-"$ref": "DirectLocationAssignment"
-},
-"gcpProjectProxy": {
-"$ref": "TenantProjectProxy"
-},
-"placerLocation": {
-"$ref": "PlacerLocation"
-},
-"spannerLocation": {
-"$ref": "SpannerLocation"
-}
-},
-"type": "object"
-},
 "LocationMetadata": {
 "description": "Metadata for the given google.cloud.location.Location.",
 "id": "LocationMetadata",
@@ -1951,74 +1672,6 @@
 },
 "type": "object"
 },
-"PlacerLocation": {
-"description": "Message describing that the location of the customer resource is tied to placer allocations",
-"id": "PlacerLocation",
-"properties": {
-"placerConfig": {
-"description": "Directory with a config related to it in placer (e.g. \"/placer/prod/home/my-root/my-dir\")",
-"type": "string"
-}
-},
-"type": "object"
-},
-"RegionalMigDistributionPolicy": {
-"description": "To be used for specifying the intended distribution of regional compute.googleapis.com/InstanceGroupManager instances",
-"id": "RegionalMigDistributionPolicy",
-"properties": {
-"targetShape": {
-"description": "The shape in which the group converges around distribution of resources. Instance of proto2 enum",
-"format": "int32",
-"type": "integer"
-},
-"zones": {
-"description": "Cloud zones used by regional MIG to create instances.",
-"items": {
-"$ref": "ZoneConfiguration"
-},
-"type": "array"
-}
-},
-"type": "object"
-},
-"RequirementOverride": {
-"id": "RequirementOverride",
-"properties": {
-"ziOverride": {
-"enum": [
-"ZI_UNSPECIFIED",
-"ZI_UNKNOWN",
-"ZI_NOT_REQUIRED",
-"ZI_PREFERRED",
-"ZI_REQUIRED"
-],
-"enumDescriptions": [
-"",
-"To be used if tracking is not available",
-"",
-"",
-""
-],
-"type": "string"
-},
-"zsOverride": {
-"enum": [
-"ZS_UNSPECIFIED",
-"ZS_UNKNOWN",
-"ZS_NOT_REQUIRED",
-"ZS_REQUIRED"
-],
-"enumDescriptions": [
-"",
-"To be used if tracking is not available",
-"",
-""
-],
-"type": "string"
-}
-},
-"type": "object"
-},
 "RescheduleMaintenanceRequest": {
 "description": "Request for RescheduleMaintenance.",
 "id": "RescheduleMaintenanceRequest",
@@ -2087,26 +1740,6 @@
 },
 "type": "object"
 },
-"SpannerLocation": {
-"id": "SpannerLocation",
-"properties": {
-"backupName": {
-"description": "Set of backups used by the resource with name in the same format as what is available at http://table/spanner_automon.backup_metadata",
-"items": {
-"type": "string"
-},
-"type": "array"
-},
-"dbName": {
-"description": "Set of databases used by the resource in format /span//",
-"items": {
-"type": "string"
-},
-"type": "array"
-}
-},
-"type": "object"
-},
 "Status": {
 "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). 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).",
 "id": "Status",
@@ -2134,18 +1767,6 @@
 },
 "type": "object"
 },
-"TenantProjectProxy": {
-"id": "TenantProjectProxy",
-"properties": {
-"projectNumbers": {
-"items": {
-"type": "string"
-},
-"type": "array"
-}
-},
-"type": "object"
-},
 "TimeOfDay": {
 "description": "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`.",
 "id": "TimeOfDay",
@@ -2281,15 +1902,6 @@
 },
 "type": "object"
 },
-"ZoneConfiguration": {
-"id": "ZoneConfiguration",
-"properties": {
-"zone": {
-"type": "string"
-}
-},
-"type": "object"
-},
 "ZoneMetadata": {
 "id": "ZoneMetadata",
 "properties": {},

From 144697ef81133bf404390281f2030f6f8ddb8c51 Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 25 Feb 2025 07:08:19 +0000
Subject: [PATCH 20/36] feat(merchantapi): update the api

#### merchantapi:accounts_v1beta

The following keys were added:
- schemas.ProductStatusChangeMessage.properties.eventTime (Total Keys: 2)

#### merchantapi:conversions_v1beta

The following keys were added:
- schemas.ProductStatusChangeMessage.properties.eventTime (Total Keys: 2)

#### merchantapi:datasources_v1beta

The following keys were added:
- schemas.ProductStatusChangeMessage.properties.eventTime (Total Keys: 2)

#### merchantapi:inventories_v1beta

The following keys were added:
- schemas.ProductStatusChangeMessage.properties.eventTime (Total Keys: 2)

#### merchantapi:lfp_v1beta

The following keys were added:
- schemas.ProductStatusChangeMessage.properties.eventTime (Total Keys: 2)

#### merchantapi:notifications_v1beta

The following keys were added:
- schemas.ProductStatusChangeMessage.properties.eventTime (Total Keys: 2)

#### merchantapi:products_v1beta

The following keys were added:
- schemas.ProductStatusChangeMessage.properties.eventTime (Total Keys: 2)

#### merchantapi:promotions_v1beta

The following keys were added:
- schemas.ProductStatusChangeMessage.properties.eventTime (Total Keys: 2)

#### merchantapi:quota_v1beta

The following keys were added:
- schemas.ProductStatusChangeMessage.properties.eventTime (Total Keys: 2)

#### merchantapi:reports_v1beta

The following keys were added:
- schemas.ProductStatusChangeMessage.properties.eventTime (Total Keys: 2)

#### merchantapi:reviews_v1beta

The following keys were added:
- schemas.ProductStatusChangeMessage.properties.eventTime (Total Keys: 2)
---
 docs/dyn/merchantapi_accounts_v1beta.accounts.html   |  4 ++--
 ...erchantapi_accounts_v1beta.accounts.programs.html |  8 ++++----
 .../merchantapi_accounts_v1beta.accounts.users.html  | 12 ++++++------
 .../documents/merchantapi.accounts_v1beta.json       | 11 ++++++++---
 .../documents/merchantapi.conversions_v1beta.json    |  7 ++++++-
 .../documents/merchantapi.datasources_v1beta.json    |  7 ++++++-
 .../documents/merchantapi.inventories_v1beta.json    |  7 ++++++-
 .../documents/merchantapi.lfp_v1beta.json            |  7 ++++++-
 .../documents/merchantapi.notifications_v1beta.json  |  7 ++++++-
 .../documents/merchantapi.products_v1beta.json       |  7 ++++++-
 .../documents/merchantapi.promotions_v1beta.json     |  7 ++++++-
 .../documents/merchantapi.quota_v1beta.json          |  7 ++++++-
 .../documents/merchantapi.reports_v1beta.json        |  7 ++++++-
 .../documents/merchantapi.reviews_v1beta.json        |  7 ++++++-
 14 files changed, 80 insertions(+), 25 deletions(-)

diff --git a/docs/dyn/merchantapi_accounts_v1beta.accounts.html b/docs/dyn/merchantapi_accounts_v1beta.accounts.html
index aecafcc5571..3a814fdab33 100644
--- a/docs/dyn/merchantapi_accounts_v1beta.accounts.html
+++ b/docs/dyn/merchantapi_accounts_v1beta.accounts.html
@@ -198,7 +198,7 @@ 

Method Details

"user": [ # Optional. Users to be added to the account. { # Instruction for adding a user to the account during creation. "user": { # The `User` message represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472). # Optional. Details about the user to be added. At the moment, only access rights may be specified. - "accessRights": [ # Optional. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has. + "accessRights": [ # Required. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has. "A String", ], "name": "A String", # Identifier. The resource name of the user. Format: `accounts/{account}/user/{email}` Use `me` to refer to your own email address, for example `accounts/{account}/users/me`. @@ -211,7 +211,7 @@

Method Details

{ # Request message for the `CreateUser` method. "parent": "A String", # Required. The resource name of the account for which a user will be created. Format: `accounts/{account}` "user": { # The `User` message represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472). # Optional. The user to create. - "accessRights": [ # Optional. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has. + "accessRights": [ # Required. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has. "A String", ], "name": "A String", # Identifier. The resource name of the user. Format: `accounts/{account}/user/{email}` Use `me` to refer to your own email address, for example `accounts/{account}/users/me`. diff --git a/docs/dyn/merchantapi_accounts_v1beta.accounts.programs.html b/docs/dyn/merchantapi_accounts_v1beta.accounts.programs.html index a0adb38dac8..ffe751f78c4 100644 --- a/docs/dyn/merchantapi_accounts_v1beta.accounts.programs.html +++ b/docs/dyn/merchantapi_accounts_v1beta.accounts.programs.html @@ -118,7 +118,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 merchant accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/topic/9240261?ref_topic=7257954,7259405,&sjid=796648681813264022-EU) program, which enables products from a merchant's store to be shown across Google for free. + { # Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to merchant accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/topic/9240261?ref_topic=7257954,7259405,&sjid=796648681813264022-EU) program, which enables products from a merchant's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `free-listings` * `shopping-ads` * `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", ], @@ -157,7 +157,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 merchant accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/topic/9240261?ref_topic=7257954,7259405,&sjid=796648681813264022-EU) program, which enables products from a merchant's store to be shown across Google for free. + { # Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to merchant accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/topic/9240261?ref_topic=7257954,7259405,&sjid=796648681813264022-EU) program, which enables products from a merchant's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `free-listings` * `shopping-ads` * `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", ], @@ -190,7 +190,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 merchant accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/topic/9240261?ref_topic=7257954,7259405,&sjid=796648681813264022-EU) program, which enables products from a merchant's store to be shown across Google for free. + { # Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to merchant accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/topic/9240261?ref_topic=7257954,7259405,&sjid=796648681813264022-EU) program, which enables products from a merchant's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `free-listings` * `shopping-ads` * `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", ], @@ -228,7 +228,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 merchant accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/topic/9240261?ref_topic=7257954,7259405,&sjid=796648681813264022-EU) program, which enables products from a merchant's store to be shown across Google for free. + { # Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to merchant accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/topic/9240261?ref_topic=7257954,7259405,&sjid=796648681813264022-EU) program, which enables products from a merchant's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `free-listings` * `shopping-ads` * `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.users.html b/docs/dyn/merchantapi_accounts_v1beta.accounts.users.html index 9ac73f15dd7..e1a562df084 100644 --- a/docs/dyn/merchantapi_accounts_v1beta.accounts.users.html +++ b/docs/dyn/merchantapi_accounts_v1beta.accounts.users.html @@ -111,7 +111,7 @@

Method Details

The object takes the form of: { # The `User` message represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472). - "accessRights": [ # Optional. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has. + "accessRights": [ # Required. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has. "A String", ], "name": "A String", # Identifier. The resource name of the user. Format: `accounts/{account}/user/{email}` Use `me` to refer to your own email address, for example `accounts/{account}/users/me`. @@ -128,7 +128,7 @@

Method Details

An object of the form: { # The `User` message represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472). - "accessRights": [ # Optional. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has. + "accessRights": [ # Required. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has. "A String", ], "name": "A String", # Identifier. The resource name of the user. Format: `accounts/{account}/user/{email}` Use `me` to refer to your own email address, for example `accounts/{account}/users/me`. @@ -169,7 +169,7 @@

Method Details

An object of the form: { # The `User` message represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472). - "accessRights": [ # Optional. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has. + "accessRights": [ # Required. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has. "A String", ], "name": "A String", # Identifier. The resource name of the user. Format: `accounts/{account}/user/{email}` Use `me` to refer to your own email address, for example `accounts/{account}/users/me`. @@ -197,7 +197,7 @@

Method Details

"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. "users": [ # The users from the specified account. { # The `User` message represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472). - "accessRights": [ # Optional. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has. + "accessRights": [ # Required. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has. "A String", ], "name": "A String", # Identifier. The resource name of the user. Format: `accounts/{account}/user/{email}` Use `me` to refer to your own email address, for example `accounts/{account}/users/me`. @@ -231,7 +231,7 @@

Method Details

The object takes the form of: { # The `User` message represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472). - "accessRights": [ # Optional. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has. + "accessRights": [ # Required. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has. "A String", ], "name": "A String", # Identifier. The resource name of the user. Format: `accounts/{account}/user/{email}` Use `me` to refer to your own email address, for example `accounts/{account}/users/me`. @@ -248,7 +248,7 @@

Method Details

An object of the form: { # The `User` message represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472). - "accessRights": [ # Optional. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has. + "accessRights": [ # Required. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has. "A String", ], "name": "A String", # Identifier. The resource name of the user. Format: `accounts/{account}/user/{email}` Use `me` to refer to your own email address, for example `accounts/{account}/users/me`. diff --git a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json index d66a8c79d79..cfbc458a70b 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json @@ -1417,7 +1417,7 @@ } } }, -"revision": "20250208", +"revision": "20250219", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Accepted": { @@ -2797,6 +2797,11 @@ false }, "type": "array" }, +"eventTime": { +"description": "The time at which the event was generated.", +"format": "google-datetime", +"type": "string" +}, "expirationTime": { "description": "The product expiration time. This field will not bet set if the notification is sent for a product deletion event.", "format": "google-datetime", @@ -2830,7 +2835,7 @@ false "type": "object" }, "Program": { -"description": "Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to merchant accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/topic/9240261?ref_topic=7257954,7259405,&sjid=796648681813264022-EU) program, which enables products from a merchant's store to be shown across Google for free.", +"description": "Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to merchant accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/topic/9240261?ref_topic=7257954,7259405,&sjid=796648681813264022-EU) program, which enables products from a merchant's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `free-listings` * `shopping-ads` * `youtube-shopping-checkout`", "id": "Program", "properties": { "activeRegionCodes": { @@ -3420,7 +3425,7 @@ false "id": "User", "properties": { "accessRights": { -"description": "Optional. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has.", +"description": "Required. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has.", "items": { "enum": [ "ACCESS_RIGHT_UNSPECIFIED", diff --git a/googleapiclient/discovery_cache/documents/merchantapi.conversions_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.conversions_v1beta.json index 45f1a6d51a1..7d70906991d 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.conversions_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.conversions_v1beta.json @@ -295,7 +295,7 @@ } } }, -"revision": "20250203", +"revision": "20250219", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "AttributionSettings": { @@ -598,6 +598,11 @@ false }, "type": "array" }, +"eventTime": { +"description": "The time at which the event was generated.", +"format": "google-datetime", +"type": "string" +}, "expirationTime": { "description": "The product expiration time. This field will not bet set if the notification is sent for a product deletion event.", "format": "google-datetime", diff --git a/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json index a80189df16f..d5be2cde3cb 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json @@ -321,7 +321,7 @@ } } }, -"revision": "20250203", +"revision": "20250219", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "DataSource": { @@ -863,6 +863,11 @@ false }, "type": "array" }, +"eventTime": { +"description": "The time at which the event was generated.", +"format": "google-datetime", +"type": "string" +}, "expirationTime": { "description": "The product expiration time. This field will not bet set if the notification is sent for a product deletion event.", "format": "google-datetime", diff --git a/googleapiclient/discovery_cache/documents/merchantapi.inventories_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.inventories_v1beta.json index 17f737f0ff5..44a35eb8663 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.inventories_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.inventories_v1beta.json @@ -300,7 +300,7 @@ } } }, -"revision": "20250203", +"revision": "20250219", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "CustomAttribute": { @@ -575,6 +575,11 @@ false }, "type": "array" }, +"eventTime": { +"description": "The time at which the event was generated.", +"format": "google-datetime", +"type": "string" +}, "expirationTime": { "description": "The product expiration time. This field will not bet set if the notification is sent for a product deletion event.", "format": "google-datetime", diff --git a/googleapiclient/discovery_cache/documents/merchantapi.lfp_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.lfp_v1beta.json index 07142ac074a..74af197128e 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.lfp_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.lfp_v1beta.json @@ -298,7 +298,7 @@ } } }, -"revision": "20250203", +"revision": "20250219", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Empty": { @@ -649,6 +649,11 @@ false }, "type": "array" }, +"eventTime": { +"description": "The time at which the event was generated.", +"format": "google-datetime", +"type": "string" +}, "expirationTime": { "description": "The product expiration time. This field will not bet set if the notification is sent for a product deletion event.", "format": "google-datetime", diff --git a/googleapiclient/discovery_cache/documents/merchantapi.notifications_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.notifications_v1beta.json index 22e8c369e3f..fbe7e8b4029 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.notifications_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.notifications_v1beta.json @@ -262,7 +262,7 @@ } } }, -"revision": "20250203", +"revision": "20250219", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Empty": { @@ -438,6 +438,11 @@ false }, "type": "array" }, +"eventTime": { +"description": "The time at which the event was generated.", +"format": "google-datetime", +"type": "string" +}, "expirationTime": { "description": "The product expiration time. This field will not bet set if the notification is sent for a product deletion event.", "format": "google-datetime", diff --git a/googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json index 66a7ab3a2bc..c1e14b1e447 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json @@ -242,7 +242,7 @@ } } }, -"revision": "20250208", +"revision": "20250219", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Attributes": { @@ -1470,6 +1470,11 @@ false }, "type": "array" }, +"eventTime": { +"description": "The time at which the event was generated.", +"format": "google-datetime", +"type": "string" +}, "expirationTime": { "description": "The product expiration time. This field will not bet set if the notification is sent for a product deletion event.", "format": "google-datetime", diff --git a/googleapiclient/discovery_cache/documents/merchantapi.promotions_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.promotions_v1beta.json index 1a1a360c8f9..b54ed2e306e 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.promotions_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.promotions_v1beta.json @@ -203,7 +203,7 @@ } } }, -"revision": "20250204", +"revision": "20250219", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Attributes": { @@ -889,6 +889,11 @@ false }, "type": "array" }, +"eventTime": { +"description": "The time at which the event was generated.", +"format": "google-datetime", +"type": "string" +}, "expirationTime": { "description": "The product expiration time. This field will not bet set if the notification is sent for a product deletion event.", "format": "google-datetime", diff --git a/googleapiclient/discovery_cache/documents/merchantapi.quota_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.quota_v1beta.json index ee335709b2f..9beaf79969f 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.quota_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.quota_v1beta.json @@ -150,7 +150,7 @@ } } }, -"revision": "20250203", +"revision": "20250219", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "ListQuotaGroupsResponse": { @@ -311,6 +311,11 @@ false }, "type": "array" }, +"eventTime": { +"description": "The time at which the event was generated.", +"format": "google-datetime", +"type": "string" +}, "expirationTime": { "description": "The product expiration time. This field will not bet set if the notification is sent for a product deletion event.", "format": "google-datetime", diff --git a/googleapiclient/discovery_cache/documents/merchantapi.reports_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.reports_v1beta.json index 3dfe8bb8592..dd1c4b84c90 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.reports_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.reports_v1beta.json @@ -142,7 +142,7 @@ } } }, -"revision": "20250203", +"revision": "20250219", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "BestSellersBrandView": { @@ -1249,6 +1249,11 @@ false }, "type": "array" }, +"eventTime": { +"description": "The time at which the event was generated.", +"format": "google-datetime", +"type": "string" +}, "expirationTime": { "description": "The product expiration time. This field will not bet set if the notification is sent for a product deletion event.", "format": "google-datetime", diff --git a/googleapiclient/discovery_cache/documents/merchantapi.reviews_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.reviews_v1beta.json index 1d36c73b67a..45929a88da3 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.reviews_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.reviews_v1beta.json @@ -356,7 +356,7 @@ } } }, -"revision": "20250204", +"revision": "20250219", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "CustomAttribute": { @@ -1322,6 +1322,11 @@ false }, "type": "array" }, +"eventTime": { +"description": "The time at which the event was generated.", +"format": "google-datetime", +"type": "string" +}, "expirationTime": { "description": "The product expiration time. This field will not bet set if the notification is sent for a product deletion event.", "format": "google-datetime", From 9482d413d9ee4b423b4e3d063aee64947fa34d54 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 25 Feb 2025 07:08:19 +0000 Subject: [PATCH 21/36] feat(mybusinessbusinessinformation): update the api #### mybusinessbusinessinformation:v1 The following keys were added: - schemas.Metadata.properties.canOperateLocalPost.deprecated (Total Keys: 1) --- ...businessbusinessinformation_v1.accounts.locations.html | 6 +++--- .../mybusinessbusinessinformation_v1.googleLocations.html | 4 ++-- docs/dyn/mybusinessbusinessinformation_v1.locations.html | 8 ++++---- .../documents/mybusinessbusinessinformation.v1.json | 5 +++-- 4 files changed, 12 insertions(+), 11 deletions(-) diff --git a/docs/dyn/mybusinessbusinessinformation_v1.accounts.locations.html b/docs/dyn/mybusinessbusinessinformation_v1.accounts.locations.html index c6037a3ea92..7538de4522f 100644 --- a/docs/dyn/mybusinessbusinessinformation_v1.accounts.locations.html +++ b/docs/dyn/mybusinessbusinessinformation_v1.accounts.locations.html @@ -157,7 +157,7 @@

Method Details

"canHaveFoodMenus": True or False, # Output only. Indicates if the listing is eligible for food menu. "canModifyServiceList": True or False, # Output only. Indicates if the listing can modify the service list. "canOperateHealthData": True or False, # Output only. Indicates whether the location can operate on Health data. - "canOperateLocalPost": True or False, # Output only. Indicates if the listing can manage local posts. + "canOperateLocalPost": True or False, # Output only. Indicates if the listing can manage local posts. Deprecated: This field is no longer populated and will be removed in a future version. "canOperateLodgingData": True or False, # Output only. Indicates whether the location can operate on Lodging data. "duplicateLocation": "A String", # Output only. The location resource that this location duplicates. "hasGoogleUpdated": True or False, # Output only. Indicates whether the place ID associated with this location has updates that need to be updated or rejected by the client. If this boolean is set, you should call the `getGoogleUpdated` method to lookup information that's needs to be verified. @@ -392,7 +392,7 @@

Method Details

"canHaveFoodMenus": True or False, # Output only. Indicates if the listing is eligible for food menu. "canModifyServiceList": True or False, # Output only. Indicates if the listing can modify the service list. "canOperateHealthData": True or False, # Output only. Indicates whether the location can operate on Health data. - "canOperateLocalPost": True or False, # Output only. Indicates if the listing can manage local posts. + "canOperateLocalPost": True or False, # Output only. Indicates if the listing can manage local posts. Deprecated: This field is no longer populated and will be removed in a future version. "canOperateLodgingData": True or False, # Output only. Indicates whether the location can operate on Lodging data. "duplicateLocation": "A String", # Output only. The location resource that this location duplicates. "hasGoogleUpdated": True or False, # Output only. Indicates whether the place ID associated with this location has updates that need to be updated or rejected by the client. If this boolean is set, you should call the `getGoogleUpdated` method to lookup information that's needs to be verified. @@ -639,7 +639,7 @@

Method Details

"canHaveFoodMenus": True or False, # Output only. Indicates if the listing is eligible for food menu. "canModifyServiceList": True or False, # Output only. Indicates if the listing can modify the service list. "canOperateHealthData": True or False, # Output only. Indicates whether the location can operate on Health data. - "canOperateLocalPost": True or False, # Output only. Indicates if the listing can manage local posts. + "canOperateLocalPost": True or False, # Output only. Indicates if the listing can manage local posts. Deprecated: This field is no longer populated and will be removed in a future version. "canOperateLodgingData": True or False, # Output only. Indicates whether the location can operate on Lodging data. "duplicateLocation": "A String", # Output only. The location resource that this location duplicates. "hasGoogleUpdated": True or False, # Output only. Indicates whether the place ID associated with this location has updates that need to be updated or rejected by the client. If this boolean is set, you should call the `getGoogleUpdated` method to lookup information that's needs to be verified. diff --git a/docs/dyn/mybusinessbusinessinformation_v1.googleLocations.html b/docs/dyn/mybusinessbusinessinformation_v1.googleLocations.html index 4403bd5a0aa..a65374060d5 100644 --- a/docs/dyn/mybusinessbusinessinformation_v1.googleLocations.html +++ b/docs/dyn/mybusinessbusinessinformation_v1.googleLocations.html @@ -151,7 +151,7 @@

Method Details

"canHaveFoodMenus": True or False, # Output only. Indicates if the listing is eligible for food menu. "canModifyServiceList": True or False, # Output only. Indicates if the listing can modify the service list. "canOperateHealthData": True or False, # Output only. Indicates whether the location can operate on Health data. - "canOperateLocalPost": True or False, # Output only. Indicates if the listing can manage local posts. + "canOperateLocalPost": True or False, # Output only. Indicates if the listing can manage local posts. Deprecated: This field is no longer populated and will be removed in a future version. "canOperateLodgingData": True or False, # Output only. Indicates whether the location can operate on Lodging data. "duplicateLocation": "A String", # Output only. The location resource that this location duplicates. "hasGoogleUpdated": True or False, # Output only. Indicates whether the place ID associated with this location has updates that need to be updated or rejected by the client. If this boolean is set, you should call the `getGoogleUpdated` method to lookup information that's needs to be verified. @@ -390,7 +390,7 @@

Method Details

"canHaveFoodMenus": True or False, # Output only. Indicates if the listing is eligible for food menu. "canModifyServiceList": True or False, # Output only. Indicates if the listing can modify the service list. "canOperateHealthData": True or False, # Output only. Indicates whether the location can operate on Health data. - "canOperateLocalPost": True or False, # Output only. Indicates if the listing can manage local posts. + "canOperateLocalPost": True or False, # Output only. Indicates if the listing can manage local posts. Deprecated: This field is no longer populated and will be removed in a future version. "canOperateLodgingData": True or False, # Output only. Indicates whether the location can operate on Lodging data. "duplicateLocation": "A String", # Output only. The location resource that this location duplicates. "hasGoogleUpdated": True or False, # Output only. Indicates whether the place ID associated with this location has updates that need to be updated or rejected by the client. If this boolean is set, you should call the `getGoogleUpdated` method to lookup information that's needs to be verified. diff --git a/docs/dyn/mybusinessbusinessinformation_v1.locations.html b/docs/dyn/mybusinessbusinessinformation_v1.locations.html index 918cb76a98e..9d6a46d53b3 100644 --- a/docs/dyn/mybusinessbusinessinformation_v1.locations.html +++ b/docs/dyn/mybusinessbusinessinformation_v1.locations.html @@ -195,7 +195,7 @@

Method Details

"canHaveFoodMenus": True or False, # Output only. Indicates if the listing is eligible for food menu. "canModifyServiceList": True or False, # Output only. Indicates if the listing can modify the service list. "canOperateHealthData": True or False, # Output only. Indicates whether the location can operate on Health data. - "canOperateLocalPost": True or False, # Output only. Indicates if the listing can manage local posts. + "canOperateLocalPost": True or False, # Output only. Indicates if the listing can manage local posts. Deprecated: This field is no longer populated and will be removed in a future version. "canOperateLodgingData": True or False, # Output only. Indicates whether the location can operate on Lodging data. "duplicateLocation": "A String", # Output only. The location resource that this location duplicates. "hasGoogleUpdated": True or False, # Output only. Indicates whether the place ID associated with this location has updates that need to be updated or rejected by the client. If this boolean is set, you should call the `getGoogleUpdated` method to lookup information that's needs to be verified. @@ -479,7 +479,7 @@

Method Details

"canHaveFoodMenus": True or False, # Output only. Indicates if the listing is eligible for food menu. "canModifyServiceList": True or False, # Output only. Indicates if the listing can modify the service list. "canOperateHealthData": True or False, # Output only. Indicates whether the location can operate on Health data. - "canOperateLocalPost": True or False, # Output only. Indicates if the listing can manage local posts. + "canOperateLocalPost": True or False, # Output only. Indicates if the listing can manage local posts. Deprecated: This field is no longer populated and will be removed in a future version. "canOperateLodgingData": True or False, # Output only. Indicates whether the location can operate on Lodging data. "duplicateLocation": "A String", # Output only. The location resource that this location duplicates. "hasGoogleUpdated": True or False, # Output only. Indicates whether the place ID associated with this location has updates that need to be updated or rejected by the client. If this boolean is set, you should call the `getGoogleUpdated` method to lookup information that's needs to be verified. @@ -716,7 +716,7 @@

Method Details

"canHaveFoodMenus": True or False, # Output only. Indicates if the listing is eligible for food menu. "canModifyServiceList": True or False, # Output only. Indicates if the listing can modify the service list. "canOperateHealthData": True or False, # Output only. Indicates whether the location can operate on Health data. - "canOperateLocalPost": True or False, # Output only. Indicates if the listing can manage local posts. + "canOperateLocalPost": True or False, # Output only. Indicates if the listing can manage local posts. Deprecated: This field is no longer populated and will be removed in a future version. "canOperateLodgingData": True or False, # Output only. Indicates whether the location can operate on Lodging data. "duplicateLocation": "A String", # Output only. The location resource that this location duplicates. "hasGoogleUpdated": True or False, # Output only. Indicates whether the place ID associated with this location has updates that need to be updated or rejected by the client. If this boolean is set, you should call the `getGoogleUpdated` method to lookup information that's needs to be verified. @@ -951,7 +951,7 @@

Method Details

"canHaveFoodMenus": True or False, # Output only. Indicates if the listing is eligible for food menu. "canModifyServiceList": True or False, # Output only. Indicates if the listing can modify the service list. "canOperateHealthData": True or False, # Output only. Indicates whether the location can operate on Health data. - "canOperateLocalPost": True or False, # Output only. Indicates if the listing can manage local posts. + "canOperateLocalPost": True or False, # Output only. Indicates if the listing can manage local posts. Deprecated: This field is no longer populated and will be removed in a future version. "canOperateLodgingData": True or False, # Output only. Indicates whether the location can operate on Lodging data. "duplicateLocation": "A String", # Output only. The location resource that this location duplicates. "hasGoogleUpdated": True or False, # Output only. Indicates whether the place ID associated with this location has updates that need to be updated or rejected by the client. If this boolean is set, you should call the `getGoogleUpdated` method to lookup information that's needs to be verified. diff --git a/googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json b/googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json index 575aecc23cd..3e56a068687 100644 --- a/googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json @@ -612,7 +612,7 @@ } } }, -"revision": "20241120", +"revision": "20250217", "rootUrl": "https://mybusinessbusinessinformation.googleapis.com/", "schemas": { "AdWordsLocationExtensions": { @@ -1198,7 +1198,8 @@ "type": "boolean" }, "canOperateLocalPost": { -"description": "Output only. Indicates if the listing can manage local posts.", +"deprecated": true, +"description": "Output only. Indicates if the listing can manage local posts. Deprecated: This field is no longer populated and will be removed in a future version.", "readOnly": true, "type": "boolean" }, From edbf3bd7b70630c1f66a00ef520b44a312d9b2dd Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 25 Feb 2025 07:08:19 +0000 Subject: [PATCH 22/36] feat(ondemandscanning): update the api #### ondemandscanning:v1 The following keys were deleted: - schemas.BaseImage.properties.numLayers.type (Total Keys: 1) The following keys were added: - schemas.BaseImage.properties.layerCount (Total Keys: 2) - schemas.FileLocation.properties.layerDetails.$ref (Total Keys: 1) - schemas.GrafeasV1BaseImage (Total Keys: 6) - schemas.GrafeasV1FileLocation.properties.layerDetails.$ref (Total Keys: 1) - schemas.GrafeasV1LayerDetails (Total Keys: 8) #### ondemandscanning:v1beta1 The following keys were deleted: - schemas.BaseImage.properties.numLayers.type (Total Keys: 1) The following keys were added: - schemas.BaseImage.properties.layerCount (Total Keys: 2) - schemas.FileLocation.properties.layerDetails.$ref (Total Keys: 1) - schemas.GrafeasV1BaseImage (Total Keys: 6) - schemas.GrafeasV1FileLocation.properties.layerDetails.$ref (Total Keys: 1) - schemas.GrafeasV1LayerDetails (Total Keys: 8) --- ...dscanning_v1.projects.locations.scans.html | 14 +++- ...jects.locations.scans.vulnerabilities.html | 12 ++++ ...ning_v1beta1.projects.locations.scans.html | 14 +++- ...jects.locations.scans.vulnerabilities.html | 12 ++++ .../documents/ondemandscanning.v1.json | 65 +++++++++++++++++-- .../documents/ondemandscanning.v1beta1.json | 65 +++++++++++++++++-- 6 files changed, 170 insertions(+), 12 deletions(-) diff --git a/docs/dyn/ondemandscanning_v1.projects.locations.scans.html b/docs/dyn/ondemandscanning_v1.projects.locations.scans.html index 4512d86e97f..6a14c6a2277 100644 --- a/docs/dyn/ondemandscanning_v1.projects.locations.scans.html +++ b/docs/dyn/ondemandscanning_v1.projects.locations.scans.html @@ -135,14 +135,26 @@

Method Details

"fileLocation": [ # The path to the jar file / go binary file. { # Indicates the location at which a package was found. "filePath": "A String", # For jars that are contained inside .war files, this filepath can indicate the path to war file combined with the path to jar file. + "layerDetails": { # Details about the layer a package was found in. This should be the same as the LayerDetails message in google3/third_party/scalibr/binary/proto/scan_result.proto. + "baseImages": [ # The base images the layer is found within. + { # BaseImage describes a base image of a container image. + "layerCount": 42, # The number of layers that the base image is composed of. + "name": "A String", # The name of the base image. + "repository": "A String", # The repository name in which the base image is from. + }, + ], + "command": "A String", # The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built. + "diffId": "A String", # The diff ID (sha256 hash) of the layer in the container image. + "index": 42, # The index of the layer in the container image. + }, }, ], "hashDigest": "A String", # HashDigest stores the SHA512 hash digest of the jar file if the package is of type Maven. This field will be unset for non Maven packages. "layerDetails": { # Details about the layer a package was found in. This should be the same as the LayerDetails message in google3/third_party/scalibr/binary/proto/scan_result.proto. "baseImages": [ # The base images the layer is found within. { # BaseImage describes a base image of a container image. + "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. - "numLayers": "A String", # The number of layers that the base image is composed of. "repository": "A String", # The repository name in which the base image is from. }, ], diff --git a/docs/dyn/ondemandscanning_v1.projects.locations.scans.vulnerabilities.html b/docs/dyn/ondemandscanning_v1.projects.locations.scans.vulnerabilities.html index 7a4e3309c90..d74a1796e23 100644 --- a/docs/dyn/ondemandscanning_v1.projects.locations.scans.vulnerabilities.html +++ b/docs/dyn/ondemandscanning_v1.projects.locations.scans.vulnerabilities.html @@ -865,6 +865,18 @@

Method Details

"fileLocation": [ # The location at which this package was found. { # Indicates the location at which a package was found. "filePath": "A String", # For jars that are contained inside .war files, this filepath can indicate the path to war file combined with the path to jar file. + "layerDetails": { # Details about the layer a package was found in. # Each package found in a file should have its own layer metadata (that is, information from the origin layer of the package). + "baseImages": [ # The base images the layer is found within. + { # BaseImage describes a base image of a container image. + "layerCount": 42, # The number of layers that the base image is composed of. + "name": "A String", # The name of the base image. + "repository": "A String", # The repository name in which the base image is from. + }, + ], + "command": "A String", # The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built. + "diffId": "A String", # The diff ID (typically a sha256 hash) of the layer in the container image. + "index": 42, # The index of the layer in the container image. + }, }, ], "fixAvailable": True or False, # Output only. Whether a fix is available for this package. diff --git a/docs/dyn/ondemandscanning_v1beta1.projects.locations.scans.html b/docs/dyn/ondemandscanning_v1beta1.projects.locations.scans.html index 13e7ad9b641..714ec385d70 100644 --- a/docs/dyn/ondemandscanning_v1beta1.projects.locations.scans.html +++ b/docs/dyn/ondemandscanning_v1beta1.projects.locations.scans.html @@ -134,14 +134,26 @@

Method Details

"fileLocation": [ # The path to the jar file / go binary file. { # Indicates the location at which a package was found. "filePath": "A String", # For jars that are contained inside .war files, this filepath can indicate the path to war file combined with the path to jar file. + "layerDetails": { # Details about the layer a package was found in. This should be the same as the LayerDetails message in google3/third_party/scalibr/binary/proto/scan_result.proto. + "baseImages": [ # The base images the layer is found within. + { # BaseImage describes a base image of a container image. + "layerCount": 42, # The number of layers that the base image is composed of. + "name": "A String", # The name of the base image. + "repository": "A String", # The repository name in which the base image is from. + }, + ], + "command": "A String", # The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built. + "diffId": "A String", # The diff ID (sha256 hash) of the layer in the container image. + "index": 42, # The index of the layer in the container image. + }, }, ], "hashDigest": "A String", # HashDigest stores the SHA512 hash digest of the jar file if the package is of type Maven. This field will be unset for non Maven packages. "layerDetails": { # Details about the layer a package was found in. This should be the same as the LayerDetails message in google3/third_party/scalibr/binary/proto/scan_result.proto. "baseImages": [ # The base images the layer is found within. { # BaseImage describes a base image of a container image. + "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. - "numLayers": "A String", # The number of layers that the base image is composed of. "repository": "A String", # The repository name in which the base image is from. }, ], diff --git a/docs/dyn/ondemandscanning_v1beta1.projects.locations.scans.vulnerabilities.html b/docs/dyn/ondemandscanning_v1beta1.projects.locations.scans.vulnerabilities.html index 0b8e033cdeb..779e7384c9c 100644 --- a/docs/dyn/ondemandscanning_v1beta1.projects.locations.scans.vulnerabilities.html +++ b/docs/dyn/ondemandscanning_v1beta1.projects.locations.scans.vulnerabilities.html @@ -865,6 +865,18 @@

Method Details

"fileLocation": [ # The location at which this package was found. { # Indicates the location at which a package was found. "filePath": "A String", # For jars that are contained inside .war files, this filepath can indicate the path to war file combined with the path to jar file. + "layerDetails": { # Details about the layer a package was found in. # Each package found in a file should have its own layer metadata (that is, information from the origin layer of the package). + "baseImages": [ # The base images the layer is found within. + { # BaseImage describes a base image of a container image. + "layerCount": 42, # The number of layers that the base image is composed of. + "name": "A String", # The name of the base image. + "repository": "A String", # The repository name in which the base image is from. + }, + ], + "command": "A String", # The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built. + "diffId": "A String", # The diff ID (typically a sha256 hash) of the layer in the container image. + "index": 42, # The index of the layer in the container image. + }, }, ], "fixAvailable": True or False, # Output only. Whether a fix is available for this package. diff --git a/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json b/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json index 032df64ed6f..50978016da2 100644 --- a/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json +++ b/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json @@ -339,7 +339,7 @@ } } }, -"revision": "20250210", +"revision": "20250217", "rootUrl": "https://ondemandscanning.googleapis.com/", "schemas": { "AliasContext": { @@ -511,14 +511,15 @@ "description": "BaseImage describes a base image of a container image.", "id": "BaseImage", "properties": { +"layerCount": { +"description": "The number of layers that the base image is composed of.", +"format": "int32", +"type": "integer" +}, "name": { "description": "The name of the base image.", "type": "string" }, -"numLayers": { -"description": "The number of layers that the base image is composed of.", -"type": "string" -}, "repository": { "description": "The repository name in which the base image is from.", "type": "string" @@ -1193,6 +1194,9 @@ "filePath": { "description": "For jars that are contained inside .war files, this filepath can indicate the path to war file combined with the path to jar file.", "type": "string" +}, +"layerDetails": { +"$ref": "LayerDetails" } }, "type": "object" @@ -1257,6 +1261,26 @@ }, "type": "object" }, +"GrafeasV1BaseImage": { +"description": "BaseImage describes a base image of a container image.", +"id": "GrafeasV1BaseImage", +"properties": { +"layerCount": { +"description": "The number of layers that the base image is composed of.", +"format": "int32", +"type": "integer" +}, +"name": { +"description": "The name of the base image.", +"type": "string" +}, +"repository": { +"description": "The repository name in which the base image is from.", +"type": "string" +} +}, +"type": "object" +}, "GrafeasV1FileLocation": { "description": "Indicates the location at which a package was found.", "id": "GrafeasV1FileLocation", @@ -1264,6 +1288,37 @@ "filePath": { "description": "For jars that are contained inside .war files, this filepath can indicate the path to war file combined with the path to jar file.", "type": "string" +}, +"layerDetails": { +"$ref": "GrafeasV1LayerDetails", +"description": "Each package found in a file should have its own layer metadata (that is, information from the origin layer of the package)." +} +}, +"type": "object" +}, +"GrafeasV1LayerDetails": { +"description": "Details about the layer a package was found in.", +"id": "GrafeasV1LayerDetails", +"properties": { +"baseImages": { +"description": "The base images the layer is found within.", +"items": { +"$ref": "GrafeasV1BaseImage" +}, +"type": "array" +}, +"command": { +"description": "The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built.", +"type": "string" +}, +"diffId": { +"description": "The diff ID (typically a sha256 hash) of the layer in the container image.", +"type": "string" +}, +"index": { +"description": "The index of the layer in the container image.", +"format": "int32", +"type": "integer" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json b/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json index 1de2ba671e2..63f21d1071e 100644 --- a/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json @@ -339,7 +339,7 @@ } } }, -"revision": "20250210", +"revision": "20250217", "rootUrl": "https://ondemandscanning.googleapis.com/", "schemas": { "AliasContext": { @@ -506,14 +506,15 @@ "description": "BaseImage describes a base image of a container image.", "id": "BaseImage", "properties": { +"layerCount": { +"description": "The number of layers that the base image is composed of.", +"format": "int32", +"type": "integer" +}, "name": { "description": "The name of the base image.", "type": "string" }, -"numLayers": { -"description": "The number of layers that the base image is composed of.", -"type": "string" -}, "repository": { "description": "The repository name in which the base image is from.", "type": "string" @@ -1188,6 +1189,9 @@ "filePath": { "description": "For jars that are contained inside .war files, this filepath can indicate the path to war file combined with the path to jar file.", "type": "string" +}, +"layerDetails": { +"$ref": "LayerDetails" } }, "type": "object" @@ -1252,6 +1256,26 @@ }, "type": "object" }, +"GrafeasV1BaseImage": { +"description": "BaseImage describes a base image of a container image.", +"id": "GrafeasV1BaseImage", +"properties": { +"layerCount": { +"description": "The number of layers that the base image is composed of.", +"format": "int32", +"type": "integer" +}, +"name": { +"description": "The name of the base image.", +"type": "string" +}, +"repository": { +"description": "The repository name in which the base image is from.", +"type": "string" +} +}, +"type": "object" +}, "GrafeasV1FileLocation": { "description": "Indicates the location at which a package was found.", "id": "GrafeasV1FileLocation", @@ -1259,6 +1283,37 @@ "filePath": { "description": "For jars that are contained inside .war files, this filepath can indicate the path to war file combined with the path to jar file.", "type": "string" +}, +"layerDetails": { +"$ref": "GrafeasV1LayerDetails", +"description": "Each package found in a file should have its own layer metadata (that is, information from the origin layer of the package)." +} +}, +"type": "object" +}, +"GrafeasV1LayerDetails": { +"description": "Details about the layer a package was found in.", +"id": "GrafeasV1LayerDetails", +"properties": { +"baseImages": { +"description": "The base images the layer is found within.", +"items": { +"$ref": "GrafeasV1BaseImage" +}, +"type": "array" +}, +"command": { +"description": "The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built.", +"type": "string" +}, +"diffId": { +"description": "The diff ID (typically a sha256 hash) of the layer in the container image.", +"type": "string" +}, +"index": { +"description": "The index of the layer in the container image.", +"format": "int32", +"type": "integer" } }, "type": "object" From f0f64d4918311f1777fcb3d5469bc309df5f53e5 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 25 Feb 2025 07:08:19 +0000 Subject: [PATCH 23/36] feat(parallelstore): update the api #### parallelstore:v1 The following keys were added: - schemas.Instance.properties.daosVersion (Total Keys: 3) #### parallelstore:v1beta The following keys were added: - schemas.Instance.properties.daosVersion (Total Keys: 3) --- .../parallelstore_v1.projects.locations.instances.html | 4 ++++ ...parallelstore_v1beta.projects.locations.instances.html | 4 ++++ .../discovery_cache/documents/parallelstore.v1.json | 8 +++++++- .../discovery_cache/documents/parallelstore.v1beta.json | 8 +++++++- 4 files changed, 22 insertions(+), 2 deletions(-) diff --git a/docs/dyn/parallelstore_v1.projects.locations.instances.html b/docs/dyn/parallelstore_v1.projects.locations.instances.html index 417f34c8ea1..607c1c26b78 100644 --- a/docs/dyn/parallelstore_v1.projects.locations.instances.html +++ b/docs/dyn/parallelstore_v1.projects.locations.instances.html @@ -122,6 +122,7 @@

Method Details

], "capacityGib": "A String", # Required. Immutable. The instance's storage capacity in Gibibytes (GiB). Allowed values are between 12000 and 100000, in multiples of 4000; e.g., 12000, 16000, 20000, ... "createTime": "A String", # Output only. The time when the instance was created. + "daosVersion": "A String", # Output only. Deprecated 'daos_version' field. Output only. The version of DAOS software running in the instance. "deploymentType": "A String", # Optional. Immutable. The deployment type of the instance. Allowed values are: * `SCRATCH`: the instance is a scratch instance. * `PERSISTENT`: the instance is a persistent instance. "description": "A String", # Optional. The description of the instance. 2048 characters or less. "directoryStripeLevel": "A String", # Optional. Immutable. Stripe level for directories. Allowed values are: * `DIRECTORY_STRIPE_LEVEL_MIN`: recommended when directories contain a small number of files. * `DIRECTORY_STRIPE_LEVEL_BALANCED`: balances performance for workloads involving a mix of small and large directories. * `DIRECTORY_STRIPE_LEVEL_MAX`: recommended for directories with a large number of files. @@ -273,6 +274,7 @@

Method Details

], "capacityGib": "A String", # Required. Immutable. The instance's storage capacity in Gibibytes (GiB). Allowed values are between 12000 and 100000, in multiples of 4000; e.g., 12000, 16000, 20000, ... "createTime": "A String", # Output only. The time when the instance was created. + "daosVersion": "A String", # Output only. Deprecated 'daos_version' field. Output only. The version of DAOS software running in the instance. "deploymentType": "A String", # Optional. Immutable. The deployment type of the instance. Allowed values are: * `SCRATCH`: the instance is a scratch instance. * `PERSISTENT`: the instance is a persistent instance. "description": "A String", # Optional. The description of the instance. 2048 characters or less. "directoryStripeLevel": "A String", # Optional. Immutable. Stripe level for directories. Allowed values are: * `DIRECTORY_STRIPE_LEVEL_MIN`: recommended when directories contain a small number of files. * `DIRECTORY_STRIPE_LEVEL_BALANCED`: balances performance for workloads involving a mix of small and large directories. * `DIRECTORY_STRIPE_LEVEL_MAX`: recommended for directories with a large number of files. @@ -364,6 +366,7 @@

Method Details

], "capacityGib": "A String", # Required. Immutable. The instance's storage capacity in Gibibytes (GiB). Allowed values are between 12000 and 100000, in multiples of 4000; e.g., 12000, 16000, 20000, ... "createTime": "A String", # Output only. The time when the instance was created. + "daosVersion": "A String", # Output only. Deprecated 'daos_version' field. Output only. The version of DAOS software running in the instance. "deploymentType": "A String", # Optional. Immutable. The deployment type of the instance. Allowed values are: * `SCRATCH`: the instance is a scratch instance. * `PERSISTENT`: the instance is a persistent instance. "description": "A String", # Optional. The description of the instance. 2048 characters or less. "directoryStripeLevel": "A String", # Optional. Immutable. Stripe level for directories. Allowed values are: * `DIRECTORY_STRIPE_LEVEL_MIN`: recommended when directories contain a small number of files. * `DIRECTORY_STRIPE_LEVEL_BALANCED`: balances performance for workloads involving a mix of small and large directories. * `DIRECTORY_STRIPE_LEVEL_MAX`: recommended for directories with a large number of files. @@ -415,6 +418,7 @@

Method Details

], "capacityGib": "A String", # Required. Immutable. The instance's storage capacity in Gibibytes (GiB). Allowed values are between 12000 and 100000, in multiples of 4000; e.g., 12000, 16000, 20000, ... "createTime": "A String", # Output only. The time when the instance was created. + "daosVersion": "A String", # Output only. Deprecated 'daos_version' field. Output only. The version of DAOS software running in the instance. "deploymentType": "A String", # Optional. Immutable. The deployment type of the instance. Allowed values are: * `SCRATCH`: the instance is a scratch instance. * `PERSISTENT`: the instance is a persistent instance. "description": "A String", # Optional. The description of the instance. 2048 characters or less. "directoryStripeLevel": "A String", # Optional. Immutable. Stripe level for directories. Allowed values are: * `DIRECTORY_STRIPE_LEVEL_MIN`: recommended when directories contain a small number of files. * `DIRECTORY_STRIPE_LEVEL_BALANCED`: balances performance for workloads involving a mix of small and large directories. * `DIRECTORY_STRIPE_LEVEL_MAX`: recommended for directories with a large number of files. diff --git a/docs/dyn/parallelstore_v1beta.projects.locations.instances.html b/docs/dyn/parallelstore_v1beta.projects.locations.instances.html index 20ce41b5d56..3db1246a69a 100644 --- a/docs/dyn/parallelstore_v1beta.projects.locations.instances.html +++ b/docs/dyn/parallelstore_v1beta.projects.locations.instances.html @@ -122,6 +122,7 @@

Method Details

], "capacityGib": "A String", # Required. Immutable. The instance's storage capacity in Gibibytes (GiB). Allowed values are between 12000 and 100000, in multiples of 4000; e.g., 12000, 16000, 20000, ... "createTime": "A String", # Output only. The time when the instance was created. + "daosVersion": "A String", # Output only. Deprecated 'daos_version' field. Output only. The version of DAOS software running in the instance. "deploymentType": "A String", # Optional. Immutable. The deployment type of the instance. Allowed values are: * `SCRATCH`: the instance is a scratch instance. * `PERSISTENT`: the instance is a persistent instance. "description": "A String", # Optional. The description of the instance. 2048 characters or less. "directoryStripeLevel": "A String", # Optional. Immutable. Stripe level for directories. Allowed values are: * `DIRECTORY_STRIPE_LEVEL_MIN`: recommended when directories contain a small number of files. * `DIRECTORY_STRIPE_LEVEL_BALANCED`: balances performance for workloads involving a mix of small and large directories. * `DIRECTORY_STRIPE_LEVEL_MAX`: recommended for directories with a large number of files. @@ -273,6 +274,7 @@

Method Details

], "capacityGib": "A String", # Required. Immutable. The instance's storage capacity in Gibibytes (GiB). Allowed values are between 12000 and 100000, in multiples of 4000; e.g., 12000, 16000, 20000, ... "createTime": "A String", # Output only. The time when the instance was created. + "daosVersion": "A String", # Output only. Deprecated 'daos_version' field. Output only. The version of DAOS software running in the instance. "deploymentType": "A String", # Optional. Immutable. The deployment type of the instance. Allowed values are: * `SCRATCH`: the instance is a scratch instance. * `PERSISTENT`: the instance is a persistent instance. "description": "A String", # Optional. The description of the instance. 2048 characters or less. "directoryStripeLevel": "A String", # Optional. Immutable. Stripe level for directories. Allowed values are: * `DIRECTORY_STRIPE_LEVEL_MIN`: recommended when directories contain a small number of files. * `DIRECTORY_STRIPE_LEVEL_BALANCED`: balances performance for workloads involving a mix of small and large directories. * `DIRECTORY_STRIPE_LEVEL_MAX`: recommended for directories with a large number of files. @@ -364,6 +366,7 @@

Method Details

], "capacityGib": "A String", # Required. Immutable. The instance's storage capacity in Gibibytes (GiB). Allowed values are between 12000 and 100000, in multiples of 4000; e.g., 12000, 16000, 20000, ... "createTime": "A String", # Output only. The time when the instance was created. + "daosVersion": "A String", # Output only. Deprecated 'daos_version' field. Output only. The version of DAOS software running in the instance. "deploymentType": "A String", # Optional. Immutable. The deployment type of the instance. Allowed values are: * `SCRATCH`: the instance is a scratch instance. * `PERSISTENT`: the instance is a persistent instance. "description": "A String", # Optional. The description of the instance. 2048 characters or less. "directoryStripeLevel": "A String", # Optional. Immutable. Stripe level for directories. Allowed values are: * `DIRECTORY_STRIPE_LEVEL_MIN`: recommended when directories contain a small number of files. * `DIRECTORY_STRIPE_LEVEL_BALANCED`: balances performance for workloads involving a mix of small and large directories. * `DIRECTORY_STRIPE_LEVEL_MAX`: recommended for directories with a large number of files. @@ -415,6 +418,7 @@

Method Details

], "capacityGib": "A String", # Required. Immutable. The instance's storage capacity in Gibibytes (GiB). Allowed values are between 12000 and 100000, in multiples of 4000; e.g., 12000, 16000, 20000, ... "createTime": "A String", # Output only. The time when the instance was created. + "daosVersion": "A String", # Output only. Deprecated 'daos_version' field. Output only. The version of DAOS software running in the instance. "deploymentType": "A String", # Optional. Immutable. The deployment type of the instance. Allowed values are: * `SCRATCH`: the instance is a scratch instance. * `PERSISTENT`: the instance is a persistent instance. "description": "A String", # Optional. The description of the instance. 2048 characters or less. "directoryStripeLevel": "A String", # Optional. Immutable. Stripe level for directories. Allowed values are: * `DIRECTORY_STRIPE_LEVEL_MIN`: recommended when directories contain a small number of files. * `DIRECTORY_STRIPE_LEVEL_BALANCED`: balances performance for workloads involving a mix of small and large directories. * `DIRECTORY_STRIPE_LEVEL_MAX`: recommended for directories with a large number of files. diff --git a/googleapiclient/discovery_cache/documents/parallelstore.v1.json b/googleapiclient/discovery_cache/documents/parallelstore.v1.json index 055a168f783..2c06fc5be82 100644 --- a/googleapiclient/discovery_cache/documents/parallelstore.v1.json +++ b/googleapiclient/discovery_cache/documents/parallelstore.v1.json @@ -543,7 +543,7 @@ } } }, -"revision": "20250205", +"revision": "20250219", "rootUrl": "https://parallelstore.googleapis.com/", "schemas": { "CancelOperationRequest": { @@ -649,6 +649,12 @@ "readOnly": true, "type": "string" }, +"daosVersion": { +"deprecated": true, +"description": "Output only. Deprecated 'daos_version' field. Output only. The version of DAOS software running in the instance.", +"readOnly": true, +"type": "string" +}, "deploymentType": { "description": "Optional. Immutable. The deployment type of the instance. Allowed values are: * `SCRATCH`: the instance is a scratch instance. * `PERSISTENT`: the instance is a persistent instance.", "enum": [ diff --git a/googleapiclient/discovery_cache/documents/parallelstore.v1beta.json b/googleapiclient/discovery_cache/documents/parallelstore.v1beta.json index 9ca673ebd6d..2c40c9c478f 100644 --- a/googleapiclient/discovery_cache/documents/parallelstore.v1beta.json +++ b/googleapiclient/discovery_cache/documents/parallelstore.v1beta.json @@ -540,7 +540,7 @@ } } }, -"revision": "20250205", +"revision": "20250219", "rootUrl": "https://parallelstore.googleapis.com/", "schemas": { "DestinationGcsBucket": { @@ -640,6 +640,12 @@ "readOnly": true, "type": "string" }, +"daosVersion": { +"deprecated": true, +"description": "Output only. Deprecated 'daos_version' field. Output only. The version of DAOS software running in the instance.", +"readOnly": true, +"type": "string" +}, "deploymentType": { "description": "Optional. Immutable. The deployment type of the instance. Allowed values are: * `SCRATCH`: the instance is a scratch instance. * `PERSISTENT`: the instance is a persistent instance.", "enum": [ From cede46628ef28fcacefc6976896c861f08f88c29 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 25 Feb 2025 07:08:19 +0000 Subject: [PATCH 24/36] feat(playintegrity): update the api #### playintegrity:v1 The following keys were deleted: - schemas.AppAccessRiskVerdict.properties.otherApps (Total Keys: 2) - schemas.AppAccessRiskVerdict.properties.playOrSystemApps (Total Keys: 2) --- docs/dyn/playintegrity_v1.v1.html | 2 - .../documents/playintegrity.v1.json | 44 +------------------ 2 files changed, 1 insertion(+), 45 deletions(-) diff --git a/docs/dyn/playintegrity_v1.v1.html b/docs/dyn/playintegrity_v1.v1.html index a05e73cbf2a..de30c3d8cbb 100644 --- a/docs/dyn/playintegrity_v1.v1.html +++ b/docs/dyn/playintegrity_v1.v1.html @@ -154,8 +154,6 @@

Method Details

"appsDetected": [ # List of detected app types signalled for App Access Risk. "A String", ], - "otherApps": "A String", # Deprecated: this field will be removed, please use apps_detected instead. App access risk verdict related to apps that are not installed by Google Play, and are not preloaded on the system image by the device manufacturer. - "playOrSystemApps": "A String", # Deprecated: this field will be removed, please use apps_detected instead. App access risk verdict related to apps that are not installed by the Google Play Store, and are not preloaded on the system image by the device manufacturer. }, "playProtectVerdict": "A String", # The evaluation of Play Protect verdict. }, diff --git a/googleapiclient/discovery_cache/documents/playintegrity.v1.json b/googleapiclient/discovery_cache/documents/playintegrity.v1.json index e383bfa761b..e136b93b546 100644 --- a/googleapiclient/discovery_cache/documents/playintegrity.v1.json +++ b/googleapiclient/discovery_cache/documents/playintegrity.v1.json @@ -170,7 +170,7 @@ } } }, -"revision": "20241127", +"revision": "20250223", "rootUrl": "https://playintegrity.googleapis.com/", "schemas": { "AccountActivity": { @@ -259,48 +259,6 @@ "type": "string" }, "type": "array" -}, -"otherApps": { -"deprecated": true, -"description": "Deprecated: this field will be removed, please use apps_detected instead. App access risk verdict related to apps that are not installed by Google Play, and are not preloaded on the system image by the device manufacturer.", -"enum": [ -"UNKNOWN", -"UNEVALUATED", -"NOT_INSTALLED", -"INSTALLED", -"CAPTURING", -"CONTROLLING" -], -"enumDescriptions": [ -"Risk type is unknown.", -"App access risk was not evaluated because a requirement was missed, such as the device not being trusted enough.", -"No apps under this field are installed on the device. This is only valid for the other apps field.", -"One or more apps under this field are installed on the device.", -"Apps under this field are running that could be used to read or capture inputs and outputs of the requesting app, such as screen recording apps.", -"Apps under this field are running that could be used to control the device and inputs and outputs of the requesting app, such as remote controlling apps." -], -"type": "string" -}, -"playOrSystemApps": { -"deprecated": true, -"description": "Deprecated: this field will be removed, please use apps_detected instead. App access risk verdict related to apps that are not installed by the Google Play Store, and are not preloaded on the system image by the device manufacturer.", -"enum": [ -"UNKNOWN", -"UNEVALUATED", -"NOT_INSTALLED", -"INSTALLED", -"CAPTURING", -"CONTROLLING" -], -"enumDescriptions": [ -"Risk type is unknown.", -"App access risk was not evaluated because a requirement was missed, such as the device not being trusted enough.", -"No apps under this field are installed on the device. This is only valid for the other apps field.", -"One or more apps under this field are installed on the device.", -"Apps under this field are running that could be used to read or capture inputs and outputs of the requesting app, such as screen recording apps.", -"Apps under this field are running that could be used to control the device and inputs and outputs of the requesting app, such as remote controlling apps." -], -"type": "string" } }, "type": "object" From 70afb0fde5e22a089b317de253befb8004fb9dd7 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 25 Feb 2025 07:08:20 +0000 Subject: [PATCH 25/36] feat(redis): update the api #### redis:v1 The following keys were added: - schemas.DatabaseResourceMetadata.properties.gcbdrConfiguration.$ref (Total Keys: 1) - schemas.GCBDRConfiguration (Total Keys: 3) - schemas.PscConnection.properties.port (Total Keys: 3) #### redis:v1beta1 The following keys were added: - schemas.DatabaseResourceMetadata.properties.gcbdrConfiguration.$ref (Total Keys: 1) - schemas.GCBDRConfiguration (Total Keys: 3) - schemas.PscConnection.properties.port (Total Keys: 3) --- .../redis_v1.projects.locations.clusters.html | 46 +++++++++------- ...s_v1beta1.projects.locations.clusters.html | 46 +++++++++------- .../discovery_cache/documents/redis.v1.json | 55 ++++++++++++++----- .../documents/redis.v1beta1.json | 55 ++++++++++++++----- 4 files changed, 136 insertions(+), 66 deletions(-) diff --git a/docs/dyn/redis_v1.projects.locations.clusters.html b/docs/dyn/redis_v1.projects.locations.clusters.html index d7aac48347c..8eb6376c07f 100644 --- a/docs/dyn/redis_v1.projects.locations.clusters.html +++ b/docs/dyn/redis_v1.projects.locations.clusters.html @@ -178,9 +178,9 @@

Method Details

"retention": "A String", # Optional. How long to keep automated backups before the backups are deleted. The value should be between 1 day and 365 days. If not specified, the default value is 35 days. }, "backupCollection": "A String", # Optional. Output only. The backup collection full resource name. Example: projects/{project}/locations/{location}/backupCollections/{collection} - "clusterEndpoints": [ # Optional. A list of cluster enpoints. + "clusterEndpoints": [ # Optional. A list of cluster endpoints. { # ClusterEndpoint consists of PSC connections that are created as a group in each VPC network for accessing the cluster. In each group, there shall be one connection for each service attachment in the cluster. - "connections": [ # A group of PSC connections. They are created in the same VPC network, one for each service attachment in the cluster. + "connections": [ # Required. A group of PSC connections. They are created in the same VPC network, one for each service attachment in the cluster. { # Detailed information of each PSC connection. "pscAutoConnection": { # Details of consumer resources in a PSC connection that is created through Service Connectivity Automation. # Detailed information of a PSC connection that is created through service connectivity automation. "address": "A String", # Output only. The IP allocated on the consumer network for the PSC forwarding rule. @@ -197,6 +197,7 @@

Method Details

"connectionType": "A String", # Output only. Type of the PSC connection. "forwardingRule": "A String", # Required. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}. "network": "A String", # Required. The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}. + "port": 42, # Output only. The port number of the exposed discovery endpoint. "projectId": "A String", # Optional. Project ID of the consumer project where the forwarding rule is created in. "pscConnectionId": "A String", # Required. The PSC connection id of the forwarding rule connected to the service attachment. "pscConnectionStatus": "A String", # Output only. The status of the PSC connection. Please note that this value is updated periodically. To get the latest status of a PSC connection, follow https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details. @@ -252,7 +253,7 @@

Method Details

"lastUpdateTime": "A String", # Output only. The most recent time when the encryption info was updated. }, "gcsSource": { # Backups stored in Cloud Storage buckets. The Cloud Storage buckets need to be the same region as the clusters. # Optional. Backups stored in Cloud Storage buckets. The Cloud Storage buckets need to be the same region as the clusters. Read permission is required to import from the provided Cloud Storage objects. - "uris": [ # Optional. URIs of the GCS objects to import. Example: gs://bucket1/object1, gs://bucket2/folder2/object2 + "uris": [ # Optional. URIs of the Cloud Storage objects to import. Example: gs://bucket1/object1, gs://bucket2/folder2/object2 "A String", ], }, @@ -272,7 +273,7 @@

Method Details

}, ], }, - "maintenanceSchedule": { # Upcoming maitenance schedule. # Output only. ClusterMaintenanceSchedule Output only Published maintenance schedule. + "maintenanceSchedule": { # Upcoming maintenance schedule. # Output only. ClusterMaintenanceSchedule Output only Published maintenance schedule. "endTime": "A String", # Output only. The end time of any upcoming scheduled maintenance for this instance. "startTime": "A String", # Output only. The start time of any upcoming scheduled maintenance for this instance. }, @@ -303,6 +304,7 @@

Method Details

"connectionType": "A String", # Output only. Type of the PSC connection. "forwardingRule": "A String", # Required. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}. "network": "A String", # Required. The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}. + "port": 42, # Output only. The port number of the exposed discovery endpoint. "projectId": "A String", # Optional. Project ID of the consumer project where the forwarding rule is created in. "pscConnectionId": "A String", # Required. The PSC connection id of the forwarding rule connected to the service attachment. "pscConnectionStatus": "A String", # Output only. The status of the PSC connection. Please note that this value is updated periodically. To get the latest status of a PSC connection, follow https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details. @@ -338,7 +340,7 @@

Method Details

} clusterId: string, Required. The logical name of the Redis cluster in the customer project with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the customer project / location - requestId: string, Idempotent request UUID. + requestId: string, Optional. Idempotent request UUID. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -374,7 +376,7 @@

Method Details

Args: name: string, Required. Redis cluster resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` where `location_id` refers to a GCP region. (required) - requestId: string, Idempotent request UUID. + requestId: string, Optional. Idempotent request UUID. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -434,9 +436,9 @@

Method Details

"retention": "A String", # Optional. How long to keep automated backups before the backups are deleted. The value should be between 1 day and 365 days. If not specified, the default value is 35 days. }, "backupCollection": "A String", # Optional. Output only. The backup collection full resource name. Example: projects/{project}/locations/{location}/backupCollections/{collection} - "clusterEndpoints": [ # Optional. A list of cluster enpoints. + "clusterEndpoints": [ # Optional. A list of cluster endpoints. { # ClusterEndpoint consists of PSC connections that are created as a group in each VPC network for accessing the cluster. In each group, there shall be one connection for each service attachment in the cluster. - "connections": [ # A group of PSC connections. They are created in the same VPC network, one for each service attachment in the cluster. + "connections": [ # Required. A group of PSC connections. They are created in the same VPC network, one for each service attachment in the cluster. { # Detailed information of each PSC connection. "pscAutoConnection": { # Details of consumer resources in a PSC connection that is created through Service Connectivity Automation. # Detailed information of a PSC connection that is created through service connectivity automation. "address": "A String", # Output only. The IP allocated on the consumer network for the PSC forwarding rule. @@ -453,6 +455,7 @@

Method Details

"connectionType": "A String", # Output only. Type of the PSC connection. "forwardingRule": "A String", # Required. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}. "network": "A String", # Required. The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}. + "port": 42, # Output only. The port number of the exposed discovery endpoint. "projectId": "A String", # Optional. Project ID of the consumer project where the forwarding rule is created in. "pscConnectionId": "A String", # Required. The PSC connection id of the forwarding rule connected to the service attachment. "pscConnectionStatus": "A String", # Output only. The status of the PSC connection. Please note that this value is updated periodically. To get the latest status of a PSC connection, follow https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details. @@ -508,7 +511,7 @@

Method Details

"lastUpdateTime": "A String", # Output only. The most recent time when the encryption info was updated. }, "gcsSource": { # Backups stored in Cloud Storage buckets. The Cloud Storage buckets need to be the same region as the clusters. # Optional. Backups stored in Cloud Storage buckets. The Cloud Storage buckets need to be the same region as the clusters. Read permission is required to import from the provided Cloud Storage objects. - "uris": [ # Optional. URIs of the GCS objects to import. Example: gs://bucket1/object1, gs://bucket2/folder2/object2 + "uris": [ # Optional. URIs of the Cloud Storage objects to import. Example: gs://bucket1/object1, gs://bucket2/folder2/object2 "A String", ], }, @@ -528,7 +531,7 @@

Method Details

}, ], }, - "maintenanceSchedule": { # Upcoming maitenance schedule. # Output only. ClusterMaintenanceSchedule Output only Published maintenance schedule. + "maintenanceSchedule": { # Upcoming maintenance schedule. # Output only. ClusterMaintenanceSchedule Output only Published maintenance schedule. "endTime": "A String", # Output only. The end time of any upcoming scheduled maintenance for this instance. "startTime": "A String", # Output only. The start time of any upcoming scheduled maintenance for this instance. }, @@ -559,6 +562,7 @@

Method Details

"connectionType": "A String", # Output only. Type of the PSC connection. "forwardingRule": "A String", # Required. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}. "network": "A String", # Required. The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}. + "port": 42, # Output only. The port number of the exposed discovery endpoint. "projectId": "A String", # Optional. Project ID of the consumer project where the forwarding rule is created in. "pscConnectionId": "A String", # Required. The PSC connection id of the forwarding rule connected to the service attachment. "pscConnectionStatus": "A String", # Output only. The status of the PSC connection. Please note that this value is updated periodically. To get the latest status of a PSC connection, follow https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details. @@ -656,9 +660,9 @@

Method Details

"retention": "A String", # Optional. How long to keep automated backups before the backups are deleted. The value should be between 1 day and 365 days. If not specified, the default value is 35 days. }, "backupCollection": "A String", # Optional. Output only. The backup collection full resource name. Example: projects/{project}/locations/{location}/backupCollections/{collection} - "clusterEndpoints": [ # Optional. A list of cluster enpoints. + "clusterEndpoints": [ # Optional. A list of cluster endpoints. { # ClusterEndpoint consists of PSC connections that are created as a group in each VPC network for accessing the cluster. In each group, there shall be one connection for each service attachment in the cluster. - "connections": [ # A group of PSC connections. They are created in the same VPC network, one for each service attachment in the cluster. + "connections": [ # Required. A group of PSC connections. They are created in the same VPC network, one for each service attachment in the cluster. { # Detailed information of each PSC connection. "pscAutoConnection": { # Details of consumer resources in a PSC connection that is created through Service Connectivity Automation. # Detailed information of a PSC connection that is created through service connectivity automation. "address": "A String", # Output only. The IP allocated on the consumer network for the PSC forwarding rule. @@ -675,6 +679,7 @@

Method Details

"connectionType": "A String", # Output only. Type of the PSC connection. "forwardingRule": "A String", # Required. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}. "network": "A String", # Required. The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}. + "port": 42, # Output only. The port number of the exposed discovery endpoint. "projectId": "A String", # Optional. Project ID of the consumer project where the forwarding rule is created in. "pscConnectionId": "A String", # Required. The PSC connection id of the forwarding rule connected to the service attachment. "pscConnectionStatus": "A String", # Output only. The status of the PSC connection. Please note that this value is updated periodically. To get the latest status of a PSC connection, follow https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details. @@ -730,7 +735,7 @@

Method Details

"lastUpdateTime": "A String", # Output only. The most recent time when the encryption info was updated. }, "gcsSource": { # Backups stored in Cloud Storage buckets. The Cloud Storage buckets need to be the same region as the clusters. # Optional. Backups stored in Cloud Storage buckets. The Cloud Storage buckets need to be the same region as the clusters. Read permission is required to import from the provided Cloud Storage objects. - "uris": [ # Optional. URIs of the GCS objects to import. Example: gs://bucket1/object1, gs://bucket2/folder2/object2 + "uris": [ # Optional. URIs of the Cloud Storage objects to import. Example: gs://bucket1/object1, gs://bucket2/folder2/object2 "A String", ], }, @@ -750,7 +755,7 @@

Method Details

}, ], }, - "maintenanceSchedule": { # Upcoming maitenance schedule. # Output only. ClusterMaintenanceSchedule Output only Published maintenance schedule. + "maintenanceSchedule": { # Upcoming maintenance schedule. # Output only. ClusterMaintenanceSchedule Output only Published maintenance schedule. "endTime": "A String", # Output only. The end time of any upcoming scheduled maintenance for this instance. "startTime": "A String", # Output only. The start time of any upcoming scheduled maintenance for this instance. }, @@ -781,6 +786,7 @@

Method Details

"connectionType": "A String", # Output only. Type of the PSC connection. "forwardingRule": "A String", # Required. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}. "network": "A String", # Required. The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}. + "port": 42, # Output only. The port number of the exposed discovery endpoint. "projectId": "A String", # Optional. Project ID of the consumer project where the forwarding rule is created in. "pscConnectionId": "A String", # Required. The PSC connection id of the forwarding rule connected to the service attachment. "pscConnectionStatus": "A String", # Output only. The status of the PSC connection. Please note that this value is updated periodically. To get the latest status of a PSC connection, follow https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details. @@ -861,9 +867,9 @@

Method Details

"retention": "A String", # Optional. How long to keep automated backups before the backups are deleted. The value should be between 1 day and 365 days. If not specified, the default value is 35 days. }, "backupCollection": "A String", # Optional. Output only. The backup collection full resource name. Example: projects/{project}/locations/{location}/backupCollections/{collection} - "clusterEndpoints": [ # Optional. A list of cluster enpoints. + "clusterEndpoints": [ # Optional. A list of cluster endpoints. { # ClusterEndpoint consists of PSC connections that are created as a group in each VPC network for accessing the cluster. In each group, there shall be one connection for each service attachment in the cluster. - "connections": [ # A group of PSC connections. They are created in the same VPC network, one for each service attachment in the cluster. + "connections": [ # Required. A group of PSC connections. They are created in the same VPC network, one for each service attachment in the cluster. { # Detailed information of each PSC connection. "pscAutoConnection": { # Details of consumer resources in a PSC connection that is created through Service Connectivity Automation. # Detailed information of a PSC connection that is created through service connectivity automation. "address": "A String", # Output only. The IP allocated on the consumer network for the PSC forwarding rule. @@ -880,6 +886,7 @@

Method Details

"connectionType": "A String", # Output only. Type of the PSC connection. "forwardingRule": "A String", # Required. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}. "network": "A String", # Required. The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}. + "port": 42, # Output only. The port number of the exposed discovery endpoint. "projectId": "A String", # Optional. Project ID of the consumer project where the forwarding rule is created in. "pscConnectionId": "A String", # Required. The PSC connection id of the forwarding rule connected to the service attachment. "pscConnectionStatus": "A String", # Output only. The status of the PSC connection. Please note that this value is updated periodically. To get the latest status of a PSC connection, follow https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details. @@ -935,7 +942,7 @@

Method Details

"lastUpdateTime": "A String", # Output only. The most recent time when the encryption info was updated. }, "gcsSource": { # Backups stored in Cloud Storage buckets. The Cloud Storage buckets need to be the same region as the clusters. # Optional. Backups stored in Cloud Storage buckets. The Cloud Storage buckets need to be the same region as the clusters. Read permission is required to import from the provided Cloud Storage objects. - "uris": [ # Optional. URIs of the GCS objects to import. Example: gs://bucket1/object1, gs://bucket2/folder2/object2 + "uris": [ # Optional. URIs of the Cloud Storage objects to import. Example: gs://bucket1/object1, gs://bucket2/folder2/object2 "A String", ], }, @@ -955,7 +962,7 @@

Method Details

}, ], }, - "maintenanceSchedule": { # Upcoming maitenance schedule. # Output only. ClusterMaintenanceSchedule Output only Published maintenance schedule. + "maintenanceSchedule": { # Upcoming maintenance schedule. # Output only. ClusterMaintenanceSchedule Output only Published maintenance schedule. "endTime": "A String", # Output only. The end time of any upcoming scheduled maintenance for this instance. "startTime": "A String", # Output only. The start time of any upcoming scheduled maintenance for this instance. }, @@ -986,6 +993,7 @@

Method Details

"connectionType": "A String", # Output only. Type of the PSC connection. "forwardingRule": "A String", # Required. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}. "network": "A String", # Required. The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}. + "port": 42, # Output only. The port number of the exposed discovery endpoint. "projectId": "A String", # Optional. Project ID of the consumer project where the forwarding rule is created in. "pscConnectionId": "A String", # Required. The PSC connection id of the forwarding rule connected to the service attachment. "pscConnectionStatus": "A String", # Output only. The status of the PSC connection. Please note that this value is updated periodically. To get the latest status of a PSC connection, follow https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details. @@ -1020,7 +1028,7 @@

Method Details

}, } - requestId: string, Idempotent request UUID. + requestId: string, Optional. Idempotent request UUID. updateMask: string, Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from Cluster: * `size_gb` * `replica_count` * `cluster_endpoints` x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/redis_v1beta1.projects.locations.clusters.html b/docs/dyn/redis_v1beta1.projects.locations.clusters.html index 88784f36c32..4653ab32dee 100644 --- a/docs/dyn/redis_v1beta1.projects.locations.clusters.html +++ b/docs/dyn/redis_v1beta1.projects.locations.clusters.html @@ -178,9 +178,9 @@

Method Details

"retention": "A String", # Optional. How long to keep automated backups before the backups are deleted. The value should be between 1 day and 365 days. If not specified, the default value is 35 days. }, "backupCollection": "A String", # Optional. Output only. The backup collection full resource name. Example: projects/{project}/locations/{location}/backupCollections/{collection} - "clusterEndpoints": [ # Optional. A list of cluster enpoints. + "clusterEndpoints": [ # Optional. A list of cluster endpoints. { # ClusterEndpoint consists of PSC connections that are created as a group in each VPC network for accessing the cluster. In each group, there shall be one connection for each service attachment in the cluster. - "connections": [ # A group of PSC connections. They are created in the same VPC network, one for each service attachment in the cluster. + "connections": [ # Required. A group of PSC connections. They are created in the same VPC network, one for each service attachment in the cluster. { # Detailed information of each PSC connection. "pscAutoConnection": { # Details of consumer resources in a PSC connection that is created through Service Connectivity Automation. # Detailed information of a PSC connection that is created through service connectivity automation. "address": "A String", # Output only. The IP allocated on the consumer network for the PSC forwarding rule. @@ -197,6 +197,7 @@

Method Details

"connectionType": "A String", # Output only. Type of the PSC connection. "forwardingRule": "A String", # Required. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}. "network": "A String", # Required. The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}. + "port": 42, # Output only. The port number of the exposed discovery endpoint. "projectId": "A String", # Optional. Project ID of the consumer project where the forwarding rule is created in. "pscConnectionId": "A String", # Required. The PSC connection id of the forwarding rule connected to the service attachment. "pscConnectionStatus": "A String", # Output only. The status of the PSC connection. Please note that this value is updated periodically. To get the latest status of a PSC connection, follow https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details. @@ -252,7 +253,7 @@

Method Details

"lastUpdateTime": "A String", # Output only. The most recent time when the encryption info was updated. }, "gcsSource": { # Backups stored in Cloud Storage buckets. The Cloud Storage buckets need to be the same region as the clusters. # Optional. Backups stored in Cloud Storage buckets. The Cloud Storage buckets need to be the same region as the clusters. Read permission is required to import from the provided Cloud Storage objects. - "uris": [ # Optional. URIs of the GCS objects to import. Example: gs://bucket1/object1, gs://bucket2/folder2/object2 + "uris": [ # Optional. URIs of the Cloud Storage objects to import. Example: gs://bucket1/object1, gs://bucket2/folder2/object2 "A String", ], }, @@ -272,7 +273,7 @@

Method Details

}, ], }, - "maintenanceSchedule": { # Upcoming maitenance schedule. # Output only. ClusterMaintenanceSchedule Output only Published maintenance schedule. + "maintenanceSchedule": { # Upcoming maintenance schedule. # Output only. ClusterMaintenanceSchedule Output only Published maintenance schedule. "endTime": "A String", # Output only. The end time of any upcoming scheduled maintenance for this instance. "startTime": "A String", # Output only. The start time of any upcoming scheduled maintenance for this instance. }, @@ -303,6 +304,7 @@

Method Details

"connectionType": "A String", # Output only. Type of the PSC connection. "forwardingRule": "A String", # Required. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}. "network": "A String", # Required. The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}. + "port": 42, # Output only. The port number of the exposed discovery endpoint. "projectId": "A String", # Optional. Project ID of the consumer project where the forwarding rule is created in. "pscConnectionId": "A String", # Required. The PSC connection id of the forwarding rule connected to the service attachment. "pscConnectionStatus": "A String", # Output only. The status of the PSC connection. Please note that this value is updated periodically. To get the latest status of a PSC connection, follow https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details. @@ -338,7 +340,7 @@

Method Details

} clusterId: string, Required. The logical name of the Redis cluster in the customer project with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the customer project / location - requestId: string, Idempotent request UUID. + requestId: string, Optional. Idempotent request UUID. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -374,7 +376,7 @@

Method Details

Args: name: string, Required. Redis cluster resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` where `location_id` refers to a GCP region. (required) - requestId: string, Idempotent request UUID. + requestId: string, Optional. Idempotent request UUID. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -434,9 +436,9 @@

Method Details

"retention": "A String", # Optional. How long to keep automated backups before the backups are deleted. The value should be between 1 day and 365 days. If not specified, the default value is 35 days. }, "backupCollection": "A String", # Optional. Output only. The backup collection full resource name. Example: projects/{project}/locations/{location}/backupCollections/{collection} - "clusterEndpoints": [ # Optional. A list of cluster enpoints. + "clusterEndpoints": [ # Optional. A list of cluster endpoints. { # ClusterEndpoint consists of PSC connections that are created as a group in each VPC network for accessing the cluster. In each group, there shall be one connection for each service attachment in the cluster. - "connections": [ # A group of PSC connections. They are created in the same VPC network, one for each service attachment in the cluster. + "connections": [ # Required. A group of PSC connections. They are created in the same VPC network, one for each service attachment in the cluster. { # Detailed information of each PSC connection. "pscAutoConnection": { # Details of consumer resources in a PSC connection that is created through Service Connectivity Automation. # Detailed information of a PSC connection that is created through service connectivity automation. "address": "A String", # Output only. The IP allocated on the consumer network for the PSC forwarding rule. @@ -453,6 +455,7 @@

Method Details

"connectionType": "A String", # Output only. Type of the PSC connection. "forwardingRule": "A String", # Required. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}. "network": "A String", # Required. The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}. + "port": 42, # Output only. The port number of the exposed discovery endpoint. "projectId": "A String", # Optional. Project ID of the consumer project where the forwarding rule is created in. "pscConnectionId": "A String", # Required. The PSC connection id of the forwarding rule connected to the service attachment. "pscConnectionStatus": "A String", # Output only. The status of the PSC connection. Please note that this value is updated periodically. To get the latest status of a PSC connection, follow https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details. @@ -508,7 +511,7 @@

Method Details

"lastUpdateTime": "A String", # Output only. The most recent time when the encryption info was updated. }, "gcsSource": { # Backups stored in Cloud Storage buckets. The Cloud Storage buckets need to be the same region as the clusters. # Optional. Backups stored in Cloud Storage buckets. The Cloud Storage buckets need to be the same region as the clusters. Read permission is required to import from the provided Cloud Storage objects. - "uris": [ # Optional. URIs of the GCS objects to import. Example: gs://bucket1/object1, gs://bucket2/folder2/object2 + "uris": [ # Optional. URIs of the Cloud Storage objects to import. Example: gs://bucket1/object1, gs://bucket2/folder2/object2 "A String", ], }, @@ -528,7 +531,7 @@

Method Details

}, ], }, - "maintenanceSchedule": { # Upcoming maitenance schedule. # Output only. ClusterMaintenanceSchedule Output only Published maintenance schedule. + "maintenanceSchedule": { # Upcoming maintenance schedule. # Output only. ClusterMaintenanceSchedule Output only Published maintenance schedule. "endTime": "A String", # Output only. The end time of any upcoming scheduled maintenance for this instance. "startTime": "A String", # Output only. The start time of any upcoming scheduled maintenance for this instance. }, @@ -559,6 +562,7 @@

Method Details

"connectionType": "A String", # Output only. Type of the PSC connection. "forwardingRule": "A String", # Required. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}. "network": "A String", # Required. The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}. + "port": 42, # Output only. The port number of the exposed discovery endpoint. "projectId": "A String", # Optional. Project ID of the consumer project where the forwarding rule is created in. "pscConnectionId": "A String", # Required. The PSC connection id of the forwarding rule connected to the service attachment. "pscConnectionStatus": "A String", # Output only. The status of the PSC connection. Please note that this value is updated periodically. To get the latest status of a PSC connection, follow https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details. @@ -656,9 +660,9 @@

Method Details

"retention": "A String", # Optional. How long to keep automated backups before the backups are deleted. The value should be between 1 day and 365 days. If not specified, the default value is 35 days. }, "backupCollection": "A String", # Optional. Output only. The backup collection full resource name. Example: projects/{project}/locations/{location}/backupCollections/{collection} - "clusterEndpoints": [ # Optional. A list of cluster enpoints. + "clusterEndpoints": [ # Optional. A list of cluster endpoints. { # ClusterEndpoint consists of PSC connections that are created as a group in each VPC network for accessing the cluster. In each group, there shall be one connection for each service attachment in the cluster. - "connections": [ # A group of PSC connections. They are created in the same VPC network, one for each service attachment in the cluster. + "connections": [ # Required. A group of PSC connections. They are created in the same VPC network, one for each service attachment in the cluster. { # Detailed information of each PSC connection. "pscAutoConnection": { # Details of consumer resources in a PSC connection that is created through Service Connectivity Automation. # Detailed information of a PSC connection that is created through service connectivity automation. "address": "A String", # Output only. The IP allocated on the consumer network for the PSC forwarding rule. @@ -675,6 +679,7 @@

Method Details

"connectionType": "A String", # Output only. Type of the PSC connection. "forwardingRule": "A String", # Required. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}. "network": "A String", # Required. The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}. + "port": 42, # Output only. The port number of the exposed discovery endpoint. "projectId": "A String", # Optional. Project ID of the consumer project where the forwarding rule is created in. "pscConnectionId": "A String", # Required. The PSC connection id of the forwarding rule connected to the service attachment. "pscConnectionStatus": "A String", # Output only. The status of the PSC connection. Please note that this value is updated periodically. To get the latest status of a PSC connection, follow https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details. @@ -730,7 +735,7 @@

Method Details

"lastUpdateTime": "A String", # Output only. The most recent time when the encryption info was updated. }, "gcsSource": { # Backups stored in Cloud Storage buckets. The Cloud Storage buckets need to be the same region as the clusters. # Optional. Backups stored in Cloud Storage buckets. The Cloud Storage buckets need to be the same region as the clusters. Read permission is required to import from the provided Cloud Storage objects. - "uris": [ # Optional. URIs of the GCS objects to import. Example: gs://bucket1/object1, gs://bucket2/folder2/object2 + "uris": [ # Optional. URIs of the Cloud Storage objects to import. Example: gs://bucket1/object1, gs://bucket2/folder2/object2 "A String", ], }, @@ -750,7 +755,7 @@

Method Details

}, ], }, - "maintenanceSchedule": { # Upcoming maitenance schedule. # Output only. ClusterMaintenanceSchedule Output only Published maintenance schedule. + "maintenanceSchedule": { # Upcoming maintenance schedule. # Output only. ClusterMaintenanceSchedule Output only Published maintenance schedule. "endTime": "A String", # Output only. The end time of any upcoming scheduled maintenance for this instance. "startTime": "A String", # Output only. The start time of any upcoming scheduled maintenance for this instance. }, @@ -781,6 +786,7 @@

Method Details

"connectionType": "A String", # Output only. Type of the PSC connection. "forwardingRule": "A String", # Required. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}. "network": "A String", # Required. The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}. + "port": 42, # Output only. The port number of the exposed discovery endpoint. "projectId": "A String", # Optional. Project ID of the consumer project where the forwarding rule is created in. "pscConnectionId": "A String", # Required. The PSC connection id of the forwarding rule connected to the service attachment. "pscConnectionStatus": "A String", # Output only. The status of the PSC connection. Please note that this value is updated periodically. To get the latest status of a PSC connection, follow https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details. @@ -861,9 +867,9 @@

Method Details

"retention": "A String", # Optional. How long to keep automated backups before the backups are deleted. The value should be between 1 day and 365 days. If not specified, the default value is 35 days. }, "backupCollection": "A String", # Optional. Output only. The backup collection full resource name. Example: projects/{project}/locations/{location}/backupCollections/{collection} - "clusterEndpoints": [ # Optional. A list of cluster enpoints. + "clusterEndpoints": [ # Optional. A list of cluster endpoints. { # ClusterEndpoint consists of PSC connections that are created as a group in each VPC network for accessing the cluster. In each group, there shall be one connection for each service attachment in the cluster. - "connections": [ # A group of PSC connections. They are created in the same VPC network, one for each service attachment in the cluster. + "connections": [ # Required. A group of PSC connections. They are created in the same VPC network, one for each service attachment in the cluster. { # Detailed information of each PSC connection. "pscAutoConnection": { # Details of consumer resources in a PSC connection that is created through Service Connectivity Automation. # Detailed information of a PSC connection that is created through service connectivity automation. "address": "A String", # Output only. The IP allocated on the consumer network for the PSC forwarding rule. @@ -880,6 +886,7 @@

Method Details

"connectionType": "A String", # Output only. Type of the PSC connection. "forwardingRule": "A String", # Required. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}. "network": "A String", # Required. The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}. + "port": 42, # Output only. The port number of the exposed discovery endpoint. "projectId": "A String", # Optional. Project ID of the consumer project where the forwarding rule is created in. "pscConnectionId": "A String", # Required. The PSC connection id of the forwarding rule connected to the service attachment. "pscConnectionStatus": "A String", # Output only. The status of the PSC connection. Please note that this value is updated periodically. To get the latest status of a PSC connection, follow https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details. @@ -935,7 +942,7 @@

Method Details

"lastUpdateTime": "A String", # Output only. The most recent time when the encryption info was updated. }, "gcsSource": { # Backups stored in Cloud Storage buckets. The Cloud Storage buckets need to be the same region as the clusters. # Optional. Backups stored in Cloud Storage buckets. The Cloud Storage buckets need to be the same region as the clusters. Read permission is required to import from the provided Cloud Storage objects. - "uris": [ # Optional. URIs of the GCS objects to import. Example: gs://bucket1/object1, gs://bucket2/folder2/object2 + "uris": [ # Optional. URIs of the Cloud Storage objects to import. Example: gs://bucket1/object1, gs://bucket2/folder2/object2 "A String", ], }, @@ -955,7 +962,7 @@

Method Details

}, ], }, - "maintenanceSchedule": { # Upcoming maitenance schedule. # Output only. ClusterMaintenanceSchedule Output only Published maintenance schedule. + "maintenanceSchedule": { # Upcoming maintenance schedule. # Output only. ClusterMaintenanceSchedule Output only Published maintenance schedule. "endTime": "A String", # Output only. The end time of any upcoming scheduled maintenance for this instance. "startTime": "A String", # Output only. The start time of any upcoming scheduled maintenance for this instance. }, @@ -986,6 +993,7 @@

Method Details

"connectionType": "A String", # Output only. Type of the PSC connection. "forwardingRule": "A String", # Required. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}. "network": "A String", # Required. The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}. + "port": 42, # Output only. The port number of the exposed discovery endpoint. "projectId": "A String", # Optional. Project ID of the consumer project where the forwarding rule is created in. "pscConnectionId": "A String", # Required. The PSC connection id of the forwarding rule connected to the service attachment. "pscConnectionStatus": "A String", # Output only. The status of the PSC connection. Please note that this value is updated periodically. To get the latest status of a PSC connection, follow https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details. @@ -1020,7 +1028,7 @@

Method Details

}, } - requestId: string, Idempotent request UUID. + requestId: string, Optional. Idempotent request UUID. updateMask: string, Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from Cluster: * `size_gb` * `replica_count` * `cluster_endpoints` x__xgafv: string, V1 error format. Allowed values diff --git a/googleapiclient/discovery_cache/documents/redis.v1.json b/googleapiclient/discovery_cache/documents/redis.v1.json index b6b35d2c2e7..4db557408e5 100644 --- a/googleapiclient/discovery_cache/documents/redis.v1.json +++ b/googleapiclient/discovery_cache/documents/redis.v1.json @@ -419,7 +419,7 @@ "type": "string" }, "requestId": { -"description": "Idempotent request UUID.", +"description": "Optional. Idempotent request UUID.", "location": "query", "type": "string" } @@ -452,7 +452,7 @@ "type": "string" }, "requestId": { -"description": "Idempotent request UUID.", +"description": "Optional. Idempotent request UUID.", "location": "query", "type": "string" } @@ -568,7 +568,7 @@ "type": "string" }, "requestId": { -"description": "Idempotent request UUID.", +"description": "Optional. Idempotent request UUID.", "location": "query", "type": "string" }, @@ -1067,7 +1067,7 @@ } } }, -"revision": "20250206", +"revision": "20250213", "rootUrl": "https://redis.googleapis.com/", "schemas": { "AOFConfig": { @@ -1479,7 +1479,7 @@ "type": "string" }, "clusterEndpoints": { -"description": "Optional. A list of cluster enpoints.", +"description": "Optional. A list of cluster endpoints.", "items": { "$ref": "ClusterEndpoint" }, @@ -1666,7 +1666,7 @@ "id": "ClusterEndpoint", "properties": { "connections": { -"description": "A group of PSC connections. They are created in the same VPC network, one for each service attachment in the cluster.", +"description": "Required. A group of PSC connections. They are created in the same VPC network, one for each service attachment in the cluster.", "items": { "$ref": "ConnectionDetail" }, @@ -1702,7 +1702,7 @@ "type": "object" }, "ClusterMaintenanceSchedule": { -"description": "Upcoming maitenance schedule.", +"description": "Upcoming maintenance schedule.", "id": "ClusterMaintenanceSchedule", "properties": { "endTime": { @@ -2119,7 +2119,8 @@ "SIGNAL_TYPE_RESOURCE_SUSPENDED", "SIGNAL_TYPE_EXPENSIVE_COMMANDS", "SIGNAL_TYPE_NO_MAINTENANCE_POLICY_CONFIGURED", -"SIGNAL_TYPE_NO_DELETION_PROTECTION" +"SIGNAL_TYPE_NO_DELETION_PROTECTION", +"SIGNAL_TYPE_INEFFICIENT_QUERY" ], "enumDeprecated": [ false, @@ -2208,6 +2209,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -2297,7 +2299,8 @@ false "Detects if a database instance/cluster is suspended.", "Detects that expensive commands are being run on a database instance impacting overall performance.", "Indicates that the instance does not have a maintenance policy configured.", -"Deletion Protection Disabled for the resource" +"Deletion Protection Disabled for the resource", +"Indicates that the instance has inefficient queries detected." ], "type": "string" }, @@ -2361,7 +2364,7 @@ false "type": "object" }, "DatabaseResourceMetadata": { -"description": "Common model for database resource instance metadata. Next ID: 24", +"description": "Common model for database resource instance metadata. Next ID: 25", "id": "DatabaseResourceMetadata", "properties": { "availabilityConfiguration": { @@ -2446,6 +2449,10 @@ false ], "type": "string" }, +"gcbdrConfiguration": { +"$ref": "GCBDRConfiguration", +"description": "GCBDR configuration for the resource." +}, "id": { "$ref": "DatabaseResourceId", "description": "Required. Unique identifier for a Database resource" @@ -2522,7 +2529,7 @@ false "type": "string" }, "suspensionReason": { -"description": "Suspension reason for the resource.", +"description": "Optional. Suspension reason for the resource.", "enum": [ "SUSPENSION_REASON_UNSPECIFIED", "WIPEOUT_HIDE_EVENT", @@ -2701,7 +2708,8 @@ false "SIGNAL_TYPE_RESOURCE_SUSPENDED", "SIGNAL_TYPE_EXPENSIVE_COMMANDS", "SIGNAL_TYPE_NO_MAINTENANCE_POLICY_CONFIGURED", -"SIGNAL_TYPE_NO_DELETION_PROTECTION" +"SIGNAL_TYPE_NO_DELETION_PROTECTION", +"SIGNAL_TYPE_INEFFICIENT_QUERY" ], "enumDeprecated": [ false, @@ -2790,6 +2798,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -2879,7 +2888,8 @@ false "Detects if a database instance/cluster is suspended.", "Detects that expensive commands are being run on a database instance impacting overall performance.", "Indicates that the instance does not have a maintenance policy configured.", -"Deletion Protection Disabled for the resource" +"Deletion Protection Disabled for the resource", +"Indicates that the instance has inefficient queries detected." ], "type": "string" } @@ -3075,12 +3085,23 @@ false }, "type": "object" }, +"GCBDRConfiguration": { +"description": "GCBDR Configuration for the resource.", +"id": "GCBDRConfiguration", +"properties": { +"gcbdrManaged": { +"description": "Whether the resource is managed by GCBDR.", +"type": "boolean" +} +}, +"type": "object" +}, "GcsBackupSource": { "description": "Backups stored in Cloud Storage buckets. The Cloud Storage buckets need to be the same region as the clusters.", "id": "GcsBackupSource", "properties": { "uris": { -"description": "Optional. URIs of the GCS objects to import. Example: gs://bucket1/object1, gs://bucket2/folder2/object2", +"description": "Optional. URIs of the Cloud Storage objects to import. Example: gs://bucket1/object1, gs://bucket2/folder2/object2", "items": { "type": "string" }, @@ -4276,6 +4297,12 @@ false "description": "Required. The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}.", "type": "string" }, +"port": { +"description": "Output only. The port number of the exposed discovery endpoint.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, "projectId": { "description": "Optional. Project ID of the consumer project where the forwarding rule is created in.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/redis.v1beta1.json b/googleapiclient/discovery_cache/documents/redis.v1beta1.json index e925fa05a05..0d34be2877f 100644 --- a/googleapiclient/discovery_cache/documents/redis.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/redis.v1beta1.json @@ -419,7 +419,7 @@ "type": "string" }, "requestId": { -"description": "Idempotent request UUID.", +"description": "Optional. Idempotent request UUID.", "location": "query", "type": "string" } @@ -452,7 +452,7 @@ "type": "string" }, "requestId": { -"description": "Idempotent request UUID.", +"description": "Optional. Idempotent request UUID.", "location": "query", "type": "string" } @@ -568,7 +568,7 @@ "type": "string" }, "requestId": { -"description": "Idempotent request UUID.", +"description": "Optional. Idempotent request UUID.", "location": "query", "type": "string" }, @@ -1067,7 +1067,7 @@ } } }, -"revision": "20250206", +"revision": "20250213", "rootUrl": "https://redis.googleapis.com/", "schemas": { "AOFConfig": { @@ -1479,7 +1479,7 @@ "type": "string" }, "clusterEndpoints": { -"description": "Optional. A list of cluster enpoints.", +"description": "Optional. A list of cluster endpoints.", "items": { "$ref": "ClusterEndpoint" }, @@ -1666,7 +1666,7 @@ "id": "ClusterEndpoint", "properties": { "connections": { -"description": "A group of PSC connections. They are created in the same VPC network, one for each service attachment in the cluster.", +"description": "Required. A group of PSC connections. They are created in the same VPC network, one for each service attachment in the cluster.", "items": { "$ref": "ConnectionDetail" }, @@ -1702,7 +1702,7 @@ "type": "object" }, "ClusterMaintenanceSchedule": { -"description": "Upcoming maitenance schedule.", +"description": "Upcoming maintenance schedule.", "id": "ClusterMaintenanceSchedule", "properties": { "endTime": { @@ -2119,7 +2119,8 @@ "SIGNAL_TYPE_RESOURCE_SUSPENDED", "SIGNAL_TYPE_EXPENSIVE_COMMANDS", "SIGNAL_TYPE_NO_MAINTENANCE_POLICY_CONFIGURED", -"SIGNAL_TYPE_NO_DELETION_PROTECTION" +"SIGNAL_TYPE_NO_DELETION_PROTECTION", +"SIGNAL_TYPE_INEFFICIENT_QUERY" ], "enumDeprecated": [ false, @@ -2208,6 +2209,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -2297,7 +2299,8 @@ false "Detects if a database instance/cluster is suspended.", "Detects that expensive commands are being run on a database instance impacting overall performance.", "Indicates that the instance does not have a maintenance policy configured.", -"Deletion Protection Disabled for the resource" +"Deletion Protection Disabled for the resource", +"Indicates that the instance has inefficient queries detected." ], "type": "string" }, @@ -2361,7 +2364,7 @@ false "type": "object" }, "DatabaseResourceMetadata": { -"description": "Common model for database resource instance metadata. Next ID: 24", +"description": "Common model for database resource instance metadata. Next ID: 25", "id": "DatabaseResourceMetadata", "properties": { "availabilityConfiguration": { @@ -2446,6 +2449,10 @@ false ], "type": "string" }, +"gcbdrConfiguration": { +"$ref": "GCBDRConfiguration", +"description": "GCBDR configuration for the resource." +}, "id": { "$ref": "DatabaseResourceId", "description": "Required. Unique identifier for a Database resource" @@ -2522,7 +2529,7 @@ false "type": "string" }, "suspensionReason": { -"description": "Suspension reason for the resource.", +"description": "Optional. Suspension reason for the resource.", "enum": [ "SUSPENSION_REASON_UNSPECIFIED", "WIPEOUT_HIDE_EVENT", @@ -2701,7 +2708,8 @@ false "SIGNAL_TYPE_RESOURCE_SUSPENDED", "SIGNAL_TYPE_EXPENSIVE_COMMANDS", "SIGNAL_TYPE_NO_MAINTENANCE_POLICY_CONFIGURED", -"SIGNAL_TYPE_NO_DELETION_PROTECTION" +"SIGNAL_TYPE_NO_DELETION_PROTECTION", +"SIGNAL_TYPE_INEFFICIENT_QUERY" ], "enumDeprecated": [ false, @@ -2790,6 +2798,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -2879,7 +2888,8 @@ false "Detects if a database instance/cluster is suspended.", "Detects that expensive commands are being run on a database instance impacting overall performance.", "Indicates that the instance does not have a maintenance policy configured.", -"Deletion Protection Disabled for the resource" +"Deletion Protection Disabled for the resource", +"Indicates that the instance has inefficient queries detected." ], "type": "string" } @@ -3075,12 +3085,23 @@ false }, "type": "object" }, +"GCBDRConfiguration": { +"description": "GCBDR Configuration for the resource.", +"id": "GCBDRConfiguration", +"properties": { +"gcbdrManaged": { +"description": "Whether the resource is managed by GCBDR.", +"type": "boolean" +} +}, +"type": "object" +}, "GcsBackupSource": { "description": "Backups stored in Cloud Storage buckets. The Cloud Storage buckets need to be the same region as the clusters.", "id": "GcsBackupSource", "properties": { "uris": { -"description": "Optional. URIs of the GCS objects to import. Example: gs://bucket1/object1, gs://bucket2/folder2/object2", +"description": "Optional. URIs of the Cloud Storage objects to import. Example: gs://bucket1/object1, gs://bucket2/folder2/object2", "items": { "type": "string" }, @@ -4283,6 +4304,12 @@ false "description": "Required. The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}.", "type": "string" }, +"port": { +"description": "Output only. The port number of the exposed discovery endpoint.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, "projectId": { "description": "Optional. Project ID of the consumer project where the forwarding rule is created in.", "type": "string" From 95aacfd75b3578c53f77ab136f2bb7491f88ee19 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 25 Feb 2025 07:08:20 +0000 Subject: [PATCH 26/36] feat(run): update the api #### run:v1 The following keys were added: - schemas.TaskSpec.properties.nodeSelector (Total Keys: 2) #### run:v2 The following keys were added: - resources.projects.resources.locations.resources.workerPools.methods.create (Total Keys: 16) - resources.projects.resources.locations.resources.workerPools.methods.delete (Total Keys: 13) - resources.projects.resources.locations.resources.workerPools.methods.get (Total Keys: 25) - resources.projects.resources.locations.resources.workerPools.methods.list (Total Keys: 18) - resources.projects.resources.locations.resources.workerPools.methods.patch (Total Keys: 19) - resources.projects.resources.locations.resources.workerPools.methods.setIamPolicy (Total Keys: 12) - resources.projects.resources.locations.resources.workerPools.methods.testIamPermissions (Total Keys: 12) - schemas.GoogleCloudRunV2InstanceSplit (Total Keys: 10) - schemas.GoogleCloudRunV2ListWorkerPoolsResponse (Total Keys: 5) - schemas.GoogleCloudRunV2WorkerPool (Total Keys: 66) --- docs/dyn/run_v1.namespaces.executions.html | 9 + docs/dyn/run_v1.namespaces.jobs.html | 21 + docs/dyn/run_v1.namespaces.tasks.html | 6 + ...run_v2.projects.locations.workerPools.html | 1353 +++++++++++++++++ .../discovery_cache/documents/run.v1.json | 9 +- .../discovery_cache/documents/run.v2.json | 681 ++++++++- 6 files changed, 2071 insertions(+), 8 deletions(-) diff --git a/docs/dyn/run_v1.namespaces.executions.html b/docs/dyn/run_v1.namespaces.executions.html index 4cf44501a82..d38b7e7f8fc 100644 --- a/docs/dyn/run_v1.namespaces.executions.html +++ b/docs/dyn/run_v1.namespaces.executions.html @@ -332,6 +332,9 @@

Method Details

}, ], "maxRetries": 42, # Optional. Number of retries allowed per task, before marking this job failed. Defaults to 3. + "nodeSelector": { # Optional. The Node Selector configuration. Map of selector key to a value which matches a node. + "a_key": "A String", + }, "serviceAccountName": "A String", # Optional. Email address of the IAM service account associated with the task of a job execution. The service account represents the identity of the running task, and determines what permissions the task has. If not provided, the task will use the project's default service account. "timeoutSeconds": "A String", # Optional. Duration in seconds the task may be active before the system will actively try to mark it failed and kill associated containers. This applies per attempt of a task, meaning each retry can run for the full timeout. Defaults to 600 seconds. "volumes": [ # Optional. List of volumes that can be mounted by containers belonging to the task. @@ -691,6 +694,9 @@

Method Details

}, ], "maxRetries": 42, # Optional. Number of retries allowed per task, before marking this job failed. Defaults to 3. + "nodeSelector": { # Optional. The Node Selector configuration. Map of selector key to a value which matches a node. + "a_key": "A String", + }, "serviceAccountName": "A String", # Optional. Email address of the IAM service account associated with the task of a job execution. The service account represents the identity of the running task, and determines what permissions the task has. If not provided, the task will use the project's default service account. "timeoutSeconds": "A String", # Optional. Duration in seconds the task may be active before the system will actively try to mark it failed and kill associated containers. This applies per attempt of a task, meaning each retry can run for the full timeout. Defaults to 600 seconds. "volumes": [ # Optional. List of volumes that can be mounted by containers belonging to the task. @@ -1011,6 +1017,9 @@

Method Details

}, ], "maxRetries": 42, # Optional. Number of retries allowed per task, before marking this job failed. Defaults to 3. + "nodeSelector": { # Optional. The Node Selector configuration. Map of selector key to a value which matches a node. + "a_key": "A String", + }, "serviceAccountName": "A String", # Optional. Email address of the IAM service account associated with the task of a job execution. The service account represents the identity of the running task, and determines what permissions the task has. If not provided, the task will use the project's default service account. "timeoutSeconds": "A String", # Optional. Duration in seconds the task may be active before the system will actively try to mark it failed and kill associated containers. This applies per attempt of a task, meaning each retry can run for the full timeout. Defaults to 600 seconds. "volumes": [ # Optional. List of volumes that can be mounted by containers belonging to the task. diff --git a/docs/dyn/run_v1.namespaces.jobs.html b/docs/dyn/run_v1.namespaces.jobs.html index d9100d599b6..7e3eff8c763 100644 --- a/docs/dyn/run_v1.namespaces.jobs.html +++ b/docs/dyn/run_v1.namespaces.jobs.html @@ -368,6 +368,9 @@

Method Details

}, ], "maxRetries": 42, # Optional. Number of retries allowed per task, before marking this job failed. Defaults to 3. + "nodeSelector": { # Optional. The Node Selector configuration. Map of selector key to a value which matches a node. + "a_key": "A String", + }, "serviceAccountName": "A String", # Optional. Email address of the IAM service account associated with the task of a job execution. The service account represents the identity of the running task, and determines what permissions the task has. If not provided, the task will use the project's default service account. "timeoutSeconds": "A String", # Optional. Duration in seconds the task may be active before the system will actively try to mark it failed and kill associated containers. This applies per attempt of a task, meaning each retry can run for the full timeout. Defaults to 600 seconds. "volumes": [ # Optional. List of volumes that can be mounted by containers belonging to the task. @@ -709,6 +712,9 @@

Method Details

}, ], "maxRetries": 42, # Optional. Number of retries allowed per task, before marking this job failed. Defaults to 3. + "nodeSelector": { # Optional. The Node Selector configuration. Map of selector key to a value which matches a node. + "a_key": "A String", + }, "serviceAccountName": "A String", # Optional. Email address of the IAM service account associated with the task of a job execution. The service account represents the identity of the running task, and determines what permissions the task has. If not provided, the task will use the project's default service account. "timeoutSeconds": "A String", # Optional. Duration in seconds the task may be active before the system will actively try to mark it failed and kill associated containers. This applies per attempt of a task, meaning each retry can run for the full timeout. Defaults to 600 seconds. "volumes": [ # Optional. List of volumes that can be mounted by containers belonging to the task. @@ -1101,6 +1107,9 @@

Method Details

}, ], "maxRetries": 42, # Optional. Number of retries allowed per task, before marking this job failed. Defaults to 3. + "nodeSelector": { # Optional. The Node Selector configuration. Map of selector key to a value which matches a node. + "a_key": "A String", + }, "serviceAccountName": "A String", # Optional. Email address of the IAM service account associated with the task of a job execution. The service account represents the identity of the running task, and determines what permissions the task has. If not provided, the task will use the project's default service account. "timeoutSeconds": "A String", # Optional. Duration in seconds the task may be active before the system will actively try to mark it failed and kill associated containers. This applies per attempt of a task, meaning each retry can run for the full timeout. Defaults to 600 seconds. "volumes": [ # Optional. List of volumes that can be mounted by containers belonging to the task. @@ -1459,6 +1468,9 @@

Method Details

}, ], "maxRetries": 42, # Optional. Number of retries allowed per task, before marking this job failed. Defaults to 3. + "nodeSelector": { # Optional. The Node Selector configuration. Map of selector key to a value which matches a node. + "a_key": "A String", + }, "serviceAccountName": "A String", # Optional. Email address of the IAM service account associated with the task of a job execution. The service account represents the identity of the running task, and determines what permissions the task has. If not provided, the task will use the project's default service account. "timeoutSeconds": "A String", # Optional. Duration in seconds the task may be active before the system will actively try to mark it failed and kill associated containers. This applies per attempt of a task, meaning each retry can run for the full timeout. Defaults to 600 seconds. "volumes": [ # Optional. List of volumes that can be mounted by containers belonging to the task. @@ -1813,6 +1825,9 @@

Method Details

}, ], "maxRetries": 42, # Optional. Number of retries allowed per task, before marking this job failed. Defaults to 3. + "nodeSelector": { # Optional. The Node Selector configuration. Map of selector key to a value which matches a node. + "a_key": "A String", + }, "serviceAccountName": "A String", # Optional. Email address of the IAM service account associated with the task of a job execution. The service account represents the identity of the running task, and determines what permissions the task has. If not provided, the task will use the project's default service account. "timeoutSeconds": "A String", # Optional. Duration in seconds the task may be active before the system will actively try to mark it failed and kill associated containers. This applies per attempt of a task, meaning each retry can run for the full timeout. Defaults to 600 seconds. "volumes": [ # Optional. List of volumes that can be mounted by containers belonging to the task. @@ -2154,6 +2169,9 @@

Method Details

}, ], "maxRetries": 42, # Optional. Number of retries allowed per task, before marking this job failed. Defaults to 3. + "nodeSelector": { # Optional. The Node Selector configuration. Map of selector key to a value which matches a node. + "a_key": "A String", + }, "serviceAccountName": "A String", # Optional. Email address of the IAM service account associated with the task of a job execution. The service account represents the identity of the running task, and determines what permissions the task has. If not provided, the task will use the project's default service account. "timeoutSeconds": "A String", # Optional. Duration in seconds the task may be active before the system will actively try to mark it failed and kill associated containers. This applies per attempt of a task, meaning each retry can run for the full timeout. Defaults to 600 seconds. "volumes": [ # Optional. List of volumes that can be mounted by containers belonging to the task. @@ -2509,6 +2527,9 @@

Method Details

}, ], "maxRetries": 42, # Optional. Number of retries allowed per task, before marking this job failed. Defaults to 3. + "nodeSelector": { # Optional. The Node Selector configuration. Map of selector key to a value which matches a node. + "a_key": "A String", + }, "serviceAccountName": "A String", # Optional. Email address of the IAM service account associated with the task of a job execution. The service account represents the identity of the running task, and determines what permissions the task has. If not provided, the task will use the project's default service account. "timeoutSeconds": "A String", # Optional. Duration in seconds the task may be active before the system will actively try to mark it failed and kill associated containers. This applies per attempt of a task, meaning each retry can run for the full timeout. Defaults to 600 seconds. "volumes": [ # Optional. List of volumes that can be mounted by containers belonging to the task. diff --git a/docs/dyn/run_v1.namespaces.tasks.html b/docs/dyn/run_v1.namespaces.tasks.html index 8dd34cd5b6a..cbeb2ec2784 100644 --- a/docs/dyn/run_v1.namespaces.tasks.html +++ b/docs/dyn/run_v1.namespaces.tasks.html @@ -321,6 +321,9 @@

Method Details

}, ], "maxRetries": 42, # Optional. Number of retries allowed per task, before marking this job failed. Defaults to 3. + "nodeSelector": { # Optional. The Node Selector configuration. Map of selector key to a value which matches a node. + "a_key": "A String", + }, "serviceAccountName": "A String", # Optional. Email address of the IAM service account associated with the task of a job execution. The service account represents the identity of the running task, and determines what permissions the task has. If not provided, the task will use the project's default service account. "timeoutSeconds": "A String", # Optional. Duration in seconds the task may be active before the system will actively try to mark it failed and kill associated containers. This applies per attempt of a task, meaning each retry can run for the full timeout. Defaults to 600 seconds. "volumes": [ # Optional. List of volumes that can be mounted by containers belonging to the task. @@ -644,6 +647,9 @@

Method Details

}, ], "maxRetries": 42, # Optional. Number of retries allowed per task, before marking this job failed. Defaults to 3. + "nodeSelector": { # Optional. The Node Selector configuration. Map of selector key to a value which matches a node. + "a_key": "A String", + }, "serviceAccountName": "A String", # Optional. Email address of the IAM service account associated with the task of a job execution. The service account represents the identity of the running task, and determines what permissions the task has. If not provided, the task will use the project's default service account. "timeoutSeconds": "A String", # Optional. Duration in seconds the task may be active before the system will actively try to mark it failed and kill associated containers. This applies per attempt of a task, meaning each retry can run for the full timeout. Defaults to 600 seconds. "volumes": [ # Optional. List of volumes that can be mounted by containers belonging to the task. diff --git a/docs/dyn/run_v2.projects.locations.workerPools.html b/docs/dyn/run_v2.projects.locations.workerPools.html index 0c127fc524e..bfbd38c779a 100644 --- a/docs/dyn/run_v2.projects.locations.workerPools.html +++ b/docs/dyn/run_v2.projects.locations.workerPools.html @@ -82,10 +82,1363 @@

Instance Methods

close()

Close httplib2 connections.

+

+ create(parent, body=None, validateOnly=None, workerPoolId=None, x__xgafv=None)

+

Creates a new WorkerPool in a given project and location.

+

+ delete(name, etag=None, validateOnly=None, x__xgafv=None)

+

Deletes a WorkerPool.

+

+ get(name, x__xgafv=None)

+

Gets information about a WorkerPool.

+

+ getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)

+

Gets the IAM Access Control policy currently in effect for the given Cloud Run WorkerPool. This result does not include any inherited policies.

+

+ list(parent, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None)

+

Lists WorkerPools. Results are sorted by creation time, descending.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(name, allowMissing=None, body=None, forceNewRevision=None, updateMask=None, validateOnly=None, x__xgafv=None)

+

Updates a WorkerPool.

+

+ setIamPolicy(resource, body=None, x__xgafv=None)

+

Sets the IAM Access control policy for the specified WorkerPool. Overwrites any existing policy.

+

+ testIamPermissions(resource, body=None, x__xgafv=None)

+

Returns permissions that a caller has on the specified Project. There are no permissions required for making this API call.

Method Details

close()
Close httplib2 connections.
+
+ create(parent, body=None, validateOnly=None, workerPoolId=None, x__xgafv=None) +
Creates a new WorkerPool in a given project and location.
+
+Args:
+  parent: string, Required. The location and project in which this worker pool should be created. Format: projects/{project}/locations/{location}, where {project} can be project id or number. Only lowercase characters, digits, and hyphens. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # WorkerPool acts as a top-level container that manages a set of configurations and revision templates which implement a pull-based workload. WorkerPool exists to provide a singular abstraction which can be access controlled, reasoned about, and which encapsulates software lifecycle decisions such as rollout policy and team resource ownership.
+  "annotations": { # Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run API v2 does not support annotations with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected in new resources. All system annotations in v1 now have a corresponding field in v2 WorkerPool. This field follows Kubernetes annotations' namespacing, limits, and rules.
+    "a_key": "A String",
+  },
+  "binaryAuthorization": { # Settings for Binary Authorization feature. # Optional. Settings for the Binary Authorization feature.
+    "breakglassJustification": "A String", # Optional. If present, indicates to use Breakglass using this justification. If use_default is False, then it must be empty. For more information on breakglass, see https://cloud.google.com/binary-authorization/docs/using-breakglass
+    "policy": "A String", # Optional. The path to a binary authorization policy. Format: `projects/{project}/platforms/cloudRun/{policy-name}`
+    "useDefault": True or False, # Optional. If True, indicates to use the default project's binary authorization policy. If False, binary authorization will be disabled.
+  },
+  "client": "A String", # Arbitrary identifier for the API client.
+  "clientVersion": "A String", # Arbitrary version identifier for the API client.
+  "conditions": [ # Output only. The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the WorkerPool does not reach its Serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run.
+    { # Defines a status condition for a resource.
+      "executionReason": "A String", # Output only. A reason for the execution condition.
+      "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another.
+      "message": "A String", # Human readable message indicating details about the current status.
+      "reason": "A String", # Output only. A common (service-level) reason for this condition.
+      "revisionReason": "A String", # Output only. A reason for the revision condition.
+      "severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info
+      "state": "A String", # State of the condition.
+      "type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready.
+    },
+  ],
+  "createTime": "A String", # Output only. The creation time.
+  "creator": "A String", # Output only. Email address of the authenticated creator.
+  "customAudiences": [ # One or more custom audiences that you want this worker pool to support. Specify each custom audience as the full URL in a string. The custom audiences are encoded in the token and used to authenticate requests. For more information, see https://cloud.google.com/run/docs/configuring/custom-audiences.
+    "A String",
+  ],
+  "deleteTime": "A String", # Output only. The deletion time. It is only populated as a response to a Delete request.
+  "description": "A String", # User-provided description of the WorkerPool. This field currently has a 512-character limit.
+  "etag": "A String", # Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.
+  "expireTime": "A String", # Output only. For a deleted resource, the time after which it will be permamently deleted.
+  "generation": "A String", # Output only. A number that monotonically increases every time the user modifies the desired state. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a `string` instead of an `integer`.
+  "instanceSplitStatuses": [ # Output only. Detailed status information for corresponding instance splits. See comments in `reconciling` for additional information on reconciliation process in Cloud Run.
+    { # Represents the observed state of a single `InstanceSplit` entry.
+      "percent": 42, # Specifies percent of the instance split to this Revision.
+      "revision": "A String", # Revision to which this instance split is assigned.
+      "type": "A String", # The allocation type for this instance split.
+    },
+  ],
+  "instanceSplits": [ # Optional. Specifies how to distribute instances over a collection of Revisions belonging to the WorkerPool. If instance split is empty or not provided, defaults to 100% instances assigned to the latest `Ready` Revision.
+    { # Holds a single instance split entry for the Worker. Allocations can be done to a specific Revision name, or pointing to the latest Ready Revision.
+      "percent": 42, # Specifies percent of the instance split to this Revision. This defaults to zero if unspecified.
+      "revision": "A String", # Revision to which to assign this portion of instances, if split allocation is by revision.
+      "type": "A String", # The allocation type for this instance split.
+    },
+  ],
+  "labels": { # Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 WorkerPool.
+    "a_key": "A String",
+  },
+  "lastModifier": "A String", # Output only. Email address of the last authenticated modifier.
+  "latestCreatedRevision": "A String", # Output only. Name of the last created revision. See comments in `reconciling` for additional information on reconciliation process in Cloud Run.
+  "latestReadyRevision": "A String", # Output only. Name of the latest revision that is serving traffic. See comments in `reconciling` for additional information on reconciliation process in Cloud Run.
+  "launchStage": "A String", # Optional. The launch stage as defined by [Google Cloud Platform Launch Stages](https://cloud.google.com/terms/launch-stages). Cloud Run supports `ALPHA`, `BETA`, and `GA`. If no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features. For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output.
+  "name": "A String", # The fully qualified name of this WorkerPool. In CreateWorkerPoolRequest, this field is ignored, and instead composed from CreateWorkerPoolRequest.parent and CreateWorkerPoolRequest.worker_id. Format: projects/{project}/locations/{location}/workerPools/{worker_id}
+  "observedGeneration": "A String", # Output only. The generation of this WorkerPool currently serving traffic. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a `string` instead of an `integer`.
+  "reconciling": True or False, # Output only. Returns true if the WorkerPool is currently being acted upon by the system to bring it into the desired state. When a new WorkerPool is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the WorkerPool to the desired serving state. This process is called reconciliation. While reconciliation is in process, `observed_generation`, `latest_ready_revison`, `traffic_statuses`, and `uri` will have transient values that might mismatch the intended state: Once reconciliation is over (and this field is false), there are two possible outcomes: reconciliation succeeded and the serving state matches the WorkerPool, or there was an error, and reconciliation failed. This state can be found in `terminal_condition.state`. If reconciliation succeeded, the following fields will match: `traffic` and `traffic_statuses`, `observed_generation` and `generation`, `latest_ready_revision` and `latest_created_revision`. If reconciliation failed, `traffic_statuses`, `observed_generation`, and `latest_ready_revision` will have the state of the last serving revision, or empty for newly created WorkerPools. Additional information on the failure can be found in `terminal_condition` and `conditions`.
+  "satisfiesPzs": True or False, # Output only. Reserved for future use.
+  "scaling": { # Worker pool scaling settings. # Optional. Specifies worker-pool-level scaling settings
+    "manualInstanceCount": 42, # Optional. The total number of instances in manual scaling mode.
+    "maxInstanceCount": 42, # Optional. The maximum count of instances distributed among revisions based on the specified instance split percentages.
+    "maxSurge": 42, # Optional. A maximum percentage of instances that will be moved in each step of traffic split changes. When set to a positive value, the server will bring up, at most, that percentage of new instances at a time before moving traffic to them. After moving traffic, the server will bring down instances of the old revision. This can reduce a spike of total active instances during changes from one revision to another but specifying how many extra instances can be brought up at a time.
+    "maxUnavailable": 42, # Optional. A maximum percentage of instances that may be unavailable during changes from one revision to another. When set to a positive value, the server may bring down instances before bringing up new instances. This can prevent a spike of total active instances during changes from one revision by reducing the pool of instances before bringing up new ones. Some requests may be slow or fail to serve during the transition.
+    "minInstanceCount": 42, # Optional. The minimum count of instances distributed among revisions based on the specified instance split percentages.
+    "scalingMode": "A String", # Optional. The scaling mode for the worker pool.
+  },
+  "template": { # WorkerPoolRevisionTemplate describes the data a worker pool revision should have when created from a template. # Required. The template used to create revisions for this WorkerPool.
+    "annotations": { # Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run API v2 does not support annotations with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system annotations in v1 now have a corresponding field in v2 WorkerPoolRevisionTemplate. This field follows Kubernetes annotations' namespacing, limits, and rules.
+      "a_key": "A String",
+    },
+    "containers": [ # Holds list of the containers that defines the unit of execution for this Revision.
+      { # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments can be supplied by the system to the container at runtime.
+        "args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided.
+          "A String",
+        ],
+        "baseImageUri": "A String", # Base image for this container. Only supported for services. If set, it indicates that the service is enrolled into automatic base image update.
+        "buildInfo": { # Build information of the image. # Output only. The build info of the container image.
+          "functionTarget": "A String", # Output only. Entry point of the function when the image is a Cloud Run function.
+          "sourceLocation": "A String", # Output only. Source code location of the image.
+        },
+        "command": [ # Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided.
+          "A String",
+        ],
+        "dependsOn": [ # Names of the containers that must start before this container.
+          "A String",
+        ],
+        "env": [ # List of environment variables to set in the container.
+          { # EnvVar represents an environment variable present in a Container.
+            "name": "A String", # Required. Name of the environment variable. Must not exceed 32768 characters.
+            "value": "A String", # Literal value of the environment variable. Defaults to "", and the maximum length is 32768 bytes. Variable references are not supported in Cloud Run.
+            "valueSource": { # EnvVarSource represents a source for the value of an EnvVar. # Source for the environment variable's value.
+              "secretKeyRef": { # SecretEnvVarSource represents a source for the value of an EnvVar. # Selects a secret and a specific version from Cloud Secret Manager.
+                "secret": "A String", # Required. The name of the secret in Cloud Secret Manager. Format: {secret_name} if the secret is in the same project. projects/{project}/secrets/{secret_name} if the secret is in a different project.
+                "version": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest version, an integer for a specific version, or a version alias.
+              },
+            },
+          },
+        ],
+        "image": "A String", # Required. Name of the container image in Dockerhub, Google Artifact Registry, or Google Container Registry. If the host is not provided, Dockerhub is assumed.
+        "livenessProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Periodic probe of container liveness. Container will be restarted if the probe fails.
+          "failureThreshold": 42, # Optional. Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
+          "grpc": { # GRPCAction describes an action involving a GRPC port. # Optional. GRPC specifies an action involving a gRPC port. Exactly one of httpGet, tcpSocket, or grpc must be specified.
+            "port": 42, # Optional. Port number of the gRPC service. Number must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
+            "service": "A String", # Optional. Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md ). If this is not specified, the default behavior is defined by gRPC.
+          },
+          "httpGet": { # HTTPGetAction describes an action based on HTTP Get requests. # Optional. HTTPGet specifies the http request to perform. Exactly one of httpGet, tcpSocket, or grpc must be specified.
+            "httpHeaders": [ # Optional. Custom headers to set in the request. HTTP allows repeated headers.
+              { # HTTPHeader describes a custom header to be used in HTTP probes
+                "name": "A String", # Required. The header field name
+                "value": "A String", # Optional. The header field value
+              },
+            ],
+            "path": "A String", # Optional. Path to access on the HTTP server. Defaults to '/'.
+            "port": 42, # Optional. Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
+          },
+          "initialDelaySeconds": 42, # Optional. Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240.
+          "periodSeconds": 42, # Optional. How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeout_seconds.
+          "tcpSocket": { # TCPSocketAction describes an action based on opening a socket # Optional. TCPSocket specifies an action involving a TCP port. Exactly one of httpGet, tcpSocket, or grpc must be specified.
+            "port": 42, # Optional. Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
+          },
+          "timeoutSeconds": 42, # Optional. Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds.
+        },
+        "name": "A String", # Name of the container specified as a DNS_LABEL (RFC 1123).
+        "ports": [ # List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
+          { # ContainerPort represents a network port in a single container.
+            "containerPort": 42, # Port number the container listens on. This must be a valid TCP port number, 0 < container_port < 65536.
+            "name": "A String", # If specified, used to specify which protocol to use. Allowed values are "http1" and "h2c".
+          },
+        ],
+        "resources": { # ResourceRequirements describes the compute resource requirements. # Compute Resource requirements by this container.
+          "cpuIdle": True or False, # Determines whether CPU is only allocated during requests (true by default). However, if ResourceRequirements is set, the caller must explicitly set this field to true to preserve the default behavior.
+          "limits": { # Only `memory` and `cpu` keys in the map are supported. Notes: * The only supported values for CPU are '1', '2', '4', and '8'. Setting 4 CPU requires at least 2Gi of memory. For more information, go to https://cloud.google.com/run/docs/configuring/cpu. * For supported 'memory' values and syntax, go to https://cloud.google.com/run/docs/configuring/memory-limits
+            "a_key": "A String",
+          },
+          "startupCpuBoost": True or False, # Determines whether CPU should be boosted on startup of a new container instance above the requested CPU threshold, this can help reduce cold-start latency.
+        },
+        "startupProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Startup probe of application within the container. All other probes are disabled if a startup probe is provided, until it succeeds. Container will not be added to service endpoints if the probe fails.
+          "failureThreshold": 42, # Optional. Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
+          "grpc": { # GRPCAction describes an action involving a GRPC port. # Optional. GRPC specifies an action involving a gRPC port. Exactly one of httpGet, tcpSocket, or grpc must be specified.
+            "port": 42, # Optional. Port number of the gRPC service. Number must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
+            "service": "A String", # Optional. Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md ). If this is not specified, the default behavior is defined by gRPC.
+          },
+          "httpGet": { # HTTPGetAction describes an action based on HTTP Get requests. # Optional. HTTPGet specifies the http request to perform. Exactly one of httpGet, tcpSocket, or grpc must be specified.
+            "httpHeaders": [ # Optional. Custom headers to set in the request. HTTP allows repeated headers.
+              { # HTTPHeader describes a custom header to be used in HTTP probes
+                "name": "A String", # Required. The header field name
+                "value": "A String", # Optional. The header field value
+              },
+            ],
+            "path": "A String", # Optional. Path to access on the HTTP server. Defaults to '/'.
+            "port": 42, # Optional. Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
+          },
+          "initialDelaySeconds": 42, # Optional. Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240.
+          "periodSeconds": 42, # Optional. How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeout_seconds.
+          "tcpSocket": { # TCPSocketAction describes an action based on opening a socket # Optional. TCPSocket specifies an action involving a TCP port. Exactly one of httpGet, tcpSocket, or grpc must be specified.
+            "port": 42, # Optional. Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
+          },
+          "timeoutSeconds": 42, # Optional. Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds.
+        },
+        "volumeMounts": [ # Volume to mount into the container's filesystem.
+          { # VolumeMount describes a mounting of a Volume within a container.
+            "mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be `/cloudsql`. All instances defined in the Volume will be available as `/cloudsql/[instance]`. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run
+            "name": "A String", # Required. This must match the Name of a Volume.
+          },
+        ],
+        "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image.
+      },
+    ],
+    "encryptionKey": "A String", # A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek
+    "encryptionKeyRevocationAction": "A String", # Optional. The action to take if the encryption key is revoked.
+    "encryptionKeyShutdownDuration": "A String", # Optional. If encryption_key_revocation_action is SHUTDOWN, the duration before shutting down all instances. The minimum increment is 1 hour.
+    "labels": { # Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 WorkerPoolRevisionTemplate.
+      "a_key": "A String",
+    },
+    "nodeSelector": { # Hardware constraints configuration. # Optional. The node selector for the revision template.
+      "accelerator": "A String", # Required. GPU accelerator type to attach to an instance.
+    },
+    "revision": "A String", # Optional. The unique name for the revision. If this field is omitted, it will be automatically generated based on the WorkerPool name.
+    "serviceAccount": "A String", # Optional. Email address of the IAM service account associated with the revision of the service. The service account represents the identity of the running revision, and determines what permissions the revision has. If not provided, the revision will use the project's default service account.
+    "serviceMesh": { # Settings for Cloud Service Mesh. For more information see https://cloud.google.com/service-mesh/docs/overview. # Optional. Enables service mesh connectivity.
+      "mesh": "A String", # The Mesh resource name. Format: `projects/{project}/locations/global/meshes/{mesh}`, where `{project}` can be project id or number.
+    },
+    "sessionAffinity": True or False, # Optional. Enable session affinity.
+    "volumes": [ # Optional. A list of Volumes to make available to containers.
+      { # Volume represents a named volume in a container.
+        "cloudSqlInstance": { # Represents a set of Cloud SQL instances. Each one will be available under /cloudsql/[instance]. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. # For Cloud SQL volumes, contains the specific instances that should be mounted. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run.
+          "instances": [ # The Cloud SQL instance connection names, as can be found in https://console.cloud.google.com/sql/instances. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. Format: {project}:{location}:{instance}
+            "A String",
+          ],
+        },
+        "emptyDir": { # In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume.
+          "medium": "A String", # The medium on which the data is stored. Acceptable values today is only MEMORY or none. When none, the default will currently be backed by memory but could change over time. +optional
+          "sizeLimit": "A String", # Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers. The default is nil which means that the limit is undefined. More info: https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. Info in Kubernetes: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir
+        },
+        "gcs": { # Represents a volume backed by a Cloud Storage bucket using Cloud Storage FUSE. # Persistent storage backed by a Google Cloud Storage bucket.
+          "bucket": "A String", # Cloud Storage Bucket name.
+          "mountOptions": [ # A list of additional flags to pass to the gcsfuse CLI. Options should be specified without the leading "--".
+            "A String",
+          ],
+          "readOnly": True or False, # If true, the volume will be mounted as read only for all mounts.
+        },
+        "name": "A String", # Required. Volume's name.
+        "nfs": { # Represents an NFS mount. # For NFS Voumes, contains the path to the nfs Volume
+          "path": "A String", # Path that is exported by the NFS server.
+          "readOnly": True or False, # If true, the volume will be mounted as read only for all mounts.
+          "server": "A String", # Hostname or IP address of the NFS server
+        },
+        "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret. # Secret represents a secret that should populate this volume.
+          "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set.
+          "items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version.
+            { # VersionToPath maps a specific version of a secret to a relative file to mount to, relative to VolumeMount's mount_path.
+              "mode": 42, # Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
+              "path": "A String", # Required. The relative path of the secret in the container.
+              "version": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest value, or an integer or a secret alias for a specific version.
+            },
+          ],
+          "secret": "A String", # Required. The name of the secret in Cloud Secret Manager. Format: {secret} if the secret is in the same project. projects/{project}/secrets/{secret} if the secret is in a different project.
+        },
+      },
+    ],
+    "vpcAccess": { # VPC Access settings. For more information on sending traffic to a VPC network, visit https://cloud.google.com/run/docs/configuring/connecting-vpc. # Optional. VPC Access configuration to use for this Revision. For more information, visit https://cloud.google.com/run/docs/configuring/connecting-vpc.
+      "connector": "A String", # VPC Access connector name. Format: `projects/{project}/locations/{location}/connectors/{connector}`, where `{project}` can be project id or number. For more information on sending traffic to a VPC network via a connector, visit https://cloud.google.com/run/docs/configuring/vpc-connectors.
+      "egress": "A String", # Optional. Traffic VPC egress settings. If not provided, it defaults to PRIVATE_RANGES_ONLY.
+      "networkInterfaces": [ # Optional. Direct VPC egress settings. Currently only single network interface is supported.
+        { # Direct VPC egress settings.
+          "network": "A String", # Optional. The VPC network that the Cloud Run resource will be able to send traffic to. At least one of network or subnetwork must be specified. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If network is not specified, it will be looked up from the subnetwork.
+          "subnetwork": "A String", # Optional. The VPC subnetwork that the Cloud Run resource will get IPs from. At least one of network or subnetwork must be specified. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If subnetwork is not specified, the subnetwork with the same name with the network will be used.
+          "tags": [ # Optional. Network tags applied to this Cloud Run resource.
+            "A String",
+          ],
+        },
+      ],
+    },
+  },
+  "terminalCondition": { # Defines a status condition for a resource. # Output only. The Condition of this WorkerPool, containing its readiness status, and detailed error information in case it did not reach a serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run.
+    "executionReason": "A String", # Output only. A reason for the execution condition.
+    "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another.
+    "message": "A String", # Human readable message indicating details about the current status.
+    "reason": "A String", # Output only. A common (service-level) reason for this condition.
+    "revisionReason": "A String", # Output only. A reason for the revision condition.
+    "severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info
+    "state": "A String", # State of the condition.
+    "type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready.
+  },
+  "uid": "A String", # Output only. Server assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
+  "updateTime": "A String", # Output only. The last-modified time.
+}
+
+  validateOnly: boolean, Optional. Indicates that the request should be validated and default values populated, without persisting the request or creating any resources.
+  workerPoolId: string, Required. The unique identifier for the WorkerPool. It must begin with letter, and cannot end with hyphen; must contain fewer than 50 characters. The name of the worker pool becomes {parent}/workerPools/{worker_pool_id}.
+  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, etag=None, validateOnly=None, x__xgafv=None) +
Deletes a WorkerPool.
+
+Args:
+  name: string, Required. The full name of the WorkerPool. Format: projects/{project}/locations/{location}/workerPools/{worker_pool}, where {project} can be project id or number. (required)
+  etag: string, A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.
+  validateOnly: boolean, Optional. Indicates that the request should be validated without actually deleting any resources.
+  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.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets information about a WorkerPool.
+
+Args:
+  name: string, Required. The full name of the WorkerPool. Format: projects/{project}/locations/{location}/workerPools/{worker_pool}, where {project} can be project id or number. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # WorkerPool acts as a top-level container that manages a set of configurations and revision templates which implement a pull-based workload. WorkerPool exists to provide a singular abstraction which can be access controlled, reasoned about, and which encapsulates software lifecycle decisions such as rollout policy and team resource ownership.
+  "annotations": { # Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run API v2 does not support annotations with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected in new resources. All system annotations in v1 now have a corresponding field in v2 WorkerPool. This field follows Kubernetes annotations' namespacing, limits, and rules.
+    "a_key": "A String",
+  },
+  "binaryAuthorization": { # Settings for Binary Authorization feature. # Optional. Settings for the Binary Authorization feature.
+    "breakglassJustification": "A String", # Optional. If present, indicates to use Breakglass using this justification. If use_default is False, then it must be empty. For more information on breakglass, see https://cloud.google.com/binary-authorization/docs/using-breakglass
+    "policy": "A String", # Optional. The path to a binary authorization policy. Format: `projects/{project}/platforms/cloudRun/{policy-name}`
+    "useDefault": True or False, # Optional. If True, indicates to use the default project's binary authorization policy. If False, binary authorization will be disabled.
+  },
+  "client": "A String", # Arbitrary identifier for the API client.
+  "clientVersion": "A String", # Arbitrary version identifier for the API client.
+  "conditions": [ # Output only. The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the WorkerPool does not reach its Serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run.
+    { # Defines a status condition for a resource.
+      "executionReason": "A String", # Output only. A reason for the execution condition.
+      "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another.
+      "message": "A String", # Human readable message indicating details about the current status.
+      "reason": "A String", # Output only. A common (service-level) reason for this condition.
+      "revisionReason": "A String", # Output only. A reason for the revision condition.
+      "severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info
+      "state": "A String", # State of the condition.
+      "type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready.
+    },
+  ],
+  "createTime": "A String", # Output only. The creation time.
+  "creator": "A String", # Output only. Email address of the authenticated creator.
+  "customAudiences": [ # One or more custom audiences that you want this worker pool to support. Specify each custom audience as the full URL in a string. The custom audiences are encoded in the token and used to authenticate requests. For more information, see https://cloud.google.com/run/docs/configuring/custom-audiences.
+    "A String",
+  ],
+  "deleteTime": "A String", # Output only. The deletion time. It is only populated as a response to a Delete request.
+  "description": "A String", # User-provided description of the WorkerPool. This field currently has a 512-character limit.
+  "etag": "A String", # Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.
+  "expireTime": "A String", # Output only. For a deleted resource, the time after which it will be permamently deleted.
+  "generation": "A String", # Output only. A number that monotonically increases every time the user modifies the desired state. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a `string` instead of an `integer`.
+  "instanceSplitStatuses": [ # Output only. Detailed status information for corresponding instance splits. See comments in `reconciling` for additional information on reconciliation process in Cloud Run.
+    { # Represents the observed state of a single `InstanceSplit` entry.
+      "percent": 42, # Specifies percent of the instance split to this Revision.
+      "revision": "A String", # Revision to which this instance split is assigned.
+      "type": "A String", # The allocation type for this instance split.
+    },
+  ],
+  "instanceSplits": [ # Optional. Specifies how to distribute instances over a collection of Revisions belonging to the WorkerPool. If instance split is empty or not provided, defaults to 100% instances assigned to the latest `Ready` Revision.
+    { # Holds a single instance split entry for the Worker. Allocations can be done to a specific Revision name, or pointing to the latest Ready Revision.
+      "percent": 42, # Specifies percent of the instance split to this Revision. This defaults to zero if unspecified.
+      "revision": "A String", # Revision to which to assign this portion of instances, if split allocation is by revision.
+      "type": "A String", # The allocation type for this instance split.
+    },
+  ],
+  "labels": { # Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 WorkerPool.
+    "a_key": "A String",
+  },
+  "lastModifier": "A String", # Output only. Email address of the last authenticated modifier.
+  "latestCreatedRevision": "A String", # Output only. Name of the last created revision. See comments in `reconciling` for additional information on reconciliation process in Cloud Run.
+  "latestReadyRevision": "A String", # Output only. Name of the latest revision that is serving traffic. See comments in `reconciling` for additional information on reconciliation process in Cloud Run.
+  "launchStage": "A String", # Optional. The launch stage as defined by [Google Cloud Platform Launch Stages](https://cloud.google.com/terms/launch-stages). Cloud Run supports `ALPHA`, `BETA`, and `GA`. If no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features. For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output.
+  "name": "A String", # The fully qualified name of this WorkerPool. In CreateWorkerPoolRequest, this field is ignored, and instead composed from CreateWorkerPoolRequest.parent and CreateWorkerPoolRequest.worker_id. Format: projects/{project}/locations/{location}/workerPools/{worker_id}
+  "observedGeneration": "A String", # Output only. The generation of this WorkerPool currently serving traffic. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a `string` instead of an `integer`.
+  "reconciling": True or False, # Output only. Returns true if the WorkerPool is currently being acted upon by the system to bring it into the desired state. When a new WorkerPool is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the WorkerPool to the desired serving state. This process is called reconciliation. While reconciliation is in process, `observed_generation`, `latest_ready_revison`, `traffic_statuses`, and `uri` will have transient values that might mismatch the intended state: Once reconciliation is over (and this field is false), there are two possible outcomes: reconciliation succeeded and the serving state matches the WorkerPool, or there was an error, and reconciliation failed. This state can be found in `terminal_condition.state`. If reconciliation succeeded, the following fields will match: `traffic` and `traffic_statuses`, `observed_generation` and `generation`, `latest_ready_revision` and `latest_created_revision`. If reconciliation failed, `traffic_statuses`, `observed_generation`, and `latest_ready_revision` will have the state of the last serving revision, or empty for newly created WorkerPools. Additional information on the failure can be found in `terminal_condition` and `conditions`.
+  "satisfiesPzs": True or False, # Output only. Reserved for future use.
+  "scaling": { # Worker pool scaling settings. # Optional. Specifies worker-pool-level scaling settings
+    "manualInstanceCount": 42, # Optional. The total number of instances in manual scaling mode.
+    "maxInstanceCount": 42, # Optional. The maximum count of instances distributed among revisions based on the specified instance split percentages.
+    "maxSurge": 42, # Optional. A maximum percentage of instances that will be moved in each step of traffic split changes. When set to a positive value, the server will bring up, at most, that percentage of new instances at a time before moving traffic to them. After moving traffic, the server will bring down instances of the old revision. This can reduce a spike of total active instances during changes from one revision to another but specifying how many extra instances can be brought up at a time.
+    "maxUnavailable": 42, # Optional. A maximum percentage of instances that may be unavailable during changes from one revision to another. When set to a positive value, the server may bring down instances before bringing up new instances. This can prevent a spike of total active instances during changes from one revision by reducing the pool of instances before bringing up new ones. Some requests may be slow or fail to serve during the transition.
+    "minInstanceCount": 42, # Optional. The minimum count of instances distributed among revisions based on the specified instance split percentages.
+    "scalingMode": "A String", # Optional. The scaling mode for the worker pool.
+  },
+  "template": { # WorkerPoolRevisionTemplate describes the data a worker pool revision should have when created from a template. # Required. The template used to create revisions for this WorkerPool.
+    "annotations": { # Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run API v2 does not support annotations with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system annotations in v1 now have a corresponding field in v2 WorkerPoolRevisionTemplate. This field follows Kubernetes annotations' namespacing, limits, and rules.
+      "a_key": "A String",
+    },
+    "containers": [ # Holds list of the containers that defines the unit of execution for this Revision.
+      { # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments can be supplied by the system to the container at runtime.
+        "args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided.
+          "A String",
+        ],
+        "baseImageUri": "A String", # Base image for this container. Only supported for services. If set, it indicates that the service is enrolled into automatic base image update.
+        "buildInfo": { # Build information of the image. # Output only. The build info of the container image.
+          "functionTarget": "A String", # Output only. Entry point of the function when the image is a Cloud Run function.
+          "sourceLocation": "A String", # Output only. Source code location of the image.
+        },
+        "command": [ # Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided.
+          "A String",
+        ],
+        "dependsOn": [ # Names of the containers that must start before this container.
+          "A String",
+        ],
+        "env": [ # List of environment variables to set in the container.
+          { # EnvVar represents an environment variable present in a Container.
+            "name": "A String", # Required. Name of the environment variable. Must not exceed 32768 characters.
+            "value": "A String", # Literal value of the environment variable. Defaults to "", and the maximum length is 32768 bytes. Variable references are not supported in Cloud Run.
+            "valueSource": { # EnvVarSource represents a source for the value of an EnvVar. # Source for the environment variable's value.
+              "secretKeyRef": { # SecretEnvVarSource represents a source for the value of an EnvVar. # Selects a secret and a specific version from Cloud Secret Manager.
+                "secret": "A String", # Required. The name of the secret in Cloud Secret Manager. Format: {secret_name} if the secret is in the same project. projects/{project}/secrets/{secret_name} if the secret is in a different project.
+                "version": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest version, an integer for a specific version, or a version alias.
+              },
+            },
+          },
+        ],
+        "image": "A String", # Required. Name of the container image in Dockerhub, Google Artifact Registry, or Google Container Registry. If the host is not provided, Dockerhub is assumed.
+        "livenessProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Periodic probe of container liveness. Container will be restarted if the probe fails.
+          "failureThreshold": 42, # Optional. Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
+          "grpc": { # GRPCAction describes an action involving a GRPC port. # Optional. GRPC specifies an action involving a gRPC port. Exactly one of httpGet, tcpSocket, or grpc must be specified.
+            "port": 42, # Optional. Port number of the gRPC service. Number must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
+            "service": "A String", # Optional. Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md ). If this is not specified, the default behavior is defined by gRPC.
+          },
+          "httpGet": { # HTTPGetAction describes an action based on HTTP Get requests. # Optional. HTTPGet specifies the http request to perform. Exactly one of httpGet, tcpSocket, or grpc must be specified.
+            "httpHeaders": [ # Optional. Custom headers to set in the request. HTTP allows repeated headers.
+              { # HTTPHeader describes a custom header to be used in HTTP probes
+                "name": "A String", # Required. The header field name
+                "value": "A String", # Optional. The header field value
+              },
+            ],
+            "path": "A String", # Optional. Path to access on the HTTP server. Defaults to '/'.
+            "port": 42, # Optional. Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
+          },
+          "initialDelaySeconds": 42, # Optional. Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240.
+          "periodSeconds": 42, # Optional. How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeout_seconds.
+          "tcpSocket": { # TCPSocketAction describes an action based on opening a socket # Optional. TCPSocket specifies an action involving a TCP port. Exactly one of httpGet, tcpSocket, or grpc must be specified.
+            "port": 42, # Optional. Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
+          },
+          "timeoutSeconds": 42, # Optional. Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds.
+        },
+        "name": "A String", # Name of the container specified as a DNS_LABEL (RFC 1123).
+        "ports": [ # List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
+          { # ContainerPort represents a network port in a single container.
+            "containerPort": 42, # Port number the container listens on. This must be a valid TCP port number, 0 < container_port < 65536.
+            "name": "A String", # If specified, used to specify which protocol to use. Allowed values are "http1" and "h2c".
+          },
+        ],
+        "resources": { # ResourceRequirements describes the compute resource requirements. # Compute Resource requirements by this container.
+          "cpuIdle": True or False, # Determines whether CPU is only allocated during requests (true by default). However, if ResourceRequirements is set, the caller must explicitly set this field to true to preserve the default behavior.
+          "limits": { # Only `memory` and `cpu` keys in the map are supported. Notes: * The only supported values for CPU are '1', '2', '4', and '8'. Setting 4 CPU requires at least 2Gi of memory. For more information, go to https://cloud.google.com/run/docs/configuring/cpu. * For supported 'memory' values and syntax, go to https://cloud.google.com/run/docs/configuring/memory-limits
+            "a_key": "A String",
+          },
+          "startupCpuBoost": True or False, # Determines whether CPU should be boosted on startup of a new container instance above the requested CPU threshold, this can help reduce cold-start latency.
+        },
+        "startupProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Startup probe of application within the container. All other probes are disabled if a startup probe is provided, until it succeeds. Container will not be added to service endpoints if the probe fails.
+          "failureThreshold": 42, # Optional. Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
+          "grpc": { # GRPCAction describes an action involving a GRPC port. # Optional. GRPC specifies an action involving a gRPC port. Exactly one of httpGet, tcpSocket, or grpc must be specified.
+            "port": 42, # Optional. Port number of the gRPC service. Number must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
+            "service": "A String", # Optional. Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md ). If this is not specified, the default behavior is defined by gRPC.
+          },
+          "httpGet": { # HTTPGetAction describes an action based on HTTP Get requests. # Optional. HTTPGet specifies the http request to perform. Exactly one of httpGet, tcpSocket, or grpc must be specified.
+            "httpHeaders": [ # Optional. Custom headers to set in the request. HTTP allows repeated headers.
+              { # HTTPHeader describes a custom header to be used in HTTP probes
+                "name": "A String", # Required. The header field name
+                "value": "A String", # Optional. The header field value
+              },
+            ],
+            "path": "A String", # Optional. Path to access on the HTTP server. Defaults to '/'.
+            "port": 42, # Optional. Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
+          },
+          "initialDelaySeconds": 42, # Optional. Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240.
+          "periodSeconds": 42, # Optional. How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeout_seconds.
+          "tcpSocket": { # TCPSocketAction describes an action based on opening a socket # Optional. TCPSocket specifies an action involving a TCP port. Exactly one of httpGet, tcpSocket, or grpc must be specified.
+            "port": 42, # Optional. Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
+          },
+          "timeoutSeconds": 42, # Optional. Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds.
+        },
+        "volumeMounts": [ # Volume to mount into the container's filesystem.
+          { # VolumeMount describes a mounting of a Volume within a container.
+            "mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be `/cloudsql`. All instances defined in the Volume will be available as `/cloudsql/[instance]`. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run
+            "name": "A String", # Required. This must match the Name of a Volume.
+          },
+        ],
+        "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image.
+      },
+    ],
+    "encryptionKey": "A String", # A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek
+    "encryptionKeyRevocationAction": "A String", # Optional. The action to take if the encryption key is revoked.
+    "encryptionKeyShutdownDuration": "A String", # Optional. If encryption_key_revocation_action is SHUTDOWN, the duration before shutting down all instances. The minimum increment is 1 hour.
+    "labels": { # Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 WorkerPoolRevisionTemplate.
+      "a_key": "A String",
+    },
+    "nodeSelector": { # Hardware constraints configuration. # Optional. The node selector for the revision template.
+      "accelerator": "A String", # Required. GPU accelerator type to attach to an instance.
+    },
+    "revision": "A String", # Optional. The unique name for the revision. If this field is omitted, it will be automatically generated based on the WorkerPool name.
+    "serviceAccount": "A String", # Optional. Email address of the IAM service account associated with the revision of the service. The service account represents the identity of the running revision, and determines what permissions the revision has. If not provided, the revision will use the project's default service account.
+    "serviceMesh": { # Settings for Cloud Service Mesh. For more information see https://cloud.google.com/service-mesh/docs/overview. # Optional. Enables service mesh connectivity.
+      "mesh": "A String", # The Mesh resource name. Format: `projects/{project}/locations/global/meshes/{mesh}`, where `{project}` can be project id or number.
+    },
+    "sessionAffinity": True or False, # Optional. Enable session affinity.
+    "volumes": [ # Optional. A list of Volumes to make available to containers.
+      { # Volume represents a named volume in a container.
+        "cloudSqlInstance": { # Represents a set of Cloud SQL instances. Each one will be available under /cloudsql/[instance]. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. # For Cloud SQL volumes, contains the specific instances that should be mounted. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run.
+          "instances": [ # The Cloud SQL instance connection names, as can be found in https://console.cloud.google.com/sql/instances. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. Format: {project}:{location}:{instance}
+            "A String",
+          ],
+        },
+        "emptyDir": { # In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume.
+          "medium": "A String", # The medium on which the data is stored. Acceptable values today is only MEMORY or none. When none, the default will currently be backed by memory but could change over time. +optional
+          "sizeLimit": "A String", # Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers. The default is nil which means that the limit is undefined. More info: https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. Info in Kubernetes: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir
+        },
+        "gcs": { # Represents a volume backed by a Cloud Storage bucket using Cloud Storage FUSE. # Persistent storage backed by a Google Cloud Storage bucket.
+          "bucket": "A String", # Cloud Storage Bucket name.
+          "mountOptions": [ # A list of additional flags to pass to the gcsfuse CLI. Options should be specified without the leading "--".
+            "A String",
+          ],
+          "readOnly": True or False, # If true, the volume will be mounted as read only for all mounts.
+        },
+        "name": "A String", # Required. Volume's name.
+        "nfs": { # Represents an NFS mount. # For NFS Voumes, contains the path to the nfs Volume
+          "path": "A String", # Path that is exported by the NFS server.
+          "readOnly": True or False, # If true, the volume will be mounted as read only for all mounts.
+          "server": "A String", # Hostname or IP address of the NFS server
+        },
+        "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret. # Secret represents a secret that should populate this volume.
+          "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set.
+          "items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version.
+            { # VersionToPath maps a specific version of a secret to a relative file to mount to, relative to VolumeMount's mount_path.
+              "mode": 42, # Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
+              "path": "A String", # Required. The relative path of the secret in the container.
+              "version": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest value, or an integer or a secret alias for a specific version.
+            },
+          ],
+          "secret": "A String", # Required. The name of the secret in Cloud Secret Manager. Format: {secret} if the secret is in the same project. projects/{project}/secrets/{secret} if the secret is in a different project.
+        },
+      },
+    ],
+    "vpcAccess": { # VPC Access settings. For more information on sending traffic to a VPC network, visit https://cloud.google.com/run/docs/configuring/connecting-vpc. # Optional. VPC Access configuration to use for this Revision. For more information, visit https://cloud.google.com/run/docs/configuring/connecting-vpc.
+      "connector": "A String", # VPC Access connector name. Format: `projects/{project}/locations/{location}/connectors/{connector}`, where `{project}` can be project id or number. For more information on sending traffic to a VPC network via a connector, visit https://cloud.google.com/run/docs/configuring/vpc-connectors.
+      "egress": "A String", # Optional. Traffic VPC egress settings. If not provided, it defaults to PRIVATE_RANGES_ONLY.
+      "networkInterfaces": [ # Optional. Direct VPC egress settings. Currently only single network interface is supported.
+        { # Direct VPC egress settings.
+          "network": "A String", # Optional. The VPC network that the Cloud Run resource will be able to send traffic to. At least one of network or subnetwork must be specified. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If network is not specified, it will be looked up from the subnetwork.
+          "subnetwork": "A String", # Optional. The VPC subnetwork that the Cloud Run resource will get IPs from. At least one of network or subnetwork must be specified. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If subnetwork is not specified, the subnetwork with the same name with the network will be used.
+          "tags": [ # Optional. Network tags applied to this Cloud Run resource.
+            "A String",
+          ],
+        },
+      ],
+    },
+  },
+  "terminalCondition": { # Defines a status condition for a resource. # Output only. The Condition of this WorkerPool, containing its readiness status, and detailed error information in case it did not reach a serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run.
+    "executionReason": "A String", # Output only. A reason for the execution condition.
+    "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another.
+    "message": "A String", # Human readable message indicating details about the current status.
+    "reason": "A String", # Output only. A common (service-level) reason for this condition.
+    "revisionReason": "A String", # Output only. A reason for the revision condition.
+    "severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info
+    "state": "A String", # State of the condition.
+    "type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready.
+  },
+  "uid": "A String", # Output only. Server assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
+  "updateTime": "A String", # Output only. The last-modified time.
+}
+
+ +
+ getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None) +
Gets the IAM Access Control policy currently in effect for the given Cloud Run WorkerPool. This result does not include any inherited policies.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
+  "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+    { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
+      "auditLogConfigs": [ # The configuration for logging of each type of permission.
+        { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+          "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+            "A String",
+          ],
+          "logType": "A String", # The log type that this config enables.
+        },
+      ],
+      "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
+    },
+  ],
+  "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+    { # Associates `members`, or principals, with a `role`.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+  "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None) +
Lists WorkerPools. Results are sorted by creation time, descending.
+
+Args:
+  parent: string, Required. The location and project to list resources on. Location must be a valid Google Cloud region, and cannot be the "-" wildcard. Format: projects/{project}/locations/{location}, where {project} can be project id or number. (required)
+  pageSize: integer, Maximum number of WorkerPools to return in this call.
+  pageToken: string, A page token received from a previous call to ListWorkerPools. All other parameters must match.
+  showDeleted: boolean, If true, returns deleted (but unexpired) resources along with active ones.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message containing a list of WorkerPools.
+  "nextPageToken": "A String", # A token indicating there are more items than page_size. Use it in the next ListWorkerPools request to continue.
+  "workerPools": [ # The resulting list of WorkerPools.
+    { # WorkerPool acts as a top-level container that manages a set of configurations and revision templates which implement a pull-based workload. WorkerPool exists to provide a singular abstraction which can be access controlled, reasoned about, and which encapsulates software lifecycle decisions such as rollout policy and team resource ownership.
+      "annotations": { # Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run API v2 does not support annotations with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected in new resources. All system annotations in v1 now have a corresponding field in v2 WorkerPool. This field follows Kubernetes annotations' namespacing, limits, and rules.
+        "a_key": "A String",
+      },
+      "binaryAuthorization": { # Settings for Binary Authorization feature. # Optional. Settings for the Binary Authorization feature.
+        "breakglassJustification": "A String", # Optional. If present, indicates to use Breakglass using this justification. If use_default is False, then it must be empty. For more information on breakglass, see https://cloud.google.com/binary-authorization/docs/using-breakglass
+        "policy": "A String", # Optional. The path to a binary authorization policy. Format: `projects/{project}/platforms/cloudRun/{policy-name}`
+        "useDefault": True or False, # Optional. If True, indicates to use the default project's binary authorization policy. If False, binary authorization will be disabled.
+      },
+      "client": "A String", # Arbitrary identifier for the API client.
+      "clientVersion": "A String", # Arbitrary version identifier for the API client.
+      "conditions": [ # Output only. The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the WorkerPool does not reach its Serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run.
+        { # Defines a status condition for a resource.
+          "executionReason": "A String", # Output only. A reason for the execution condition.
+          "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another.
+          "message": "A String", # Human readable message indicating details about the current status.
+          "reason": "A String", # Output only. A common (service-level) reason for this condition.
+          "revisionReason": "A String", # Output only. A reason for the revision condition.
+          "severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info
+          "state": "A String", # State of the condition.
+          "type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready.
+        },
+      ],
+      "createTime": "A String", # Output only. The creation time.
+      "creator": "A String", # Output only. Email address of the authenticated creator.
+      "customAudiences": [ # One or more custom audiences that you want this worker pool to support. Specify each custom audience as the full URL in a string. The custom audiences are encoded in the token and used to authenticate requests. For more information, see https://cloud.google.com/run/docs/configuring/custom-audiences.
+        "A String",
+      ],
+      "deleteTime": "A String", # Output only. The deletion time. It is only populated as a response to a Delete request.
+      "description": "A String", # User-provided description of the WorkerPool. This field currently has a 512-character limit.
+      "etag": "A String", # Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.
+      "expireTime": "A String", # Output only. For a deleted resource, the time after which it will be permamently deleted.
+      "generation": "A String", # Output only. A number that monotonically increases every time the user modifies the desired state. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a `string` instead of an `integer`.
+      "instanceSplitStatuses": [ # Output only. Detailed status information for corresponding instance splits. See comments in `reconciling` for additional information on reconciliation process in Cloud Run.
+        { # Represents the observed state of a single `InstanceSplit` entry.
+          "percent": 42, # Specifies percent of the instance split to this Revision.
+          "revision": "A String", # Revision to which this instance split is assigned.
+          "type": "A String", # The allocation type for this instance split.
+        },
+      ],
+      "instanceSplits": [ # Optional. Specifies how to distribute instances over a collection of Revisions belonging to the WorkerPool. If instance split is empty or not provided, defaults to 100% instances assigned to the latest `Ready` Revision.
+        { # Holds a single instance split entry for the Worker. Allocations can be done to a specific Revision name, or pointing to the latest Ready Revision.
+          "percent": 42, # Specifies percent of the instance split to this Revision. This defaults to zero if unspecified.
+          "revision": "A String", # Revision to which to assign this portion of instances, if split allocation is by revision.
+          "type": "A String", # The allocation type for this instance split.
+        },
+      ],
+      "labels": { # Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 WorkerPool.
+        "a_key": "A String",
+      },
+      "lastModifier": "A String", # Output only. Email address of the last authenticated modifier.
+      "latestCreatedRevision": "A String", # Output only. Name of the last created revision. See comments in `reconciling` for additional information on reconciliation process in Cloud Run.
+      "latestReadyRevision": "A String", # Output only. Name of the latest revision that is serving traffic. See comments in `reconciling` for additional information on reconciliation process in Cloud Run.
+      "launchStage": "A String", # Optional. The launch stage as defined by [Google Cloud Platform Launch Stages](https://cloud.google.com/terms/launch-stages). Cloud Run supports `ALPHA`, `BETA`, and `GA`. If no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features. For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output.
+      "name": "A String", # The fully qualified name of this WorkerPool. In CreateWorkerPoolRequest, this field is ignored, and instead composed from CreateWorkerPoolRequest.parent and CreateWorkerPoolRequest.worker_id. Format: projects/{project}/locations/{location}/workerPools/{worker_id}
+      "observedGeneration": "A String", # Output only. The generation of this WorkerPool currently serving traffic. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a `string` instead of an `integer`.
+      "reconciling": True or False, # Output only. Returns true if the WorkerPool is currently being acted upon by the system to bring it into the desired state. When a new WorkerPool is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the WorkerPool to the desired serving state. This process is called reconciliation. While reconciliation is in process, `observed_generation`, `latest_ready_revison`, `traffic_statuses`, and `uri` will have transient values that might mismatch the intended state: Once reconciliation is over (and this field is false), there are two possible outcomes: reconciliation succeeded and the serving state matches the WorkerPool, or there was an error, and reconciliation failed. This state can be found in `terminal_condition.state`. If reconciliation succeeded, the following fields will match: `traffic` and `traffic_statuses`, `observed_generation` and `generation`, `latest_ready_revision` and `latest_created_revision`. If reconciliation failed, `traffic_statuses`, `observed_generation`, and `latest_ready_revision` will have the state of the last serving revision, or empty for newly created WorkerPools. Additional information on the failure can be found in `terminal_condition` and `conditions`.
+      "satisfiesPzs": True or False, # Output only. Reserved for future use.
+      "scaling": { # Worker pool scaling settings. # Optional. Specifies worker-pool-level scaling settings
+        "manualInstanceCount": 42, # Optional. The total number of instances in manual scaling mode.
+        "maxInstanceCount": 42, # Optional. The maximum count of instances distributed among revisions based on the specified instance split percentages.
+        "maxSurge": 42, # Optional. A maximum percentage of instances that will be moved in each step of traffic split changes. When set to a positive value, the server will bring up, at most, that percentage of new instances at a time before moving traffic to them. After moving traffic, the server will bring down instances of the old revision. This can reduce a spike of total active instances during changes from one revision to another but specifying how many extra instances can be brought up at a time.
+        "maxUnavailable": 42, # Optional. A maximum percentage of instances that may be unavailable during changes from one revision to another. When set to a positive value, the server may bring down instances before bringing up new instances. This can prevent a spike of total active instances during changes from one revision by reducing the pool of instances before bringing up new ones. Some requests may be slow or fail to serve during the transition.
+        "minInstanceCount": 42, # Optional. The minimum count of instances distributed among revisions based on the specified instance split percentages.
+        "scalingMode": "A String", # Optional. The scaling mode for the worker pool.
+      },
+      "template": { # WorkerPoolRevisionTemplate describes the data a worker pool revision should have when created from a template. # Required. The template used to create revisions for this WorkerPool.
+        "annotations": { # Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run API v2 does not support annotations with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system annotations in v1 now have a corresponding field in v2 WorkerPoolRevisionTemplate. This field follows Kubernetes annotations' namespacing, limits, and rules.
+          "a_key": "A String",
+        },
+        "containers": [ # Holds list of the containers that defines the unit of execution for this Revision.
+          { # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments can be supplied by the system to the container at runtime.
+            "args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided.
+              "A String",
+            ],
+            "baseImageUri": "A String", # Base image for this container. Only supported for services. If set, it indicates that the service is enrolled into automatic base image update.
+            "buildInfo": { # Build information of the image. # Output only. The build info of the container image.
+              "functionTarget": "A String", # Output only. Entry point of the function when the image is a Cloud Run function.
+              "sourceLocation": "A String", # Output only. Source code location of the image.
+            },
+            "command": [ # Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided.
+              "A String",
+            ],
+            "dependsOn": [ # Names of the containers that must start before this container.
+              "A String",
+            ],
+            "env": [ # List of environment variables to set in the container.
+              { # EnvVar represents an environment variable present in a Container.
+                "name": "A String", # Required. Name of the environment variable. Must not exceed 32768 characters.
+                "value": "A String", # Literal value of the environment variable. Defaults to "", and the maximum length is 32768 bytes. Variable references are not supported in Cloud Run.
+                "valueSource": { # EnvVarSource represents a source for the value of an EnvVar. # Source for the environment variable's value.
+                  "secretKeyRef": { # SecretEnvVarSource represents a source for the value of an EnvVar. # Selects a secret and a specific version from Cloud Secret Manager.
+                    "secret": "A String", # Required. The name of the secret in Cloud Secret Manager. Format: {secret_name} if the secret is in the same project. projects/{project}/secrets/{secret_name} if the secret is in a different project.
+                    "version": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest version, an integer for a specific version, or a version alias.
+                  },
+                },
+              },
+            ],
+            "image": "A String", # Required. Name of the container image in Dockerhub, Google Artifact Registry, or Google Container Registry. If the host is not provided, Dockerhub is assumed.
+            "livenessProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Periodic probe of container liveness. Container will be restarted if the probe fails.
+              "failureThreshold": 42, # Optional. Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
+              "grpc": { # GRPCAction describes an action involving a GRPC port. # Optional. GRPC specifies an action involving a gRPC port. Exactly one of httpGet, tcpSocket, or grpc must be specified.
+                "port": 42, # Optional. Port number of the gRPC service. Number must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
+                "service": "A String", # Optional. Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md ). If this is not specified, the default behavior is defined by gRPC.
+              },
+              "httpGet": { # HTTPGetAction describes an action based on HTTP Get requests. # Optional. HTTPGet specifies the http request to perform. Exactly one of httpGet, tcpSocket, or grpc must be specified.
+                "httpHeaders": [ # Optional. Custom headers to set in the request. HTTP allows repeated headers.
+                  { # HTTPHeader describes a custom header to be used in HTTP probes
+                    "name": "A String", # Required. The header field name
+                    "value": "A String", # Optional. The header field value
+                  },
+                ],
+                "path": "A String", # Optional. Path to access on the HTTP server. Defaults to '/'.
+                "port": 42, # Optional. Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
+              },
+              "initialDelaySeconds": 42, # Optional. Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240.
+              "periodSeconds": 42, # Optional. How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeout_seconds.
+              "tcpSocket": { # TCPSocketAction describes an action based on opening a socket # Optional. TCPSocket specifies an action involving a TCP port. Exactly one of httpGet, tcpSocket, or grpc must be specified.
+                "port": 42, # Optional. Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
+              },
+              "timeoutSeconds": 42, # Optional. Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds.
+            },
+            "name": "A String", # Name of the container specified as a DNS_LABEL (RFC 1123).
+            "ports": [ # List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
+              { # ContainerPort represents a network port in a single container.
+                "containerPort": 42, # Port number the container listens on. This must be a valid TCP port number, 0 < container_port < 65536.
+                "name": "A String", # If specified, used to specify which protocol to use. Allowed values are "http1" and "h2c".
+              },
+            ],
+            "resources": { # ResourceRequirements describes the compute resource requirements. # Compute Resource requirements by this container.
+              "cpuIdle": True or False, # Determines whether CPU is only allocated during requests (true by default). However, if ResourceRequirements is set, the caller must explicitly set this field to true to preserve the default behavior.
+              "limits": { # Only `memory` and `cpu` keys in the map are supported. Notes: * The only supported values for CPU are '1', '2', '4', and '8'. Setting 4 CPU requires at least 2Gi of memory. For more information, go to https://cloud.google.com/run/docs/configuring/cpu. * For supported 'memory' values and syntax, go to https://cloud.google.com/run/docs/configuring/memory-limits
+                "a_key": "A String",
+              },
+              "startupCpuBoost": True or False, # Determines whether CPU should be boosted on startup of a new container instance above the requested CPU threshold, this can help reduce cold-start latency.
+            },
+            "startupProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Startup probe of application within the container. All other probes are disabled if a startup probe is provided, until it succeeds. Container will not be added to service endpoints if the probe fails.
+              "failureThreshold": 42, # Optional. Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
+              "grpc": { # GRPCAction describes an action involving a GRPC port. # Optional. GRPC specifies an action involving a gRPC port. Exactly one of httpGet, tcpSocket, or grpc must be specified.
+                "port": 42, # Optional. Port number of the gRPC service. Number must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
+                "service": "A String", # Optional. Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md ). If this is not specified, the default behavior is defined by gRPC.
+              },
+              "httpGet": { # HTTPGetAction describes an action based on HTTP Get requests. # Optional. HTTPGet specifies the http request to perform. Exactly one of httpGet, tcpSocket, or grpc must be specified.
+                "httpHeaders": [ # Optional. Custom headers to set in the request. HTTP allows repeated headers.
+                  { # HTTPHeader describes a custom header to be used in HTTP probes
+                    "name": "A String", # Required. The header field name
+                    "value": "A String", # Optional. The header field value
+                  },
+                ],
+                "path": "A String", # Optional. Path to access on the HTTP server. Defaults to '/'.
+                "port": 42, # Optional. Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
+              },
+              "initialDelaySeconds": 42, # Optional. Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240.
+              "periodSeconds": 42, # Optional. How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeout_seconds.
+              "tcpSocket": { # TCPSocketAction describes an action based on opening a socket # Optional. TCPSocket specifies an action involving a TCP port. Exactly one of httpGet, tcpSocket, or grpc must be specified.
+                "port": 42, # Optional. Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
+              },
+              "timeoutSeconds": 42, # Optional. Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds.
+            },
+            "volumeMounts": [ # Volume to mount into the container's filesystem.
+              { # VolumeMount describes a mounting of a Volume within a container.
+                "mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be `/cloudsql`. All instances defined in the Volume will be available as `/cloudsql/[instance]`. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run
+                "name": "A String", # Required. This must match the Name of a Volume.
+              },
+            ],
+            "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image.
+          },
+        ],
+        "encryptionKey": "A String", # A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek
+        "encryptionKeyRevocationAction": "A String", # Optional. The action to take if the encryption key is revoked.
+        "encryptionKeyShutdownDuration": "A String", # Optional. If encryption_key_revocation_action is SHUTDOWN, the duration before shutting down all instances. The minimum increment is 1 hour.
+        "labels": { # Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 WorkerPoolRevisionTemplate.
+          "a_key": "A String",
+        },
+        "nodeSelector": { # Hardware constraints configuration. # Optional. The node selector for the revision template.
+          "accelerator": "A String", # Required. GPU accelerator type to attach to an instance.
+        },
+        "revision": "A String", # Optional. The unique name for the revision. If this field is omitted, it will be automatically generated based on the WorkerPool name.
+        "serviceAccount": "A String", # Optional. Email address of the IAM service account associated with the revision of the service. The service account represents the identity of the running revision, and determines what permissions the revision has. If not provided, the revision will use the project's default service account.
+        "serviceMesh": { # Settings for Cloud Service Mesh. For more information see https://cloud.google.com/service-mesh/docs/overview. # Optional. Enables service mesh connectivity.
+          "mesh": "A String", # The Mesh resource name. Format: `projects/{project}/locations/global/meshes/{mesh}`, where `{project}` can be project id or number.
+        },
+        "sessionAffinity": True or False, # Optional. Enable session affinity.
+        "volumes": [ # Optional. A list of Volumes to make available to containers.
+          { # Volume represents a named volume in a container.
+            "cloudSqlInstance": { # Represents a set of Cloud SQL instances. Each one will be available under /cloudsql/[instance]. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. # For Cloud SQL volumes, contains the specific instances that should be mounted. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run.
+              "instances": [ # The Cloud SQL instance connection names, as can be found in https://console.cloud.google.com/sql/instances. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. Format: {project}:{location}:{instance}
+                "A String",
+              ],
+            },
+            "emptyDir": { # In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume.
+              "medium": "A String", # The medium on which the data is stored. Acceptable values today is only MEMORY or none. When none, the default will currently be backed by memory but could change over time. +optional
+              "sizeLimit": "A String", # Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers. The default is nil which means that the limit is undefined. More info: https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. Info in Kubernetes: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir
+            },
+            "gcs": { # Represents a volume backed by a Cloud Storage bucket using Cloud Storage FUSE. # Persistent storage backed by a Google Cloud Storage bucket.
+              "bucket": "A String", # Cloud Storage Bucket name.
+              "mountOptions": [ # A list of additional flags to pass to the gcsfuse CLI. Options should be specified without the leading "--".
+                "A String",
+              ],
+              "readOnly": True or False, # If true, the volume will be mounted as read only for all mounts.
+            },
+            "name": "A String", # Required. Volume's name.
+            "nfs": { # Represents an NFS mount. # For NFS Voumes, contains the path to the nfs Volume
+              "path": "A String", # Path that is exported by the NFS server.
+              "readOnly": True or False, # If true, the volume will be mounted as read only for all mounts.
+              "server": "A String", # Hostname or IP address of the NFS server
+            },
+            "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret. # Secret represents a secret that should populate this volume.
+              "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set.
+              "items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version.
+                { # VersionToPath maps a specific version of a secret to a relative file to mount to, relative to VolumeMount's mount_path.
+                  "mode": 42, # Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
+                  "path": "A String", # Required. The relative path of the secret in the container.
+                  "version": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest value, or an integer or a secret alias for a specific version.
+                },
+              ],
+              "secret": "A String", # Required. The name of the secret in Cloud Secret Manager. Format: {secret} if the secret is in the same project. projects/{project}/secrets/{secret} if the secret is in a different project.
+            },
+          },
+        ],
+        "vpcAccess": { # VPC Access settings. For more information on sending traffic to a VPC network, visit https://cloud.google.com/run/docs/configuring/connecting-vpc. # Optional. VPC Access configuration to use for this Revision. For more information, visit https://cloud.google.com/run/docs/configuring/connecting-vpc.
+          "connector": "A String", # VPC Access connector name. Format: `projects/{project}/locations/{location}/connectors/{connector}`, where `{project}` can be project id or number. For more information on sending traffic to a VPC network via a connector, visit https://cloud.google.com/run/docs/configuring/vpc-connectors.
+          "egress": "A String", # Optional. Traffic VPC egress settings. If not provided, it defaults to PRIVATE_RANGES_ONLY.
+          "networkInterfaces": [ # Optional. Direct VPC egress settings. Currently only single network interface is supported.
+            { # Direct VPC egress settings.
+              "network": "A String", # Optional. The VPC network that the Cloud Run resource will be able to send traffic to. At least one of network or subnetwork must be specified. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If network is not specified, it will be looked up from the subnetwork.
+              "subnetwork": "A String", # Optional. The VPC subnetwork that the Cloud Run resource will get IPs from. At least one of network or subnetwork must be specified. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If subnetwork is not specified, the subnetwork with the same name with the network will be used.
+              "tags": [ # Optional. Network tags applied to this Cloud Run resource.
+                "A String",
+              ],
+            },
+          ],
+        },
+      },
+      "terminalCondition": { # Defines a status condition for a resource. # Output only. The Condition of this WorkerPool, containing its readiness status, and detailed error information in case it did not reach a serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run.
+        "executionReason": "A String", # Output only. A reason for the execution condition.
+        "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another.
+        "message": "A String", # Human readable message indicating details about the current status.
+        "reason": "A String", # Output only. A common (service-level) reason for this condition.
+        "revisionReason": "A String", # Output only. A reason for the revision condition.
+        "severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info
+        "state": "A String", # State of the condition.
+        "type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready.
+      },
+      "uid": "A String", # Output only. Server assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
+      "updateTime": "A String", # Output only. The last-modified time.
+    },
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, allowMissing=None, body=None, forceNewRevision=None, updateMask=None, validateOnly=None, x__xgafv=None) +
Updates a WorkerPool.
+
+Args:
+  name: string, The fully qualified name of this WorkerPool. In CreateWorkerPoolRequest, this field is ignored, and instead composed from CreateWorkerPoolRequest.parent and CreateWorkerPoolRequest.worker_id. Format: projects/{project}/locations/{location}/workerPools/{worker_id} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # WorkerPool acts as a top-level container that manages a set of configurations and revision templates which implement a pull-based workload. WorkerPool exists to provide a singular abstraction which can be access controlled, reasoned about, and which encapsulates software lifecycle decisions such as rollout policy and team resource ownership.
+  "annotations": { # Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run API v2 does not support annotations with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected in new resources. All system annotations in v1 now have a corresponding field in v2 WorkerPool. This field follows Kubernetes annotations' namespacing, limits, and rules.
+    "a_key": "A String",
+  },
+  "binaryAuthorization": { # Settings for Binary Authorization feature. # Optional. Settings for the Binary Authorization feature.
+    "breakglassJustification": "A String", # Optional. If present, indicates to use Breakglass using this justification. If use_default is False, then it must be empty. For more information on breakglass, see https://cloud.google.com/binary-authorization/docs/using-breakglass
+    "policy": "A String", # Optional. The path to a binary authorization policy. Format: `projects/{project}/platforms/cloudRun/{policy-name}`
+    "useDefault": True or False, # Optional. If True, indicates to use the default project's binary authorization policy. If False, binary authorization will be disabled.
+  },
+  "client": "A String", # Arbitrary identifier for the API client.
+  "clientVersion": "A String", # Arbitrary version identifier for the API client.
+  "conditions": [ # Output only. The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the WorkerPool does not reach its Serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run.
+    { # Defines a status condition for a resource.
+      "executionReason": "A String", # Output only. A reason for the execution condition.
+      "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another.
+      "message": "A String", # Human readable message indicating details about the current status.
+      "reason": "A String", # Output only. A common (service-level) reason for this condition.
+      "revisionReason": "A String", # Output only. A reason for the revision condition.
+      "severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info
+      "state": "A String", # State of the condition.
+      "type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready.
+    },
+  ],
+  "createTime": "A String", # Output only. The creation time.
+  "creator": "A String", # Output only. Email address of the authenticated creator.
+  "customAudiences": [ # One or more custom audiences that you want this worker pool to support. Specify each custom audience as the full URL in a string. The custom audiences are encoded in the token and used to authenticate requests. For more information, see https://cloud.google.com/run/docs/configuring/custom-audiences.
+    "A String",
+  ],
+  "deleteTime": "A String", # Output only. The deletion time. It is only populated as a response to a Delete request.
+  "description": "A String", # User-provided description of the WorkerPool. This field currently has a 512-character limit.
+  "etag": "A String", # Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.
+  "expireTime": "A String", # Output only. For a deleted resource, the time after which it will be permamently deleted.
+  "generation": "A String", # Output only. A number that monotonically increases every time the user modifies the desired state. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a `string` instead of an `integer`.
+  "instanceSplitStatuses": [ # Output only. Detailed status information for corresponding instance splits. See comments in `reconciling` for additional information on reconciliation process in Cloud Run.
+    { # Represents the observed state of a single `InstanceSplit` entry.
+      "percent": 42, # Specifies percent of the instance split to this Revision.
+      "revision": "A String", # Revision to which this instance split is assigned.
+      "type": "A String", # The allocation type for this instance split.
+    },
+  ],
+  "instanceSplits": [ # Optional. Specifies how to distribute instances over a collection of Revisions belonging to the WorkerPool. If instance split is empty or not provided, defaults to 100% instances assigned to the latest `Ready` Revision.
+    { # Holds a single instance split entry for the Worker. Allocations can be done to a specific Revision name, or pointing to the latest Ready Revision.
+      "percent": 42, # Specifies percent of the instance split to this Revision. This defaults to zero if unspecified.
+      "revision": "A String", # Revision to which to assign this portion of instances, if split allocation is by revision.
+      "type": "A String", # The allocation type for this instance split.
+    },
+  ],
+  "labels": { # Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 WorkerPool.
+    "a_key": "A String",
+  },
+  "lastModifier": "A String", # Output only. Email address of the last authenticated modifier.
+  "latestCreatedRevision": "A String", # Output only. Name of the last created revision. See comments in `reconciling` for additional information on reconciliation process in Cloud Run.
+  "latestReadyRevision": "A String", # Output only. Name of the latest revision that is serving traffic. See comments in `reconciling` for additional information on reconciliation process in Cloud Run.
+  "launchStage": "A String", # Optional. The launch stage as defined by [Google Cloud Platform Launch Stages](https://cloud.google.com/terms/launch-stages). Cloud Run supports `ALPHA`, `BETA`, and `GA`. If no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features. For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output.
+  "name": "A String", # The fully qualified name of this WorkerPool. In CreateWorkerPoolRequest, this field is ignored, and instead composed from CreateWorkerPoolRequest.parent and CreateWorkerPoolRequest.worker_id. Format: projects/{project}/locations/{location}/workerPools/{worker_id}
+  "observedGeneration": "A String", # Output only. The generation of this WorkerPool currently serving traffic. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a `string` instead of an `integer`.
+  "reconciling": True or False, # Output only. Returns true if the WorkerPool is currently being acted upon by the system to bring it into the desired state. When a new WorkerPool is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the WorkerPool to the desired serving state. This process is called reconciliation. While reconciliation is in process, `observed_generation`, `latest_ready_revison`, `traffic_statuses`, and `uri` will have transient values that might mismatch the intended state: Once reconciliation is over (and this field is false), there are two possible outcomes: reconciliation succeeded and the serving state matches the WorkerPool, or there was an error, and reconciliation failed. This state can be found in `terminal_condition.state`. If reconciliation succeeded, the following fields will match: `traffic` and `traffic_statuses`, `observed_generation` and `generation`, `latest_ready_revision` and `latest_created_revision`. If reconciliation failed, `traffic_statuses`, `observed_generation`, and `latest_ready_revision` will have the state of the last serving revision, or empty for newly created WorkerPools. Additional information on the failure can be found in `terminal_condition` and `conditions`.
+  "satisfiesPzs": True or False, # Output only. Reserved for future use.
+  "scaling": { # Worker pool scaling settings. # Optional. Specifies worker-pool-level scaling settings
+    "manualInstanceCount": 42, # Optional. The total number of instances in manual scaling mode.
+    "maxInstanceCount": 42, # Optional. The maximum count of instances distributed among revisions based on the specified instance split percentages.
+    "maxSurge": 42, # Optional. A maximum percentage of instances that will be moved in each step of traffic split changes. When set to a positive value, the server will bring up, at most, that percentage of new instances at a time before moving traffic to them. After moving traffic, the server will bring down instances of the old revision. This can reduce a spike of total active instances during changes from one revision to another but specifying how many extra instances can be brought up at a time.
+    "maxUnavailable": 42, # Optional. A maximum percentage of instances that may be unavailable during changes from one revision to another. When set to a positive value, the server may bring down instances before bringing up new instances. This can prevent a spike of total active instances during changes from one revision by reducing the pool of instances before bringing up new ones. Some requests may be slow or fail to serve during the transition.
+    "minInstanceCount": 42, # Optional. The minimum count of instances distributed among revisions based on the specified instance split percentages.
+    "scalingMode": "A String", # Optional. The scaling mode for the worker pool.
+  },
+  "template": { # WorkerPoolRevisionTemplate describes the data a worker pool revision should have when created from a template. # Required. The template used to create revisions for this WorkerPool.
+    "annotations": { # Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run API v2 does not support annotations with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system annotations in v1 now have a corresponding field in v2 WorkerPoolRevisionTemplate. This field follows Kubernetes annotations' namespacing, limits, and rules.
+      "a_key": "A String",
+    },
+    "containers": [ # Holds list of the containers that defines the unit of execution for this Revision.
+      { # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments can be supplied by the system to the container at runtime.
+        "args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided.
+          "A String",
+        ],
+        "baseImageUri": "A String", # Base image for this container. Only supported for services. If set, it indicates that the service is enrolled into automatic base image update.
+        "buildInfo": { # Build information of the image. # Output only. The build info of the container image.
+          "functionTarget": "A String", # Output only. Entry point of the function when the image is a Cloud Run function.
+          "sourceLocation": "A String", # Output only. Source code location of the image.
+        },
+        "command": [ # Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided.
+          "A String",
+        ],
+        "dependsOn": [ # Names of the containers that must start before this container.
+          "A String",
+        ],
+        "env": [ # List of environment variables to set in the container.
+          { # EnvVar represents an environment variable present in a Container.
+            "name": "A String", # Required. Name of the environment variable. Must not exceed 32768 characters.
+            "value": "A String", # Literal value of the environment variable. Defaults to "", and the maximum length is 32768 bytes. Variable references are not supported in Cloud Run.
+            "valueSource": { # EnvVarSource represents a source for the value of an EnvVar. # Source for the environment variable's value.
+              "secretKeyRef": { # SecretEnvVarSource represents a source for the value of an EnvVar. # Selects a secret and a specific version from Cloud Secret Manager.
+                "secret": "A String", # Required. The name of the secret in Cloud Secret Manager. Format: {secret_name} if the secret is in the same project. projects/{project}/secrets/{secret_name} if the secret is in a different project.
+                "version": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest version, an integer for a specific version, or a version alias.
+              },
+            },
+          },
+        ],
+        "image": "A String", # Required. Name of the container image in Dockerhub, Google Artifact Registry, or Google Container Registry. If the host is not provided, Dockerhub is assumed.
+        "livenessProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Periodic probe of container liveness. Container will be restarted if the probe fails.
+          "failureThreshold": 42, # Optional. Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
+          "grpc": { # GRPCAction describes an action involving a GRPC port. # Optional. GRPC specifies an action involving a gRPC port. Exactly one of httpGet, tcpSocket, or grpc must be specified.
+            "port": 42, # Optional. Port number of the gRPC service. Number must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
+            "service": "A String", # Optional. Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md ). If this is not specified, the default behavior is defined by gRPC.
+          },
+          "httpGet": { # HTTPGetAction describes an action based on HTTP Get requests. # Optional. HTTPGet specifies the http request to perform. Exactly one of httpGet, tcpSocket, or grpc must be specified.
+            "httpHeaders": [ # Optional. Custom headers to set in the request. HTTP allows repeated headers.
+              { # HTTPHeader describes a custom header to be used in HTTP probes
+                "name": "A String", # Required. The header field name
+                "value": "A String", # Optional. The header field value
+              },
+            ],
+            "path": "A String", # Optional. Path to access on the HTTP server. Defaults to '/'.
+            "port": 42, # Optional. Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
+          },
+          "initialDelaySeconds": 42, # Optional. Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240.
+          "periodSeconds": 42, # Optional. How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeout_seconds.
+          "tcpSocket": { # TCPSocketAction describes an action based on opening a socket # Optional. TCPSocket specifies an action involving a TCP port. Exactly one of httpGet, tcpSocket, or grpc must be specified.
+            "port": 42, # Optional. Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
+          },
+          "timeoutSeconds": 42, # Optional. Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds.
+        },
+        "name": "A String", # Name of the container specified as a DNS_LABEL (RFC 1123).
+        "ports": [ # List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
+          { # ContainerPort represents a network port in a single container.
+            "containerPort": 42, # Port number the container listens on. This must be a valid TCP port number, 0 < container_port < 65536.
+            "name": "A String", # If specified, used to specify which protocol to use. Allowed values are "http1" and "h2c".
+          },
+        ],
+        "resources": { # ResourceRequirements describes the compute resource requirements. # Compute Resource requirements by this container.
+          "cpuIdle": True or False, # Determines whether CPU is only allocated during requests (true by default). However, if ResourceRequirements is set, the caller must explicitly set this field to true to preserve the default behavior.
+          "limits": { # Only `memory` and `cpu` keys in the map are supported. Notes: * The only supported values for CPU are '1', '2', '4', and '8'. Setting 4 CPU requires at least 2Gi of memory. For more information, go to https://cloud.google.com/run/docs/configuring/cpu. * For supported 'memory' values and syntax, go to https://cloud.google.com/run/docs/configuring/memory-limits
+            "a_key": "A String",
+          },
+          "startupCpuBoost": True or False, # Determines whether CPU should be boosted on startup of a new container instance above the requested CPU threshold, this can help reduce cold-start latency.
+        },
+        "startupProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Startup probe of application within the container. All other probes are disabled if a startup probe is provided, until it succeeds. Container will not be added to service endpoints if the probe fails.
+          "failureThreshold": 42, # Optional. Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
+          "grpc": { # GRPCAction describes an action involving a GRPC port. # Optional. GRPC specifies an action involving a gRPC port. Exactly one of httpGet, tcpSocket, or grpc must be specified.
+            "port": 42, # Optional. Port number of the gRPC service. Number must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
+            "service": "A String", # Optional. Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md ). If this is not specified, the default behavior is defined by gRPC.
+          },
+          "httpGet": { # HTTPGetAction describes an action based on HTTP Get requests. # Optional. HTTPGet specifies the http request to perform. Exactly one of httpGet, tcpSocket, or grpc must be specified.
+            "httpHeaders": [ # Optional. Custom headers to set in the request. HTTP allows repeated headers.
+              { # HTTPHeader describes a custom header to be used in HTTP probes
+                "name": "A String", # Required. The header field name
+                "value": "A String", # Optional. The header field value
+              },
+            ],
+            "path": "A String", # Optional. Path to access on the HTTP server. Defaults to '/'.
+            "port": 42, # Optional. Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
+          },
+          "initialDelaySeconds": 42, # Optional. Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240.
+          "periodSeconds": 42, # Optional. How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeout_seconds.
+          "tcpSocket": { # TCPSocketAction describes an action based on opening a socket # Optional. TCPSocket specifies an action involving a TCP port. Exactly one of httpGet, tcpSocket, or grpc must be specified.
+            "port": 42, # Optional. Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
+          },
+          "timeoutSeconds": 42, # Optional. Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds.
+        },
+        "volumeMounts": [ # Volume to mount into the container's filesystem.
+          { # VolumeMount describes a mounting of a Volume within a container.
+            "mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be `/cloudsql`. All instances defined in the Volume will be available as `/cloudsql/[instance]`. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run
+            "name": "A String", # Required. This must match the Name of a Volume.
+          },
+        ],
+        "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image.
+      },
+    ],
+    "encryptionKey": "A String", # A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek
+    "encryptionKeyRevocationAction": "A String", # Optional. The action to take if the encryption key is revoked.
+    "encryptionKeyShutdownDuration": "A String", # Optional. If encryption_key_revocation_action is SHUTDOWN, the duration before shutting down all instances. The minimum increment is 1 hour.
+    "labels": { # Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 WorkerPoolRevisionTemplate.
+      "a_key": "A String",
+    },
+    "nodeSelector": { # Hardware constraints configuration. # Optional. The node selector for the revision template.
+      "accelerator": "A String", # Required. GPU accelerator type to attach to an instance.
+    },
+    "revision": "A String", # Optional. The unique name for the revision. If this field is omitted, it will be automatically generated based on the WorkerPool name.
+    "serviceAccount": "A String", # Optional. Email address of the IAM service account associated with the revision of the service. The service account represents the identity of the running revision, and determines what permissions the revision has. If not provided, the revision will use the project's default service account.
+    "serviceMesh": { # Settings for Cloud Service Mesh. For more information see https://cloud.google.com/service-mesh/docs/overview. # Optional. Enables service mesh connectivity.
+      "mesh": "A String", # The Mesh resource name. Format: `projects/{project}/locations/global/meshes/{mesh}`, where `{project}` can be project id or number.
+    },
+    "sessionAffinity": True or False, # Optional. Enable session affinity.
+    "volumes": [ # Optional. A list of Volumes to make available to containers.
+      { # Volume represents a named volume in a container.
+        "cloudSqlInstance": { # Represents a set of Cloud SQL instances. Each one will be available under /cloudsql/[instance]. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. # For Cloud SQL volumes, contains the specific instances that should be mounted. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run.
+          "instances": [ # The Cloud SQL instance connection names, as can be found in https://console.cloud.google.com/sql/instances. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. Format: {project}:{location}:{instance}
+            "A String",
+          ],
+        },
+        "emptyDir": { # In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume.
+          "medium": "A String", # The medium on which the data is stored. Acceptable values today is only MEMORY or none. When none, the default will currently be backed by memory but could change over time. +optional
+          "sizeLimit": "A String", # Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers. The default is nil which means that the limit is undefined. More info: https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. Info in Kubernetes: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir
+        },
+        "gcs": { # Represents a volume backed by a Cloud Storage bucket using Cloud Storage FUSE. # Persistent storage backed by a Google Cloud Storage bucket.
+          "bucket": "A String", # Cloud Storage Bucket name.
+          "mountOptions": [ # A list of additional flags to pass to the gcsfuse CLI. Options should be specified without the leading "--".
+            "A String",
+          ],
+          "readOnly": True or False, # If true, the volume will be mounted as read only for all mounts.
+        },
+        "name": "A String", # Required. Volume's name.
+        "nfs": { # Represents an NFS mount. # For NFS Voumes, contains the path to the nfs Volume
+          "path": "A String", # Path that is exported by the NFS server.
+          "readOnly": True or False, # If true, the volume will be mounted as read only for all mounts.
+          "server": "A String", # Hostname or IP address of the NFS server
+        },
+        "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret. # Secret represents a secret that should populate this volume.
+          "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set.
+          "items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version.
+            { # VersionToPath maps a specific version of a secret to a relative file to mount to, relative to VolumeMount's mount_path.
+              "mode": 42, # Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
+              "path": "A String", # Required. The relative path of the secret in the container.
+              "version": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest value, or an integer or a secret alias for a specific version.
+            },
+          ],
+          "secret": "A String", # Required. The name of the secret in Cloud Secret Manager. Format: {secret} if the secret is in the same project. projects/{project}/secrets/{secret} if the secret is in a different project.
+        },
+      },
+    ],
+    "vpcAccess": { # VPC Access settings. For more information on sending traffic to a VPC network, visit https://cloud.google.com/run/docs/configuring/connecting-vpc. # Optional. VPC Access configuration to use for this Revision. For more information, visit https://cloud.google.com/run/docs/configuring/connecting-vpc.
+      "connector": "A String", # VPC Access connector name. Format: `projects/{project}/locations/{location}/connectors/{connector}`, where `{project}` can be project id or number. For more information on sending traffic to a VPC network via a connector, visit https://cloud.google.com/run/docs/configuring/vpc-connectors.
+      "egress": "A String", # Optional. Traffic VPC egress settings. If not provided, it defaults to PRIVATE_RANGES_ONLY.
+      "networkInterfaces": [ # Optional. Direct VPC egress settings. Currently only single network interface is supported.
+        { # Direct VPC egress settings.
+          "network": "A String", # Optional. The VPC network that the Cloud Run resource will be able to send traffic to. At least one of network or subnetwork must be specified. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If network is not specified, it will be looked up from the subnetwork.
+          "subnetwork": "A String", # Optional. The VPC subnetwork that the Cloud Run resource will get IPs from. At least one of network or subnetwork must be specified. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If subnetwork is not specified, the subnetwork with the same name with the network will be used.
+          "tags": [ # Optional. Network tags applied to this Cloud Run resource.
+            "A String",
+          ],
+        },
+      ],
+    },
+  },
+  "terminalCondition": { # Defines a status condition for a resource. # Output only. The Condition of this WorkerPool, containing its readiness status, and detailed error information in case it did not reach a serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run.
+    "executionReason": "A String", # Output only. A reason for the execution condition.
+    "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another.
+    "message": "A String", # Human readable message indicating details about the current status.
+    "reason": "A String", # Output only. A common (service-level) reason for this condition.
+    "revisionReason": "A String", # Output only. A reason for the revision condition.
+    "severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info
+    "state": "A String", # State of the condition.
+    "type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready.
+  },
+  "uid": "A String", # Output only. Server assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
+  "updateTime": "A String", # Output only. The last-modified time.
+}
+
+  allowMissing: boolean, Optional. If set to true, and if the WorkerPool does not exist, it will create a new one. The caller must have 'run.workerpools.create' permissions if this is set to true and the WorkerPool does not exist.
+  forceNewRevision: boolean, Optional. If set to true, a new revision will be created from the template even if the system doesn't detect any changes from the previously deployed revision. This may be useful for cases where the underlying resources need to be recreated or reinitialized. For example if the image is specified by label, but the underlying image digest has changed) or if the container performs deployment initialization work that needs to be performed again.
+  updateMask: string, Optional. The list of fields to be updated.
+  validateOnly: boolean, Optional. Indicates that the request should be validated and default values populated, without persisting the request or updating any resources.
+  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.
+  },
+}
+
+ +
+ setIamPolicy(resource, body=None, x__xgafv=None) +
Sets the IAM Access control policy for the specified WorkerPool. Overwrites any existing policy.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `SetIamPolicy` method.
+  "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.
+    "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+      { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
+        "auditLogConfigs": [ # The configuration for logging of each type of permission.
+          { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+            "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+              "A String",
+            ],
+            "logType": "A String", # The log type that this config enables.
+          },
+        ],
+        "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
+      },
+    ],
+    "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+      { # Associates `members`, or principals, with a `role`.
+        "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+          "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+          "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+          "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+          "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+        },
+        "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+          "A String",
+        ],
+        "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+      },
+    ],
+    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+    "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+  },
+  "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"`
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
+  "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+    { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
+      "auditLogConfigs": [ # The configuration for logging of each type of permission.
+        { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+          "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+            "A String",
+          ],
+          "logType": "A String", # The log type that this config enables.
+        },
+      ],
+      "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
+    },
+  ],
+  "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+    { # Associates `members`, or principals, with a `role`.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+  "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+ +
+ testIamPermissions(resource, body=None, x__xgafv=None) +
Returns permissions that a caller has on the specified Project. There are no permissions required for making this API call.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `TestIamPermissions` method.
+  "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
+    "A String",
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for `TestIamPermissions` method.
+  "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+    "A String",
+  ],
+}
+
+ \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/run.v1.json b/googleapiclient/discovery_cache/documents/run.v1.json index eeb5204f9e0..140b30f85d0 100644 --- a/googleapiclient/discovery_cache/documents/run.v1.json +++ b/googleapiclient/discovery_cache/documents/run.v1.json @@ -2614,7 +2614,7 @@ } } }, -"revision": "20250207", +"revision": "20250214", "rootUrl": "https://run.googleapis.com/", "schemas": { "Addressable": { @@ -6355,6 +6355,13 @@ false "format": "int32", "type": "integer" }, +"nodeSelector": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. The Node Selector configuration. Map of selector key to a value which matches a node.", +"type": "object" +}, "serviceAccountName": { "description": "Optional. Email address of the IAM service account associated with the task of a job execution. The service account represents the identity of the running task, and determines what permissions the task has. If not provided, the task will use the project's default service account.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/run.v2.json b/googleapiclient/discovery_cache/documents/run.v2.json index 5b09575a4d4..d8b0f57387c 100644 --- a/googleapiclient/discovery_cache/documents/run.v2.json +++ b/googleapiclient/discovery_cache/documents/run.v2.json @@ -1522,6 +1522,283 @@ } }, "workerPools": { +"methods": { +"create": { +"description": "Creates a new WorkerPool in a given project and location.", +"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/workerPools", +"httpMethod": "POST", +"id": "run.projects.locations.workerPools.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The location and project in which this worker pool should be created. Format: projects/{project}/locations/{location}, where {project} can be project id or number. Only lowercase characters, digits, and hyphens.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"validateOnly": { +"description": "Optional. Indicates that the request should be validated and default values populated, without persisting the request or creating any resources.", +"location": "query", +"type": "boolean" +}, +"workerPoolId": { +"description": "Required. The unique identifier for the WorkerPool. It must begin with letter, and cannot end with hyphen; must contain fewer than 50 characters. The name of the worker pool becomes {parent}/workerPools/{worker_pool_id}.", +"location": "query", +"type": "string" +} +}, +"path": "v2/{+parent}/workerPools", +"request": { +"$ref": "GoogleCloudRunV2WorkerPool" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a WorkerPool.", +"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/workerPools/{workerPoolsId}", +"httpMethod": "DELETE", +"id": "run.projects.locations.workerPools.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"etag": { +"description": "A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. The full name of the WorkerPool. Format: projects/{project}/locations/{location}/workerPools/{worker_pool}, where {project} can be project id or number.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/workerPools/[^/]+$", +"required": true, +"type": "string" +}, +"validateOnly": { +"description": "Optional. Indicates that the request should be validated without actually deleting any resources.", +"location": "query", +"type": "boolean" +} +}, +"path": "v2/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets information about a WorkerPool.", +"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/workerPools/{workerPoolsId}", +"httpMethod": "GET", +"id": "run.projects.locations.workerPools.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The full name of the WorkerPool. Format: projects/{project}/locations/{location}/workerPools/{worker_pool}, where {project} can be project id or number.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/workerPools/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+name}", +"response": { +"$ref": "GoogleCloudRunV2WorkerPool" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"getIamPolicy": { +"description": "Gets the IAM Access Control policy currently in effect for the given Cloud Run WorkerPool. This result does not include any inherited policies.", +"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/workerPools/{workerPoolsId}:getIamPolicy", +"httpMethod": "GET", +"id": "run.projects.locations.workerPools.getIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"options.requestedPolicyVersion": { +"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", +"format": "int32", +"location": "query", +"type": "integer" +}, +"resource": { +"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/workerPools/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+resource}:getIamPolicy", +"response": { +"$ref": "GoogleIamV1Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists WorkerPools. Results are sorted by creation time, descending.", +"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/workerPools", +"httpMethod": "GET", +"id": "run.projects.locations.workerPools.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Maximum number of WorkerPools to return in this call.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A page token received from a previous call to ListWorkerPools. All other parameters must match.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The location and project to list resources on. Location must be a valid Google Cloud region, and cannot be the \"-\" wildcard. Format: projects/{project}/locations/{location}, where {project} can be project id or number.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"showDeleted": { +"description": "If true, returns deleted (but unexpired) resources along with active ones.", +"location": "query", +"type": "boolean" +} +}, +"path": "v2/{+parent}/workerPools", +"response": { +"$ref": "GoogleCloudRunV2ListWorkerPoolsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates a WorkerPool.", +"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/workerPools/{workerPoolsId}", +"httpMethod": "PATCH", +"id": "run.projects.locations.workerPools.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"allowMissing": { +"description": "Optional. If set to true, and if the WorkerPool does not exist, it will create a new one. The caller must have 'run.workerpools.create' permissions if this is set to true and the WorkerPool does not exist.", +"location": "query", +"type": "boolean" +}, +"forceNewRevision": { +"description": "Optional. If set to true, a new revision will be created from the template even if the system doesn't detect any changes from the previously deployed revision. This may be useful for cases where the underlying resources need to be recreated or reinitialized. For example if the image is specified by label, but the underlying image digest has changed) or if the container performs deployment initialization work that needs to be performed again.", +"location": "query", +"type": "boolean" +}, +"name": { +"description": "The fully qualified name of this WorkerPool. In CreateWorkerPoolRequest, this field is ignored, and instead composed from CreateWorkerPoolRequest.parent and CreateWorkerPoolRequest.worker_id. Format: projects/{project}/locations/{location}/workerPools/{worker_id}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/workerPools/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. The list of fields to be updated.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +}, +"validateOnly": { +"description": "Optional. Indicates that the request should be validated and default values populated, without persisting the request or updating any resources.", +"location": "query", +"type": "boolean" +} +}, +"path": "v2/{+name}", +"request": { +"$ref": "GoogleCloudRunV2WorkerPool" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"setIamPolicy": { +"description": "Sets the IAM Access control policy for the specified WorkerPool. Overwrites any existing policy.", +"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/workerPools/{workerPoolsId}:setIamPolicy", +"httpMethod": "POST", +"id": "run.projects.locations.workerPools.setIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/workerPools/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+resource}:setIamPolicy", +"request": { +"$ref": "GoogleIamV1SetIamPolicyRequest" +}, +"response": { +"$ref": "GoogleIamV1Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"testIamPermissions": { +"description": "Returns permissions that a caller has on the specified Project. There are no permissions required for making this API call.", +"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/workerPools/{workerPoolsId}:testIamPermissions", +"httpMethod": "POST", +"id": "run.projects.locations.workerPools.testIamPermissions", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/workerPools/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+resource}:testIamPermissions", +"request": { +"$ref": "GoogleIamV1TestIamPermissionsRequest" +}, +"response": { +"$ref": "GoogleIamV1TestIamPermissionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, "resources": { "revisions": { "methods": { @@ -1635,7 +1912,7 @@ } } }, -"revision": "20250207", +"revision": "20250214", "rootUrl": "https://run.googleapis.com/", "schemas": { "GoogleCloudRunV2BinaryAuthorization": { @@ -2560,15 +2837,75 @@ }, "type": "object" }, -"GoogleCloudRunV2Job": { -"description": "Job represents the configuration of a single job, which references a container image that is run to completion.", -"id": "GoogleCloudRunV2Job", +"GoogleCloudRunV2InstanceSplit": { +"description": "Holds a single instance split entry for the Worker. Allocations can be done to a specific Revision name, or pointing to the latest Ready Revision.", +"id": "GoogleCloudRunV2InstanceSplit", "properties": { -"annotations": { -"additionalProperties": { +"percent": { +"description": "Specifies percent of the instance split to this Revision. This defaults to zero if unspecified.", +"format": "int32", +"type": "integer" +}, +"revision": { +"description": "Revision to which to assign this portion of instances, if split allocation is by revision.", "type": "string" }, -"description": "Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run API v2 does not support annotations with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected on new resources. All system annotations in v1 now have a corresponding field in v2 Job. This field follows Kubernetes annotations' namespacing, limits, and rules.", +"type": { +"description": "The allocation type for this instance split.", +"enum": [ +"INSTANCE_SPLIT_ALLOCATION_TYPE_UNSPECIFIED", +"INSTANCE_SPLIT_ALLOCATION_TYPE_LATEST", +"INSTANCE_SPLIT_ALLOCATION_TYPE_REVISION" +], +"enumDescriptions": [ +"Unspecified instance allocation type.", +"Allocates instances to the Service's latest ready Revision.", +"Allocates instances to a Revision by name." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudRunV2InstanceSplitStatus": { +"description": "Represents the observed state of a single `InstanceSplit` entry.", +"id": "GoogleCloudRunV2InstanceSplitStatus", +"properties": { +"percent": { +"description": "Specifies percent of the instance split to this Revision.", +"format": "int32", +"type": "integer" +}, +"revision": { +"description": "Revision to which this instance split is assigned.", +"type": "string" +}, +"type": { +"description": "The allocation type for this instance split.", +"enum": [ +"INSTANCE_SPLIT_ALLOCATION_TYPE_UNSPECIFIED", +"INSTANCE_SPLIT_ALLOCATION_TYPE_LATEST", +"INSTANCE_SPLIT_ALLOCATION_TYPE_REVISION" +], +"enumDescriptions": [ +"Unspecified instance allocation type.", +"Allocates instances to the Service's latest ready Revision.", +"Allocates instances to a Revision by name." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudRunV2Job": { +"description": "Job represents the configuration of a single job, which references a container image that is run to completion.", +"id": "GoogleCloudRunV2Job", +"properties": { +"annotations": { +"additionalProperties": { +"type": "string" +}, +"description": "Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run API v2 does not support annotations with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected on new resources. All system annotations in v1 now have a corresponding field in v2 Job. This field follows Kubernetes annotations' namespacing, limits, and rules.", "type": "object" }, "binaryAuthorization": { @@ -2813,6 +3150,24 @@ }, "type": "object" }, +"GoogleCloudRunV2ListWorkerPoolsResponse": { +"description": "Response message containing a list of WorkerPools.", +"id": "GoogleCloudRunV2ListWorkerPoolsResponse", +"properties": { +"nextPageToken": { +"description": "A token indicating there are more items than page_size. Use it in the next ListWorkerPools request to continue.", +"type": "string" +}, +"workerPools": { +"description": "The resulting list of WorkerPools.", +"items": { +"$ref": "GoogleCloudRunV2WorkerPool" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudRunV2Metadata": { "description": "Metadata represents the JSON encoded generated customer metadata.", "id": "GoogleCloudRunV2Metadata", @@ -4184,6 +4539,318 @@ }, "type": "object" }, +"GoogleCloudRunV2WorkerPool": { +"description": "WorkerPool acts as a top-level container that manages a set of configurations and revision templates which implement a pull-based workload. WorkerPool exists to provide a singular abstraction which can be access controlled, reasoned about, and which encapsulates software lifecycle decisions such as rollout policy and team resource ownership.", +"id": "GoogleCloudRunV2WorkerPool", +"properties": { +"annotations": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run API v2 does not support annotations with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected in new resources. All system annotations in v1 now have a corresponding field in v2 WorkerPool. This field follows Kubernetes annotations' namespacing, limits, and rules.", +"type": "object" +}, +"binaryAuthorization": { +"$ref": "GoogleCloudRunV2BinaryAuthorization", +"description": "Optional. Settings for the Binary Authorization feature." +}, +"client": { +"description": "Arbitrary identifier for the API client.", +"type": "string" +}, +"clientVersion": { +"description": "Arbitrary version identifier for the API client.", +"type": "string" +}, +"conditions": { +"description": "Output only. The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the WorkerPool does not reach its Serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run.", +"items": { +"$ref": "GoogleCloudRunV2Condition" +}, +"readOnly": true, +"type": "array" +}, +"createTime": { +"description": "Output only. The creation time.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"creator": { +"description": "Output only. Email address of the authenticated creator.", +"readOnly": true, +"type": "string" +}, +"customAudiences": { +"description": "One or more custom audiences that you want this worker pool to support. Specify each custom audience as the full URL in a string. The custom audiences are encoded in the token and used to authenticate requests. For more information, see https://cloud.google.com/run/docs/configuring/custom-audiences.", +"items": { +"type": "string" +}, +"type": "array" +}, +"deleteTime": { +"description": "Output only. The deletion time. It is only populated as a response to a Delete request.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "User-provided description of the WorkerPool. This field currently has a 512-character limit.", +"type": "string" +}, +"etag": { +"description": "Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.", +"readOnly": true, +"type": "string" +}, +"expireTime": { +"description": "Output only. For a deleted resource, the time after which it will be permamently deleted.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"generation": { +"description": "Output only. A number that monotonically increases every time the user modifies the desired state. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a `string` instead of an `integer`.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"instanceSplitStatuses": { +"description": "Output only. Detailed status information for corresponding instance splits. See comments in `reconciling` for additional information on reconciliation process in Cloud Run.", +"items": { +"$ref": "GoogleCloudRunV2InstanceSplitStatus" +}, +"readOnly": true, +"type": "array" +}, +"instanceSplits": { +"description": "Optional. Specifies how to distribute instances over a collection of Revisions belonging to the WorkerPool. If instance split is empty or not provided, defaults to 100% instances assigned to the latest `Ready` Revision.", +"items": { +"$ref": "GoogleCloudRunV2InstanceSplit" +}, +"type": "array" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 WorkerPool.", +"type": "object" +}, +"lastModifier": { +"description": "Output only. Email address of the last authenticated modifier.", +"readOnly": true, +"type": "string" +}, +"latestCreatedRevision": { +"description": "Output only. Name of the last created revision. See comments in `reconciling` for additional information on reconciliation process in Cloud Run.", +"readOnly": true, +"type": "string" +}, +"latestReadyRevision": { +"description": "Output only. Name of the latest revision that is serving traffic. See comments in `reconciling` for additional information on reconciliation process in Cloud Run.", +"readOnly": true, +"type": "string" +}, +"launchStage": { +"description": "Optional. The launch stage as defined by [Google Cloud Platform Launch Stages](https://cloud.google.com/terms/launch-stages). Cloud Run supports `ALPHA`, `BETA`, and `GA`. If no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features. For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output.", +"enum": [ +"LAUNCH_STAGE_UNSPECIFIED", +"UNIMPLEMENTED", +"PRELAUNCH", +"EARLY_ACCESS", +"ALPHA", +"BETA", +"GA", +"DEPRECATED" +], +"enumDescriptions": [ +"Do not use this default value.", +"The feature is not yet implemented. Users can not use it.", +"Prelaunch features are hidden from users and are only visible internally.", +"Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.", +"Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.", +"Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.", +"GA features are open to all developers and are considered stable and fully qualified for production use.", +"Deprecated features are scheduled to be shut down and removed. For more information, see the \"Deprecation Policy\" section of our [Terms of Service](https://cloud.google.com/terms/) and the [Google Cloud Platform Subject to the Deprecation Policy](https://cloud.google.com/terms/deprecation) documentation." +], +"type": "string" +}, +"name": { +"description": "The fully qualified name of this WorkerPool. In CreateWorkerPoolRequest, this field is ignored, and instead composed from CreateWorkerPoolRequest.parent and CreateWorkerPoolRequest.worker_id. Format: projects/{project}/locations/{location}/workerPools/{worker_id}", +"type": "string" +}, +"observedGeneration": { +"description": "Output only. The generation of this WorkerPool currently serving traffic. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a `string` instead of an `integer`.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"reconciling": { +"description": "Output only. Returns true if the WorkerPool is currently being acted upon by the system to bring it into the desired state. When a new WorkerPool is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the WorkerPool to the desired serving state. This process is called reconciliation. While reconciliation is in process, `observed_generation`, `latest_ready_revison`, `traffic_statuses`, and `uri` will have transient values that might mismatch the intended state: Once reconciliation is over (and this field is false), there are two possible outcomes: reconciliation succeeded and the serving state matches the WorkerPool, or there was an error, and reconciliation failed. This state can be found in `terminal_condition.state`. If reconciliation succeeded, the following fields will match: `traffic` and `traffic_statuses`, `observed_generation` and `generation`, `latest_ready_revision` and `latest_created_revision`. If reconciliation failed, `traffic_statuses`, `observed_generation`, and `latest_ready_revision` will have the state of the last serving revision, or empty for newly created WorkerPools. Additional information on the failure can be found in `terminal_condition` and `conditions`.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, +"scaling": { +"$ref": "GoogleCloudRunV2WorkerPoolScaling", +"description": "Optional. Specifies worker-pool-level scaling settings" +}, +"template": { +"$ref": "GoogleCloudRunV2WorkerPoolRevisionTemplate", +"description": "Required. The template used to create revisions for this WorkerPool." +}, +"terminalCondition": { +"$ref": "GoogleCloudRunV2Condition", +"description": "Output only. The Condition of this WorkerPool, containing its readiness status, and detailed error information in case it did not reach a serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run.", +"readOnly": true +}, +"uid": { +"description": "Output only. Server assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.", +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. The last-modified time.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudRunV2WorkerPoolRevisionTemplate": { +"description": "WorkerPoolRevisionTemplate describes the data a worker pool revision should have when created from a template.", +"id": "GoogleCloudRunV2WorkerPoolRevisionTemplate", +"properties": { +"annotations": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run API v2 does not support annotations with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system annotations in v1 now have a corresponding field in v2 WorkerPoolRevisionTemplate. This field follows Kubernetes annotations' namespacing, limits, and rules.", +"type": "object" +}, +"containers": { +"description": "Holds list of the containers that defines the unit of execution for this Revision.", +"items": { +"$ref": "GoogleCloudRunV2Container" +}, +"type": "array" +}, +"encryptionKey": { +"description": "A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek", +"type": "string" +}, +"encryptionKeyRevocationAction": { +"description": "Optional. The action to take if the encryption key is revoked.", +"enum": [ +"ENCRYPTION_KEY_REVOCATION_ACTION_UNSPECIFIED", +"PREVENT_NEW", +"SHUTDOWN" +], +"enumDescriptions": [ +"Unspecified", +"Prevents the creation of new instances.", +"Shuts down existing instances, and prevents creation of new ones." +], +"type": "string" +}, +"encryptionKeyShutdownDuration": { +"description": "Optional. If encryption_key_revocation_action is SHUTDOWN, the duration before shutting down all instances. The minimum increment is 1 hour.", +"format": "google-duration", +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 WorkerPoolRevisionTemplate.", +"type": "object" +}, +"nodeSelector": { +"$ref": "GoogleCloudRunV2NodeSelector", +"description": "Optional. The node selector for the revision template." +}, +"revision": { +"description": "Optional. The unique name for the revision. If this field is omitted, it will be automatically generated based on the WorkerPool name.", +"type": "string" +}, +"serviceAccount": { +"description": "Optional. Email address of the IAM service account associated with the revision of the service. The service account represents the identity of the running revision, and determines what permissions the revision has. If not provided, the revision will use the project's default service account.", +"type": "string" +}, +"serviceMesh": { +"$ref": "GoogleCloudRunV2ServiceMesh", +"description": "Optional. Enables service mesh connectivity." +}, +"sessionAffinity": { +"description": "Optional. Enable session affinity.", +"type": "boolean" +}, +"volumes": { +"description": "Optional. A list of Volumes to make available to containers.", +"items": { +"$ref": "GoogleCloudRunV2Volume" +}, +"type": "array" +}, +"vpcAccess": { +"$ref": "GoogleCloudRunV2VpcAccess", +"description": "Optional. VPC Access configuration to use for this Revision. For more information, visit https://cloud.google.com/run/docs/configuring/connecting-vpc." +} +}, +"type": "object" +}, +"GoogleCloudRunV2WorkerPoolScaling": { +"description": "Worker pool scaling settings.", +"id": "GoogleCloudRunV2WorkerPoolScaling", +"properties": { +"manualInstanceCount": { +"description": "Optional. The total number of instances in manual scaling mode.", +"format": "int32", +"type": "integer" +}, +"maxInstanceCount": { +"description": "Optional. The maximum count of instances distributed among revisions based on the specified instance split percentages.", +"format": "int32", +"type": "integer" +}, +"maxSurge": { +"description": "Optional. A maximum percentage of instances that will be moved in each step of traffic split changes. When set to a positive value, the server will bring up, at most, that percentage of new instances at a time before moving traffic to them. After moving traffic, the server will bring down instances of the old revision. This can reduce a spike of total active instances during changes from one revision to another but specifying how many extra instances can be brought up at a time.", +"format": "int32", +"type": "integer" +}, +"maxUnavailable": { +"description": "Optional. A maximum percentage of instances that may be unavailable during changes from one revision to another. When set to a positive value, the server may bring down instances before bringing up new instances. This can prevent a spike of total active instances during changes from one revision by reducing the pool of instances before bringing up new ones. Some requests may be slow or fail to serve during the transition.", +"format": "int32", +"type": "integer" +}, +"minInstanceCount": { +"description": "Optional. The minimum count of instances distributed among revisions based on the specified instance split percentages.", +"format": "int32", +"type": "integer" +}, +"scalingMode": { +"description": "Optional. The scaling mode for the worker pool.", +"enum": [ +"SCALING_MODE_UNSPECIFIED", +"AUTOMATIC", +"MANUAL" +], +"enumDescriptions": [ +"Unspecified.", +"Automatically scale between min and max instances.", +"Scale to exactly min instances and ignore the max instances." +], +"type": "string" +} +}, +"type": "object" +}, "GoogleDevtoolsCloudbuildV1ApprovalConfig": { "description": "ApprovalConfig describes configuration for manual approval of a build.", "id": "GoogleDevtoolsCloudbuildV1ApprovalConfig", From 2129794f5e5517713891aa164e8eb99d31c5af15 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 25 Feb 2025 07:08:20 +0000 Subject: [PATCH 27/36] fix(secretmanager): update the api #### secretmanager:v1 The following keys were changed: - endpoints (Total Keys: 1) #### secretmanager:v1beta1 The following keys were changed: - endpoints (Total Keys: 1) #### secretmanager:v1beta2 The following keys were changed: - endpoints (Total Keys: 1) --- .../documents/secretmanager.v1.json | 32 ++++++++++++++++++- .../documents/secretmanager.v1beta1.json | 32 ++++++++++++++++++- .../documents/secretmanager.v1beta2.json | 32 ++++++++++++++++++- 3 files changed, 93 insertions(+), 3 deletions(-) diff --git a/googleapiclient/discovery_cache/documents/secretmanager.v1.json b/googleapiclient/discovery_cache/documents/secretmanager.v1.json index c9df9e699e8..d083f51264f 100644 --- a/googleapiclient/discovery_cache/documents/secretmanager.v1.json +++ b/googleapiclient/discovery_cache/documents/secretmanager.v1.json @@ -115,6 +115,36 @@ "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.europe-north2.rep.googleapis.com/", "location": "europe-north2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://secretmanager.asia-northeast1.rep.googleapis.com/", +"location": "asia-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://secretmanager.australia-southeast1.rep.googleapis.com/", +"location": "australia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://secretmanager.australia-southeast2.rep.googleapis.com/", +"location": "australia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://secretmanager.europe-west2.rep.googleapis.com/", +"location": "europe-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://secretmanager.northamerica-northeast1.rep.googleapis.com/", +"location": "northamerica-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://secretmanager.northamerica-northeast2.rep.googleapis.com/", +"location": "northamerica-northeast2" } ], "fullyEncodeReservedExpansion": true, @@ -1210,7 +1240,7 @@ } } }, -"revision": "20250130", +"revision": "20250217", "rootUrl": "https://secretmanager.googleapis.com/", "schemas": { "AccessSecretVersionResponse": { diff --git a/googleapiclient/discovery_cache/documents/secretmanager.v1beta1.json b/googleapiclient/discovery_cache/documents/secretmanager.v1beta1.json index b0e0f9a157e..0a5cf9d9655 100644 --- a/googleapiclient/discovery_cache/documents/secretmanager.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/secretmanager.v1beta1.json @@ -115,6 +115,36 @@ "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.europe-north2.rep.googleapis.com/", "location": "europe-north2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://secretmanager.asia-northeast1.rep.googleapis.com/", +"location": "asia-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://secretmanager.australia-southeast1.rep.googleapis.com/", +"location": "australia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://secretmanager.australia-southeast2.rep.googleapis.com/", +"location": "australia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://secretmanager.europe-west2.rep.googleapis.com/", +"location": "europe-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://secretmanager.northamerica-northeast1.rep.googleapis.com/", +"location": "northamerica-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://secretmanager.northamerica-northeast2.rep.googleapis.com/", +"location": "northamerica-northeast2" } ], "fullyEncodeReservedExpansion": true, @@ -730,7 +760,7 @@ } } }, -"revision": "20250130", +"revision": "20250217", "rootUrl": "https://secretmanager.googleapis.com/", "schemas": { "AccessSecretVersionResponse": { diff --git a/googleapiclient/discovery_cache/documents/secretmanager.v1beta2.json b/googleapiclient/discovery_cache/documents/secretmanager.v1beta2.json index 11bc526a2d7..d2cdf210a2f 100644 --- a/googleapiclient/discovery_cache/documents/secretmanager.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/secretmanager.v1beta2.json @@ -115,6 +115,36 @@ "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.europe-north2.rep.googleapis.com/", "location": "europe-north2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://secretmanager.asia-northeast1.rep.googleapis.com/", +"location": "asia-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://secretmanager.australia-southeast1.rep.googleapis.com/", +"location": "australia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://secretmanager.australia-southeast2.rep.googleapis.com/", +"location": "australia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://secretmanager.europe-west2.rep.googleapis.com/", +"location": "europe-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://secretmanager.northamerica-northeast1.rep.googleapis.com/", +"location": "northamerica-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://secretmanager.northamerica-northeast2.rep.googleapis.com/", +"location": "northamerica-northeast2" } ], "fullyEncodeReservedExpansion": true, @@ -1210,7 +1240,7 @@ } } }, -"revision": "20250130", +"revision": "20250217", "rootUrl": "https://secretmanager.googleapis.com/", "schemas": { "AccessSecretVersionResponse": { From 1ca394c7541a0276512426c6773fb018742a2aca Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 25 Feb 2025 07:08:20 +0000 Subject: [PATCH 28/36] feat(securitycenter): update the api #### securitycenter:v1 The following keys were added: - schemas.Allowed (Total Keys: 4) - schemas.Denied (Total Keys: 4) - schemas.Finding.properties.ipRules.$ref (Total Keys: 1) - schemas.Finding.properties.job.$ref (Total Keys: 1) - schemas.Finding.properties.networks (Total Keys: 2) - schemas.GoogleCloudSecuritycenterV2Allowed (Total Keys: 4) - schemas.GoogleCloudSecuritycenterV2Denied (Total Keys: 4) - schemas.GoogleCloudSecuritycenterV2Finding.properties.ipRules.$ref (Total Keys: 1) - schemas.GoogleCloudSecuritycenterV2Finding.properties.job.$ref (Total Keys: 1) - schemas.GoogleCloudSecuritycenterV2Finding.properties.networks (Total Keys: 2) - schemas.GoogleCloudSecuritycenterV2IpRule (Total Keys: 16) - schemas.GoogleCloudSecuritycenterV2Job (Total Keys: 8) - schemas.GoogleCloudSecuritycenterV2Network (Total Keys: 3) - schemas.GoogleCloudSecuritycenterV2PortRange (Total Keys: 6) - schemas.IpRule (Total Keys: 16) - schemas.Job (Total Keys: 8) - schemas.Network (Total Keys: 3) - schemas.PortRange (Total Keys: 6) #### securitycenter:v1beta1 The following keys were added: - schemas.Allowed (Total Keys: 4) - schemas.Denied (Total Keys: 4) - schemas.Finding.properties.ipRules.$ref (Total Keys: 1) - schemas.Finding.properties.job.$ref (Total Keys: 1) - schemas.Finding.properties.networks (Total Keys: 2) - schemas.GoogleCloudSecuritycenterV2Allowed (Total Keys: 4) - schemas.GoogleCloudSecuritycenterV2Denied (Total Keys: 4) - schemas.GoogleCloudSecuritycenterV2Finding.properties.ipRules.$ref (Total Keys: 1) - schemas.GoogleCloudSecuritycenterV2Finding.properties.job.$ref (Total Keys: 1) - schemas.GoogleCloudSecuritycenterV2Finding.properties.networks (Total Keys: 2) - schemas.GoogleCloudSecuritycenterV2IpRule (Total Keys: 16) - schemas.GoogleCloudSecuritycenterV2Job (Total Keys: 8) - schemas.GoogleCloudSecuritycenterV2Network (Total Keys: 3) - schemas.GoogleCloudSecuritycenterV2PortRange (Total Keys: 6) - schemas.IpRule (Total Keys: 16) - schemas.Job (Total Keys: 8) - schemas.Network (Total Keys: 3) - schemas.PortRange (Total Keys: 6) #### securitycenter:v1beta2 The following keys were added: - schemas.Allowed (Total Keys: 4) - schemas.Denied (Total Keys: 4) - schemas.Finding.properties.ipRules.$ref (Total Keys: 1) - schemas.Finding.properties.job.$ref (Total Keys: 1) - schemas.Finding.properties.networks (Total Keys: 2) - schemas.GoogleCloudSecuritycenterV2Allowed (Total Keys: 4) - schemas.GoogleCloudSecuritycenterV2Denied (Total Keys: 4) - schemas.GoogleCloudSecuritycenterV2Finding.properties.ipRules.$ref (Total Keys: 1) - schemas.GoogleCloudSecuritycenterV2Finding.properties.job.$ref (Total Keys: 1) - schemas.GoogleCloudSecuritycenterV2Finding.properties.networks (Total Keys: 2) - schemas.GoogleCloudSecuritycenterV2IpRule (Total Keys: 16) - schemas.GoogleCloudSecuritycenterV2Job (Total Keys: 8) - schemas.GoogleCloudSecuritycenterV2Network (Total Keys: 3) - schemas.GoogleCloudSecuritycenterV2PortRange (Total Keys: 6) - schemas.IpRule (Total Keys: 16) - schemas.Job (Total Keys: 8) - schemas.Network (Total Keys: 3) - schemas.PortRange (Total Keys: 6) --- ...HealthAnalyticsSettings.customModules.html | 49 +++ ...itycenter_v1.folders.sources.findings.html | 245 ++++++++++++ ...HealthAnalyticsSettings.customModules.html | 49 +++ ...ter_v1.organizations.sources.findings.html | 343 +++++++++++++++++ ...HealthAnalyticsSettings.customModules.html | 49 +++ ...tycenter_v1.projects.sources.findings.html | 245 ++++++++++++ .../documents/securitycenter.v1.json | 358 +++++++++++++++++- .../documents/securitycenter.v1beta1.json | 358 +++++++++++++++++- .../documents/securitycenter.v1beta2.json | 358 +++++++++++++++++- 9 files changed, 2051 insertions(+), 3 deletions(-) diff --git a/docs/dyn/securitycenter_v1.folders.securityHealthAnalyticsSettings.customModules.html b/docs/dyn/securitycenter_v1.folders.securityHealthAnalyticsSettings.customModules.html index a386896acd1..4fc10c1cb38 100644 --- a/docs/dyn/securitycenter_v1.folders.securityHealthAnalyticsSettings.customModules.html +++ b/docs/dyn/securitycenter_v1.folders.securityHealthAnalyticsSettings.customModules.html @@ -893,6 +893,50 @@

Method Details

"A String", ], }, + "ipRules": { # IP rules associated with the finding. # IP rules associated with the finding. + "allowed": { # Allowed IP rule. # Tuple with allowed rules. + "ipRules": [ # Optional. Optional list of allowed IP rules. + { # IP rule information. + "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. + { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. + "max": "A String", # Maximum port value. + "min": "A String", # Minimum port value. + }, + ], + "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + }, + ], + }, + "denied": { # Denied IP rule. # Tuple with denied rules. + "ipRules": [ # Optional. Optional list of denied IP rules. + { # IP rule information. + "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. + { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. + "max": "A String", # Maximum port value. + "min": "A String", # Minimum port value. + }, + ], + "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + }, + ], + }, + "destinationIpRanges": [ # If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "A String", + ], + "direction": "A String", # The direction that the rule is applicable to, one of ingress or egress. + "exposedServices": [ # Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml. + "A String", + ], + "sourceIpRanges": [ # If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "A String", + ], + }, + "job": { # Describes a job # Job associated with the finding. + "errorCode": 42, # Optional. If the job did not complete successfully, this field describes why. + "location": "A String", # Optional. Gives the location where the job ran, such as `US` or `europe-west1` + "name": "A String", # The fully-qualified name for a job. e.g. `projects//jobs/` + "state": "A String", # Output only. State of the job, such as `RUNNING` or `PENDING`. + }, "kernelRootkit": { # Kernel mode rootkit signatures. # Signature of the kernel rootkit. "name": "A String", # Rootkit name, when available. "unexpectedCodeModification": True or False, # True if unexpected modifications of kernel code memory are present. @@ -1050,6 +1094,11 @@

Method Details

"muteInitiator": "A String", # Records additional information about the mute operation, for example, the [mute configuration](/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding. "muteUpdateTime": "A String", # Output only. The most recent time this finding was muted or unmuted. "name": "A String", # The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}", "projects/{project_id}/sources/{source_id}/findings/{finding_id}". + "networks": [ # Represents the VPC networks that the resource is attached to. + { # Contains information about a VPC network associated with the finding. + "name": "A String", # The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`. + }, + ], "nextSteps": "A String", # Steps to address the finding. "notebook": { # Represents a Jupyter notebook IPYNB file, such as a [Colab Enterprise notebook](https://cloud.google.com/colab/docs/introduction) file, that is associated with a finding. # Notebook associated with the finding. "lastAuthor": "A String", # The user ID of the latest author to modify the notebook. diff --git a/docs/dyn/securitycenter_v1.folders.sources.findings.html b/docs/dyn/securitycenter_v1.folders.sources.findings.html index 1a6450e2a42..2a6395b8a27 100644 --- a/docs/dyn/securitycenter_v1.folders.sources.findings.html +++ b/docs/dyn/securitycenter_v1.folders.sources.findings.html @@ -462,6 +462,50 @@

Method Details

"A String", ], }, + "ipRules": { # IP rules associated with the finding. # IP rules associated with the finding. + "allowed": { # Allowed IP rule. # Tuple with allowed rules. + "ipRules": [ # Optional. Optional list of allowed IP rules. + { # IP rule information. + "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. + { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. + "max": "A String", # Maximum port value. + "min": "A String", # Minimum port value. + }, + ], + "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + }, + ], + }, + "denied": { # Denied IP rule. # Tuple with denied rules. + "ipRules": [ # Optional. Optional list of denied IP rules. + { # IP rule information. + "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. + { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. + "max": "A String", # Maximum port value. + "min": "A String", # Minimum port value. + }, + ], + "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + }, + ], + }, + "destinationIpRanges": [ # If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "A String", + ], + "direction": "A String", # The direction that the rule is applicable to, one of ingress or egress. + "exposedServices": [ # Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml. + "A String", + ], + "sourceIpRanges": [ # If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "A String", + ], + }, + "job": { # Describes a job # Job associated with the finding. + "errorCode": 42, # Optional. If the job did not complete successfully, this field describes why. + "location": "A String", # Optional. Gives the location where the job ran, such as `US` or `europe-west1` + "name": "A String", # The fully-qualified name for a job. e.g. `projects//jobs/` + "state": "A String", # Output only. State of the job, such as `RUNNING` or `PENDING`. + }, "kernelRootkit": { # Kernel mode rootkit signatures. # Signature of the kernel rootkit. "name": "A String", # Rootkit name, when available. "unexpectedCodeModification": True or False, # True if unexpected modifications of kernel code memory are present. @@ -619,6 +663,11 @@

Method Details

"muteInitiator": "A String", # Records additional information about the mute operation, for example, the [mute configuration](/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding. "muteUpdateTime": "A String", # Output only. The most recent time this finding was muted or unmuted. "name": "A String", # The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}", "projects/{project_id}/sources/{source_id}/findings/{finding_id}". + "networks": [ # Represents the VPC networks that the resource is attached to. + { # Contains information about a VPC network associated with the finding. + "name": "A String", # The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`. + }, + ], "nextSteps": "A String", # Steps to address the finding. "notebook": { # Represents a Jupyter notebook IPYNB file, such as a [Colab Enterprise notebook](https://cloud.google.com/colab/docs/introduction) file, that is associated with a finding. # Notebook associated with the finding. "lastAuthor": "A String", # The user ID of the latest author to modify the notebook. @@ -1138,6 +1187,50 @@

Method Details

"A String", ], }, + "ipRules": { # IP rules associated with the finding. # IP rules associated with the finding. + "allowed": { # Allowed IP rule. # Tuple with allowed rules. + "ipRules": [ # Optional. Optional list of allowed IP rules. + { # IP rule information. + "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. + { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. + "max": "A String", # Maximum port value. + "min": "A String", # Minimum port value. + }, + ], + "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + }, + ], + }, + "denied": { # Denied IP rule. # Tuple with denied rules. + "ipRules": [ # Optional. Optional list of denied IP rules. + { # IP rule information. + "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. + { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. + "max": "A String", # Maximum port value. + "min": "A String", # Minimum port value. + }, + ], + "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + }, + ], + }, + "destinationIpRanges": [ # If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "A String", + ], + "direction": "A String", # The direction that the rule is applicable to, one of ingress or egress. + "exposedServices": [ # Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml. + "A String", + ], + "sourceIpRanges": [ # If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "A String", + ], + }, + "job": { # Describes a job # Job associated with the finding. + "errorCode": 42, # Optional. If the job did not complete successfully, this field describes why. + "location": "A String", # Optional. Gives the location where the job ran, such as `US` or `europe-west1` + "name": "A String", # The fully-qualified name for a job. e.g. `projects//jobs/` + "state": "A String", # Output only. State of the job, such as `RUNNING` or `PENDING`. + }, "kernelRootkit": { # Kernel mode rootkit signatures. # Signature of the kernel rootkit. "name": "A String", # Rootkit name, when available. "unexpectedCodeModification": True or False, # True if unexpected modifications of kernel code memory are present. @@ -1295,6 +1388,11 @@

Method Details

"muteInitiator": "A String", # Records additional information about the mute operation, for example, the [mute configuration](/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding. "muteUpdateTime": "A String", # Output only. The most recent time this finding was muted or unmuted. "name": "A String", # The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}", "projects/{project_id}/sources/{source_id}/findings/{finding_id}". + "networks": [ # Represents the VPC networks that the resource is attached to. + { # Contains information about a VPC network associated with the finding. + "name": "A String", # The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`. + }, + ], "nextSteps": "A String", # Steps to address the finding. "notebook": { # Represents a Jupyter notebook IPYNB file, such as a [Colab Enterprise notebook](https://cloud.google.com/colab/docs/introduction) file, that is associated with a finding. # Notebook associated with the finding. "lastAuthor": "A String", # The user ID of the latest author to modify the notebook. @@ -1728,6 +1826,50 @@

Method Details

"A String", ], }, + "ipRules": { # IP rules associated with the finding. # IP rules associated with the finding. + "allowed": { # Allowed IP rule. # Tuple with allowed rules. + "ipRules": [ # Optional. Optional list of allowed IP rules. + { # IP rule information. + "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. + { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. + "max": "A String", # Maximum port value. + "min": "A String", # Minimum port value. + }, + ], + "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + }, + ], + }, + "denied": { # Denied IP rule. # Tuple with denied rules. + "ipRules": [ # Optional. Optional list of denied IP rules. + { # IP rule information. + "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. + { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. + "max": "A String", # Maximum port value. + "min": "A String", # Minimum port value. + }, + ], + "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + }, + ], + }, + "destinationIpRanges": [ # If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "A String", + ], + "direction": "A String", # The direction that the rule is applicable to, one of ingress or egress. + "exposedServices": [ # Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml. + "A String", + ], + "sourceIpRanges": [ # If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "A String", + ], + }, + "job": { # Describes a job # Job associated with the finding. + "errorCode": 42, # Optional. If the job did not complete successfully, this field describes why. + "location": "A String", # Optional. Gives the location where the job ran, such as `US` or `europe-west1` + "name": "A String", # The fully-qualified name for a job. e.g. `projects//jobs/` + "state": "A String", # Output only. State of the job, such as `RUNNING` or `PENDING`. + }, "kernelRootkit": { # Kernel mode rootkit signatures. # Signature of the kernel rootkit. "name": "A String", # Rootkit name, when available. "unexpectedCodeModification": True or False, # True if unexpected modifications of kernel code memory are present. @@ -1885,6 +2027,11 @@

Method Details

"muteInitiator": "A String", # Records additional information about the mute operation, for example, the [mute configuration](/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding. "muteUpdateTime": "A String", # Output only. The most recent time this finding was muted or unmuted. "name": "A String", # The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}", "projects/{project_id}/sources/{source_id}/findings/{finding_id}". + "networks": [ # Represents the VPC networks that the resource is attached to. + { # Contains information about a VPC network associated with the finding. + "name": "A String", # The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`. + }, + ], "nextSteps": "A String", # Steps to address the finding. "notebook": { # Represents a Jupyter notebook IPYNB file, such as a [Colab Enterprise notebook](https://cloud.google.com/colab/docs/introduction) file, that is associated with a finding. # Notebook associated with the finding. "lastAuthor": "A String", # The user ID of the latest author to modify the notebook. @@ -2331,6 +2478,50 @@

Method Details

"A String", ], }, + "ipRules": { # IP rules associated with the finding. # IP rules associated with the finding. + "allowed": { # Allowed IP rule. # Tuple with allowed rules. + "ipRules": [ # Optional. Optional list of allowed IP rules. + { # IP rule information. + "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. + { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. + "max": "A String", # Maximum port value. + "min": "A String", # Minimum port value. + }, + ], + "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + }, + ], + }, + "denied": { # Denied IP rule. # Tuple with denied rules. + "ipRules": [ # Optional. Optional list of denied IP rules. + { # IP rule information. + "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. + { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. + "max": "A String", # Maximum port value. + "min": "A String", # Minimum port value. + }, + ], + "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + }, + ], + }, + "destinationIpRanges": [ # If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "A String", + ], + "direction": "A String", # The direction that the rule is applicable to, one of ingress or egress. + "exposedServices": [ # Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml. + "A String", + ], + "sourceIpRanges": [ # If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "A String", + ], + }, + "job": { # Describes a job # Job associated with the finding. + "errorCode": 42, # Optional. If the job did not complete successfully, this field describes why. + "location": "A String", # Optional. Gives the location where the job ran, such as `US` or `europe-west1` + "name": "A String", # The fully-qualified name for a job. e.g. `projects//jobs/` + "state": "A String", # Output only. State of the job, such as `RUNNING` or `PENDING`. + }, "kernelRootkit": { # Kernel mode rootkit signatures. # Signature of the kernel rootkit. "name": "A String", # Rootkit name, when available. "unexpectedCodeModification": True or False, # True if unexpected modifications of kernel code memory are present. @@ -2488,6 +2679,11 @@

Method Details

"muteInitiator": "A String", # Records additional information about the mute operation, for example, the [mute configuration](/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding. "muteUpdateTime": "A String", # Output only. The most recent time this finding was muted or unmuted. "name": "A String", # The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}", "projects/{project_id}/sources/{source_id}/findings/{finding_id}". + "networks": [ # Represents the VPC networks that the resource is attached to. + { # Contains information about a VPC network associated with the finding. + "name": "A String", # The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`. + }, + ], "nextSteps": "A String", # Steps to address the finding. "notebook": { # Represents a Jupyter notebook IPYNB file, such as a [Colab Enterprise notebook](https://cloud.google.com/colab/docs/introduction) file, that is associated with a finding. # Notebook associated with the finding. "lastAuthor": "A String", # The user ID of the latest author to modify the notebook. @@ -2935,6 +3131,50 @@

Method Details

"A String", ], }, + "ipRules": { # IP rules associated with the finding. # IP rules associated with the finding. + "allowed": { # Allowed IP rule. # Tuple with allowed rules. + "ipRules": [ # Optional. Optional list of allowed IP rules. + { # IP rule information. + "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. + { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. + "max": "A String", # Maximum port value. + "min": "A String", # Minimum port value. + }, + ], + "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + }, + ], + }, + "denied": { # Denied IP rule. # Tuple with denied rules. + "ipRules": [ # Optional. Optional list of denied IP rules. + { # IP rule information. + "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. + { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. + "max": "A String", # Maximum port value. + "min": "A String", # Minimum port value. + }, + ], + "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + }, + ], + }, + "destinationIpRanges": [ # If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "A String", + ], + "direction": "A String", # The direction that the rule is applicable to, one of ingress or egress. + "exposedServices": [ # Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml. + "A String", + ], + "sourceIpRanges": [ # If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "A String", + ], + }, + "job": { # Describes a job # Job associated with the finding. + "errorCode": 42, # Optional. If the job did not complete successfully, this field describes why. + "location": "A String", # Optional. Gives the location where the job ran, such as `US` or `europe-west1` + "name": "A String", # The fully-qualified name for a job. e.g. `projects//jobs/` + "state": "A String", # Output only. State of the job, such as `RUNNING` or `PENDING`. + }, "kernelRootkit": { # Kernel mode rootkit signatures. # Signature of the kernel rootkit. "name": "A String", # Rootkit name, when available. "unexpectedCodeModification": True or False, # True if unexpected modifications of kernel code memory are present. @@ -3092,6 +3332,11 @@

Method Details

"muteInitiator": "A String", # Records additional information about the mute operation, for example, the [mute configuration](/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding. "muteUpdateTime": "A String", # Output only. The most recent time this finding was muted or unmuted. "name": "A String", # The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}", "projects/{project_id}/sources/{source_id}/findings/{finding_id}". + "networks": [ # Represents the VPC networks that the resource is attached to. + { # Contains information about a VPC network associated with the finding. + "name": "A String", # The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`. + }, + ], "nextSteps": "A String", # Steps to address the finding. "notebook": { # Represents a Jupyter notebook IPYNB file, such as a [Colab Enterprise notebook](https://cloud.google.com/colab/docs/introduction) file, that is associated with a finding. # Notebook associated with the finding. "lastAuthor": "A String", # The user ID of the latest author to modify the notebook. diff --git a/docs/dyn/securitycenter_v1.organizations.securityHealthAnalyticsSettings.customModules.html b/docs/dyn/securitycenter_v1.organizations.securityHealthAnalyticsSettings.customModules.html index 3ccffc53e3a..b21799d5f7d 100644 --- a/docs/dyn/securitycenter_v1.organizations.securityHealthAnalyticsSettings.customModules.html +++ b/docs/dyn/securitycenter_v1.organizations.securityHealthAnalyticsSettings.customModules.html @@ -893,6 +893,50 @@

Method Details

"A String", ], }, + "ipRules": { # IP rules associated with the finding. # IP rules associated with the finding. + "allowed": { # Allowed IP rule. # Tuple with allowed rules. + "ipRules": [ # Optional. Optional list of allowed IP rules. + { # IP rule information. + "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. + { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. + "max": "A String", # Maximum port value. + "min": "A String", # Minimum port value. + }, + ], + "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + }, + ], + }, + "denied": { # Denied IP rule. # Tuple with denied rules. + "ipRules": [ # Optional. Optional list of denied IP rules. + { # IP rule information. + "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. + { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. + "max": "A String", # Maximum port value. + "min": "A String", # Minimum port value. + }, + ], + "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + }, + ], + }, + "destinationIpRanges": [ # If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "A String", + ], + "direction": "A String", # The direction that the rule is applicable to, one of ingress or egress. + "exposedServices": [ # Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml. + "A String", + ], + "sourceIpRanges": [ # If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "A String", + ], + }, + "job": { # Describes a job # Job associated with the finding. + "errorCode": 42, # Optional. If the job did not complete successfully, this field describes why. + "location": "A String", # Optional. Gives the location where the job ran, such as `US` or `europe-west1` + "name": "A String", # The fully-qualified name for a job. e.g. `projects//jobs/` + "state": "A String", # Output only. State of the job, such as `RUNNING` or `PENDING`. + }, "kernelRootkit": { # Kernel mode rootkit signatures. # Signature of the kernel rootkit. "name": "A String", # Rootkit name, when available. "unexpectedCodeModification": True or False, # True if unexpected modifications of kernel code memory are present. @@ -1050,6 +1094,11 @@

Method Details

"muteInitiator": "A String", # Records additional information about the mute operation, for example, the [mute configuration](/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding. "muteUpdateTime": "A String", # Output only. The most recent time this finding was muted or unmuted. "name": "A String", # The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}", "projects/{project_id}/sources/{source_id}/findings/{finding_id}". + "networks": [ # Represents the VPC networks that the resource is attached to. + { # Contains information about a VPC network associated with the finding. + "name": "A String", # The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`. + }, + ], "nextSteps": "A String", # Steps to address the finding. "notebook": { # Represents a Jupyter notebook IPYNB file, such as a [Colab Enterprise notebook](https://cloud.google.com/colab/docs/introduction) file, that is associated with a finding. # Notebook associated with the finding. "lastAuthor": "A String", # The user ID of the latest author to modify the notebook. diff --git a/docs/dyn/securitycenter_v1.organizations.sources.findings.html b/docs/dyn/securitycenter_v1.organizations.sources.findings.html index a626019d69e..8f9fe906e98 100644 --- a/docs/dyn/securitycenter_v1.organizations.sources.findings.html +++ b/docs/dyn/securitycenter_v1.organizations.sources.findings.html @@ -395,6 +395,50 @@

Method Details

"A String", ], }, + "ipRules": { # IP rules associated with the finding. # IP rules associated with the finding. + "allowed": { # Allowed IP rule. # Tuple with allowed rules. + "ipRules": [ # Optional. Optional list of allowed IP rules. + { # IP rule information. + "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. + { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. + "max": "A String", # Maximum port value. + "min": "A String", # Minimum port value. + }, + ], + "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + }, + ], + }, + "denied": { # Denied IP rule. # Tuple with denied rules. + "ipRules": [ # Optional. Optional list of denied IP rules. + { # IP rule information. + "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. + { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. + "max": "A String", # Maximum port value. + "min": "A String", # Minimum port value. + }, + ], + "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + }, + ], + }, + "destinationIpRanges": [ # If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "A String", + ], + "direction": "A String", # The direction that the rule is applicable to, one of ingress or egress. + "exposedServices": [ # Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml. + "A String", + ], + "sourceIpRanges": [ # If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "A String", + ], + }, + "job": { # Describes a job # Job associated with the finding. + "errorCode": 42, # Optional. If the job did not complete successfully, this field describes why. + "location": "A String", # Optional. Gives the location where the job ran, such as `US` or `europe-west1` + "name": "A String", # The fully-qualified name for a job. e.g. `projects//jobs/` + "state": "A String", # Output only. State of the job, such as `RUNNING` or `PENDING`. + }, "kernelRootkit": { # Kernel mode rootkit signatures. # Signature of the kernel rootkit. "name": "A String", # Rootkit name, when available. "unexpectedCodeModification": True or False, # True if unexpected modifications of kernel code memory are present. @@ -552,6 +596,11 @@

Method Details

"muteInitiator": "A String", # Records additional information about the mute operation, for example, the [mute configuration](/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding. "muteUpdateTime": "A String", # Output only. The most recent time this finding was muted or unmuted. "name": "A String", # The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}", "projects/{project_id}/sources/{source_id}/findings/{finding_id}". + "networks": [ # Represents the VPC networks that the resource is attached to. + { # Contains information about a VPC network associated with the finding. + "name": "A String", # The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`. + }, + ], "nextSteps": "A String", # Steps to address the finding. "notebook": { # Represents a Jupyter notebook IPYNB file, such as a [Colab Enterprise notebook](https://cloud.google.com/colab/docs/introduction) file, that is associated with a finding. # Notebook associated with the finding. "lastAuthor": "A String", # The user ID of the latest author to modify the notebook. @@ -985,6 +1034,50 @@

Method Details

"A String", ], }, + "ipRules": { # IP rules associated with the finding. # IP rules associated with the finding. + "allowed": { # Allowed IP rule. # Tuple with allowed rules. + "ipRules": [ # Optional. Optional list of allowed IP rules. + { # IP rule information. + "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. + { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. + "max": "A String", # Maximum port value. + "min": "A String", # Minimum port value. + }, + ], + "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + }, + ], + }, + "denied": { # Denied IP rule. # Tuple with denied rules. + "ipRules": [ # Optional. Optional list of denied IP rules. + { # IP rule information. + "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. + { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. + "max": "A String", # Maximum port value. + "min": "A String", # Minimum port value. + }, + ], + "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + }, + ], + }, + "destinationIpRanges": [ # If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "A String", + ], + "direction": "A String", # The direction that the rule is applicable to, one of ingress or egress. + "exposedServices": [ # Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml. + "A String", + ], + "sourceIpRanges": [ # If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "A String", + ], + }, + "job": { # Describes a job # Job associated with the finding. + "errorCode": 42, # Optional. If the job did not complete successfully, this field describes why. + "location": "A String", # Optional. Gives the location where the job ran, such as `US` or `europe-west1` + "name": "A String", # The fully-qualified name for a job. e.g. `projects//jobs/` + "state": "A String", # Output only. State of the job, such as `RUNNING` or `PENDING`. + }, "kernelRootkit": { # Kernel mode rootkit signatures. # Signature of the kernel rootkit. "name": "A String", # Rootkit name, when available. "unexpectedCodeModification": True or False, # True if unexpected modifications of kernel code memory are present. @@ -1142,6 +1235,11 @@

Method Details

"muteInitiator": "A String", # Records additional information about the mute operation, for example, the [mute configuration](/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding. "muteUpdateTime": "A String", # Output only. The most recent time this finding was muted or unmuted. "name": "A String", # The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}", "projects/{project_id}/sources/{source_id}/findings/{finding_id}". + "networks": [ # Represents the VPC networks that the resource is attached to. + { # Contains information about a VPC network associated with the finding. + "name": "A String", # The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`. + }, + ], "nextSteps": "A String", # Steps to address the finding. "notebook": { # Represents a Jupyter notebook IPYNB file, such as a [Colab Enterprise notebook](https://cloud.google.com/colab/docs/introduction) file, that is associated with a finding. # Notebook associated with the finding. "lastAuthor": "A String", # The user ID of the latest author to modify the notebook. @@ -1646,6 +1744,50 @@

Method Details

"A String", ], }, + "ipRules": { # IP rules associated with the finding. # IP rules associated with the finding. + "allowed": { # Allowed IP rule. # Tuple with allowed rules. + "ipRules": [ # Optional. Optional list of allowed IP rules. + { # IP rule information. + "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. + { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. + "max": "A String", # Maximum port value. + "min": "A String", # Minimum port value. + }, + ], + "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + }, + ], + }, + "denied": { # Denied IP rule. # Tuple with denied rules. + "ipRules": [ # Optional. Optional list of denied IP rules. + { # IP rule information. + "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. + { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. + "max": "A String", # Maximum port value. + "min": "A String", # Minimum port value. + }, + ], + "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + }, + ], + }, + "destinationIpRanges": [ # If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "A String", + ], + "direction": "A String", # The direction that the rule is applicable to, one of ingress or egress. + "exposedServices": [ # Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml. + "A String", + ], + "sourceIpRanges": [ # If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "A String", + ], + }, + "job": { # Describes a job # Job associated with the finding. + "errorCode": 42, # Optional. If the job did not complete successfully, this field describes why. + "location": "A String", # Optional. Gives the location where the job ran, such as `US` or `europe-west1` + "name": "A String", # The fully-qualified name for a job. e.g. `projects//jobs/` + "state": "A String", # Output only. State of the job, such as `RUNNING` or `PENDING`. + }, "kernelRootkit": { # Kernel mode rootkit signatures. # Signature of the kernel rootkit. "name": "A String", # Rootkit name, when available. "unexpectedCodeModification": True or False, # True if unexpected modifications of kernel code memory are present. @@ -1803,6 +1945,11 @@

Method Details

"muteInitiator": "A String", # Records additional information about the mute operation, for example, the [mute configuration](/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding. "muteUpdateTime": "A String", # Output only. The most recent time this finding was muted or unmuted. "name": "A String", # The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}", "projects/{project_id}/sources/{source_id}/findings/{finding_id}". + "networks": [ # Represents the VPC networks that the resource is attached to. + { # Contains information about a VPC network associated with the finding. + "name": "A String", # The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`. + }, + ], "nextSteps": "A String", # Steps to address the finding. "notebook": { # Represents a Jupyter notebook IPYNB file, such as a [Colab Enterprise notebook](https://cloud.google.com/colab/docs/introduction) file, that is associated with a finding. # Notebook associated with the finding. "lastAuthor": "A String", # The user ID of the latest author to modify the notebook. @@ -2322,6 +2469,50 @@

Method Details

"A String", ], }, + "ipRules": { # IP rules associated with the finding. # IP rules associated with the finding. + "allowed": { # Allowed IP rule. # Tuple with allowed rules. + "ipRules": [ # Optional. Optional list of allowed IP rules. + { # IP rule information. + "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. + { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. + "max": "A String", # Maximum port value. + "min": "A String", # Minimum port value. + }, + ], + "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + }, + ], + }, + "denied": { # Denied IP rule. # Tuple with denied rules. + "ipRules": [ # Optional. Optional list of denied IP rules. + { # IP rule information. + "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. + { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. + "max": "A String", # Maximum port value. + "min": "A String", # Minimum port value. + }, + ], + "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + }, + ], + }, + "destinationIpRanges": [ # If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "A String", + ], + "direction": "A String", # The direction that the rule is applicable to, one of ingress or egress. + "exposedServices": [ # Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml. + "A String", + ], + "sourceIpRanges": [ # If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "A String", + ], + }, + "job": { # Describes a job # Job associated with the finding. + "errorCode": 42, # Optional. If the job did not complete successfully, this field describes why. + "location": "A String", # Optional. Gives the location where the job ran, such as `US` or `europe-west1` + "name": "A String", # The fully-qualified name for a job. e.g. `projects//jobs/` + "state": "A String", # Output only. State of the job, such as `RUNNING` or `PENDING`. + }, "kernelRootkit": { # Kernel mode rootkit signatures. # Signature of the kernel rootkit. "name": "A String", # Rootkit name, when available. "unexpectedCodeModification": True or False, # True if unexpected modifications of kernel code memory are present. @@ -2479,6 +2670,11 @@

Method Details

"muteInitiator": "A String", # Records additional information about the mute operation, for example, the [mute configuration](/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding. "muteUpdateTime": "A String", # Output only. The most recent time this finding was muted or unmuted. "name": "A String", # The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}", "projects/{project_id}/sources/{source_id}/findings/{finding_id}". + "networks": [ # Represents the VPC networks that the resource is attached to. + { # Contains information about a VPC network associated with the finding. + "name": "A String", # The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`. + }, + ], "nextSteps": "A String", # Steps to address the finding. "notebook": { # Represents a Jupyter notebook IPYNB file, such as a [Colab Enterprise notebook](https://cloud.google.com/colab/docs/introduction) file, that is associated with a finding. # Notebook associated with the finding. "lastAuthor": "A String", # The user ID of the latest author to modify the notebook. @@ -2912,6 +3108,50 @@

Method Details

"A String", ], }, + "ipRules": { # IP rules associated with the finding. # IP rules associated with the finding. + "allowed": { # Allowed IP rule. # Tuple with allowed rules. + "ipRules": [ # Optional. Optional list of allowed IP rules. + { # IP rule information. + "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. + { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. + "max": "A String", # Maximum port value. + "min": "A String", # Minimum port value. + }, + ], + "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + }, + ], + }, + "denied": { # Denied IP rule. # Tuple with denied rules. + "ipRules": [ # Optional. Optional list of denied IP rules. + { # IP rule information. + "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. + { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. + "max": "A String", # Maximum port value. + "min": "A String", # Minimum port value. + }, + ], + "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + }, + ], + }, + "destinationIpRanges": [ # If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "A String", + ], + "direction": "A String", # The direction that the rule is applicable to, one of ingress or egress. + "exposedServices": [ # Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml. + "A String", + ], + "sourceIpRanges": [ # If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "A String", + ], + }, + "job": { # Describes a job # Job associated with the finding. + "errorCode": 42, # Optional. If the job did not complete successfully, this field describes why. + "location": "A String", # Optional. Gives the location where the job ran, such as `US` or `europe-west1` + "name": "A String", # The fully-qualified name for a job. e.g. `projects//jobs/` + "state": "A String", # Output only. State of the job, such as `RUNNING` or `PENDING`. + }, "kernelRootkit": { # Kernel mode rootkit signatures. # Signature of the kernel rootkit. "name": "A String", # Rootkit name, when available. "unexpectedCodeModification": True or False, # True if unexpected modifications of kernel code memory are present. @@ -3069,6 +3309,11 @@

Method Details

"muteInitiator": "A String", # Records additional information about the mute operation, for example, the [mute configuration](/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding. "muteUpdateTime": "A String", # Output only. The most recent time this finding was muted or unmuted. "name": "A String", # The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}", "projects/{project_id}/sources/{source_id}/findings/{finding_id}". + "networks": [ # Represents the VPC networks that the resource is attached to. + { # Contains information about a VPC network associated with the finding. + "name": "A String", # The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`. + }, + ], "nextSteps": "A String", # Steps to address the finding. "notebook": { # Represents a Jupyter notebook IPYNB file, such as a [Colab Enterprise notebook](https://cloud.google.com/colab/docs/introduction) file, that is associated with a finding. # Notebook associated with the finding. "lastAuthor": "A String", # The user ID of the latest author to modify the notebook. @@ -3515,6 +3760,50 @@

Method Details

"A String", ], }, + "ipRules": { # IP rules associated with the finding. # IP rules associated with the finding. + "allowed": { # Allowed IP rule. # Tuple with allowed rules. + "ipRules": [ # Optional. Optional list of allowed IP rules. + { # IP rule information. + "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. + { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. + "max": "A String", # Maximum port value. + "min": "A String", # Minimum port value. + }, + ], + "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + }, + ], + }, + "denied": { # Denied IP rule. # Tuple with denied rules. + "ipRules": [ # Optional. Optional list of denied IP rules. + { # IP rule information. + "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. + { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. + "max": "A String", # Maximum port value. + "min": "A String", # Minimum port value. + }, + ], + "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + }, + ], + }, + "destinationIpRanges": [ # If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "A String", + ], + "direction": "A String", # The direction that the rule is applicable to, one of ingress or egress. + "exposedServices": [ # Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml. + "A String", + ], + "sourceIpRanges": [ # If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "A String", + ], + }, + "job": { # Describes a job # Job associated with the finding. + "errorCode": 42, # Optional. If the job did not complete successfully, this field describes why. + "location": "A String", # Optional. Gives the location where the job ran, such as `US` or `europe-west1` + "name": "A String", # The fully-qualified name for a job. e.g. `projects//jobs/` + "state": "A String", # Output only. State of the job, such as `RUNNING` or `PENDING`. + }, "kernelRootkit": { # Kernel mode rootkit signatures. # Signature of the kernel rootkit. "name": "A String", # Rootkit name, when available. "unexpectedCodeModification": True or False, # True if unexpected modifications of kernel code memory are present. @@ -3672,6 +3961,11 @@

Method Details

"muteInitiator": "A String", # Records additional information about the mute operation, for example, the [mute configuration](/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding. "muteUpdateTime": "A String", # Output only. The most recent time this finding was muted or unmuted. "name": "A String", # The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}", "projects/{project_id}/sources/{source_id}/findings/{finding_id}". + "networks": [ # Represents the VPC networks that the resource is attached to. + { # Contains information about a VPC network associated with the finding. + "name": "A String", # The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`. + }, + ], "nextSteps": "A String", # Steps to address the finding. "notebook": { # Represents a Jupyter notebook IPYNB file, such as a [Colab Enterprise notebook](https://cloud.google.com/colab/docs/introduction) file, that is associated with a finding. # Notebook associated with the finding. "lastAuthor": "A String", # The user ID of the latest author to modify the notebook. @@ -4119,6 +4413,50 @@

Method Details

"A String", ], }, + "ipRules": { # IP rules associated with the finding. # IP rules associated with the finding. + "allowed": { # Allowed IP rule. # Tuple with allowed rules. + "ipRules": [ # Optional. Optional list of allowed IP rules. + { # IP rule information. + "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. + { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. + "max": "A String", # Maximum port value. + "min": "A String", # Minimum port value. + }, + ], + "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + }, + ], + }, + "denied": { # Denied IP rule. # Tuple with denied rules. + "ipRules": [ # Optional. Optional list of denied IP rules. + { # IP rule information. + "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. + { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. + "max": "A String", # Maximum port value. + "min": "A String", # Minimum port value. + }, + ], + "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + }, + ], + }, + "destinationIpRanges": [ # If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "A String", + ], + "direction": "A String", # The direction that the rule is applicable to, one of ingress or egress. + "exposedServices": [ # Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml. + "A String", + ], + "sourceIpRanges": [ # If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "A String", + ], + }, + "job": { # Describes a job # Job associated with the finding. + "errorCode": 42, # Optional. If the job did not complete successfully, this field describes why. + "location": "A String", # Optional. Gives the location where the job ran, such as `US` or `europe-west1` + "name": "A String", # The fully-qualified name for a job. e.g. `projects//jobs/` + "state": "A String", # Output only. State of the job, such as `RUNNING` or `PENDING`. + }, "kernelRootkit": { # Kernel mode rootkit signatures. # Signature of the kernel rootkit. "name": "A String", # Rootkit name, when available. "unexpectedCodeModification": True or False, # True if unexpected modifications of kernel code memory are present. @@ -4276,6 +4614,11 @@

Method Details

"muteInitiator": "A String", # Records additional information about the mute operation, for example, the [mute configuration](/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding. "muteUpdateTime": "A String", # Output only. The most recent time this finding was muted or unmuted. "name": "A String", # The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}", "projects/{project_id}/sources/{source_id}/findings/{finding_id}". + "networks": [ # Represents the VPC networks that the resource is attached to. + { # Contains information about a VPC network associated with the finding. + "name": "A String", # The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`. + }, + ], "nextSteps": "A String", # Steps to address the finding. "notebook": { # Represents a Jupyter notebook IPYNB file, such as a [Colab Enterprise notebook](https://cloud.google.com/colab/docs/introduction) file, that is associated with a finding. # Notebook associated with the finding. "lastAuthor": "A String", # The user ID of the latest author to modify the notebook. diff --git a/docs/dyn/securitycenter_v1.projects.securityHealthAnalyticsSettings.customModules.html b/docs/dyn/securitycenter_v1.projects.securityHealthAnalyticsSettings.customModules.html index 9640aeb9bf0..bf5cc414c72 100644 --- a/docs/dyn/securitycenter_v1.projects.securityHealthAnalyticsSettings.customModules.html +++ b/docs/dyn/securitycenter_v1.projects.securityHealthAnalyticsSettings.customModules.html @@ -893,6 +893,50 @@

Method Details

"A String", ], }, + "ipRules": { # IP rules associated with the finding. # IP rules associated with the finding. + "allowed": { # Allowed IP rule. # Tuple with allowed rules. + "ipRules": [ # Optional. Optional list of allowed IP rules. + { # IP rule information. + "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. + { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. + "max": "A String", # Maximum port value. + "min": "A String", # Minimum port value. + }, + ], + "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + }, + ], + }, + "denied": { # Denied IP rule. # Tuple with denied rules. + "ipRules": [ # Optional. Optional list of denied IP rules. + { # IP rule information. + "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. + { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. + "max": "A String", # Maximum port value. + "min": "A String", # Minimum port value. + }, + ], + "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + }, + ], + }, + "destinationIpRanges": [ # If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "A String", + ], + "direction": "A String", # The direction that the rule is applicable to, one of ingress or egress. + "exposedServices": [ # Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml. + "A String", + ], + "sourceIpRanges": [ # If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "A String", + ], + }, + "job": { # Describes a job # Job associated with the finding. + "errorCode": 42, # Optional. If the job did not complete successfully, this field describes why. + "location": "A String", # Optional. Gives the location where the job ran, such as `US` or `europe-west1` + "name": "A String", # The fully-qualified name for a job. e.g. `projects//jobs/` + "state": "A String", # Output only. State of the job, such as `RUNNING` or `PENDING`. + }, "kernelRootkit": { # Kernel mode rootkit signatures. # Signature of the kernel rootkit. "name": "A String", # Rootkit name, when available. "unexpectedCodeModification": True or False, # True if unexpected modifications of kernel code memory are present. @@ -1050,6 +1094,11 @@

Method Details

"muteInitiator": "A String", # Records additional information about the mute operation, for example, the [mute configuration](/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding. "muteUpdateTime": "A String", # Output only. The most recent time this finding was muted or unmuted. "name": "A String", # The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}", "projects/{project_id}/sources/{source_id}/findings/{finding_id}". + "networks": [ # Represents the VPC networks that the resource is attached to. + { # Contains information about a VPC network associated with the finding. + "name": "A String", # The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`. + }, + ], "nextSteps": "A String", # Steps to address the finding. "notebook": { # Represents a Jupyter notebook IPYNB file, such as a [Colab Enterprise notebook](https://cloud.google.com/colab/docs/introduction) file, that is associated with a finding. # Notebook associated with the finding. "lastAuthor": "A String", # The user ID of the latest author to modify the notebook. diff --git a/docs/dyn/securitycenter_v1.projects.sources.findings.html b/docs/dyn/securitycenter_v1.projects.sources.findings.html index 78375dc32ab..5cc115b2b9e 100644 --- a/docs/dyn/securitycenter_v1.projects.sources.findings.html +++ b/docs/dyn/securitycenter_v1.projects.sources.findings.html @@ -462,6 +462,50 @@

Method Details

"A String", ], }, + "ipRules": { # IP rules associated with the finding. # IP rules associated with the finding. + "allowed": { # Allowed IP rule. # Tuple with allowed rules. + "ipRules": [ # Optional. Optional list of allowed IP rules. + { # IP rule information. + "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. + { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. + "max": "A String", # Maximum port value. + "min": "A String", # Minimum port value. + }, + ], + "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + }, + ], + }, + "denied": { # Denied IP rule. # Tuple with denied rules. + "ipRules": [ # Optional. Optional list of denied IP rules. + { # IP rule information. + "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. + { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. + "max": "A String", # Maximum port value. + "min": "A String", # Minimum port value. + }, + ], + "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + }, + ], + }, + "destinationIpRanges": [ # If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "A String", + ], + "direction": "A String", # The direction that the rule is applicable to, one of ingress or egress. + "exposedServices": [ # Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml. + "A String", + ], + "sourceIpRanges": [ # If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "A String", + ], + }, + "job": { # Describes a job # Job associated with the finding. + "errorCode": 42, # Optional. If the job did not complete successfully, this field describes why. + "location": "A String", # Optional. Gives the location where the job ran, such as `US` or `europe-west1` + "name": "A String", # The fully-qualified name for a job. e.g. `projects//jobs/` + "state": "A String", # Output only. State of the job, such as `RUNNING` or `PENDING`. + }, "kernelRootkit": { # Kernel mode rootkit signatures. # Signature of the kernel rootkit. "name": "A String", # Rootkit name, when available. "unexpectedCodeModification": True or False, # True if unexpected modifications of kernel code memory are present. @@ -619,6 +663,11 @@

Method Details

"muteInitiator": "A String", # Records additional information about the mute operation, for example, the [mute configuration](/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding. "muteUpdateTime": "A String", # Output only. The most recent time this finding was muted or unmuted. "name": "A String", # The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}", "projects/{project_id}/sources/{source_id}/findings/{finding_id}". + "networks": [ # Represents the VPC networks that the resource is attached to. + { # Contains information about a VPC network associated with the finding. + "name": "A String", # The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`. + }, + ], "nextSteps": "A String", # Steps to address the finding. "notebook": { # Represents a Jupyter notebook IPYNB file, such as a [Colab Enterprise notebook](https://cloud.google.com/colab/docs/introduction) file, that is associated with a finding. # Notebook associated with the finding. "lastAuthor": "A String", # The user ID of the latest author to modify the notebook. @@ -1138,6 +1187,50 @@

Method Details

"A String", ], }, + "ipRules": { # IP rules associated with the finding. # IP rules associated with the finding. + "allowed": { # Allowed IP rule. # Tuple with allowed rules. + "ipRules": [ # Optional. Optional list of allowed IP rules. + { # IP rule information. + "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. + { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. + "max": "A String", # Maximum port value. + "min": "A String", # Minimum port value. + }, + ], + "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + }, + ], + }, + "denied": { # Denied IP rule. # Tuple with denied rules. + "ipRules": [ # Optional. Optional list of denied IP rules. + { # IP rule information. + "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. + { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. + "max": "A String", # Maximum port value. + "min": "A String", # Minimum port value. + }, + ], + "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + }, + ], + }, + "destinationIpRanges": [ # If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "A String", + ], + "direction": "A String", # The direction that the rule is applicable to, one of ingress or egress. + "exposedServices": [ # Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml. + "A String", + ], + "sourceIpRanges": [ # If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "A String", + ], + }, + "job": { # Describes a job # Job associated with the finding. + "errorCode": 42, # Optional. If the job did not complete successfully, this field describes why. + "location": "A String", # Optional. Gives the location where the job ran, such as `US` or `europe-west1` + "name": "A String", # The fully-qualified name for a job. e.g. `projects//jobs/` + "state": "A String", # Output only. State of the job, such as `RUNNING` or `PENDING`. + }, "kernelRootkit": { # Kernel mode rootkit signatures. # Signature of the kernel rootkit. "name": "A String", # Rootkit name, when available. "unexpectedCodeModification": True or False, # True if unexpected modifications of kernel code memory are present. @@ -1295,6 +1388,11 @@

Method Details

"muteInitiator": "A String", # Records additional information about the mute operation, for example, the [mute configuration](/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding. "muteUpdateTime": "A String", # Output only. The most recent time this finding was muted or unmuted. "name": "A String", # The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}", "projects/{project_id}/sources/{source_id}/findings/{finding_id}". + "networks": [ # Represents the VPC networks that the resource is attached to. + { # Contains information about a VPC network associated with the finding. + "name": "A String", # The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`. + }, + ], "nextSteps": "A String", # Steps to address the finding. "notebook": { # Represents a Jupyter notebook IPYNB file, such as a [Colab Enterprise notebook](https://cloud.google.com/colab/docs/introduction) file, that is associated with a finding. # Notebook associated with the finding. "lastAuthor": "A String", # The user ID of the latest author to modify the notebook. @@ -1728,6 +1826,50 @@

Method Details

"A String", ], }, + "ipRules": { # IP rules associated with the finding. # IP rules associated with the finding. + "allowed": { # Allowed IP rule. # Tuple with allowed rules. + "ipRules": [ # Optional. Optional list of allowed IP rules. + { # IP rule information. + "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. + { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. + "max": "A String", # Maximum port value. + "min": "A String", # Minimum port value. + }, + ], + "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + }, + ], + }, + "denied": { # Denied IP rule. # Tuple with denied rules. + "ipRules": [ # Optional. Optional list of denied IP rules. + { # IP rule information. + "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. + { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. + "max": "A String", # Maximum port value. + "min": "A String", # Minimum port value. + }, + ], + "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + }, + ], + }, + "destinationIpRanges": [ # If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "A String", + ], + "direction": "A String", # The direction that the rule is applicable to, one of ingress or egress. + "exposedServices": [ # Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml. + "A String", + ], + "sourceIpRanges": [ # If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "A String", + ], + }, + "job": { # Describes a job # Job associated with the finding. + "errorCode": 42, # Optional. If the job did not complete successfully, this field describes why. + "location": "A String", # Optional. Gives the location where the job ran, such as `US` or `europe-west1` + "name": "A String", # The fully-qualified name for a job. e.g. `projects//jobs/` + "state": "A String", # Output only. State of the job, such as `RUNNING` or `PENDING`. + }, "kernelRootkit": { # Kernel mode rootkit signatures. # Signature of the kernel rootkit. "name": "A String", # Rootkit name, when available. "unexpectedCodeModification": True or False, # True if unexpected modifications of kernel code memory are present. @@ -1885,6 +2027,11 @@

Method Details

"muteInitiator": "A String", # Records additional information about the mute operation, for example, the [mute configuration](/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding. "muteUpdateTime": "A String", # Output only. The most recent time this finding was muted or unmuted. "name": "A String", # The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}", "projects/{project_id}/sources/{source_id}/findings/{finding_id}". + "networks": [ # Represents the VPC networks that the resource is attached to. + { # Contains information about a VPC network associated with the finding. + "name": "A String", # The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`. + }, + ], "nextSteps": "A String", # Steps to address the finding. "notebook": { # Represents a Jupyter notebook IPYNB file, such as a [Colab Enterprise notebook](https://cloud.google.com/colab/docs/introduction) file, that is associated with a finding. # Notebook associated with the finding. "lastAuthor": "A String", # The user ID of the latest author to modify the notebook. @@ -2331,6 +2478,50 @@

Method Details

"A String", ], }, + "ipRules": { # IP rules associated with the finding. # IP rules associated with the finding. + "allowed": { # Allowed IP rule. # Tuple with allowed rules. + "ipRules": [ # Optional. Optional list of allowed IP rules. + { # IP rule information. + "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. + { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. + "max": "A String", # Maximum port value. + "min": "A String", # Minimum port value. + }, + ], + "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + }, + ], + }, + "denied": { # Denied IP rule. # Tuple with denied rules. + "ipRules": [ # Optional. Optional list of denied IP rules. + { # IP rule information. + "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. + { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. + "max": "A String", # Maximum port value. + "min": "A String", # Minimum port value. + }, + ], + "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + }, + ], + }, + "destinationIpRanges": [ # If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "A String", + ], + "direction": "A String", # The direction that the rule is applicable to, one of ingress or egress. + "exposedServices": [ # Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml. + "A String", + ], + "sourceIpRanges": [ # If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "A String", + ], + }, + "job": { # Describes a job # Job associated with the finding. + "errorCode": 42, # Optional. If the job did not complete successfully, this field describes why. + "location": "A String", # Optional. Gives the location where the job ran, such as `US` or `europe-west1` + "name": "A String", # The fully-qualified name for a job. e.g. `projects//jobs/` + "state": "A String", # Output only. State of the job, such as `RUNNING` or `PENDING`. + }, "kernelRootkit": { # Kernel mode rootkit signatures. # Signature of the kernel rootkit. "name": "A String", # Rootkit name, when available. "unexpectedCodeModification": True or False, # True if unexpected modifications of kernel code memory are present. @@ -2488,6 +2679,11 @@

Method Details

"muteInitiator": "A String", # Records additional information about the mute operation, for example, the [mute configuration](/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding. "muteUpdateTime": "A String", # Output only. The most recent time this finding was muted or unmuted. "name": "A String", # The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}", "projects/{project_id}/sources/{source_id}/findings/{finding_id}". + "networks": [ # Represents the VPC networks that the resource is attached to. + { # Contains information about a VPC network associated with the finding. + "name": "A String", # The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`. + }, + ], "nextSteps": "A String", # Steps to address the finding. "notebook": { # Represents a Jupyter notebook IPYNB file, such as a [Colab Enterprise notebook](https://cloud.google.com/colab/docs/introduction) file, that is associated with a finding. # Notebook associated with the finding. "lastAuthor": "A String", # The user ID of the latest author to modify the notebook. @@ -2935,6 +3131,50 @@

Method Details

"A String", ], }, + "ipRules": { # IP rules associated with the finding. # IP rules associated with the finding. + "allowed": { # Allowed IP rule. # Tuple with allowed rules. + "ipRules": [ # Optional. Optional list of allowed IP rules. + { # IP rule information. + "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. + { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. + "max": "A String", # Maximum port value. + "min": "A String", # Minimum port value. + }, + ], + "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + }, + ], + }, + "denied": { # Denied IP rule. # Tuple with denied rules. + "ipRules": [ # Optional. Optional list of denied IP rules. + { # IP rule information. + "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. + { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. + "max": "A String", # Maximum port value. + "min": "A String", # Minimum port value. + }, + ], + "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + }, + ], + }, + "destinationIpRanges": [ # If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "A String", + ], + "direction": "A String", # The direction that the rule is applicable to, one of ingress or egress. + "exposedServices": [ # Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml. + "A String", + ], + "sourceIpRanges": [ # If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "A String", + ], + }, + "job": { # Describes a job # Job associated with the finding. + "errorCode": 42, # Optional. If the job did not complete successfully, this field describes why. + "location": "A String", # Optional. Gives the location where the job ran, such as `US` or `europe-west1` + "name": "A String", # The fully-qualified name for a job. e.g. `projects//jobs/` + "state": "A String", # Output only. State of the job, such as `RUNNING` or `PENDING`. + }, "kernelRootkit": { # Kernel mode rootkit signatures. # Signature of the kernel rootkit. "name": "A String", # Rootkit name, when available. "unexpectedCodeModification": True or False, # True if unexpected modifications of kernel code memory are present. @@ -3092,6 +3332,11 @@

Method Details

"muteInitiator": "A String", # Records additional information about the mute operation, for example, the [mute configuration](/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding. "muteUpdateTime": "A String", # Output only. The most recent time this finding was muted or unmuted. "name": "A String", # The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}", "projects/{project_id}/sources/{source_id}/findings/{finding_id}". + "networks": [ # Represents the VPC networks that the resource is attached to. + { # Contains information about a VPC network associated with the finding. + "name": "A String", # The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`. + }, + ], "nextSteps": "A String", # Steps to address the finding. "notebook": { # Represents a Jupyter notebook IPYNB file, such as a [Colab Enterprise notebook](https://cloud.google.com/colab/docs/introduction) file, that is associated with a finding. # Notebook associated with the finding. "lastAuthor": "A String", # The user ID of the latest author to modify the notebook. diff --git a/googleapiclient/discovery_cache/documents/securitycenter.v1.json b/googleapiclient/discovery_cache/documents/securitycenter.v1.json index c207b8a086e..ff92294fbf7 100644 --- a/googleapiclient/discovery_cache/documents/securitycenter.v1.json +++ b/googleapiclient/discovery_cache/documents/securitycenter.v1.json @@ -5938,7 +5938,7 @@ } } }, -"revision": "20250207", +"revision": "20250218", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -6042,6 +6042,20 @@ }, "type": "object" }, +"Allowed": { +"description": "Allowed IP rule.", +"id": "Allowed", +"properties": { +"ipRules": { +"description": "Optional. Optional list of allowed IP rules.", +"items": { +"$ref": "IpRule" +}, +"type": "array" +} +}, +"type": "object" +}, "Application": { "description": "Represents an application associated with a finding.", "id": "Application", @@ -7369,6 +7383,20 @@ }, "type": "object" }, +"Denied": { +"description": "Denied IP rule.", +"id": "Denied", +"properties": { +"ipRules": { +"description": "Optional. Optional list of denied IP rules.", +"items": { +"$ref": "IpRule" +}, +"type": "array" +} +}, +"type": "object" +}, "Detection": { "description": "Memory hash detection contributing to the binary family match.", "id": "Detection", @@ -7877,6 +7905,14 @@ "$ref": "Indicator", "description": "Represents what's commonly known as an *indicator of compromise* (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise)." }, +"ipRules": { +"$ref": "IpRules", +"description": "IP rules associated with the finding." +}, +"job": { +"$ref": "Job", +"description": "Job associated with the finding." +}, "kernelRootkit": { "$ref": "KernelRootkit", "description": "Signature of the kernel rootkit." @@ -7942,6 +7978,13 @@ "description": "The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\", \"folders/{folder_id}/sources/{source_id}/findings/{finding_id}\", \"projects/{project_id}/sources/{source_id}/findings/{finding_id}\".", "type": "string" }, +"networks": { +"description": "Represents the VPC networks that the resource is attached to.", +"items": { +"$ref": "Network" +}, +"type": "array" +}, "nextSteps": { "description": "Steps to address the finding.", "type": "string" @@ -9120,6 +9163,20 @@ }, "type": "object" }, +"GoogleCloudSecuritycenterV2Allowed": { +"description": "Allowed IP rule.", +"id": "GoogleCloudSecuritycenterV2Allowed", +"properties": { +"ipRules": { +"description": "Optional. Optional list of allowed IP rules.", +"items": { +"$ref": "GoogleCloudSecuritycenterV2IpRule" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudSecuritycenterV2Application": { "description": "Represents an application associated with a finding.", "id": "GoogleCloudSecuritycenterV2Application", @@ -10092,6 +10149,20 @@ }, "type": "object" }, +"GoogleCloudSecuritycenterV2Denied": { +"description": "Denied IP rule.", +"id": "GoogleCloudSecuritycenterV2Denied", +"properties": { +"ipRules": { +"description": "Optional. Optional list of denied IP rules.", +"items": { +"$ref": "GoogleCloudSecuritycenterV2IpRule" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudSecuritycenterV2Detection": { "description": "Memory hash detection contributing to the binary family match.", "id": "GoogleCloudSecuritycenterV2Detection", @@ -10485,6 +10556,14 @@ "$ref": "GoogleCloudSecuritycenterV2Indicator", "description": "Represents what's commonly known as an *indicator of compromise* (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise)." }, +"ipRules": { +"$ref": "GoogleCloudSecuritycenterV2IpRules", +"description": "IP rules associated with the finding." +}, +"job": { +"$ref": "GoogleCloudSecuritycenterV2Job", +"description": "Job associated with the finding." +}, "kernelRootkit": { "$ref": "GoogleCloudSecuritycenterV2KernelRootkit", "description": "Signature of the kernel rootkit." @@ -10550,6 +10629,13 @@ "description": "The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. The following list shows some examples: + `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}` + `organizations/{organization_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}` + `folders/{folder_id}/sources/{source_id}/findings/{finding_id}` + `folders/{folder_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}` + `projects/{project_id}/sources/{source_id}/findings/{finding_id}` + `projects/{project_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}`", "type": "string" }, +"networks": { +"description": "Represents the VPC networks that the resource is attached to.", +"items": { +"$ref": "GoogleCloudSecuritycenterV2Network" +}, +"type": "array" +}, "nextSteps": { "description": "Steps to address the finding.", "type": "string" @@ -10758,6 +10844,74 @@ }, "type": "object" }, +"GoogleCloudSecuritycenterV2IpRule": { +"description": "IP rule information.", +"id": "GoogleCloudSecuritycenterV2IpRule", +"properties": { +"portRanges": { +"description": "Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number.", +"items": { +"$ref": "GoogleCloudSecuritycenterV2PortRange" +}, +"type": "array" +}, +"protocol": { +"description": "The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudSecuritycenterV2IpRules": { +"description": "IP rules associated with the finding.", +"id": "GoogleCloudSecuritycenterV2IpRules", +"properties": { +"allowed": { +"$ref": "GoogleCloudSecuritycenterV2Allowed", +"description": "Tuple with allowed rules." +}, +"denied": { +"$ref": "GoogleCloudSecuritycenterV2Denied", +"description": "Tuple with denied rules." +}, +"destinationIpRanges": { +"description": "If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4.", +"items": { +"type": "string" +}, +"type": "array" +}, +"direction": { +"description": "The direction that the rule is applicable to, one of ingress or egress.", +"enum": [ +"DIRECTION_UNSPECIFIED", +"INGRESS", +"EGRESS" +], +"enumDescriptions": [ +"Unspecified direction value.", +"Ingress direction value.", +"Egress direction value." +], +"type": "string" +}, +"exposedServices": { +"description": "Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml.", +"items": { +"type": "string" +}, +"type": "array" +}, +"sourceIpRanges": { +"description": "If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudSecuritycenterV2Issue": { "description": "Security Command Center Issue.", "id": "GoogleCloudSecuritycenterV2Issue", @@ -11155,6 +11309,45 @@ }, "type": "object" }, +"GoogleCloudSecuritycenterV2Job": { +"description": "Describes a job", +"id": "GoogleCloudSecuritycenterV2Job", +"properties": { +"errorCode": { +"description": "Optional. If the job did not complete successfully, this field describes why.", +"format": "int32", +"type": "integer" +}, +"location": { +"description": "Optional. Gives the location where the job ran, such as `US` or `europe-west1`", +"type": "string" +}, +"name": { +"description": "The fully-qualified name for a job. e.g. `projects//jobs/`", +"type": "string" +}, +"state": { +"description": "Output only. State of the job, such as `RUNNING` or `PENDING`.", +"enum": [ +"JOB_STATE_UNSPECIFIED", +"PENDING", +"RUNNING", +"SUCCEEDED", +"FAILED" +], +"enumDescriptions": [ +"Unspecified represents an unknown state and should not be used.", +"Job is scheduled and pending for run", +"Job in progress", +"Job has completed with success", +"Job has completed but with failure" +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudSecuritycenterV2KernelRootkit": { "description": "Kernel mode rootkit signatures.", "id": "GoogleCloudSecuritycenterV2KernelRootkit", @@ -11762,6 +11955,17 @@ }, "type": "object" }, +"GoogleCloudSecuritycenterV2Network": { +"description": "Contains information about a VPC network associated with the finding.", +"id": "GoogleCloudSecuritycenterV2Network", +"properties": { +"name": { +"description": "The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudSecuritycenterV2Node": { "description": "Kubernetes nodes associated with the finding.", "id": "GoogleCloudSecuritycenterV2Node", @@ -11946,6 +12150,23 @@ }, "type": "object" }, +"GoogleCloudSecuritycenterV2PortRange": { +"description": "A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port.", +"id": "GoogleCloudSecuritycenterV2PortRange", +"properties": { +"max": { +"description": "Maximum port value.", +"format": "int64", +"type": "string" +}, +"min": { +"description": "Minimum port value.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudSecuritycenterV2Process": { "description": "Represents an operating system process.", "id": "GoogleCloudSecuritycenterV2Process", @@ -12859,6 +13080,113 @@ }, "type": "object" }, +"IpRule": { +"description": "IP rule information.", +"id": "IpRule", +"properties": { +"portRanges": { +"description": "Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number.", +"items": { +"$ref": "PortRange" +}, +"type": "array" +}, +"protocol": { +"description": "The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value.", +"type": "string" +} +}, +"type": "object" +}, +"IpRules": { +"description": "IP rules associated with the finding.", +"id": "IpRules", +"properties": { +"allowed": { +"$ref": "Allowed", +"description": "Tuple with allowed rules." +}, +"denied": { +"$ref": "Denied", +"description": "Tuple with denied rules." +}, +"destinationIpRanges": { +"description": "If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4.", +"items": { +"type": "string" +}, +"type": "array" +}, +"direction": { +"description": "The direction that the rule is applicable to, one of ingress or egress.", +"enum": [ +"DIRECTION_UNSPECIFIED", +"INGRESS", +"EGRESS" +], +"enumDescriptions": [ +"Unspecified direction value.", +"Ingress direction value.", +"Egress direction value." +], +"type": "string" +}, +"exposedServices": { +"description": "Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml.", +"items": { +"type": "string" +}, +"type": "array" +}, +"sourceIpRanges": { +"description": "If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"Job": { +"description": "Describes a job", +"id": "Job", +"properties": { +"errorCode": { +"description": "Optional. If the job did not complete successfully, this field describes why.", +"format": "int32", +"type": "integer" +}, +"location": { +"description": "Optional. Gives the location where the job ran, such as `US` or `europe-west1`", +"type": "string" +}, +"name": { +"description": "The fully-qualified name for a job. e.g. `projects//jobs/`", +"type": "string" +}, +"state": { +"description": "Output only. State of the job, such as `RUNNING` or `PENDING`.", +"enum": [ +"JOB_STATE_UNSPECIFIED", +"PENDING", +"RUNNING", +"SUCCEEDED", +"FAILED" +], +"enumDescriptions": [ +"Unspecified represents an unknown state and should not be used.", +"Job is scheduled and pending for run", +"Job in progress", +"Job has completed with success", +"Job has completed but with failure" +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "KernelRootkit": { "description": "Kernel mode rootkit signatures.", "id": "KernelRootkit", @@ -13785,6 +14113,17 @@ }, "type": "object" }, +"Network": { +"description": "Contains information about a VPC network associated with the finding.", +"id": "Network", +"properties": { +"name": { +"description": "The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`.", +"type": "string" +} +}, +"type": "object" +}, "Node": { "description": "Kubernetes nodes associated with the finding.", "id": "Node", @@ -14082,6 +14421,23 @@ }, "type": "object" }, +"PortRange": { +"description": "A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port.", +"id": "PortRange", +"properties": { +"max": { +"description": "Maximum port value.", +"format": "int64", +"type": "string" +}, +"min": { +"description": "Minimum port value.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, "Position": { "description": "A position in the uploaded text version of a module.", "id": "Position", diff --git a/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json b/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json index b96a7683bb7..2a147ef235c 100644 --- a/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json @@ -913,7 +913,7 @@ } } }, -"revision": "20250207", +"revision": "20250218", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -1017,6 +1017,20 @@ }, "type": "object" }, +"Allowed": { +"description": "Allowed IP rule.", +"id": "Allowed", +"properties": { +"ipRules": { +"description": "Optional. Optional list of allowed IP rules.", +"items": { +"$ref": "IpRule" +}, +"type": "array" +} +}, +"type": "object" +}, "Application": { "description": "Represents an application associated with a finding.", "id": "Application", @@ -2105,6 +2119,20 @@ }, "type": "object" }, +"Denied": { +"description": "Denied IP rule.", +"id": "Denied", +"properties": { +"ipRules": { +"description": "Optional. Optional list of denied IP rules.", +"items": { +"$ref": "IpRule" +}, +"type": "array" +} +}, +"type": "object" +}, "Detection": { "description": "Memory hash detection contributing to the binary family match.", "id": "Detection", @@ -2467,6 +2495,14 @@ "$ref": "Indicator", "description": "Represents what's commonly known as an *indicator of compromise* (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise)." }, +"ipRules": { +"$ref": "IpRules", +"description": "IP rules associated with the finding." +}, +"job": { +"$ref": "Job", +"description": "Job associated with the finding." +}, "kernelRootkit": { "$ref": "KernelRootkit", "description": "Signature of the kernel rootkit." @@ -2532,6 +2568,13 @@ "description": "The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\", \"folders/{folder_id}/sources/{source_id}/findings/{finding_id}\", \"projects/{project_id}/sources/{source_id}/findings/{finding_id}\".", "type": "string" }, +"networks": { +"description": "Represents the VPC networks that the resource is attached to.", +"items": { +"$ref": "Network" +}, +"type": "array" +}, "nextSteps": { "description": "Steps to address the finding.", "type": "string" @@ -3791,6 +3834,20 @@ }, "type": "object" }, +"GoogleCloudSecuritycenterV2Allowed": { +"description": "Allowed IP rule.", +"id": "GoogleCloudSecuritycenterV2Allowed", +"properties": { +"ipRules": { +"description": "Optional. Optional list of allowed IP rules.", +"items": { +"$ref": "GoogleCloudSecuritycenterV2IpRule" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudSecuritycenterV2Application": { "description": "Represents an application associated with a finding.", "id": "GoogleCloudSecuritycenterV2Application", @@ -4763,6 +4820,20 @@ }, "type": "object" }, +"GoogleCloudSecuritycenterV2Denied": { +"description": "Denied IP rule.", +"id": "GoogleCloudSecuritycenterV2Denied", +"properties": { +"ipRules": { +"description": "Optional. Optional list of denied IP rules.", +"items": { +"$ref": "GoogleCloudSecuritycenterV2IpRule" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudSecuritycenterV2Detection": { "description": "Memory hash detection contributing to the binary family match.", "id": "GoogleCloudSecuritycenterV2Detection", @@ -5156,6 +5227,14 @@ "$ref": "GoogleCloudSecuritycenterV2Indicator", "description": "Represents what's commonly known as an *indicator of compromise* (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise)." }, +"ipRules": { +"$ref": "GoogleCloudSecuritycenterV2IpRules", +"description": "IP rules associated with the finding." +}, +"job": { +"$ref": "GoogleCloudSecuritycenterV2Job", +"description": "Job associated with the finding." +}, "kernelRootkit": { "$ref": "GoogleCloudSecuritycenterV2KernelRootkit", "description": "Signature of the kernel rootkit." @@ -5221,6 +5300,13 @@ "description": "The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. The following list shows some examples: + `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}` + `organizations/{organization_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}` + `folders/{folder_id}/sources/{source_id}/findings/{finding_id}` + `folders/{folder_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}` + `projects/{project_id}/sources/{source_id}/findings/{finding_id}` + `projects/{project_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}`", "type": "string" }, +"networks": { +"description": "Represents the VPC networks that the resource is attached to.", +"items": { +"$ref": "GoogleCloudSecuritycenterV2Network" +}, +"type": "array" +}, "nextSteps": { "description": "Steps to address the finding.", "type": "string" @@ -5429,6 +5515,74 @@ }, "type": "object" }, +"GoogleCloudSecuritycenterV2IpRule": { +"description": "IP rule information.", +"id": "GoogleCloudSecuritycenterV2IpRule", +"properties": { +"portRanges": { +"description": "Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number.", +"items": { +"$ref": "GoogleCloudSecuritycenterV2PortRange" +}, +"type": "array" +}, +"protocol": { +"description": "The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudSecuritycenterV2IpRules": { +"description": "IP rules associated with the finding.", +"id": "GoogleCloudSecuritycenterV2IpRules", +"properties": { +"allowed": { +"$ref": "GoogleCloudSecuritycenterV2Allowed", +"description": "Tuple with allowed rules." +}, +"denied": { +"$ref": "GoogleCloudSecuritycenterV2Denied", +"description": "Tuple with denied rules." +}, +"destinationIpRanges": { +"description": "If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4.", +"items": { +"type": "string" +}, +"type": "array" +}, +"direction": { +"description": "The direction that the rule is applicable to, one of ingress or egress.", +"enum": [ +"DIRECTION_UNSPECIFIED", +"INGRESS", +"EGRESS" +], +"enumDescriptions": [ +"Unspecified direction value.", +"Ingress direction value.", +"Egress direction value." +], +"type": "string" +}, +"exposedServices": { +"description": "Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml.", +"items": { +"type": "string" +}, +"type": "array" +}, +"sourceIpRanges": { +"description": "If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudSecuritycenterV2Issue": { "description": "Security Command Center Issue.", "id": "GoogleCloudSecuritycenterV2Issue", @@ -5826,6 +5980,45 @@ }, "type": "object" }, +"GoogleCloudSecuritycenterV2Job": { +"description": "Describes a job", +"id": "GoogleCloudSecuritycenterV2Job", +"properties": { +"errorCode": { +"description": "Optional. If the job did not complete successfully, this field describes why.", +"format": "int32", +"type": "integer" +}, +"location": { +"description": "Optional. Gives the location where the job ran, such as `US` or `europe-west1`", +"type": "string" +}, +"name": { +"description": "The fully-qualified name for a job. e.g. `projects//jobs/`", +"type": "string" +}, +"state": { +"description": "Output only. State of the job, such as `RUNNING` or `PENDING`.", +"enum": [ +"JOB_STATE_UNSPECIFIED", +"PENDING", +"RUNNING", +"SUCCEEDED", +"FAILED" +], +"enumDescriptions": [ +"Unspecified represents an unknown state and should not be used.", +"Job is scheduled and pending for run", +"Job in progress", +"Job has completed with success", +"Job has completed but with failure" +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudSecuritycenterV2KernelRootkit": { "description": "Kernel mode rootkit signatures.", "id": "GoogleCloudSecuritycenterV2KernelRootkit", @@ -6433,6 +6626,17 @@ }, "type": "object" }, +"GoogleCloudSecuritycenterV2Network": { +"description": "Contains information about a VPC network associated with the finding.", +"id": "GoogleCloudSecuritycenterV2Network", +"properties": { +"name": { +"description": "The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudSecuritycenterV2Node": { "description": "Kubernetes nodes associated with the finding.", "id": "GoogleCloudSecuritycenterV2Node", @@ -6617,6 +6821,23 @@ }, "type": "object" }, +"GoogleCloudSecuritycenterV2PortRange": { +"description": "A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port.", +"id": "GoogleCloudSecuritycenterV2PortRange", +"properties": { +"max": { +"description": "Maximum port value.", +"format": "int64", +"type": "string" +}, +"min": { +"description": "Minimum port value.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudSecuritycenterV2Process": { "description": "Represents an operating system process.", "id": "GoogleCloudSecuritycenterV2Process", @@ -7502,6 +7723,113 @@ }, "type": "object" }, +"IpRule": { +"description": "IP rule information.", +"id": "IpRule", +"properties": { +"portRanges": { +"description": "Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number.", +"items": { +"$ref": "PortRange" +}, +"type": "array" +}, +"protocol": { +"description": "The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value.", +"type": "string" +} +}, +"type": "object" +}, +"IpRules": { +"description": "IP rules associated with the finding.", +"id": "IpRules", +"properties": { +"allowed": { +"$ref": "Allowed", +"description": "Tuple with allowed rules." +}, +"denied": { +"$ref": "Denied", +"description": "Tuple with denied rules." +}, +"destinationIpRanges": { +"description": "If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4.", +"items": { +"type": "string" +}, +"type": "array" +}, +"direction": { +"description": "The direction that the rule is applicable to, one of ingress or egress.", +"enum": [ +"DIRECTION_UNSPECIFIED", +"INGRESS", +"EGRESS" +], +"enumDescriptions": [ +"Unspecified direction value.", +"Ingress direction value.", +"Egress direction value." +], +"type": "string" +}, +"exposedServices": { +"description": "Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml.", +"items": { +"type": "string" +}, +"type": "array" +}, +"sourceIpRanges": { +"description": "If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"Job": { +"description": "Describes a job", +"id": "Job", +"properties": { +"errorCode": { +"description": "Optional. If the job did not complete successfully, this field describes why.", +"format": "int32", +"type": "integer" +}, +"location": { +"description": "Optional. Gives the location where the job ran, such as `US` or `europe-west1`", +"type": "string" +}, +"name": { +"description": "The fully-qualified name for a job. e.g. `projects//jobs/`", +"type": "string" +}, +"state": { +"description": "Output only. State of the job, such as `RUNNING` or `PENDING`.", +"enum": [ +"JOB_STATE_UNSPECIFIED", +"PENDING", +"RUNNING", +"SUCCEEDED", +"FAILED" +], +"enumDescriptions": [ +"Unspecified represents an unknown state and should not be used.", +"Job is scheduled and pending for run", +"Job in progress", +"Job has completed with success", +"Job has completed but with failure" +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "KernelRootkit": { "description": "Kernel mode rootkit signatures.", "id": "KernelRootkit", @@ -8175,6 +8503,17 @@ }, "type": "object" }, +"Network": { +"description": "Contains information about a VPC network associated with the finding.", +"id": "Network", +"properties": { +"name": { +"description": "The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`.", +"type": "string" +} +}, +"type": "object" +}, "Node": { "description": "Kubernetes nodes associated with the finding.", "id": "Node", @@ -8425,6 +8764,23 @@ }, "type": "object" }, +"PortRange": { +"description": "A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port.", +"id": "PortRange", +"properties": { +"max": { +"description": "Maximum port value.", +"format": "int64", +"type": "string" +}, +"min": { +"description": "Minimum port value.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, "Process": { "description": "Represents an operating system process.", "id": "Process", diff --git a/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json b/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json index eb11c0b343a..aa693d09145 100644 --- a/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json @@ -2003,7 +2003,7 @@ } } }, -"revision": "20250207", +"revision": "20250218", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -2107,6 +2107,20 @@ }, "type": "object" }, +"Allowed": { +"description": "Allowed IP rule.", +"id": "Allowed", +"properties": { +"ipRules": { +"description": "Optional. Optional list of allowed IP rules.", +"items": { +"$ref": "IpRule" +}, +"type": "array" +} +}, +"type": "object" +}, "Application": { "description": "Represents an application associated with a finding.", "id": "Application", @@ -3131,6 +3145,20 @@ }, "type": "object" }, +"Denied": { +"description": "Denied IP rule.", +"id": "Denied", +"properties": { +"ipRules": { +"description": "Optional. Optional list of denied IP rules.", +"items": { +"$ref": "IpRule" +}, +"type": "array" +} +}, +"type": "object" +}, "Details": { "description": "Details of a subscription.", "id": "Details", @@ -3564,6 +3592,14 @@ "$ref": "Indicator", "description": "Represents what's commonly known as an *indicator of compromise* (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise)." }, +"ipRules": { +"$ref": "IpRules", +"description": "IP rules associated with the finding." +}, +"job": { +"$ref": "Job", +"description": "Job associated with the finding." +}, "kernelRootkit": { "$ref": "KernelRootkit", "description": "Signature of the kernel rootkit." @@ -3629,6 +3665,13 @@ "description": "The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\", \"folders/{folder_id}/sources/{source_id}/findings/{finding_id}\", \"projects/{project_id}/sources/{source_id}/findings/{finding_id}\".", "type": "string" }, +"networks": { +"description": "Represents the VPC networks that the resource is attached to.", +"items": { +"$ref": "Network" +}, +"type": "array" +}, "nextSteps": { "description": "Steps to address the finding.", "type": "string" @@ -4784,6 +4827,20 @@ }, "type": "object" }, +"GoogleCloudSecuritycenterV2Allowed": { +"description": "Allowed IP rule.", +"id": "GoogleCloudSecuritycenterV2Allowed", +"properties": { +"ipRules": { +"description": "Optional. Optional list of allowed IP rules.", +"items": { +"$ref": "GoogleCloudSecuritycenterV2IpRule" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudSecuritycenterV2Application": { "description": "Represents an application associated with a finding.", "id": "GoogleCloudSecuritycenterV2Application", @@ -5756,6 +5813,20 @@ }, "type": "object" }, +"GoogleCloudSecuritycenterV2Denied": { +"description": "Denied IP rule.", +"id": "GoogleCloudSecuritycenterV2Denied", +"properties": { +"ipRules": { +"description": "Optional. Optional list of denied IP rules.", +"items": { +"$ref": "GoogleCloudSecuritycenterV2IpRule" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudSecuritycenterV2Detection": { "description": "Memory hash detection contributing to the binary family match.", "id": "GoogleCloudSecuritycenterV2Detection", @@ -6149,6 +6220,14 @@ "$ref": "GoogleCloudSecuritycenterV2Indicator", "description": "Represents what's commonly known as an *indicator of compromise* (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise)." }, +"ipRules": { +"$ref": "GoogleCloudSecuritycenterV2IpRules", +"description": "IP rules associated with the finding." +}, +"job": { +"$ref": "GoogleCloudSecuritycenterV2Job", +"description": "Job associated with the finding." +}, "kernelRootkit": { "$ref": "GoogleCloudSecuritycenterV2KernelRootkit", "description": "Signature of the kernel rootkit." @@ -6214,6 +6293,13 @@ "description": "The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. The following list shows some examples: + `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}` + `organizations/{organization_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}` + `folders/{folder_id}/sources/{source_id}/findings/{finding_id}` + `folders/{folder_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}` + `projects/{project_id}/sources/{source_id}/findings/{finding_id}` + `projects/{project_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}`", "type": "string" }, +"networks": { +"description": "Represents the VPC networks that the resource is attached to.", +"items": { +"$ref": "GoogleCloudSecuritycenterV2Network" +}, +"type": "array" +}, "nextSteps": { "description": "Steps to address the finding.", "type": "string" @@ -6422,6 +6508,74 @@ }, "type": "object" }, +"GoogleCloudSecuritycenterV2IpRule": { +"description": "IP rule information.", +"id": "GoogleCloudSecuritycenterV2IpRule", +"properties": { +"portRanges": { +"description": "Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number.", +"items": { +"$ref": "GoogleCloudSecuritycenterV2PortRange" +}, +"type": "array" +}, +"protocol": { +"description": "The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudSecuritycenterV2IpRules": { +"description": "IP rules associated with the finding.", +"id": "GoogleCloudSecuritycenterV2IpRules", +"properties": { +"allowed": { +"$ref": "GoogleCloudSecuritycenterV2Allowed", +"description": "Tuple with allowed rules." +}, +"denied": { +"$ref": "GoogleCloudSecuritycenterV2Denied", +"description": "Tuple with denied rules." +}, +"destinationIpRanges": { +"description": "If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4.", +"items": { +"type": "string" +}, +"type": "array" +}, +"direction": { +"description": "The direction that the rule is applicable to, one of ingress or egress.", +"enum": [ +"DIRECTION_UNSPECIFIED", +"INGRESS", +"EGRESS" +], +"enumDescriptions": [ +"Unspecified direction value.", +"Ingress direction value.", +"Egress direction value." +], +"type": "string" +}, +"exposedServices": { +"description": "Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml.", +"items": { +"type": "string" +}, +"type": "array" +}, +"sourceIpRanges": { +"description": "If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudSecuritycenterV2Issue": { "description": "Security Command Center Issue.", "id": "GoogleCloudSecuritycenterV2Issue", @@ -6819,6 +6973,45 @@ }, "type": "object" }, +"GoogleCloudSecuritycenterV2Job": { +"description": "Describes a job", +"id": "GoogleCloudSecuritycenterV2Job", +"properties": { +"errorCode": { +"description": "Optional. If the job did not complete successfully, this field describes why.", +"format": "int32", +"type": "integer" +}, +"location": { +"description": "Optional. Gives the location where the job ran, such as `US` or `europe-west1`", +"type": "string" +}, +"name": { +"description": "The fully-qualified name for a job. e.g. `projects//jobs/`", +"type": "string" +}, +"state": { +"description": "Output only. State of the job, such as `RUNNING` or `PENDING`.", +"enum": [ +"JOB_STATE_UNSPECIFIED", +"PENDING", +"RUNNING", +"SUCCEEDED", +"FAILED" +], +"enumDescriptions": [ +"Unspecified represents an unknown state and should not be used.", +"Job is scheduled and pending for run", +"Job in progress", +"Job has completed with success", +"Job has completed but with failure" +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudSecuritycenterV2KernelRootkit": { "description": "Kernel mode rootkit signatures.", "id": "GoogleCloudSecuritycenterV2KernelRootkit", @@ -7426,6 +7619,17 @@ }, "type": "object" }, +"GoogleCloudSecuritycenterV2Network": { +"description": "Contains information about a VPC network associated with the finding.", +"id": "GoogleCloudSecuritycenterV2Network", +"properties": { +"name": { +"description": "The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudSecuritycenterV2Node": { "description": "Kubernetes nodes associated with the finding.", "id": "GoogleCloudSecuritycenterV2Node", @@ -7610,6 +7814,23 @@ }, "type": "object" }, +"GoogleCloudSecuritycenterV2PortRange": { +"description": "A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port.", +"id": "GoogleCloudSecuritycenterV2PortRange", +"properties": { +"max": { +"description": "Maximum port value.", +"format": "int64", +"type": "string" +}, +"min": { +"description": "Minimum port value.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudSecuritycenterV2Process": { "description": "Represents an operating system process.", "id": "GoogleCloudSecuritycenterV2Process", @@ -8367,6 +8588,113 @@ }, "type": "object" }, +"IpRule": { +"description": "IP rule information.", +"id": "IpRule", +"properties": { +"portRanges": { +"description": "Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number.", +"items": { +"$ref": "PortRange" +}, +"type": "array" +}, +"protocol": { +"description": "The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value.", +"type": "string" +} +}, +"type": "object" +}, +"IpRules": { +"description": "IP rules associated with the finding.", +"id": "IpRules", +"properties": { +"allowed": { +"$ref": "Allowed", +"description": "Tuple with allowed rules." +}, +"denied": { +"$ref": "Denied", +"description": "Tuple with denied rules." +}, +"destinationIpRanges": { +"description": "If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4.", +"items": { +"type": "string" +}, +"type": "array" +}, +"direction": { +"description": "The direction that the rule is applicable to, one of ingress or egress.", +"enum": [ +"DIRECTION_UNSPECIFIED", +"INGRESS", +"EGRESS" +], +"enumDescriptions": [ +"Unspecified direction value.", +"Ingress direction value.", +"Egress direction value." +], +"type": "string" +}, +"exposedServices": { +"description": "Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml.", +"items": { +"type": "string" +}, +"type": "array" +}, +"sourceIpRanges": { +"description": "If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"Job": { +"description": "Describes a job", +"id": "Job", +"properties": { +"errorCode": { +"description": "Optional. If the job did not complete successfully, this field describes why.", +"format": "int32", +"type": "integer" +}, +"location": { +"description": "Optional. Gives the location where the job ran, such as `US` or `europe-west1`", +"type": "string" +}, +"name": { +"description": "The fully-qualified name for a job. e.g. `projects//jobs/`", +"type": "string" +}, +"state": { +"description": "Output only. State of the job, such as `RUNNING` or `PENDING`.", +"enum": [ +"JOB_STATE_UNSPECIFIED", +"PENDING", +"RUNNING", +"SUCCEEDED", +"FAILED" +], +"enumDescriptions": [ +"Unspecified represents an unknown state and should not be used.", +"Job is scheduled and pending for run", +"Job in progress", +"Job has completed with success", +"Job has completed but with failure" +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "KernelRootkit": { "description": "Kernel mode rootkit signatures.", "id": "KernelRootkit", @@ -8919,6 +9247,17 @@ }, "type": "object" }, +"Network": { +"description": "Contains information about a VPC network associated with the finding.", +"id": "Network", +"properties": { +"name": { +"description": "The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`.", +"type": "string" +} +}, +"type": "object" +}, "Node": { "description": "Kubernetes nodes associated with the finding.", "id": "Node", @@ -9084,6 +9423,23 @@ }, "type": "object" }, +"PortRange": { +"description": "A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port.", +"id": "PortRange", +"properties": { +"max": { +"description": "Maximum port value.", +"format": "int64", +"type": "string" +}, +"min": { +"description": "Minimum port value.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, "Process": { "description": "Represents an operating system process.", "id": "Process", From 06dbaf2cfafb788ef26149c7b77c97208c2a293d Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 25 Feb 2025 07:08:20 +0000 Subject: [PATCH 29/36] feat(serviceconsumermanagement): update the api #### serviceconsumermanagement:v1 The following keys were added: - schemas.Aspect (Total Keys: 5) - schemas.BackendRule.properties.loadBalancingPolicy.type (Total Keys: 1) - schemas.ExperimentalFeatures.properties.unversionedPackageDisabled.type (Total Keys: 1) - schemas.Service.properties.aspects (Total Keys: 2) #### serviceconsumermanagement:v1beta1 The following keys were added: - schemas.Aspect (Total Keys: 5) - schemas.BackendRule.properties.loadBalancingPolicy.type (Total Keys: 1) - schemas.ExperimentalFeatures.properties.unversionedPackageDisabled.type (Total Keys: 1) - schemas.Service.properties.aspects (Total Keys: 2) --- .../serviceconsumermanagement.v1.json | 40 +++++++++++++++++-- .../serviceconsumermanagement.v1beta1.json | 40 +++++++++++++++++-- 2 files changed, 74 insertions(+), 6 deletions(-) diff --git a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json index 0b46f7a1689..aa296bc44b1 100644 --- a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json @@ -542,7 +542,7 @@ } } }, -"revision": "20250130", +"revision": "20250218", "rootUrl": "https://serviceconsumermanagement.googleapis.com/", "schemas": { "AddTenantProjectRequest": { @@ -629,6 +629,25 @@ }, "type": "object" }, +"Aspect": { +"description": "Aspect represents Generic aspect. It is used to configure an aspect without making direct changes to service.proto", +"id": "Aspect", +"properties": { +"kind": { +"description": "The type of this aspect configuration.", +"type": "string" +}, +"spec": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Content of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `apiserving/configaspects/proto`.", +"type": "object" +} +}, +"type": "object" +}, "AttachTenantProjectRequest": { "description": "Request to attach an existing project to the tenancy unit as a new tenant resource.", "id": "AttachTenantProjectRequest", @@ -779,6 +798,10 @@ "description": "The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP \"authorization\" header, and sent to the backend.", "type": "string" }, +"loadBalancingPolicy": { +"description": "The load balancing policy used for connection to the application backend. Defined as an arbitrary string to accomondate custom load balancing policies supported by the underlying channel, but suggest most users use one of the standard policies, such as the default, \"RoundRobin\".", +"type": "string" +}, "minDeadline": { "deprecated": true, "description": "Deprecated, do not use.", @@ -1160,7 +1183,7 @@ "type": "array" }, "sectionOverrides": { -"description": "Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries", +"description": "Specifies section and content to override the boilerplate content. Currently overrides following sections: 1. rest.service.client_libraries", "items": { "$ref": "Page" }, @@ -1190,7 +1213,7 @@ "type": "string" }, "disableReplacementWords": { -"description": "String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen.", +"description": "String of comma or space separated case-sensitive words for which method/field name replacement will be disabled.", "type": "string" }, "selector": { @@ -1359,6 +1382,10 @@ "restAsyncIoEnabled": { "description": "Enables generation of asynchronous REST clients if `rest` transport is enabled. By default, asynchronous REST clients will not be generated. This feature will be enabled by default 1 month after launching the feature in preview packages.", "type": "boolean" +}, +"unversionedPackageDisabled": { +"description": "Disables generation of an unversioned Python package for this client library. This means that the module names will need to be versioned in import statements. For example `import google.cloud.library_v2` instead of `import google.cloud.library`.", +"type": "boolean" } }, "type": "object" @@ -2525,6 +2552,13 @@ }, "type": "array" }, +"aspects": { +"description": "Configuration aspects. This is a repeated field to allow multiple aspects to be configured. The kind field in each ConfigAspect specifies the type of aspect. The spec field contains the configuration for that aspect. The schema for the spec field is defined by the backend service owners.", +"items": { +"$ref": "Aspect" +}, +"type": "array" +}, "authentication": { "$ref": "Authentication", "description": "Auth configuration." diff --git a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json index ad8f54958ae..bbb73eb50ec 100644 --- a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json @@ -715,7 +715,7 @@ } } }, -"revision": "20250130", +"revision": "20250218", "rootUrl": "https://serviceconsumermanagement.googleapis.com/", "schemas": { "Api": { @@ -772,6 +772,25 @@ }, "type": "object" }, +"Aspect": { +"description": "Aspect represents Generic aspect. It is used to configure an aspect without making direct changes to service.proto", +"id": "Aspect", +"properties": { +"kind": { +"description": "The type of this aspect configuration.", +"type": "string" +}, +"spec": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Content of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `apiserving/configaspects/proto`.", +"type": "object" +} +}, +"type": "object" +}, "AuthProvider": { "description": "Configuration for an authentication provider, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).", "id": "AuthProvider", @@ -903,6 +922,10 @@ "description": "The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP \"authorization\" header, and sent to the backend.", "type": "string" }, +"loadBalancingPolicy": { +"description": "The load balancing policy used for connection to the application backend. Defined as an arbitrary string to accomondate custom load balancing policies supported by the underlying channel, but suggest most users use one of the standard policies, such as the default, \"RoundRobin\".", +"type": "string" +}, "minDeadline": { "deprecated": true, "description": "Deprecated, do not use.", @@ -1245,7 +1268,7 @@ "type": "array" }, "sectionOverrides": { -"description": "Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries", +"description": "Specifies section and content to override the boilerplate content. Currently overrides following sections: 1. rest.service.client_libraries", "items": { "$ref": "Page" }, @@ -1275,7 +1298,7 @@ "type": "string" }, "disableReplacementWords": { -"description": "String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen.", +"description": "String of comma or space separated case-sensitive words for which method/field name replacement will be disabled.", "type": "string" }, "selector": { @@ -1444,6 +1467,10 @@ "restAsyncIoEnabled": { "description": "Enables generation of asynchronous REST clients if `rest` transport is enabled. By default, asynchronous REST clients will not be generated. This feature will be enabled by default 1 month after launching the feature in preview packages.", "type": "boolean" +}, +"unversionedPackageDisabled": { +"description": "Disables generation of an unversioned Python package for this client library. This means that the module names will need to be versioned in import statements. For example `import google.cloud.library_v2` instead of `import google.cloud.library`.", +"type": "boolean" } }, "type": "object" @@ -2527,6 +2554,13 @@ }, "type": "array" }, +"aspects": { +"description": "Configuration aspects. This is a repeated field to allow multiple aspects to be configured. The kind field in each ConfigAspect specifies the type of aspect. The spec field contains the configuration for that aspect. The schema for the spec field is defined by the backend service owners.", +"items": { +"$ref": "Aspect" +}, +"type": "array" +}, "authentication": { "$ref": "Authentication", "description": "Auth configuration." From ca45a397a81d0e33b4bfce9c20889b8e9ffc545f Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 25 Feb 2025 07:08:20 +0000 Subject: [PATCH 30/36] feat(serviceusage): update the api #### serviceusage:v1 The following keys were deleted: - schemas.GoogleApiServiceusageV2betaAnalysis.properties.analysis (Total Keys: 2) The following keys were added: - schemas.Aspect (Total Keys: 5) - schemas.BackendRule.properties.loadBalancingPolicy.type (Total Keys: 1) - schemas.ExperimentalFeatures.properties.unversionedPackageDisabled.type (Total Keys: 1) - schemas.GoogleApiService.properties.aspects (Total Keys: 2) - schemas.GoogleApiServiceusageV2betaAnalysis.properties.analysis (Total Keys: 2) #### serviceusage:v1beta1 The following keys were deleted: - schemas.GoogleApiServiceusageV2betaAnalysis.properties.analysis (Total Keys: 2) The following keys were added: - schemas.Aspect (Total Keys: 5) - schemas.BackendRule.properties.loadBalancingPolicy.type (Total Keys: 1) - schemas.ExperimentalFeatures.properties.unversionedPackageDisabled.type (Total Keys: 1) - schemas.GoogleApiService.properties.aspects (Total Keys: 2) - schemas.GoogleApiServiceusageV2betaAnalysis.properties.analysis (Total Keys: 2) --- docs/dyn/serviceusage_v1.services.html | 12 +++--- docs/dyn/serviceusage_v1beta1.services.html | 8 ++-- .../documents/serviceusage.v1.json | 42 +++++++++++++++++-- .../documents/serviceusage.v1beta1.json | 42 +++++++++++++++++-- 4 files changed, 86 insertions(+), 18 deletions(-) diff --git a/docs/dyn/serviceusage_v1.services.html b/docs/dyn/serviceusage_v1.services.html index 814a72a077a..70a1e99248e 100644 --- a/docs/dyn/serviceusage_v1.services.html +++ b/docs/dyn/serviceusage_v1.services.html @@ -255,11 +255,11 @@

Method Details

{ # A documentation rule provides information about individual API elements. "deprecationDescription": "A String", # Deprecation description of the selected element(s). It can be provided if an element is marked as `deprecated`. "description": "A String", # Description of the selected proto element (e.g. a message, a method, a 'service' definition, or a field). Defaults to leading & trailing comments taken from the proto source definition of the proto element. - "disableReplacementWords": "A String", # String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen. + "disableReplacementWords": "A String", # String of comma or space separated case-sensitive words for which method/field name replacement will be disabled. "selector": "A String", # The selector is a comma-separated list of patterns for any element such as a method, a field, an enum value. Each pattern is a qualified name of the element which may end in "*", indicating a wildcard. Wildcards are only allowed at the end and for a whole component of the qualified name, i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". A wildcard will match one or more components. To specify a default for all applicable elements, the whole pattern "*" is used. }, ], - "sectionOverrides": [ # Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries + "sectionOverrides": [ # Specifies section and content to override the boilerplate content. Currently overrides following sections: 1. rest.service.client_libraries { # Represents a documentation page. A page can contain subpages to represent nested documentation set structure. "content": "A String", # The Markdown content of the page. You can use ```(== include {path} ==)``` to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. "name": "A String", # The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with `.`) can be used as reference to the page in your documentation. For example: pages: - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java content: (== include tutorial_java.md ==) You can reference `Java` page using Markdown reference link syntax: `Java`. @@ -563,11 +563,11 @@

Method Details

{ # A documentation rule provides information about individual API elements. "deprecationDescription": "A String", # Deprecation description of the selected element(s). It can be provided if an element is marked as `deprecated`. "description": "A String", # Description of the selected proto element (e.g. a message, a method, a 'service' definition, or a field). Defaults to leading & trailing comments taken from the proto source definition of the proto element. - "disableReplacementWords": "A String", # String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen. + "disableReplacementWords": "A String", # String of comma or space separated case-sensitive words for which method/field name replacement will be disabled. "selector": "A String", # The selector is a comma-separated list of patterns for any element such as a method, a field, an enum value. Each pattern is a qualified name of the element which may end in "*", indicating a wildcard. Wildcards are only allowed at the end and for a whole component of the qualified name, i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". A wildcard will match one or more components. To specify a default for all applicable elements, the whole pattern "*" is used. }, ], - "sectionOverrides": [ # Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries + "sectionOverrides": [ # Specifies section and content to override the boilerplate content. Currently overrides following sections: 1. rest.service.client_libraries { # Represents a documentation page. A page can contain subpages to represent nested documentation set structure. "content": "A String", # The Markdown content of the page. You can use ```(== include {path} ==)``` to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. "name": "A String", # The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with `.`) can be used as reference to the page in your documentation. For example: pages: - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java content: (== include tutorial_java.md ==) You can reference `Java` page using Markdown reference link syntax: `Java`. @@ -786,11 +786,11 @@

Method Details

{ # A documentation rule provides information about individual API elements. "deprecationDescription": "A String", # Deprecation description of the selected element(s). It can be provided if an element is marked as `deprecated`. "description": "A String", # Description of the selected proto element (e.g. a message, a method, a 'service' definition, or a field). Defaults to leading & trailing comments taken from the proto source definition of the proto element. - "disableReplacementWords": "A String", # String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen. + "disableReplacementWords": "A String", # String of comma or space separated case-sensitive words for which method/field name replacement will be disabled. "selector": "A String", # The selector is a comma-separated list of patterns for any element such as a method, a field, an enum value. Each pattern is a qualified name of the element which may end in "*", indicating a wildcard. Wildcards are only allowed at the end and for a whole component of the qualified name, i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". A wildcard will match one or more components. To specify a default for all applicable elements, the whole pattern "*" is used. }, ], - "sectionOverrides": [ # Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries + "sectionOverrides": [ # Specifies section and content to override the boilerplate content. Currently overrides following sections: 1. rest.service.client_libraries { # Represents a documentation page. A page can contain subpages to represent nested documentation set structure. "content": "A String", # The Markdown content of the page. You can use ```(== include {path} ==)``` to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. "name": "A String", # The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with `.`) can be used as reference to the page in your documentation. For example: pages: - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java content: (== include tutorial_java.md ==) You can reference `Java` page using Markdown reference link syntax: `Java`. diff --git a/docs/dyn/serviceusage_v1beta1.services.html b/docs/dyn/serviceusage_v1beta1.services.html index c2772afff69..0739aa47108 100644 --- a/docs/dyn/serviceusage_v1beta1.services.html +++ b/docs/dyn/serviceusage_v1beta1.services.html @@ -379,11 +379,11 @@

Method Details

{ # A documentation rule provides information about individual API elements. "deprecationDescription": "A String", # Deprecation description of the selected element(s). It can be provided if an element is marked as `deprecated`. "description": "A String", # Description of the selected proto element (e.g. a message, a method, a 'service' definition, or a field). Defaults to leading & trailing comments taken from the proto source definition of the proto element. - "disableReplacementWords": "A String", # String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen. + "disableReplacementWords": "A String", # String of comma or space separated case-sensitive words for which method/field name replacement will be disabled. "selector": "A String", # The selector is a comma-separated list of patterns for any element such as a method, a field, an enum value. Each pattern is a qualified name of the element which may end in "*", indicating a wildcard. Wildcards are only allowed at the end and for a whole component of the qualified name, i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". A wildcard will match one or more components. To specify a default for all applicable elements, the whole pattern "*" is used. }, ], - "sectionOverrides": [ # Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries + "sectionOverrides": [ # Specifies section and content to override the boilerplate content. Currently overrides following sections: 1. rest.service.client_libraries { # Represents a documentation page. A page can contain subpages to represent nested documentation set structure. "content": "A String", # The Markdown content of the page. You can use ```(== include {path} ==)``` to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. "name": "A String", # The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with `.`) can be used as reference to the page in your documentation. For example: pages: - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java content: (== include tutorial_java.md ==) You can reference `Java` page using Markdown reference link syntax: `Java`. @@ -602,11 +602,11 @@

Method Details

{ # A documentation rule provides information about individual API elements. "deprecationDescription": "A String", # Deprecation description of the selected element(s). It can be provided if an element is marked as `deprecated`. "description": "A String", # Description of the selected proto element (e.g. a message, a method, a 'service' definition, or a field). Defaults to leading & trailing comments taken from the proto source definition of the proto element. - "disableReplacementWords": "A String", # String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen. + "disableReplacementWords": "A String", # String of comma or space separated case-sensitive words for which method/field name replacement will be disabled. "selector": "A String", # The selector is a comma-separated list of patterns for any element such as a method, a field, an enum value. Each pattern is a qualified name of the element which may end in "*", indicating a wildcard. Wildcards are only allowed at the end and for a whole component of the qualified name, i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". A wildcard will match one or more components. To specify a default for all applicable elements, the whole pattern "*" is used. }, ], - "sectionOverrides": [ # Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries + "sectionOverrides": [ # Specifies section and content to override the boilerplate content. Currently overrides following sections: 1. rest.service.client_libraries { # Represents a documentation page. A page can contain subpages to represent nested documentation set structure. "content": "A String", # The Markdown content of the page. You can use ```(== include {path} ==)``` to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. "name": "A String", # The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with `.`) can be used as reference to the page in your documentation. For example: pages: - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java content: (== include tutorial_java.md ==) You can reference `Java` page using Markdown reference link syntax: `Java`. diff --git a/googleapiclient/discovery_cache/documents/serviceusage.v1.json b/googleapiclient/discovery_cache/documents/serviceusage.v1.json index f41a344d942..7843b689044 100644 --- a/googleapiclient/discovery_cache/documents/serviceusage.v1.json +++ b/googleapiclient/discovery_cache/documents/serviceusage.v1.json @@ -426,7 +426,7 @@ } } }, -"revision": "20250130", +"revision": "20250218", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AddEnableRulesMetadata": { @@ -621,6 +621,25 @@ }, "type": "object" }, +"Aspect": { +"description": "Aspect represents Generic aspect. It is used to configure an aspect without making direct changes to service.proto", +"id": "Aspect", +"properties": { +"kind": { +"description": "The type of this aspect configuration.", +"type": "string" +}, +"spec": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Content of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `apiserving/configaspects/proto`.", +"type": "object" +} +}, +"type": "object" +}, "AuthProvider": { "description": "Configuration for an authentication provider, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).", "id": "AuthProvider", @@ -752,6 +771,10 @@ "description": "The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP \"authorization\" header, and sent to the backend.", "type": "string" }, +"loadBalancingPolicy": { +"description": "The load balancing policy used for connection to the application backend. Defined as an arbitrary string to accomondate custom load balancing policies supported by the underlying channel, but suggest most users use one of the standard policies, such as the default, \"RoundRobin\".", +"type": "string" +}, "minDeadline": { "deprecated": true, "description": "Deprecated, do not use.", @@ -1260,7 +1283,7 @@ "type": "array" }, "sectionOverrides": { -"description": "Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries", +"description": "Specifies section and content to override the boilerplate content. Currently overrides following sections: 1. rest.service.client_libraries", "items": { "$ref": "Page" }, @@ -1290,7 +1313,7 @@ "type": "string" }, "disableReplacementWords": { -"description": "String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen.", +"description": "String of comma or space separated case-sensitive words for which method/field name replacement will be disabled.", "type": "string" }, "selector": { @@ -1537,6 +1560,10 @@ "restAsyncIoEnabled": { "description": "Enables generation of asynchronous REST clients if `rest` transport is enabled. By default, asynchronous REST clients will not be generated. This feature will be enabled by default 1 month after launching the feature in preview packages.", "type": "boolean" +}, +"unversionedPackageDisabled": { +"description": "Disables generation of an unversioned Python package for this client library. This means that the module names will need to be versioned in import statements. For example `import google.cloud.library_v2` instead of `import google.cloud.library`.", +"type": "boolean" } }, "type": "object" @@ -1724,6 +1751,13 @@ }, "type": "array" }, +"aspects": { +"description": "Configuration aspects. This is a repeated field to allow multiple aspects to be configured. The kind field in each ConfigAspect specifies the type of aspect. The spec field contains the configuration for that aspect. The schema for the spec field is defined by the backend service owners.", +"items": { +"$ref": "Aspect" +}, +"type": "array" +}, "authentication": { "$ref": "Authentication", "description": "Auth configuration." @@ -2065,7 +2099,7 @@ "description": "A message to group the analysis information.", "id": "GoogleApiServiceusageV2betaAnalysis", "properties": { -"analysis": { +"analysisResult": { "$ref": "GoogleApiServiceusageV2betaAnalysisResult", "description": "Output only. Analysis result of updating a policy.", "readOnly": true diff --git a/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json b/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json index e9772f52f47..a7c1bcffe58 100644 --- a/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json @@ -964,7 +964,7 @@ } } }, -"revision": "20250130", +"revision": "20250218", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AddEnableRulesMetadata": { @@ -1159,6 +1159,25 @@ }, "type": "object" }, +"Aspect": { +"description": "Aspect represents Generic aspect. It is used to configure an aspect without making direct changes to service.proto", +"id": "Aspect", +"properties": { +"kind": { +"description": "The type of this aspect configuration.", +"type": "string" +}, +"spec": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Content of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `apiserving/configaspects/proto`.", +"type": "object" +} +}, +"type": "object" +}, "AuthProvider": { "description": "Configuration for an authentication provider, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).", "id": "AuthProvider", @@ -1290,6 +1309,10 @@ "description": "The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP \"authorization\" header, and sent to the backend.", "type": "string" }, +"loadBalancingPolicy": { +"description": "The load balancing policy used for connection to the application backend. Defined as an arbitrary string to accomondate custom load balancing policies supported by the underlying channel, but suggest most users use one of the standard policies, such as the default, \"RoundRobin\".", +"type": "string" +}, "minDeadline": { "deprecated": true, "description": "Deprecated, do not use.", @@ -1837,7 +1860,7 @@ "type": "array" }, "sectionOverrides": { -"description": "Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries", +"description": "Specifies section and content to override the boilerplate content. Currently overrides following sections: 1. rest.service.client_libraries", "items": { "$ref": "Page" }, @@ -1867,7 +1890,7 @@ "type": "string" }, "disableReplacementWords": { -"description": "String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen.", +"description": "String of comma or space separated case-sensitive words for which method/field name replacement will be disabled.", "type": "string" }, "selector": { @@ -2114,6 +2137,10 @@ "restAsyncIoEnabled": { "description": "Enables generation of asynchronous REST clients if `rest` transport is enabled. By default, asynchronous REST clients will not be generated. This feature will be enabled by default 1 month after launching the feature in preview packages.", "type": "boolean" +}, +"unversionedPackageDisabled": { +"description": "Disables generation of an unversioned Python package for this client library. This means that the module names will need to be versioned in import statements. For example `import google.cloud.library_v2` instead of `import google.cloud.library`.", +"type": "boolean" } }, "type": "object" @@ -2301,6 +2328,13 @@ }, "type": "array" }, +"aspects": { +"description": "Configuration aspects. This is a repeated field to allow multiple aspects to be configured. The kind field in each ConfigAspect specifies the type of aspect. The spec field contains the configuration for that aspect. The schema for the spec field is defined by the backend service owners.", +"items": { +"$ref": "Aspect" +}, +"type": "array" +}, "authentication": { "$ref": "Authentication", "description": "Auth configuration." @@ -2642,7 +2676,7 @@ "description": "A message to group the analysis information.", "id": "GoogleApiServiceusageV2betaAnalysis", "properties": { -"analysis": { +"analysisResult": { "$ref": "GoogleApiServiceusageV2betaAnalysisResult", "description": "Output only. Analysis result of updating a policy.", "readOnly": true From 82133a87133a7c7d00d95c0d44afc183e99a62f3 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 25 Feb 2025 07:08:20 +0000 Subject: [PATCH 31/36] fix(sts): update the api #### sts:v1 The following keys were changed: - endpoints (Total Keys: 1) #### sts:v1beta The following keys were changed: - endpoints (Total Keys: 1) --- .../discovery_cache/documents/sts.v1.json | 42 ++++++++++++++++++- .../discovery_cache/documents/sts.v1beta.json | 42 ++++++++++++++++++- 2 files changed, 82 insertions(+), 2 deletions(-) diff --git a/googleapiclient/discovery_cache/documents/sts.v1.json b/googleapiclient/discovery_cache/documents/sts.v1.json index 5767141b100..d526e678402 100644 --- a/googleapiclient/discovery_cache/documents/sts.v1.json +++ b/googleapiclient/discovery_cache/documents/sts.v1.json @@ -9,10 +9,50 @@ "endpoints": [ { "description": "Regional Endpoint", +"endpointUrl": "https://sts.asia-east1.rep.googleapis.com/", +"location": "asia-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://sts.europe-north1.rep.googleapis.com/", +"location": "europe-north1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://sts.europe-west1.rep.googleapis.com/", +"location": "europe-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://sts.europe-west4.rep.googleapis.com/", +"location": "europe-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://sts.us-central1.rep.googleapis.com/", +"location": "us-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://sts.us-central2.rep.googleapis.com/", +"location": "us-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://sts.us-east1.rep.googleapis.com/", +"location": "us-east1" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://sts.us-east7.rep.googleapis.com/", "location": "us-east7" }, { +"description": "Regional Endpoint", +"endpointUrl": "https://sts.us-west1.rep.googleapis.com/", +"location": "us-west1" +}, +{ "description": "Locational Endpoint", "endpointUrl": "https://sts.us-east4.rep.sandbox.googleapis.com/", "location": "us-east4" @@ -128,7 +168,7 @@ } } }, -"revision": "20250127", +"revision": "20250211", "rootUrl": "https://sts.googleapis.com/", "schemas": { "GoogleIamV1Binding": { diff --git a/googleapiclient/discovery_cache/documents/sts.v1beta.json b/googleapiclient/discovery_cache/documents/sts.v1beta.json index eed35d7daaa..cd295f60c6d 100644 --- a/googleapiclient/discovery_cache/documents/sts.v1beta.json +++ b/googleapiclient/discovery_cache/documents/sts.v1beta.json @@ -9,10 +9,50 @@ "endpoints": [ { "description": "Regional Endpoint", +"endpointUrl": "https://sts.asia-east1.rep.googleapis.com/", +"location": "asia-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://sts.europe-north1.rep.googleapis.com/", +"location": "europe-north1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://sts.europe-west1.rep.googleapis.com/", +"location": "europe-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://sts.europe-west4.rep.googleapis.com/", +"location": "europe-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://sts.us-central1.rep.googleapis.com/", +"location": "us-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://sts.us-central2.rep.googleapis.com/", +"location": "us-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://sts.us-east1.rep.googleapis.com/", +"location": "us-east1" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://sts.us-east7.rep.googleapis.com/", "location": "us-east7" }, { +"description": "Regional Endpoint", +"endpointUrl": "https://sts.us-west1.rep.googleapis.com/", +"location": "us-west1" +}, +{ "description": "Locational Endpoint", "endpointUrl": "https://sts.us-east4.rep.sandbox.googleapis.com/", "location": "us-east4" @@ -128,7 +168,7 @@ } } }, -"revision": "20250127", +"revision": "20250211", "rootUrl": "https://sts.googleapis.com/", "schemas": { "GoogleIamV1Binding": { From 8d92a324e1b3027d6d2c8596b66df4ab3114e4c2 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 25 Feb 2025 07:08:20 +0000 Subject: [PATCH 32/36] feat(tagmanager): update the api #### tagmanager:v2 The following keys were added: - schemas.GetContainerSnippetResponse.properties.containerConfig.type (Total Keys: 1) --- docs/dyn/tagmanager_v2.accounts.containers.html | 1 + .../discovery_cache/documents/tagmanager.v2.json | 6 +++++- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/dyn/tagmanager_v2.accounts.containers.html b/docs/dyn/tagmanager_v2.accounts.containers.html index 6c0a0f24c2f..9c6b0edf26b 100644 --- a/docs/dyn/tagmanager_v2.accounts.containers.html +++ b/docs/dyn/tagmanager_v2.accounts.containers.html @@ -566,6 +566,7 @@

Method Details

An object of the form: { + "containerConfig": "A String", # Server container config param for manually provisioning a tagging server. "snippet": "A String", # Tagging snippet for a Container. }
diff --git a/googleapiclient/discovery_cache/documents/tagmanager.v2.json b/googleapiclient/discovery_cache/documents/tagmanager.v2.json index 9f72fd1073a..9e0f98da0b2 100644 --- a/googleapiclient/discovery_cache/documents/tagmanager.v2.json +++ b/googleapiclient/discovery_cache/documents/tagmanager.v2.json @@ -3895,7 +3895,7 @@ } } }, -"revision": "20250129", +"revision": "20250218", "rootUrl": "https://tagmanager.googleapis.com/", "schemas": { "Account": { @@ -5162,6 +5162,10 @@ "GetContainerSnippetResponse": { "id": "GetContainerSnippetResponse", "properties": { +"containerConfig": { +"description": "Server container config param for manually provisioning a tagging server.", +"type": "string" +}, "snippet": { "description": "Tagging snippet for a Container.", "type": "string" From 64ee1cb5268b3327834f1e1e9e9249785550f1e0 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 25 Feb 2025 07:08:20 +0000 Subject: [PATCH 33/36] feat(vault): update the api #### vault:v1 The following keys were added: - schemas.DriveDocumentIds (Total Keys: 4) - schemas.DriveDocumentInfo (Total Keys: 3) - schemas.Query.properties.driveDocumentInfo.$ref (Total Keys: 1) --- docs/dyn/vault_v1.matters.exports.html | 28 ++++++++++++ docs/dyn/vault_v1.matters.html | 7 +++ docs/dyn/vault_v1.matters.savedQueries.html | 28 ++++++++++++ .../discovery_cache/documents/vault.v1.json | 45 ++++++++++++++++--- 4 files changed, 103 insertions(+), 5 deletions(-) diff --git a/docs/dyn/vault_v1.matters.exports.html b/docs/dyn/vault_v1.matters.exports.html index b6e712aec8f..22a330df890 100644 --- a/docs/dyn/vault_v1.matters.exports.html +++ b/docs/dyn/vault_v1.matters.exports.html @@ -173,6 +173,13 @@

Method Details

}, "corpus": "A String", # The Google Workspace service to search. "dataScope": "A String", # The data source to search. + "driveDocumentInfo": { # The Drive documents to search. # Required when **SearchMethod** is **DRIVE_DOCUMENT**. + "documentIds": { # Specify Drive documents by document ID. # Specify Drive documents by document ID. + "ids": [ # Required. A list of Drive document IDs. + "A String", + ], + }, + }, "driveOptions": { # Additional options for Drive search. # Set Drive search-specific options. "clientSideEncryptedOption": "A String", # Set whether the results include only content encrypted with [Google Workspace Client-side encryption](https://support.google.com/a?p=cse_ov) content, only unencrypted content, or both. Defaults to both. Currently supported for Drive. "includeSharedDrives": True or False, # Set to **true** to include shared drives. @@ -309,6 +316,13 @@

Method Details

}, "corpus": "A String", # The Google Workspace service to search. "dataScope": "A String", # The data source to search. + "driveDocumentInfo": { # The Drive documents to search. # Required when **SearchMethod** is **DRIVE_DOCUMENT**. + "documentIds": { # Specify Drive documents by document ID. # Specify Drive documents by document ID. + "ids": [ # Required. A list of Drive document IDs. + "A String", + ], + }, + }, "driveOptions": { # Additional options for Drive search. # Set Drive search-specific options. "clientSideEncryptedOption": "A String", # Set whether the results include only content encrypted with [Google Workspace Client-side encryption](https://support.google.com/a?p=cse_ov) content, only unencrypted content, or both. Defaults to both. Currently supported for Drive. "includeSharedDrives": True or False, # Set to **true** to include shared drives. @@ -472,6 +486,13 @@

Method Details

}, "corpus": "A String", # The Google Workspace service to search. "dataScope": "A String", # The data source to search. + "driveDocumentInfo": { # The Drive documents to search. # Required when **SearchMethod** is **DRIVE_DOCUMENT**. + "documentIds": { # Specify Drive documents by document ID. # Specify Drive documents by document ID. + "ids": [ # Required. A list of Drive document IDs. + "A String", + ], + }, + }, "driveOptions": { # Additional options for Drive search. # Set Drive search-specific options. "clientSideEncryptedOption": "A String", # Set whether the results include only content encrypted with [Google Workspace Client-side encryption](https://support.google.com/a?p=cse_ov) content, only unencrypted content, or both. Defaults to both. Currently supported for Drive. "includeSharedDrives": True or False, # Set to **true** to include shared drives. @@ -619,6 +640,13 @@

Method Details

}, "corpus": "A String", # The Google Workspace service to search. "dataScope": "A String", # The data source to search. + "driveDocumentInfo": { # The Drive documents to search. # Required when **SearchMethod** is **DRIVE_DOCUMENT**. + "documentIds": { # Specify Drive documents by document ID. # Specify Drive documents by document ID. + "ids": [ # Required. A list of Drive document IDs. + "A String", + ], + }, + }, "driveOptions": { # Additional options for Drive search. # Set Drive search-specific options. "clientSideEncryptedOption": "A String", # Set whether the results include only content encrypted with [Google Workspace Client-side encryption](https://support.google.com/a?p=cse_ov) content, only unencrypted content, or both. Defaults to both. Currently supported for Drive. "includeSharedDrives": True or False, # Set to **true** to include shared drives. diff --git a/docs/dyn/vault_v1.matters.html b/docs/dyn/vault_v1.matters.html index 4780c428cc1..37c07ad57bb 100644 --- a/docs/dyn/vault_v1.matters.html +++ b/docs/dyn/vault_v1.matters.html @@ -228,6 +228,13 @@

Method Details

}, "corpus": "A String", # The Google Workspace service to search. "dataScope": "A String", # The data source to search. + "driveDocumentInfo": { # The Drive documents to search. # Required when **SearchMethod** is **DRIVE_DOCUMENT**. + "documentIds": { # Specify Drive documents by document ID. # Specify Drive documents by document ID. + "ids": [ # Required. A list of Drive document IDs. + "A String", + ], + }, + }, "driveOptions": { # Additional options for Drive search. # Set Drive search-specific options. "clientSideEncryptedOption": "A String", # Set whether the results include only content encrypted with [Google Workspace Client-side encryption](https://support.google.com/a?p=cse_ov) content, only unencrypted content, or both. Defaults to both. Currently supported for Drive. "includeSharedDrives": True or False, # Set to **true** to include shared drives. diff --git a/docs/dyn/vault_v1.matters.savedQueries.html b/docs/dyn/vault_v1.matters.savedQueries.html index e1e3d7a2309..83f77ddcc98 100644 --- a/docs/dyn/vault_v1.matters.savedQueries.html +++ b/docs/dyn/vault_v1.matters.savedQueries.html @@ -134,6 +134,13 @@

Method Details

}, "corpus": "A String", # The Google Workspace service to search. "dataScope": "A String", # The data source to search. + "driveDocumentInfo": { # The Drive documents to search. # Required when **SearchMethod** is **DRIVE_DOCUMENT**. + "documentIds": { # Specify Drive documents by document ID. # Specify Drive documents by document ID. + "ids": [ # Required. A list of Drive document IDs. + "A String", + ], + }, + }, "driveOptions": { # Additional options for Drive search. # Set Drive search-specific options. "clientSideEncryptedOption": "A String", # Set whether the results include only content encrypted with [Google Workspace Client-side encryption](https://support.google.com/a?p=cse_ov) content, only unencrypted content, or both. Defaults to both. Currently supported for Drive. "includeSharedDrives": True or False, # Set to **true** to include shared drives. @@ -222,6 +229,13 @@

Method Details

}, "corpus": "A String", # The Google Workspace service to search. "dataScope": "A String", # The data source to search. + "driveDocumentInfo": { # The Drive documents to search. # Required when **SearchMethod** is **DRIVE_DOCUMENT**. + "documentIds": { # Specify Drive documents by document ID. # Specify Drive documents by document ID. + "ids": [ # Required. A list of Drive document IDs. + "A String", + ], + }, + }, "driveOptions": { # Additional options for Drive search. # Set Drive search-specific options. "clientSideEncryptedOption": "A String", # Set whether the results include only content encrypted with [Google Workspace Client-side encryption](https://support.google.com/a?p=cse_ov) content, only unencrypted content, or both. Defaults to both. Currently supported for Drive. "includeSharedDrives": True or False, # Set to **true** to include shared drives. @@ -337,6 +351,13 @@

Method Details

}, "corpus": "A String", # The Google Workspace service to search. "dataScope": "A String", # The data source to search. + "driveDocumentInfo": { # The Drive documents to search. # Required when **SearchMethod** is **DRIVE_DOCUMENT**. + "documentIds": { # Specify Drive documents by document ID. # Specify Drive documents by document ID. + "ids": [ # Required. A list of Drive document IDs. + "A String", + ], + }, + }, "driveOptions": { # Additional options for Drive search. # Set Drive search-specific options. "clientSideEncryptedOption": "A String", # Set whether the results include only content encrypted with [Google Workspace Client-side encryption](https://support.google.com/a?p=cse_ov) content, only unencrypted content, or both. Defaults to both. Currently supported for Drive. "includeSharedDrives": True or False, # Set to **true** to include shared drives. @@ -437,6 +458,13 @@

Method Details

}, "corpus": "A String", # The Google Workspace service to search. "dataScope": "A String", # The data source to search. + "driveDocumentInfo": { # The Drive documents to search. # Required when **SearchMethod** is **DRIVE_DOCUMENT**. + "documentIds": { # Specify Drive documents by document ID. # Specify Drive documents by document ID. + "ids": [ # Required. A list of Drive document IDs. + "A String", + ], + }, + }, "driveOptions": { # Additional options for Drive search. # Set Drive search-specific options. "clientSideEncryptedOption": "A String", # Set whether the results include only content encrypted with [Google Workspace Client-side encryption](https://support.google.com/a?p=cse_ov) content, only unencrypted content, or both. Defaults to both. Currently supported for Drive. "includeSharedDrives": True or False, # Set to **true** to include shared drives. diff --git a/googleapiclient/discovery_cache/documents/vault.v1.json b/googleapiclient/discovery_cache/documents/vault.v1.json index 86f135177d7..828b9f8f390 100644 --- a/googleapiclient/discovery_cache/documents/vault.v1.json +++ b/googleapiclient/discovery_cache/documents/vault.v1.json @@ -1203,7 +1203,7 @@ } } }, -"revision": "20250130", +"revision": "20250212", "rootUrl": "https://vault.googleapis.com/", "schemas": { "AccountCount": { @@ -1577,6 +1577,31 @@ }, "type": "object" }, +"DriveDocumentIds": { +"description": "Specify Drive documents by document ID.", +"id": "DriveDocumentIds", +"properties": { +"ids": { +"description": "Required. A list of Drive document IDs.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"DriveDocumentInfo": { +"description": "The Drive documents to search.", +"id": "DriveDocumentInfo", +"properties": { +"documentIds": { +"$ref": "DriveDocumentIds", +"description": "Specify Drive documents by document ID." +} +}, +"type": "object" +}, "DriveExportOptions": { "description": "Options for Drive exports.", "id": "DriveExportOptions", @@ -2505,6 +2530,10 @@ ], "type": "string" }, +"driveDocumentInfo": { +"$ref": "DriveDocumentInfo", +"description": "Required when **SearchMethod** is **DRIVE_DOCUMENT**." +}, "driveOptions": { "$ref": "DriveOptions", "description": "Set Drive search-specific options." @@ -2540,7 +2569,8 @@ "ENTIRE_ORG", "ROOM", "SITES_URL", -"SHARED_DRIVE" +"SHARED_DRIVE", +"DRIVE_DOCUMENT" ], "enumDeprecated": [ false, @@ -2550,6 +2580,7 @@ true, false, false, false, +false, false ], "enumDescriptions": [ @@ -2560,7 +2591,8 @@ false "Search the data of all accounts in the organization. Supported only for Gmail. When specified, you don't need to specify **AccountInfo** or **OrgUnitInfo**.", "Search messages in the Chat spaces specified in [HangoutsChatInfo](https://developers.google.com/vault/reference/rest/v1/Query#hangoutschatinfo).", "Search for sites by the published site URLs specified in [SitesUrlInfo](https://developers.google.com/vault/reference/rest/v1/Query#sitesurlinfo).", -"Search the files in the shared drives specified in [SharedDriveInfo](https://developers.google.com/vault/reference/rest/v1/Query#shareddriveinfo)." +"Search the files in the shared drives specified in [SharedDriveInfo](https://developers.google.com/vault/reference/rest/v1/Query#shareddriveinfo).", +"Retrieve the documents specified in DriveDocumentInfo." ], "type": "string" }, @@ -2579,7 +2611,8 @@ false "ENTIRE_ORG", "ROOM", "SITES_URL", -"SHARED_DRIVE" +"SHARED_DRIVE", +"DRIVE_DOCUMENT" ], "enumDeprecated": [ false, @@ -2589,6 +2622,7 @@ true, false, false, false, +false, false ], "enumDescriptions": [ @@ -2599,7 +2633,8 @@ false "Search the data of all accounts in the organization. Supported only for Gmail. When specified, you don't need to specify **AccountInfo** or **OrgUnitInfo**.", "Search messages in the Chat spaces specified in [HangoutsChatInfo](https://developers.google.com/vault/reference/rest/v1/Query#hangoutschatinfo).", "Search for sites by the published site URLs specified in [SitesUrlInfo](https://developers.google.com/vault/reference/rest/v1/Query#sitesurlinfo).", -"Search the files in the shared drives specified in [SharedDriveInfo](https://developers.google.com/vault/reference/rest/v1/Query#shareddriveinfo)." +"Search the files in the shared drives specified in [SharedDriveInfo](https://developers.google.com/vault/reference/rest/v1/Query#shareddriveinfo).", +"Retrieve the documents specified in DriveDocumentInfo." ], "type": "string" }, From 65f557ad295453a4dca9ef29d0f1800bea102e7e Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 25 Feb 2025 07:08:20 +0000 Subject: [PATCH 34/36] feat(vmwareengine): update the api #### vmwareengine:v1 The following keys were added: - resources.projects.resources.locations.resources.announcements.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.announcements.methods.list (Total Keys: 20) - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.list (Total Keys: 20) - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.patch (Total Keys: 17) - schemas.Announcement (Total Keys: 21) - schemas.Constraints (Total Keys: 10) - schemas.Interval (Total Keys: 6) - schemas.ListAnnouncementsResponse (Total Keys: 7) - schemas.ListUpgradesResponse (Total Keys: 7) - schemas.Schedule (Total Keys: 12) - schemas.TimeOfDay (Total Keys: 10) - schemas.TimeWindow (Total Keys: 6) - schemas.Upgrade (Total Keys: 32) - schemas.VmwareUpgradeComponent (Total Keys: 6) --- ...e_v1.projects.locations.announcements.html | 183 +++++ .../vmwareengine_v1.projects.locations.html | 5 + ...e_v1.projects.locations.privateClouds.html | 5 + ...ects.locations.privateClouds.upgrades.html | 344 +++++++++ .../documents/vmwareengine.v1.json | 666 +++++++++++++++++- 5 files changed, 1202 insertions(+), 1 deletion(-) create mode 100644 docs/dyn/vmwareengine_v1.projects.locations.announcements.html create mode 100644 docs/dyn/vmwareengine_v1.projects.locations.privateClouds.upgrades.html diff --git a/docs/dyn/vmwareengine_v1.projects.locations.announcements.html b/docs/dyn/vmwareengine_v1.projects.locations.announcements.html new file mode 100644 index 00000000000..26b0f3758a5 --- /dev/null +++ b/docs/dyn/vmwareengine_v1.projects.locations.announcements.html @@ -0,0 +1,183 @@ + + + +

VMware Engine API . projects . locations . announcements

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Retrieves a `Announcement` by its resource name.

+

+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists `Announcements` for a given region and project

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Retrieves a `Announcement` by its resource name.
+
+Args:
+  name: string, Required. The resource name of the announcement to retrieve. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-west1-a/announcements/announcement-uuid` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Announcement for the resources of Vmware Engine.
+  "activityType": "A String", # Optional. Activity type of the announcement There can be only one active announcement for a given activity type and target resource.
+  "cluster": "A String", # A Cluster resource name.
+  "code": "A String", # Required. Code of the announcement. Indicates the presence of a VMware Engine related announcement and corresponds to a related message in the `description` field.
+  "createTime": "A String", # Output only. Creation time of this resource. It also serves as start time of notification.
+  "description": "A String", # Output only. Description of the announcement.
+  "metadata": { # Output only. Additional structured details about this announcement.
+    "a_key": "A String",
+  },
+  "name": "A String", # Output only. The resource name of the announcement. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-west1-a/announcements/my-announcement-id`
+  "privateCloud": "A String", # A Private Cloud resource name.
+  "state": "A String", # Output only. State of the resource. New values may be added to this enum when appropriate.
+  "targetResourceType": "A String", # Output only. Target Resource Type defines the type of the target for the announcement
+  "updateTime": "A String", # Output only. Last update time of this resource.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists `Announcements` for a given region and project
+
+Args:
+  parent: string, Required. The resource name of the location to be queried for announcements. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-west1-a` (required)
+  filter: string, A filter expression that matches resources returned in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be `=`, `!=`, `>`, or `<`. For example, if you are filtering a list of announcement runs, you can exclude the ones named `example-announcement` by specifying `name != "example-announcement"`. You can also filter nested fields. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (name = "example-announcement") (createTime > "2021-04-12T08:15:10.40Z") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (name = "announcement-1") AND (createTime > "2021-04-12T08:15:10.40Z") OR (name = "announcement-2") ```
+  orderBy: string, Sorts list results by a certain order. By default, returned results are ordered by `name` in ascending order. You can also sort results in descending order based on the `name` value using `orderBy="name desc"`. Currently, only ordering by `name` is supported.
+  pageSize: integer, The maximum number of announcements to return in one page. The service may return fewer than this value. The maximum value is coerced to 1000. The default value of this field is 500.
+  pageToken: string, A page token, received from a previous `ListAnnouncements` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAnnouncements` 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 VmwareEngine.ListAnnouncements
+  "announcements": [ # A list of announcement runs.
+    { # Announcement for the resources of Vmware Engine.
+      "activityType": "A String", # Optional. Activity type of the announcement There can be only one active announcement for a given activity type and target resource.
+      "cluster": "A String", # A Cluster resource name.
+      "code": "A String", # Required. Code of the announcement. Indicates the presence of a VMware Engine related announcement and corresponds to a related message in the `description` field.
+      "createTime": "A String", # Output only. Creation time of this resource. It also serves as start time of notification.
+      "description": "A String", # Output only. Description of the announcement.
+      "metadata": { # Output only. Additional structured details about this announcement.
+        "a_key": "A String",
+      },
+      "name": "A String", # Output only. The resource name of the announcement. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-west1-a/announcements/my-announcement-id`
+      "privateCloud": "A String", # A Private Cloud resource name.
+      "state": "A String", # Output only. State of the resource. New values may be added to this enum when appropriate.
+      "targetResourceType": "A String", # Output only. Target Resource Type defines the type of the target for the announcement
+      "updateTime": "A String", # Output only. Last update time of this resource.
+    },
+  ],
+  "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.
+  "unreachable": [ # list of unreachable 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.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/vmwareengine_v1.projects.locations.html b/docs/dyn/vmwareengine_v1.projects.locations.html index 15c83982d69..d175d15b41e 100644 --- a/docs/dyn/vmwareengine_v1.projects.locations.html +++ b/docs/dyn/vmwareengine_v1.projects.locations.html @@ -74,6 +74,11 @@

VMware Engine API . projects . locations

Instance Methods

+

+ announcements() +

+

Returns the announcements Resource.

+

dnsBindPermission()

diff --git a/docs/dyn/vmwareengine_v1.projects.locations.privateClouds.html b/docs/dyn/vmwareengine_v1.projects.locations.privateClouds.html index 0bf98646701..ee88dba37cb 100644 --- a/docs/dyn/vmwareengine_v1.projects.locations.privateClouds.html +++ b/docs/dyn/vmwareengine_v1.projects.locations.privateClouds.html @@ -104,6 +104,11 @@

Instance Methods

Returns the subnets Resource.

+

+ upgrades() +

+

Returns the upgrades Resource.

+

close()

Close httplib2 connections.

diff --git a/docs/dyn/vmwareengine_v1.projects.locations.privateClouds.upgrades.html b/docs/dyn/vmwareengine_v1.projects.locations.privateClouds.upgrades.html new file mode 100644 index 00000000000..7cebf6d2c05 --- /dev/null +++ b/docs/dyn/vmwareengine_v1.projects.locations.privateClouds.upgrades.html @@ -0,0 +1,344 @@ + + + +

VMware Engine API . projects . locations . privateClouds . upgrades

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Retrieves a private cloud `Upgrade` resource by its resource name.

+

+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists past, ongoing and upcoming `Upgrades` for the given private cloud.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)

+

Update the private cloud `Upgrade` resource. Only `schedule` field can updated. The schedule can only be updated when the upgrade has not started and schedule edit window is open. Only fields specified in `update_mask` are considered.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Retrieves a private cloud `Upgrade` resource by its resource name.
+
+Args:
+  name: string, Required. The name of the `Upgrade` resource to be retrieved. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-west1-a/privateClouds/my-cloud/upgrades/my-upgrade` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Describes Private cloud Upgrade.
+  "componentUpgrades": [ # Output only. Output Only. The list of component upgrades.
+    { # Per component upgrade resource
+      "componentType": "A String", # Output only. Type of component
+      "state": "A String", # Output only. Component's upgrade state.
+    },
+  ],
+  "createTime": "A String", # Output only. Output Only. Creation time of this resource.
+  "description": "A String", # Output only. Output Only. The description of the upgrade. This is used to provide additional information about the private cloud upgrade, such as the upgrade's purpose, the changes included in the upgrade, or any other relevant information about the upgrade.
+  "endTime": "A String", # Output only. Output Only. End time of the upgrade.
+  "estimatedDuration": "A String", # Output only. Output Only. The estimated total duration of the upgrade. This information can be used to plan or schedule upgrades to minimize disruptions. Please note that the estimated duration is only an estimate. The actual upgrade duration may vary.
+  "etag": "A String", # The etag for the upgrade resource. If this is provided on update, it must match the server's etag.
+  "name": "A String", # Output only. Identifier. The resource name of the private cloud `Upgrade`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-west1-a/privateClouds/my-cloud/upgrades/my-upgrade`
+  "schedule": { # Schedule for the upgrade. # Schedule details for the upgrade.
+    "constraints": { # Constraints to be applied while editing a schedule. These constraints ensure that `Upgrade` specific requirements are met. # Output only. Output Only. Constraints applied to the schedule. These constraints should be applicable at the time of any rescheduling.
+      "minHoursDay": 42, # Output only. Minimum number of hours must be allotted for the upgrade activities for each selected day. This is a minimum; the upgrade schedule can allot more hours for the given day.
+      "minHoursWeek": 42, # Output only. The minimum number of weekly hours must be allotted for the upgrade activities. This is just a minimum; the schedule can assign more weekly hours.
+      "rescheduleDateRange": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Output only. Output Only. The user can only reschedule an upgrade that starts within this range.
+        "endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
+        "startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
+      },
+    },
+    "editWindow": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Output only. Output Only. The schedule is open for edits during this time interval or window.
+      "endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
+      "startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
+    },
+    "lastEditor": "A String", # Output only. Output Only. Indicates who most recently edited the upgrade schedule. The value is updated whenever the upgrade is rescheduled.
+    "startTime": "A String", # Required. The scheduled start time for the upgrade.
+    "weeklyWindows": [ # Required. Weekly time windows for upgrade activities. The server performs upgrade activities during these time windows to minimize disruptions.
+      { # Represents the time window to perform upgrade activities.
+        "dayOfWeek": "A String", # Required. Day of the week for this window.
+        "duration": "A String", # Required. The duration of the window. The max allowed duration for any window is 24 hours.
+        "startTime": { # 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`. # Required. Time in UTC when the window starts.
+          "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.
+        },
+      },
+    ],
+  },
+  "startVersion": "A String", # Output only. Output Only. The start version
+  "state": "A String", # Output only. The current state of the upgrade.
+  "targetVersion": "A String", # Output only. Output Only. The target version
+  "type": "A String", # Output only. Output Only. The type of upgrade.
+  "uid": "A String", # Output only. System-generated unique identifier for the resource.
+  "updateTime": "A String", # Output only. Output Only. Last update time of this resource.
+  "version": "A String", # Output only.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists past, ongoing and upcoming `Upgrades` for the given private cloud.
+
+Args:
+  parent: string, Required. Query a list of `Upgrades` for the given private cloud resource name. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-west1-a/privateClouds/my-cloud` (required)
+  filter: string, A filter expression that matches resources returned in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be `=`, `!=`, `>`, or `<`. For example, if you are filtering a list of upgrades, you can exclude the ones named `example-upgrade1` by specifying `name != "example-upgrade1"`. You can also filter nested fields. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (name = "example-upgrade") (createTime > "2021-04-12T08:15:10.40Z") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (name = "upgrade-1") AND (createTime > "2021-04-12T08:15:10.40Z") OR (name = "upgrade-2") ```
+  orderBy: string, Sorts list results by a certain order. By default, returned results are ordered by `name` in ascending order. You can also sort results in descending order based on the `name` value using `orderBy="name desc"`. Currently, only ordering by `name` is supported.
+  pageSize: integer, The maximum number of `Upgrades` to return in one page. The service may return fewer resources than this value. The maximum value is coerced to 1000. The default value of this field is 500.
+  pageToken: string, A page token, received from a previous `ListUpgrades` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUpgrades` 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 VmwareEngine.ListUpgrades.
+  "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.
+  "unreachable": [ # List of unreachable resources.
+    "A String",
+  ],
+  "upgrades": [ # A list of `Upgrades`.
+    { # Describes Private cloud Upgrade.
+      "componentUpgrades": [ # Output only. Output Only. The list of component upgrades.
+        { # Per component upgrade resource
+          "componentType": "A String", # Output only. Type of component
+          "state": "A String", # Output only. Component's upgrade state.
+        },
+      ],
+      "createTime": "A String", # Output only. Output Only. Creation time of this resource.
+      "description": "A String", # Output only. Output Only. The description of the upgrade. This is used to provide additional information about the private cloud upgrade, such as the upgrade's purpose, the changes included in the upgrade, or any other relevant information about the upgrade.
+      "endTime": "A String", # Output only. Output Only. End time of the upgrade.
+      "estimatedDuration": "A String", # Output only. Output Only. The estimated total duration of the upgrade. This information can be used to plan or schedule upgrades to minimize disruptions. Please note that the estimated duration is only an estimate. The actual upgrade duration may vary.
+      "etag": "A String", # The etag for the upgrade resource. If this is provided on update, it must match the server's etag.
+      "name": "A String", # Output only. Identifier. The resource name of the private cloud `Upgrade`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-west1-a/privateClouds/my-cloud/upgrades/my-upgrade`
+      "schedule": { # Schedule for the upgrade. # Schedule details for the upgrade.
+        "constraints": { # Constraints to be applied while editing a schedule. These constraints ensure that `Upgrade` specific requirements are met. # Output only. Output Only. Constraints applied to the schedule. These constraints should be applicable at the time of any rescheduling.
+          "minHoursDay": 42, # Output only. Minimum number of hours must be allotted for the upgrade activities for each selected day. This is a minimum; the upgrade schedule can allot more hours for the given day.
+          "minHoursWeek": 42, # Output only. The minimum number of weekly hours must be allotted for the upgrade activities. This is just a minimum; the schedule can assign more weekly hours.
+          "rescheduleDateRange": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Output only. Output Only. The user can only reschedule an upgrade that starts within this range.
+            "endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
+            "startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
+          },
+        },
+        "editWindow": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Output only. Output Only. The schedule is open for edits during this time interval or window.
+          "endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
+          "startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
+        },
+        "lastEditor": "A String", # Output only. Output Only. Indicates who most recently edited the upgrade schedule. The value is updated whenever the upgrade is rescheduled.
+        "startTime": "A String", # Required. The scheduled start time for the upgrade.
+        "weeklyWindows": [ # Required. Weekly time windows for upgrade activities. The server performs upgrade activities during these time windows to minimize disruptions.
+          { # Represents the time window to perform upgrade activities.
+            "dayOfWeek": "A String", # Required. Day of the week for this window.
+            "duration": "A String", # Required. The duration of the window. The max allowed duration for any window is 24 hours.
+            "startTime": { # 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`. # Required. Time in UTC when the window starts.
+              "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.
+            },
+          },
+        ],
+      },
+      "startVersion": "A String", # Output only. Output Only. The start version
+      "state": "A String", # Output only. The current state of the upgrade.
+      "targetVersion": "A String", # Output only. Output Only. The target version
+      "type": "A String", # Output only. Output Only. The type of upgrade.
+      "uid": "A String", # Output only. System-generated unique identifier for the resource.
+      "updateTime": "A String", # Output only. Output Only. Last update time of this resource.
+      "version": "A String", # Output only.
+    },
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None) +
Update the private cloud `Upgrade` resource. Only `schedule` field can updated. The schedule can only be updated when the upgrade has not started and schedule edit window is open. Only fields specified in `update_mask` are considered.
+
+Args:
+  name: string, Output only. Identifier. The resource name of the private cloud `Upgrade`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-west1-a/privateClouds/my-cloud/upgrades/my-upgrade` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Describes Private cloud Upgrade.
+  "componentUpgrades": [ # Output only. Output Only. The list of component upgrades.
+    { # Per component upgrade resource
+      "componentType": "A String", # Output only. Type of component
+      "state": "A String", # Output only. Component's upgrade state.
+    },
+  ],
+  "createTime": "A String", # Output only. Output Only. Creation time of this resource.
+  "description": "A String", # Output only. Output Only. The description of the upgrade. This is used to provide additional information about the private cloud upgrade, such as the upgrade's purpose, the changes included in the upgrade, or any other relevant information about the upgrade.
+  "endTime": "A String", # Output only. Output Only. End time of the upgrade.
+  "estimatedDuration": "A String", # Output only. Output Only. The estimated total duration of the upgrade. This information can be used to plan or schedule upgrades to minimize disruptions. Please note that the estimated duration is only an estimate. The actual upgrade duration may vary.
+  "etag": "A String", # The etag for the upgrade resource. If this is provided on update, it must match the server's etag.
+  "name": "A String", # Output only. Identifier. The resource name of the private cloud `Upgrade`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-west1-a/privateClouds/my-cloud/upgrades/my-upgrade`
+  "schedule": { # Schedule for the upgrade. # Schedule details for the upgrade.
+    "constraints": { # Constraints to be applied while editing a schedule. These constraints ensure that `Upgrade` specific requirements are met. # Output only. Output Only. Constraints applied to the schedule. These constraints should be applicable at the time of any rescheduling.
+      "minHoursDay": 42, # Output only. Minimum number of hours must be allotted for the upgrade activities for each selected day. This is a minimum; the upgrade schedule can allot more hours for the given day.
+      "minHoursWeek": 42, # Output only. The minimum number of weekly hours must be allotted for the upgrade activities. This is just a minimum; the schedule can assign more weekly hours.
+      "rescheduleDateRange": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Output only. Output Only. The user can only reschedule an upgrade that starts within this range.
+        "endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
+        "startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
+      },
+    },
+    "editWindow": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Output only. Output Only. The schedule is open for edits during this time interval or window.
+      "endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
+      "startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
+    },
+    "lastEditor": "A String", # Output only. Output Only. Indicates who most recently edited the upgrade schedule. The value is updated whenever the upgrade is rescheduled.
+    "startTime": "A String", # Required. The scheduled start time for the upgrade.
+    "weeklyWindows": [ # Required. Weekly time windows for upgrade activities. The server performs upgrade activities during these time windows to minimize disruptions.
+      { # Represents the time window to perform upgrade activities.
+        "dayOfWeek": "A String", # Required. Day of the week for this window.
+        "duration": "A String", # Required. The duration of the window. The max allowed duration for any window is 24 hours.
+        "startTime": { # 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`. # Required. Time in UTC when the window starts.
+          "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.
+        },
+      },
+    ],
+  },
+  "startVersion": "A String", # Output only. Output Only. The start version
+  "state": "A String", # Output only. The current state of the upgrade.
+  "targetVersion": "A String", # Output only. Output Only. The target version
+  "type": "A String", # Output only. Output Only. The type of upgrade.
+  "uid": "A String", # Output only. System-generated unique identifier for the resource.
+  "updateTime": "A String", # Output only. Output Only. Last update time of this resource.
+  "version": "A String", # Output only.
+}
+
+  requestId: string, Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the `Upgrade` resource by the update. The fields specified in the `update_mask` are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
+  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.
+  },
+}
+
+ + \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/vmwareengine.v1.json b/googleapiclient/discovery_cache/documents/vmwareengine.v1.json index 324ec696470..4f8e8f74e4a 100644 --- a/googleapiclient/discovery_cache/documents/vmwareengine.v1.json +++ b/googleapiclient/discovery_cache/documents/vmwareengine.v1.json @@ -202,6 +202,81 @@ } }, "resources": { +"announcements": { +"methods": { +"get": { +"description": "Retrieves a `Announcement` by its resource name.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/announcements/{announcementsId}", +"httpMethod": "GET", +"id": "vmwareengine.projects.locations.announcements.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the announcement to retrieve. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-west1-a/announcements/announcement-uuid`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/announcements/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Announcement" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists `Announcements` for a given region and project", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/announcements", +"httpMethod": "GET", +"id": "vmwareengine.projects.locations.announcements.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "A filter expression that matches resources returned in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be `=`, `!=`, `>`, or `<`. For example, if you are filtering a list of announcement runs, you can exclude the ones named `example-announcement` by specifying `name != \"example-announcement\"`. You can also filter nested fields. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (name = \"example-announcement\") (createTime > \"2021-04-12T08:15:10.40Z\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (name = \"announcement-1\") AND (createTime > \"2021-04-12T08:15:10.40Z\") OR (name = \"announcement-2\") ```", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, returned results are ordered by `name` in ascending order. You can also sort results in descending order based on the `name` value using `orderBy=\"name desc\"`. Currently, only ordering by `name` is supported.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "The maximum number of announcements to return in one page. The service may return fewer than this value. The maximum value is coerced to 1000. The default value of this field is 500.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A page token, received from a previous `ListAnnouncements` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAnnouncements` must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The resource name of the location to be queried for announcements. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-west1-a`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/announcements", +"response": { +"$ref": "ListAnnouncementsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "dnsBindPermission": { "methods": { "grant": { @@ -2754,6 +2829,120 @@ ] } } +}, +"upgrades": { +"methods": { +"get": { +"description": "Retrieves a private cloud `Upgrade` resource by its resource name.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/upgrades/{upgradesId}", +"httpMethod": "GET", +"id": "vmwareengine.projects.locations.privateClouds.upgrades.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the `Upgrade` resource to be retrieved. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-west1-a/privateClouds/my-cloud/upgrades/my-upgrade`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+/upgrades/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Upgrade" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists past, ongoing and upcoming `Upgrades` for the given private cloud.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/upgrades", +"httpMethod": "GET", +"id": "vmwareengine.projects.locations.privateClouds.upgrades.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "A filter expression that matches resources returned in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be `=`, `!=`, `>`, or `<`. For example, if you are filtering a list of upgrades, you can exclude the ones named `example-upgrade1` by specifying `name != \"example-upgrade1\"`. You can also filter nested fields. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (name = \"example-upgrade\") (createTime > \"2021-04-12T08:15:10.40Z\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (name = \"upgrade-1\") AND (createTime > \"2021-04-12T08:15:10.40Z\") OR (name = \"upgrade-2\") ```", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, returned results are ordered by `name` in ascending order. You can also sort results in descending order based on the `name` value using `orderBy=\"name desc\"`. Currently, only ordering by `name` is supported.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "The maximum number of `Upgrades` to return in one page. The service may return fewer resources than this value. The maximum value is coerced to 1000. The default value of this field is 500.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A page token, received from a previous `ListUpgrades` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUpgrades` must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Query a list of `Upgrades` for the given private cloud resource name. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-west1-a/privateClouds/my-cloud`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/upgrades", +"response": { +"$ref": "ListUpgradesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Update the private cloud `Upgrade` resource. Only `schedule` field can updated. The schedule can only be updated when the upgrade has not started and schedule edit window is open. Only fields specified in `update_mask` are considered.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/upgrades/{upgradesId}", +"httpMethod": "PATCH", +"id": "vmwareengine.projects.locations.privateClouds.upgrades.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Output only. Identifier. The resource name of the private cloud `Upgrade`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-west1-a/privateClouds/my-cloud/upgrades/my-upgrade`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+/upgrades/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"updateMask": { +"description": "Required. Field mask is used to specify the fields to be overwritten in the `Upgrade` resource by the update. The fields specified in the `update_mask` are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "Upgrade" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} } } }, @@ -3173,9 +3362,86 @@ } } }, -"revision": "20241009", +"revision": "20250218", "rootUrl": "https://vmwareengine.googleapis.com/", "schemas": { +"Announcement": { +"description": "Announcement for the resources of Vmware Engine.", +"id": "Announcement", +"properties": { +"activityType": { +"description": "Optional. Activity type of the announcement There can be only one active announcement for a given activity type and target resource.", +"type": "string" +}, +"cluster": { +"description": "A Cluster resource name.", +"type": "string" +}, +"code": { +"description": "Required. Code of the announcement. Indicates the presence of a VMware Engine related announcement and corresponds to a related message in the `description` field.", +"type": "string" +}, +"createTime": { +"description": "Output only. Creation time of this resource. It also serves as start time of notification.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "Output only. Description of the announcement.", +"readOnly": true, +"type": "string" +}, +"metadata": { +"additionalProperties": { +"type": "string" +}, +"description": "Output only. Additional structured details about this announcement.", +"readOnly": true, +"type": "object" +}, +"name": { +"description": "Output only. The resource name of the announcement. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-west1-a/announcements/my-announcement-id`", +"readOnly": true, +"type": "string" +}, +"privateCloud": { +"description": "A Private Cloud resource name.", +"type": "string" +}, +"state": { +"description": "Output only. State of the resource. New values may be added to this enum when appropriate.", +"enum": [ +"STATE_UNSPECIFIED", +"ACTIVE", +"INACTIVE", +"DELETING", +"CREATING" +], +"enumDescriptions": [ +"The default value. This value should never be used.", +"Active announcement which should be visible to user.", +"Inactive announcement which should not be visible to user.", +"Announcement which is being deleted", +"Announcement which being created" +], +"readOnly": true, +"type": "string" +}, +"targetResourceType": { +"description": "Output only. Target Resource Type defines the type of the target for the announcement", +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. Last update time of this resource.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "AuditConfig": { "description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.", "id": "AuditConfig", @@ -3377,6 +3643,30 @@ }, "type": "object" }, +"Constraints": { +"description": "Constraints to be applied while editing a schedule. These constraints ensure that `Upgrade` specific requirements are met.", +"id": "Constraints", +"properties": { +"minHoursDay": { +"description": "Output only. Minimum number of hours must be allotted for the upgrade activities for each selected day. This is a minimum; the upgrade schedule can allot more hours for the given day.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"minHoursWeek": { +"description": "Output only. The minimum number of weekly hours must be allotted for the upgrade activities. This is just a minimum; the schedule can assign more weekly hours.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"rescheduleDateRange": { +"$ref": "Interval", +"description": "Output only. Output Only. The user can only reschedule an upgrade that starts within this range.", +"readOnly": true +} +}, +"type": "object" +}, "Credentials": { "description": "Credentials for a private cloud.", "id": "Credentials", @@ -3768,6 +4058,23 @@ }, "type": "object" }, +"Interval": { +"description": "Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time.", +"id": "Interval", +"properties": { +"endTime": { +"description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.", +"format": "google-datetime", +"type": "string" +}, +"startTime": { +"description": "Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "IpRange": { "description": "An IP range provided in any one of the supported formats.", "id": "IpRange", @@ -3787,6 +4094,31 @@ }, "type": "object" }, +"ListAnnouncementsResponse": { +"description": "Response message for VmwareEngine.ListAnnouncements", +"id": "ListAnnouncementsResponse", +"properties": { +"announcements": { +"description": "A list of announcement runs.", +"items": { +"$ref": "Announcement" +}, +"type": "array" +}, +"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" +}, +"unreachable": { +"description": "list of unreachable locations", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "ListClustersResponse": { "description": "Response message for VmwareEngine.ListClusters", "id": "ListClustersResponse", @@ -4177,6 +4509,31 @@ }, "type": "object" }, +"ListUpgradesResponse": { +"description": "Response message for VmwareEngine.ListUpgrades.", +"id": "ListUpgradesResponse", +"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" +}, +"unreachable": { +"description": "List of unreachable resources.", +"items": { +"type": "string" +}, +"type": "array" +}, +"upgrades": { +"description": "A list of `Upgrades`.", +"items": { +"$ref": "Upgrade" +}, +"type": "array" +} +}, +"type": "object" +}, "ListVmwareEngineNetworksResponse": { "description": "Response message for VmwareEngine.ListVmwareEngineNetworks", "id": "ListVmwareEngineNetworksResponse", @@ -5307,6 +5664,50 @@ }, "type": "object" }, +"Schedule": { +"description": "Schedule for the upgrade.", +"id": "Schedule", +"properties": { +"constraints": { +"$ref": "Constraints", +"description": "Output only. Output Only. Constraints applied to the schedule. These constraints should be applicable at the time of any rescheduling.", +"readOnly": true +}, +"editWindow": { +"$ref": "Interval", +"description": "Output only. Output Only. The schedule is open for edits during this time interval or window.", +"readOnly": true +}, +"lastEditor": { +"description": "Output only. Output Only. Indicates who most recently edited the upgrade schedule. The value is updated whenever the upgrade is rescheduled.", +"enum": [ +"EDITOR_UNSPECIFIED", +"SYSTEM", +"USER" +], +"enumDescriptions": [ +"The default value. This value should never be used.", +"The upgrade is scheduled by the System or internal service.", +"The upgrade is scheduled by the end user." +], +"readOnly": true, +"type": "string" +}, +"startTime": { +"description": "Required. The scheduled start time for the upgrade.", +"format": "google-datetime", +"type": "string" +}, +"weeklyWindows": { +"description": "Required. Weekly time windows for upgrade activities. The server performs upgrade activities during these time windows to minimize disruptions.", +"items": { +"$ref": "TimeWindow" +}, +"type": "array" +} +}, +"type": "object" +}, "SetIamPolicyRequest": { "description": "Request message for `SetIamPolicy` method.", "id": "SetIamPolicyRequest", @@ -5464,6 +5865,73 @@ }, "type": "object" }, +"TimeOfDay": { +"description": "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`.", +"id": "TimeOfDay", +"properties": { +"hours": { +"description": "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.", +"format": "int32", +"type": "integer" +}, +"minutes": { +"description": "Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.", +"format": "int32", +"type": "integer" +}, +"nanos": { +"description": "Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.", +"format": "int32", +"type": "integer" +}, +"seconds": { +"description": "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.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"TimeWindow": { +"description": "Represents the time window to perform upgrade activities.", +"id": "TimeWindow", +"properties": { +"dayOfWeek": { +"description": "Required. Day of the week for this window.", +"enum": [ +"DAY_OF_WEEK_UNSPECIFIED", +"MONDAY", +"TUESDAY", +"WEDNESDAY", +"THURSDAY", +"FRIDAY", +"SATURDAY", +"SUNDAY" +], +"enumDescriptions": [ +"The day of the week is unspecified.", +"Monday", +"Tuesday", +"Wednesday", +"Thursday", +"Friday", +"Saturday", +"Sunday" +], +"type": "string" +}, +"duration": { +"description": "Required. The duration of the window. The max allowed duration for any window is 24 hours.", +"format": "google-duration", +"type": "string" +}, +"startTime": { +"$ref": "TimeOfDay", +"description": "Required. Time in UTC when the window starts." +} +}, +"type": "object" +}, "UndeletePrivateCloudRequest": { "description": "Request message for VmwareEngine.UndeletePrivateCloud", "id": "UndeletePrivateCloudRequest", @@ -5475,6 +5943,135 @@ }, "type": "object" }, +"Upgrade": { +"description": "Describes Private cloud Upgrade.", +"id": "Upgrade", +"properties": { +"componentUpgrades": { +"description": "Output only. Output Only. The list of component upgrades.", +"items": { +"$ref": "VmwareUpgradeComponent" +}, +"readOnly": true, +"type": "array" +}, +"createTime": { +"description": "Output only. Output Only. Creation time of this resource.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "Output only. Output Only. The description of the upgrade. This is used to provide additional information about the private cloud upgrade, such as the upgrade's purpose, the changes included in the upgrade, or any other relevant information about the upgrade.", +"readOnly": true, +"type": "string" +}, +"endTime": { +"description": "Output only. Output Only. End time of the upgrade.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"estimatedDuration": { +"description": "Output only. Output Only. The estimated total duration of the upgrade. This information can be used to plan or schedule upgrades to minimize disruptions. Please note that the estimated duration is only an estimate. The actual upgrade duration may vary.", +"format": "google-duration", +"readOnly": true, +"type": "string" +}, +"etag": { +"description": "The etag for the upgrade resource. If this is provided on update, it must match the server's etag.", +"type": "string" +}, +"name": { +"description": "Output only. Identifier. The resource name of the private cloud `Upgrade`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-west1-a/privateClouds/my-cloud/upgrades/my-upgrade`", +"readOnly": true, +"type": "string" +}, +"schedule": { +"$ref": "Schedule", +"description": "Schedule details for the upgrade." +}, +"startVersion": { +"description": "Output only. Output Only. The start version", +"readOnly": true, +"type": "string" +}, +"state": { +"description": "Output only. The current state of the upgrade.", +"enum": [ +"STATE_UNSPECIFIED", +"SCHEDULED", +"ONGOING", +"SUCCEEDED", +"PAUSED", +"FAILED", +"CANCELLING", +"CANCELLED", +"RESCHEDULING" +], +"enumDescriptions": [ +"The default value. This value should never be used.", +"The upgrade is scheduled but not started yet.", +"The upgrade is currently in progress and has not completed yet.", +"The upgrade completed successfully.", +"The upgrade is currently paused.", +"The upgrade failed.", +"The upgrade is in process of being canceled.", +"The upgrade is canceled.", +"The upgrade is in process of being rescheduled." +], +"readOnly": true, +"type": "string" +}, +"targetVersion": { +"description": "Output only. Output Only. The target version", +"readOnly": true, +"type": "string" +}, +"type": { +"description": "Output only. Output Only. The type of upgrade.", +"enum": [ +"TYPE_UNSPECIFIED", +"VSPHERE_UPGRADE", +"VSPHERE_PATCH", +"WORKAROUND", +"FIRMWARE_UPGRADE", +"SWITCH_UPGRADE", +"OTHER", +"INFRASTRUCTURE_UPGRADE" +], +"enumDescriptions": [ +"The default value. This value should never be used.", +"Upgrade of vmware components when a major version is available. 7.0u2 -> 7.0u3.", +"Patching of vmware components when a minor version is available. 7.0u2c -> 7.0u2d.", +"Workarounds are hotfixes for vulnerabilities or issues applied to mitigate the known vulnerability or issue until a patch or update is released. The description of the upgrade will have more details.", +"Firmware upgrade for VMware product used in the private cloud.", +"Switch upgrade.", +"The upgrade type that doesn't fall into any other category.", +"Infrastructure upgrade in BM node maintenance." +], +"readOnly": true, +"type": "string" +}, +"uid": { +"description": "Output only. System-generated unique identifier for the resource.", +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. Output Only. Last update time of this resource.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"version": { +"description": "Output only. ", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "Vcenter": { "description": "Details about a vCenter Server management appliance.", "id": "Vcenter", @@ -5587,6 +6184,73 @@ }, "type": "object" }, +"VmwareUpgradeComponent": { +"description": "Per component upgrade resource", +"id": "VmwareUpgradeComponent", +"properties": { +"componentType": { +"description": "Output only. Type of component", +"enum": [ +"VMWARE_COMPONENT_TYPE_UNSPECIFIED", +"VCENTER", +"ESXI", +"NSXT_UC", +"NSXT_EDGE", +"NSXT_MGR", +"HCX", +"VSAN", +"DVS", +"NAMESERVER_VM", +"KMS_VM", +"WITNESS_VM", +"NSXT", +"CLUSTER" +], +"enumDescriptions": [ +"The default value. This value should never be used.", +"vcenter", +"esxi nodes + transport nodes", +"nsxt upgrade coordinator", +"nsxt edges cluster", +"nsxt managers/management plane", +"hcx", +"VSAN cluster", +"DVS switch", +"Nameserver VMs", +"KMS VM used for vsan encryption", +"witness VM in case of stretch PC", +"nsxt", +"Cluster is used in case of BM" +], +"readOnly": true, +"type": "string" +}, +"state": { +"description": "Output only. Component's upgrade state.", +"enum": [ +"STATE_UNSPECIFIED", +"RUNNING", +"PAUSED", +"SUCCEEDED", +"FAILED", +"NOT_STARTED", +"NOT_APPLICABLE" +], +"enumDescriptions": [ +"The default value. This value should never be used.", +"Component's upgrade is in progress", +"The component's upgrade is paused. Will be resumed when upgrade job is resumed", +"The component's upgrade is successfully completed", +"The component's upgrade has failed. This will move to resume if upgrade is resumed or stay as is", +"Component's upgrade has not started yet", +"Component's upgrade is not applicable in this upgrade. It will be skipped." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "VpcNetwork": { "description": "Represents a VMware Engine VPC network that is managed by a VMware Engine network resource.", "id": "VpcNetwork", From e994041c9c21df16d316162558a46a3f590d6dda Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 25 Feb 2025 07:08:20 +0000 Subject: [PATCH 35/36] feat(workloadmanager): update the api #### workloadmanager:v1 The following keys were added: - resources.projects.resources.locations.resources.discoveredprofiles.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.discoveredprofiles.methods.list (Total Keys: 18) - resources.projects.resources.locations.resources.discoveredprofiles.resources.healthes.methods.get (Total Keys: 11) - schemas.APILayerServer (Total Keys: 9) - schemas.AvailabilityGroup (Total Keys: 12) - schemas.BackendServer (Total Keys: 13) - schemas.BackupProperties (Total Keys: 6) - schemas.CloudResource (Total Keys: 8) - schemas.Cluster (Total Keys: 7) - schemas.ComponentHealth (Total Keys: 13) - schemas.Database (Total Keys: 16) - schemas.FrontEndServer (Total Keys: 9) - schemas.HealthCheck (Total Keys: 12) - schemas.Instance (Total Keys: 18) - schemas.Layer (Total Keys: 8) - schemas.ListDiscoveredProfilesResponse (Total Keys: 9) - schemas.LoadBalancerServer (Total Keys: 6) - schemas.Product (Total Keys: 4) - schemas.SapComponent (Total Keys: 12) - schemas.SapInstanceProperties (Total Keys: 4) - schemas.SapWorkload (Total Keys: 14) - schemas.SqlserverWorkload (Total Keys: 12) - schemas.ThreeTierWorkload (Total Keys: 10) - schemas.UpcomingMaintenanceEvent (Total Keys: 8) - schemas.WorkloadProfile (Total Keys: 28) --- ...locations.discoveredprofiles.healthes.html | 152 +++ ...projects.locations.discoveredprofiles.html | 685 +++++++++++ ...workloadmanager_v1.projects.locations.html | 5 + .../documents/workloadmanager.v1.json | 1082 ++++++++++++++++- 4 files changed, 1894 insertions(+), 30 deletions(-) create mode 100644 docs/dyn/workloadmanager_v1.projects.locations.discoveredprofiles.healthes.html create mode 100644 docs/dyn/workloadmanager_v1.projects.locations.discoveredprofiles.html diff --git a/docs/dyn/workloadmanager_v1.projects.locations.discoveredprofiles.healthes.html b/docs/dyn/workloadmanager_v1.projects.locations.discoveredprofiles.healthes.html new file mode 100644 index 00000000000..6c15d1b1af5 --- /dev/null +++ b/docs/dyn/workloadmanager_v1.projects.locations.discoveredprofiles.healthes.html @@ -0,0 +1,152 @@ + + + +

Workload Manager API . projects . locations . discoveredprofiles . healthes

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Get the health of a discovered workload profile.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Get the health of a discovered workload profile.
+
+Args:
+  name: string, Required. The resource name (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # WorkloadProfileHealth contains the detailed health check of workload.
+  "checkTime": "A String", # The time when the health check was performed.
+  "componentHealthes": [ # The detailed condition reports of each component.
+    { # HealthCondition contains the detailed health check of each component.
+      "component": "A String", # The component of a workload.
+      "componentHealthChecks": [ # The detailed health checks of the component.
+        { # HealthCheck contains the detailed health check of a component based on asource.
+          "message": "A String", # Output only. The message of the health check.
+          "metric": "A String", # Output only. The health check source metric name.
+          "resource": { # The resource on GCP # Output only. The resource the check performs on.
+            "instanceProperties": { # Instance Properties. # Output only. All instance properties.
+              "instanceNumber": "A String", # Optional. Instance number.
+              "machineType": "A String", # Optional. Instance machine type.
+              "role": "A String", # Optional. Instance role.
+              "roles": [ # Optional. Instance roles.
+                "A String",
+              ],
+              "sapInstanceProperties": { # SAP instance properties. # Optional. SAP Instance properties.
+                "numbers": [ # Optional. SAP Instance numbers. They are from '00' to '99'.
+                  "A String",
+                ],
+              },
+              "status": "A String", # Optional. Instance status.
+              "upcomingMaintenanceEvent": { # Maintenance Event # Optional. the next maintenance event on VM
+                "endTime": "A String", # Optional. End time
+                "maintenanceStatus": "A String", # Optional. Maintenance status
+                "startTime": "A String", # Optional. Start time
+                "type": "A String", # Optional. Type
+              },
+            },
+            "kind": "A String", # Output only. ComputeInstance, ComputeDisk, VPC, Bare Metal server, etc.
+            "name": "A String", # Output only. resource name
+          },
+          "source": "A String", # Output only. The source of the health check.
+          "state": "A String", # Output only. The state of the health check.
+        },
+      ],
+      "componentHealthType": "A String", # Output only. The type of the component health.
+      "isRequired": True or False, # Output only. The requirement of the component.
+      "state": "A String", # Output only. The health state of the component.
+      "subComponentHealthes": [ # Sub component health.
+        # Object with schema name: ComponentHealth
+      ],
+    },
+  ],
+  "state": "A String", # Output only. The health state of the workload.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/workloadmanager_v1.projects.locations.discoveredprofiles.html b/docs/dyn/workloadmanager_v1.projects.locations.discoveredprofiles.html new file mode 100644 index 00000000000..8355966ea24 --- /dev/null +++ b/docs/dyn/workloadmanager_v1.projects.locations.discoveredprofiles.html @@ -0,0 +1,685 @@ + + + +

Workload Manager API . projects . locations . discoveredprofiles

+

Instance Methods

+

+ healthes() +

+

Returns the healthes Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets details of a discovered workload profile.

+

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

+

List discovered workload profiles

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets details of a discovered workload profile.
+
+Args:
+  name: string, Required. Name of the resource (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # workload resource
+  "application": { # The database layer # Optional. The application layer
+    "applicationType": "A String", # the application layer
+    "databaseType": "A String", # Optional. the database layer
+    "instances": [ # Optional. instances in a layer
+      { # a vm instance
+        "name": "A String", # Output only. name of the VM
+        "region": "A String", # Output only. The location of the VM
+        "status": "A String", # Output only. The state of the VM
+      },
+    ],
+    "sid": "A String", # Output only. system identification of a layer
+  },
+  "ascs": { # The database layer # Optional. The ascs layer
+    "applicationType": "A String", # the application layer
+    "databaseType": "A String", # Optional. the database layer
+    "instances": [ # Optional. instances in a layer
+      { # a vm instance
+        "name": "A String", # Output only. name of the VM
+        "region": "A String", # Output only. The location of the VM
+        "status": "A String", # Output only. The state of the VM
+      },
+    ],
+    "sid": "A String", # Output only. system identification of a layer
+  },
+  "database": { # The database layer # Optional. The database layer
+    "applicationType": "A String", # the application layer
+    "databaseType": "A String", # Optional. the database layer
+    "instances": [ # Optional. instances in a layer
+      { # a vm instance
+        "name": "A String", # Output only. name of the VM
+        "region": "A String", # Output only. The location of the VM
+        "status": "A String", # Output only. The state of the VM
+      },
+    ],
+    "sid": "A String", # Output only. system identification of a layer
+  },
+  "labels": { # Optional. such as name, description, version. More example can be found in deployment
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. name of resource names have the form 'projects/{project_id}/workloads/{workload_id}'
+  "refreshedTime": "A String", # Required. time when the workload data was refreshed
+  "sapWorkload": { # The body of sap workload # The sap workload content
+    "application": { # The component of sap workload # Output only. the acsc componment
+      "databaseProperties": { # Database Properties. # Output only. All instance properties.
+        "backupProperties": { # Backup properties. # Output only. Backup properties.
+          "latestBackupStatus": "A String", # Output only. The state of the latest backup.
+          "latestBackupTime": "A String", # The time when the latest backup was performed.
+        },
+        "databaseType": "A String", # Output only. Type of the database. HANA, DB2, etc.
+      },
+      "haHosts": [ # A list of host URIs that are part of the HA configuration if present. An empty list indicates the component is not configured for HA.
+        "A String",
+      ],
+      "resources": [ # Output only. resources in the component
+        { # The resource on GCP
+          "instanceProperties": { # Instance Properties. # Output only. All instance properties.
+            "instanceNumber": "A String", # Optional. Instance number.
+            "machineType": "A String", # Optional. Instance machine type.
+            "role": "A String", # Optional. Instance role.
+            "roles": [ # Optional. Instance roles.
+              "A String",
+            ],
+            "sapInstanceProperties": { # SAP instance properties. # Optional. SAP Instance properties.
+              "numbers": [ # Optional. SAP Instance numbers. They are from '00' to '99'.
+                "A String",
+              ],
+            },
+            "status": "A String", # Optional. Instance status.
+            "upcomingMaintenanceEvent": { # Maintenance Event # Optional. the next maintenance event on VM
+              "endTime": "A String", # Optional. End time
+              "maintenanceStatus": "A String", # Optional. Maintenance status
+              "startTime": "A String", # Optional. Start time
+              "type": "A String", # Optional. Type
+            },
+          },
+          "kind": "A String", # Output only. ComputeInstance, ComputeDisk, VPC, Bare Metal server, etc.
+          "name": "A String", # Output only. resource name
+        },
+      ],
+      "sid": "A String", # Output only. sid is the sap component identificator
+      "topologyType": "A String", # The detected topology of the component.
+    },
+    "architecture": "A String", # Output only. the architecture
+    "database": { # The component of sap workload # Output only. the database componment
+      "databaseProperties": { # Database Properties. # Output only. All instance properties.
+        "backupProperties": { # Backup properties. # Output only. Backup properties.
+          "latestBackupStatus": "A String", # Output only. The state of the latest backup.
+          "latestBackupTime": "A String", # The time when the latest backup was performed.
+        },
+        "databaseType": "A String", # Output only. Type of the database. HANA, DB2, etc.
+      },
+      "haHosts": [ # A list of host URIs that are part of the HA configuration if present. An empty list indicates the component is not configured for HA.
+        "A String",
+      ],
+      "resources": [ # Output only. resources in the component
+        { # The resource on GCP
+          "instanceProperties": { # Instance Properties. # Output only. All instance properties.
+            "instanceNumber": "A String", # Optional. Instance number.
+            "machineType": "A String", # Optional. Instance machine type.
+            "role": "A String", # Optional. Instance role.
+            "roles": [ # Optional. Instance roles.
+              "A String",
+            ],
+            "sapInstanceProperties": { # SAP instance properties. # Optional. SAP Instance properties.
+              "numbers": [ # Optional. SAP Instance numbers. They are from '00' to '99'.
+                "A String",
+              ],
+            },
+            "status": "A String", # Optional. Instance status.
+            "upcomingMaintenanceEvent": { # Maintenance Event # Optional. the next maintenance event on VM
+              "endTime": "A String", # Optional. End time
+              "maintenanceStatus": "A String", # Optional. Maintenance status
+              "startTime": "A String", # Optional. Start time
+              "type": "A String", # Optional. Type
+            },
+          },
+          "kind": "A String", # Output only. ComputeInstance, ComputeDisk, VPC, Bare Metal server, etc.
+          "name": "A String", # Output only. resource name
+        },
+      ],
+      "sid": "A String", # Output only. sid is the sap component identificator
+      "topologyType": "A String", # The detected topology of the component.
+    },
+    "metadata": { # Output only. The metadata for SAP workload.
+      "a_key": "A String",
+    },
+    "products": [ # Output only. the products on this workload.
+      { # Product contains the details of a product.
+        "name": "A String", # Optional. Name of the product.
+        "version": "A String", # Optional. Version of the product.
+      },
+    ],
+  },
+  "sqlserverWorkload": { # The body of sqlserver workload # The sqlserver workload content
+    "ags": [ # Output only. The availability groups for sqlserver
+      { # The availability groups for sqlserver
+        "databases": [ # Output only. The databases
+          "A String",
+        ],
+        "name": "A String", # Output only. The availability group name
+        "primaryServer": "A String", # Output only. The primary server
+        "secondaryServers": [ # Output only. The secondary servers
+          "A String",
+        ],
+      },
+    ],
+    "cluster": { # The cluster for sqlserver # Output only. The cluster for sqlserver
+      "nodes": [ # Output only. The nodes
+        "A String",
+      ],
+      "witnessServer": "A String", # Output only. The witness server
+    },
+    "databases": [ # Output only. The databases for sqlserver
+      { # The database for sqlserver
+        "backupFile": "A String", # Output only. The backup file
+        "backupSchedule": "A String", # Output only. The backup schedule
+        "hostVm": "A String", # Output only. The host VM
+        "name": "A String", # Output only. The database name
+      },
+    ],
+    "loadBalancerServer": { # The load balancer for sqlserver # Output only. The load balancer for sqlserver
+      "ip": "A String", # Output only. The IP address
+      "vm": "A String", # Output only. The VM name
+    },
+  },
+  "state": "A String", # Output only. [output only] the current state if a a workload
+  "threeTierWorkload": { # The body of three tier workload # The 3 tier web app workload content
+    "apiLayer": { # The API layer server # Output only. The API layer for three tier workload
+      "name": "A String", # Output only. The api layer name
+      "osVersion": "A String", # Output only. OS information
+      "resources": [ # Output only. resources in the component
+        { # The resource on GCP
+          "instanceProperties": { # Instance Properties. # Output only. All instance properties.
+            "instanceNumber": "A String", # Optional. Instance number.
+            "machineType": "A String", # Optional. Instance machine type.
+            "role": "A String", # Optional. Instance role.
+            "roles": [ # Optional. Instance roles.
+              "A String",
+            ],
+            "sapInstanceProperties": { # SAP instance properties. # Optional. SAP Instance properties.
+              "numbers": [ # Optional. SAP Instance numbers. They are from '00' to '99'.
+                "A String",
+              ],
+            },
+            "status": "A String", # Optional. Instance status.
+            "upcomingMaintenanceEvent": { # Maintenance Event # Optional. the next maintenance event on VM
+              "endTime": "A String", # Optional. End time
+              "maintenanceStatus": "A String", # Optional. Maintenance status
+              "startTime": "A String", # Optional. Start time
+              "type": "A String", # Optional. Type
+            },
+          },
+          "kind": "A String", # Output only. ComputeInstance, ComputeDisk, VPC, Bare Metal server, etc.
+          "name": "A String", # Output only. resource name
+        },
+      ],
+    },
+    "backend": { # The backend server # Output only. The backend for three tier workload
+      "backupFile": "A String", # Output only. The backup file
+      "backupSchedule": "A String", # Output only. The backup schedule
+      "name": "A String", # Output only. The backend name
+      "osVersion": "A String", # Output only. OS information
+      "resources": [ # Output only. resources in the component
+        { # The resource on GCP
+          "instanceProperties": { # Instance Properties. # Output only. All instance properties.
+            "instanceNumber": "A String", # Optional. Instance number.
+            "machineType": "A String", # Optional. Instance machine type.
+            "role": "A String", # Optional. Instance role.
+            "roles": [ # Optional. Instance roles.
+              "A String",
+            ],
+            "sapInstanceProperties": { # SAP instance properties. # Optional. SAP Instance properties.
+              "numbers": [ # Optional. SAP Instance numbers. They are from '00' to '99'.
+                "A String",
+              ],
+            },
+            "status": "A String", # Optional. Instance status.
+            "upcomingMaintenanceEvent": { # Maintenance Event # Optional. the next maintenance event on VM
+              "endTime": "A String", # Optional. End time
+              "maintenanceStatus": "A String", # Optional. Maintenance status
+              "startTime": "A String", # Optional. Start time
+              "type": "A String", # Optional. Type
+            },
+          },
+          "kind": "A String", # Output only. ComputeInstance, ComputeDisk, VPC, Bare Metal server, etc.
+          "name": "A String", # Output only. resource name
+        },
+      ],
+    },
+    "endpoint": "A String", # Output only. the workload endpoint
+    "frontend": { # The front end server # Output only. The frontend for three tier workload
+      "name": "A String", # Output only. The frontend name
+      "osVersion": "A String", # Output only. OS information
+      "resources": [ # Output only. resources in the component
+        { # The resource on GCP
+          "instanceProperties": { # Instance Properties. # Output only. All instance properties.
+            "instanceNumber": "A String", # Optional. Instance number.
+            "machineType": "A String", # Optional. Instance machine type.
+            "role": "A String", # Optional. Instance role.
+            "roles": [ # Optional. Instance roles.
+              "A String",
+            ],
+            "sapInstanceProperties": { # SAP instance properties. # Optional. SAP Instance properties.
+              "numbers": [ # Optional. SAP Instance numbers. They are from '00' to '99'.
+                "A String",
+              ],
+            },
+            "status": "A String", # Optional. Instance status.
+            "upcomingMaintenanceEvent": { # Maintenance Event # Optional. the next maintenance event on VM
+              "endTime": "A String", # Optional. End time
+              "maintenanceStatus": "A String", # Optional. Maintenance status
+              "startTime": "A String", # Optional. Start time
+              "type": "A String", # Optional. Type
+            },
+          },
+          "kind": "A String", # Output only. ComputeInstance, ComputeDisk, VPC, Bare Metal server, etc.
+          "name": "A String", # Output only. resource name
+        },
+      ],
+    },
+  },
+  "workloadType": "A String", # Required. The type of the workload
+}
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
List discovered workload profiles
+
+Args:
+  parent: string, Required. Parent value for ListDiscoveredProfilesRequest (required)
+  filter: string, Optional. Filtering results
+  pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
+  pageToken: string, Optional. A token identifying a page of results the server should return.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # List discovered profile Response returns discovered profiles from agents
+  "nextPageToken": "A String", # Output only. A token identifying a page of results the server should return
+  "unreachable": [ # Locations that could not be reached.
+    "A String",
+  ],
+  "workloadProfiles": [ # Output only. The list of workload profiles
+    { # workload resource
+      "application": { # The database layer # Optional. The application layer
+        "applicationType": "A String", # the application layer
+        "databaseType": "A String", # Optional. the database layer
+        "instances": [ # Optional. instances in a layer
+          { # a vm instance
+            "name": "A String", # Output only. name of the VM
+            "region": "A String", # Output only. The location of the VM
+            "status": "A String", # Output only. The state of the VM
+          },
+        ],
+        "sid": "A String", # Output only. system identification of a layer
+      },
+      "ascs": { # The database layer # Optional. The ascs layer
+        "applicationType": "A String", # the application layer
+        "databaseType": "A String", # Optional. the database layer
+        "instances": [ # Optional. instances in a layer
+          { # a vm instance
+            "name": "A String", # Output only. name of the VM
+            "region": "A String", # Output only. The location of the VM
+            "status": "A String", # Output only. The state of the VM
+          },
+        ],
+        "sid": "A String", # Output only. system identification of a layer
+      },
+      "database": { # The database layer # Optional. The database layer
+        "applicationType": "A String", # the application layer
+        "databaseType": "A String", # Optional. the database layer
+        "instances": [ # Optional. instances in a layer
+          { # a vm instance
+            "name": "A String", # Output only. name of the VM
+            "region": "A String", # Output only. The location of the VM
+            "status": "A String", # Output only. The state of the VM
+          },
+        ],
+        "sid": "A String", # Output only. system identification of a layer
+      },
+      "labels": { # Optional. such as name, description, version. More example can be found in deployment
+        "a_key": "A String",
+      },
+      "name": "A String", # Identifier. name of resource names have the form 'projects/{project_id}/workloads/{workload_id}'
+      "refreshedTime": "A String", # Required. time when the workload data was refreshed
+      "sapWorkload": { # The body of sap workload # The sap workload content
+        "application": { # The component of sap workload # Output only. the acsc componment
+          "databaseProperties": { # Database Properties. # Output only. All instance properties.
+            "backupProperties": { # Backup properties. # Output only. Backup properties.
+              "latestBackupStatus": "A String", # Output only. The state of the latest backup.
+              "latestBackupTime": "A String", # The time when the latest backup was performed.
+            },
+            "databaseType": "A String", # Output only. Type of the database. HANA, DB2, etc.
+          },
+          "haHosts": [ # A list of host URIs that are part of the HA configuration if present. An empty list indicates the component is not configured for HA.
+            "A String",
+          ],
+          "resources": [ # Output only. resources in the component
+            { # The resource on GCP
+              "instanceProperties": { # Instance Properties. # Output only. All instance properties.
+                "instanceNumber": "A String", # Optional. Instance number.
+                "machineType": "A String", # Optional. Instance machine type.
+                "role": "A String", # Optional. Instance role.
+                "roles": [ # Optional. Instance roles.
+                  "A String",
+                ],
+                "sapInstanceProperties": { # SAP instance properties. # Optional. SAP Instance properties.
+                  "numbers": [ # Optional. SAP Instance numbers. They are from '00' to '99'.
+                    "A String",
+                  ],
+                },
+                "status": "A String", # Optional. Instance status.
+                "upcomingMaintenanceEvent": { # Maintenance Event # Optional. the next maintenance event on VM
+                  "endTime": "A String", # Optional. End time
+                  "maintenanceStatus": "A String", # Optional. Maintenance status
+                  "startTime": "A String", # Optional. Start time
+                  "type": "A String", # Optional. Type
+                },
+              },
+              "kind": "A String", # Output only. ComputeInstance, ComputeDisk, VPC, Bare Metal server, etc.
+              "name": "A String", # Output only. resource name
+            },
+          ],
+          "sid": "A String", # Output only. sid is the sap component identificator
+          "topologyType": "A String", # The detected topology of the component.
+        },
+        "architecture": "A String", # Output only. the architecture
+        "database": { # The component of sap workload # Output only. the database componment
+          "databaseProperties": { # Database Properties. # Output only. All instance properties.
+            "backupProperties": { # Backup properties. # Output only. Backup properties.
+              "latestBackupStatus": "A String", # Output only. The state of the latest backup.
+              "latestBackupTime": "A String", # The time when the latest backup was performed.
+            },
+            "databaseType": "A String", # Output only. Type of the database. HANA, DB2, etc.
+          },
+          "haHosts": [ # A list of host URIs that are part of the HA configuration if present. An empty list indicates the component is not configured for HA.
+            "A String",
+          ],
+          "resources": [ # Output only. resources in the component
+            { # The resource on GCP
+              "instanceProperties": { # Instance Properties. # Output only. All instance properties.
+                "instanceNumber": "A String", # Optional. Instance number.
+                "machineType": "A String", # Optional. Instance machine type.
+                "role": "A String", # Optional. Instance role.
+                "roles": [ # Optional. Instance roles.
+                  "A String",
+                ],
+                "sapInstanceProperties": { # SAP instance properties. # Optional. SAP Instance properties.
+                  "numbers": [ # Optional. SAP Instance numbers. They are from '00' to '99'.
+                    "A String",
+                  ],
+                },
+                "status": "A String", # Optional. Instance status.
+                "upcomingMaintenanceEvent": { # Maintenance Event # Optional. the next maintenance event on VM
+                  "endTime": "A String", # Optional. End time
+                  "maintenanceStatus": "A String", # Optional. Maintenance status
+                  "startTime": "A String", # Optional. Start time
+                  "type": "A String", # Optional. Type
+                },
+              },
+              "kind": "A String", # Output only. ComputeInstance, ComputeDisk, VPC, Bare Metal server, etc.
+              "name": "A String", # Output only. resource name
+            },
+          ],
+          "sid": "A String", # Output only. sid is the sap component identificator
+          "topologyType": "A String", # The detected topology of the component.
+        },
+        "metadata": { # Output only. The metadata for SAP workload.
+          "a_key": "A String",
+        },
+        "products": [ # Output only. the products on this workload.
+          { # Product contains the details of a product.
+            "name": "A String", # Optional. Name of the product.
+            "version": "A String", # Optional. Version of the product.
+          },
+        ],
+      },
+      "sqlserverWorkload": { # The body of sqlserver workload # The sqlserver workload content
+        "ags": [ # Output only. The availability groups for sqlserver
+          { # The availability groups for sqlserver
+            "databases": [ # Output only. The databases
+              "A String",
+            ],
+            "name": "A String", # Output only. The availability group name
+            "primaryServer": "A String", # Output only. The primary server
+            "secondaryServers": [ # Output only. The secondary servers
+              "A String",
+            ],
+          },
+        ],
+        "cluster": { # The cluster for sqlserver # Output only. The cluster for sqlserver
+          "nodes": [ # Output only. The nodes
+            "A String",
+          ],
+          "witnessServer": "A String", # Output only. The witness server
+        },
+        "databases": [ # Output only. The databases for sqlserver
+          { # The database for sqlserver
+            "backupFile": "A String", # Output only. The backup file
+            "backupSchedule": "A String", # Output only. The backup schedule
+            "hostVm": "A String", # Output only. The host VM
+            "name": "A String", # Output only. The database name
+          },
+        ],
+        "loadBalancerServer": { # The load balancer for sqlserver # Output only. The load balancer for sqlserver
+          "ip": "A String", # Output only. The IP address
+          "vm": "A String", # Output only. The VM name
+        },
+      },
+      "state": "A String", # Output only. [output only] the current state if a a workload
+      "threeTierWorkload": { # The body of three tier workload # The 3 tier web app workload content
+        "apiLayer": { # The API layer server # Output only. The API layer for three tier workload
+          "name": "A String", # Output only. The api layer name
+          "osVersion": "A String", # Output only. OS information
+          "resources": [ # Output only. resources in the component
+            { # The resource on GCP
+              "instanceProperties": { # Instance Properties. # Output only. All instance properties.
+                "instanceNumber": "A String", # Optional. Instance number.
+                "machineType": "A String", # Optional. Instance machine type.
+                "role": "A String", # Optional. Instance role.
+                "roles": [ # Optional. Instance roles.
+                  "A String",
+                ],
+                "sapInstanceProperties": { # SAP instance properties. # Optional. SAP Instance properties.
+                  "numbers": [ # Optional. SAP Instance numbers. They are from '00' to '99'.
+                    "A String",
+                  ],
+                },
+                "status": "A String", # Optional. Instance status.
+                "upcomingMaintenanceEvent": { # Maintenance Event # Optional. the next maintenance event on VM
+                  "endTime": "A String", # Optional. End time
+                  "maintenanceStatus": "A String", # Optional. Maintenance status
+                  "startTime": "A String", # Optional. Start time
+                  "type": "A String", # Optional. Type
+                },
+              },
+              "kind": "A String", # Output only. ComputeInstance, ComputeDisk, VPC, Bare Metal server, etc.
+              "name": "A String", # Output only. resource name
+            },
+          ],
+        },
+        "backend": { # The backend server # Output only. The backend for three tier workload
+          "backupFile": "A String", # Output only. The backup file
+          "backupSchedule": "A String", # Output only. The backup schedule
+          "name": "A String", # Output only. The backend name
+          "osVersion": "A String", # Output only. OS information
+          "resources": [ # Output only. resources in the component
+            { # The resource on GCP
+              "instanceProperties": { # Instance Properties. # Output only. All instance properties.
+                "instanceNumber": "A String", # Optional. Instance number.
+                "machineType": "A String", # Optional. Instance machine type.
+                "role": "A String", # Optional. Instance role.
+                "roles": [ # Optional. Instance roles.
+                  "A String",
+                ],
+                "sapInstanceProperties": { # SAP instance properties. # Optional. SAP Instance properties.
+                  "numbers": [ # Optional. SAP Instance numbers. They are from '00' to '99'.
+                    "A String",
+                  ],
+                },
+                "status": "A String", # Optional. Instance status.
+                "upcomingMaintenanceEvent": { # Maintenance Event # Optional. the next maintenance event on VM
+                  "endTime": "A String", # Optional. End time
+                  "maintenanceStatus": "A String", # Optional. Maintenance status
+                  "startTime": "A String", # Optional. Start time
+                  "type": "A String", # Optional. Type
+                },
+              },
+              "kind": "A String", # Output only. ComputeInstance, ComputeDisk, VPC, Bare Metal server, etc.
+              "name": "A String", # Output only. resource name
+            },
+          ],
+        },
+        "endpoint": "A String", # Output only. the workload endpoint
+        "frontend": { # The front end server # Output only. The frontend for three tier workload
+          "name": "A String", # Output only. The frontend name
+          "osVersion": "A String", # Output only. OS information
+          "resources": [ # Output only. resources in the component
+            { # The resource on GCP
+              "instanceProperties": { # Instance Properties. # Output only. All instance properties.
+                "instanceNumber": "A String", # Optional. Instance number.
+                "machineType": "A String", # Optional. Instance machine type.
+                "role": "A String", # Optional. Instance role.
+                "roles": [ # Optional. Instance roles.
+                  "A String",
+                ],
+                "sapInstanceProperties": { # SAP instance properties. # Optional. SAP Instance properties.
+                  "numbers": [ # Optional. SAP Instance numbers. They are from '00' to '99'.
+                    "A String",
+                  ],
+                },
+                "status": "A String", # Optional. Instance status.
+                "upcomingMaintenanceEvent": { # Maintenance Event # Optional. the next maintenance event on VM
+                  "endTime": "A String", # Optional. End time
+                  "maintenanceStatus": "A String", # Optional. Maintenance status
+                  "startTime": "A String", # Optional. Start time
+                  "type": "A String", # Optional. Type
+                },
+              },
+              "kind": "A String", # Output only. ComputeInstance, ComputeDisk, VPC, Bare Metal server, etc.
+              "name": "A String", # Output only. resource name
+            },
+          ],
+        },
+      },
+      "workloadType": "A String", # Required. The type of the workload
+    },
+  ],
+}
+
+ +
+ 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/workloadmanager_v1.projects.locations.html b/docs/dyn/workloadmanager_v1.projects.locations.html index b7986dc12e7..e15f8e7cf0a 100644 --- a/docs/dyn/workloadmanager_v1.projects.locations.html +++ b/docs/dyn/workloadmanager_v1.projects.locations.html @@ -74,6 +74,11 @@

Workload Manager API . projects . locations

Instance Methods

+

+ discoveredprofiles() +

+

Returns the discoveredprofiles Resource.

+

evaluations()

diff --git a/googleapiclient/discovery_cache/documents/workloadmanager.v1.json b/googleapiclient/discovery_cache/documents/workloadmanager.v1.json index f0b30ac40b4..0f70e4fc22e 100644 --- a/googleapiclient/discovery_cache/documents/workloadmanager.v1.json +++ b/googleapiclient/discovery_cache/documents/workloadmanager.v1.json @@ -177,6 +177,107 @@ } }, "resources": { +"discoveredprofiles": { +"methods": { +"get": { +"description": "Gets details of a discovered workload profile.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/discoveredprofiles/{discoveredprofilesId}", +"httpMethod": "GET", +"id": "workloadmanager.projects.locations.discoveredprofiles.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the resource", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/discoveredprofiles/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "WorkloadProfile" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "List discovered workload profiles", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/discoveredprofiles", +"httpMethod": "GET", +"id": "workloadmanager.projects.locations.discoveredprofiles.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Filtering results", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A token identifying a page of results the server should return.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Parent value for ListDiscoveredProfilesRequest", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/discoveredprofiles", +"response": { +"$ref": "ListDiscoveredProfilesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"healthes": { +"methods": { +"get": { +"description": "Get the health of a discovered workload profile.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/discoveredprofiles/{discoveredprofilesId}/healthes/{healthesId}", +"httpMethod": "GET", +"id": "workloadmanager.projects.locations.discoveredprofiles.healthes.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/discoveredprofiles/[^/]+/healthes/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "WorkloadProfileHealth" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, "evaluations": { "methods": { "create": { @@ -806,9 +907,34 @@ } } }, -"revision": "20250205", +"revision": "20250219", "rootUrl": "https://workloadmanager.googleapis.com/", "schemas": { +"APILayerServer": { +"description": "The API layer server", +"id": "APILayerServer", +"properties": { +"name": { +"description": "Output only. The api layer name", +"readOnly": true, +"type": "string" +}, +"osVersion": { +"description": "Output only. OS information", +"readOnly": true, +"type": "string" +}, +"resources": { +"description": "Output only. resources in the component", +"items": { +"$ref": "CloudResource" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, "AgentCommand": { "description": "* An AgentCommand specifies a one-time executable program for the agent to run.", "id": "AgentCommand", @@ -827,6 +953,101 @@ }, "type": "object" }, +"AvailabilityGroup": { +"description": "The availability groups for sqlserver", +"id": "AvailabilityGroup", +"properties": { +"databases": { +"description": "Output only. The databases", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"name": { +"description": "Output only. The availability group name", +"readOnly": true, +"type": "string" +}, +"primaryServer": { +"description": "Output only. The primary server", +"readOnly": true, +"type": "string" +}, +"secondaryServers": { +"description": "Output only. The secondary servers", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, +"BackendServer": { +"description": "The backend server", +"id": "BackendServer", +"properties": { +"backupFile": { +"description": "Output only. The backup file", +"readOnly": true, +"type": "string" +}, +"backupSchedule": { +"description": "Output only. The backup schedule", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Output only. The backend name", +"readOnly": true, +"type": "string" +}, +"osVersion": { +"description": "Output only. OS information", +"readOnly": true, +"type": "string" +}, +"resources": { +"description": "Output only. resources in the component", +"items": { +"$ref": "CloudResource" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, +"BackupProperties": { +"description": "Backup properties.", +"id": "BackupProperties", +"properties": { +"latestBackupStatus": { +"description": "Output only. The state of the latest backup.", +"enum": [ +"BACKUP_STATE_UNSPECIFIED", +"BACKUP_STATE_SUCCESS", +"BACKUP_STATE_FAILURE" +], +"enumDescriptions": [ +"unspecified", +"SUCCESS state", +"FAILURE state" +], +"readOnly": true, +"type": "string" +}, +"latestBackupTime": { +"description": "The time when the latest backup was performed.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "BigQueryDestination": { "description": "Message describing big query destination", "id": "BigQueryDestination", @@ -848,6 +1069,76 @@ "properties": {}, "type": "object" }, +"CloudResource": { +"description": "The resource on GCP", +"id": "CloudResource", +"properties": { +"instanceProperties": { +"$ref": "InstanceProperties", +"description": "Output only. All instance properties.", +"readOnly": true +}, +"kind": { +"description": "Output only. ComputeInstance, ComputeDisk, VPC, Bare Metal server, etc.", +"enum": [ +"RESOURCE_KIND_UNSPECIFIED", +"RESOURCE_KIND_INSTANCE", +"RESOURCE_KIND_DISK", +"RESOURCE_KIND_ADDRESS", +"RESOURCE_KIND_FILESTORE", +"RESOURCE_KIND_HEALTH_CHECK", +"RESOURCE_KIND_FORWARDING_RULE", +"RESOURCE_KIND_BACKEND_SERVICE", +"RESOURCE_KIND_SUBNETWORK", +"RESOURCE_KIND_NETWORK", +"RESOURCE_KIND_PUBLIC_ADDRESS", +"RESOURCE_KIND_INSTANCE_GROUP" +], +"enumDescriptions": [ +"Unspecified resource kind.", +"This is a compute instance.", +"This is a compute disk.", +"This is a compute address.", +"This is a filestore instance.", +"This is a compute health check.", +"This is a compute forwarding rule.", +"This is a compute backend service.", +"This is a compute subnetwork.", +"This is a compute network.", +"This is a public accessible IP Address.", +"This is a compute instance group." +], +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Output only. resource name", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"Cluster": { +"description": "The cluster for sqlserver", +"id": "Cluster", +"properties": { +"nodes": { +"description": "Output only. The nodes", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"witnessServer": { +"description": "Output only. The witness server", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "Command": { "description": "* Command specifies the type of command to execute.", "id": "Command", @@ -863,6 +1154,134 @@ }, "type": "object" }, +"ComponentHealth": { +"description": "HealthCondition contains the detailed health check of each component.", +"id": "ComponentHealth", +"properties": { +"component": { +"description": "The component of a workload.", +"type": "string" +}, +"componentHealthChecks": { +"description": "The detailed health checks of the component.", +"items": { +"$ref": "HealthCheck" +}, +"type": "array" +}, +"componentHealthType": { +"description": "Output only. The type of the component health.", +"enum": [ +"TYPE_UNSPECIFIED", +"TYPE_REQUIRED", +"TYPE_OPTIONAL", +"TYPE_SPECIAL" +], +"enumDescriptions": [ +"Unspecified", +"required", +"optional", +"special" +], +"readOnly": true, +"type": "string" +}, +"isRequired": { +"description": "Output only. The requirement of the component.", +"readOnly": true, +"type": "boolean" +}, +"state": { +"description": "Output only. The health state of the component.", +"enum": [ +"HEALTH_STATE_UNSPECIFIED", +"HEALTHY", +"UNHEALTHY", +"CRITICAL", +"UNSUPPORTED" +], +"enumDescriptions": [ +"Unspecified", +"healthy workload", +"unhealthy workload", +"has critical issues", +"unsupported" +], +"readOnly": true, +"type": "string" +}, +"subComponentHealthes": { +"description": "Sub component health.", +"items": { +"$ref": "ComponentHealth" +}, +"type": "array" +} +}, +"type": "object" +}, +"Database": { +"description": "The database for sqlserver", +"id": "Database", +"properties": { +"backupFile": { +"description": "Output only. The backup file", +"readOnly": true, +"type": "string" +}, +"backupSchedule": { +"description": "Output only. The backup schedule", +"readOnly": true, +"type": "string" +}, +"hostVm": { +"description": "Output only. The host VM", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Output only. The database name", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"DatabaseProperties": { +"description": "Database Properties.", +"id": "DatabaseProperties", +"properties": { +"backupProperties": { +"$ref": "BackupProperties", +"description": "Output only. Backup properties.", +"readOnly": true +}, +"databaseType": { +"description": "Output only. Type of the database. HANA, DB2, etc.", +"enum": [ +"DATABASE_TYPE_UNSPECIFIED", +"HANA", +"MAX_DB", +"DB2", +"ORACLE", +"SQLSERVER", +"ASE" +], +"enumDescriptions": [ +"unspecified", +"SAP HANA", +"SAP MAX_DB", +"IBM DB2", +"Oracle Database", +"Microsoft SQL Server", +"SAP Sybase ASE" +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "Empty": { "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "id": "Empty", @@ -1140,49 +1559,295 @@ }, "type": "object" }, -"GceInstanceFilter": { -"description": "Message describing compute engine instance filter", -"id": "GceInstanceFilter", +"FrontEndServer": { +"description": "The front end server", +"id": "FrontEndServer", +"properties": { +"name": { +"description": "Output only. The frontend name", +"readOnly": true, +"type": "string" +}, +"osVersion": { +"description": "Output only. OS information", +"readOnly": true, +"type": "string" +}, +"resources": { +"description": "Output only. resources in the component", +"items": { +"$ref": "CloudResource" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, +"GceInstanceFilter": { +"description": "Message describing compute engine instance filter", +"id": "GceInstanceFilter", +"properties": { +"serviceAccounts": { +"description": "Service account of compute engine", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"HealthCheck": { +"description": "HealthCheck contains the detailed health check of a component based on asource.", +"id": "HealthCheck", +"properties": { +"message": { +"description": "Output only. The message of the health check.", +"readOnly": true, +"type": "string" +}, +"metric": { +"description": "Output only. The health check source metric name.", +"readOnly": true, +"type": "string" +}, +"resource": { +"$ref": "CloudResource", +"description": "Output only. The resource the check performs on.", +"readOnly": true +}, +"source": { +"description": "Output only. The source of the health check.", +"readOnly": true, +"type": "string" +}, +"state": { +"description": "Output only. The state of the health check.", +"enum": [ +"STATE_UNSPECIFIED", +"PASSED", +"FAILED", +"DEGRADED", +"SKIPPED", +"UNSUPPORTED" +], +"enumDescriptions": [ +"Unspecified", +"passed", +"failed", +"degraded", +"skipped", +"unsupported" +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"Insight": { +"description": "A presentation of host resource usage where the workload runs.", +"id": "Insight", +"properties": { +"instanceId": { +"description": "Required. The instance id where the insight is generated from", +"type": "string" +}, +"sapDiscovery": { +"$ref": "SapDiscovery", +"description": "The insights data for SAP system discovery. This is a copy of SAP System proto and should get updated whenever that one changes." +}, +"sapValidation": { +"$ref": "SapValidation", +"description": "The insights data for the SAP workload validation." +}, +"sentTime": { +"description": "Output only. [Output only] Create time stamp", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"sqlserverValidation": { +"$ref": "SqlserverValidation", +"description": "The insights data for the sqlserver workload validation." +}, +"torsoValidation": { +"$ref": "TorsoValidation", +"description": "The insights data for workload validation of torso workloads." +} +}, +"type": "object" +}, +"Instance": { +"description": "a vm instance", +"id": "Instance", +"properties": { +"name": { +"description": "Output only. name of the VM", +"readOnly": true, +"type": "string" +}, +"region": { +"description": "Output only. The location of the VM", +"readOnly": true, +"type": "string" +}, +"status": { +"description": "Output only. The state of the VM", +"enum": [ +"INSTANCESTATE_UNSPECIFIED", +"PROVISIONING", +"STAGING", +"RUNNING", +"STOPPING", +"STOPPED", +"TERMINATED", +"SUSPENDING", +"SUSPENDED", +"REPAIRING", +"DEPROVISIONING" +], +"enumDescriptions": [ +"The Status of the VM is unspecified", +"Resources are being allocated for the instance.", +"All required resources have been allocated and the instance is being started.", +"The instance is running.", +"The instance is currently stopping (either being deleted or killed).", +"The instance has stopped due to various reasons (user request, VM preemption, project freezing, etc.).", +"The instance has failed in some way.", +"The instance is suspending.", +"The instance is suspended.", +"The instance is in repair.", +"The instance is in de-provisioning state." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"InstanceProperties": { +"description": "Instance Properties.", +"id": "InstanceProperties", +"properties": { +"instanceNumber": { +"description": "Optional. Instance number.", +"type": "string" +}, +"machineType": { +"description": "Optional. Instance machine type.", +"type": "string" +}, +"role": { +"deprecated": true, +"description": "Optional. Instance role.", +"enum": [ +"INSTANCE_ROLE_UNSPECIFIED", +"INSTANCE_ROLE_ASCS", +"INSTANCE_ROLE_ERS", +"INSTANCE_ROLE_APP_SERVER", +"INSTANCE_ROLE_HANA_PRIMARY", +"INSTANCE_ROLE_HANA_SECONDARY" +], +"enumDescriptions": [ +"Unspecified role.", +"ASCS role.", +"ERS role.", +"APP server.", +"HANA primary role.", +"HANA secondary role." +], +"type": "string" +}, +"roles": { +"description": "Optional. Instance roles.", +"items": { +"enum": [ +"INSTANCE_ROLE_UNSPECIFIED", +"INSTANCE_ROLE_ASCS", +"INSTANCE_ROLE_ERS", +"INSTANCE_ROLE_APP_SERVER", +"INSTANCE_ROLE_HANA_PRIMARY", +"INSTANCE_ROLE_HANA_SECONDARY" +], +"enumDescriptions": [ +"Unspecified role.", +"ASCS role.", +"ERS role.", +"APP server.", +"HANA primary role.", +"HANA secondary role." +], +"type": "string" +}, +"type": "array" +}, +"sapInstanceProperties": { +"$ref": "SapInstanceProperties", +"description": "Optional. SAP Instance properties." +}, +"status": { +"description": "Optional. Instance status.", +"type": "string" +}, +"upcomingMaintenanceEvent": { +"$ref": "UpcomingMaintenanceEvent", +"description": "Optional. the next maintenance event on VM" +} +}, +"type": "object" +}, +"Layer": { +"description": "The database layer", +"id": "Layer", "properties": { -"serviceAccounts": { -"description": "Service account of compute engine", -"items": { +"applicationType": { +"description": "the application layer", "type": "string" }, +"databaseType": { +"description": "Optional. the database layer", +"type": "string" +}, +"instances": { +"description": "Optional. instances in a layer", +"items": { +"$ref": "Instance" +}, "type": "array" +}, +"sid": { +"description": "Output only. system identification of a layer", +"readOnly": true, +"type": "string" } }, "type": "object" }, -"Insight": { -"description": "A presentation of host resource usage where the workload runs.", -"id": "Insight", +"ListDiscoveredProfilesResponse": { +"description": "List discovered profile Response returns discovered profiles from agents", +"id": "ListDiscoveredProfilesResponse", "properties": { -"instanceId": { -"description": "Required. The instance id where the insight is generated from", +"nextPageToken": { +"description": "Output only. A token identifying a page of results the server should return", +"readOnly": true, "type": "string" }, -"sapDiscovery": { -"$ref": "SapDiscovery", -"description": "The insights data for SAP system discovery. This is a copy of SAP System proto and should get updated whenever that one changes." -}, -"sapValidation": { -"$ref": "SapValidation", -"description": "The insights data for the SAP workload validation." -}, -"sentTime": { -"description": "Output only. [Output only] Create time stamp", -"format": "google-datetime", -"readOnly": true, +"unreachable": { +"description": "Locations that could not be reached.", +"items": { "type": "string" }, -"sqlserverValidation": { -"$ref": "SqlserverValidation", -"description": "The insights data for the sqlserver workload validation." +"type": "array" }, -"torsoValidation": { -"$ref": "TorsoValidation", -"description": "The insights data for workload validation of torso workloads." +"workloadProfiles": { +"description": "Output only. The list of workload profiles", +"items": { +"$ref": "WorkloadProfile" +}, +"readOnly": true, +"type": "array" } }, "type": "object" @@ -1327,6 +1992,23 @@ }, "type": "object" }, +"LoadBalancerServer": { +"description": "The load balancer for sqlserver", +"id": "LoadBalancerServer", +"properties": { +"ip": { +"description": "Output only. The IP address", +"readOnly": true, +"type": "string" +}, +"vm": { +"description": "Output only. The VM name", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "Location": { "description": "A resource that represents a Google Cloud location.", "id": "Location", @@ -1452,6 +2134,21 @@ }, "type": "object" }, +"Product": { +"description": "Product contains the details of a product.", +"id": "Product", +"properties": { +"name": { +"description": "Optional. Name of the product.", +"type": "string" +}, +"version": { +"description": "Optional. Version of the product.", +"type": "string" +} +}, +"type": "object" +}, "Resource": { "description": "Message represent resource in execution result", "id": "Resource", @@ -1650,6 +2347,52 @@ }, "type": "object" }, +"SapComponent": { +"description": "The component of sap workload", +"id": "SapComponent", +"properties": { +"databaseProperties": { +"$ref": "DatabaseProperties", +"description": "Output only. All instance properties.", +"readOnly": true +}, +"haHosts": { +"description": "A list of host URIs that are part of the HA configuration if present. An empty list indicates the component is not configured for HA.", +"items": { +"type": "string" +}, +"type": "array" +}, +"resources": { +"description": "Output only. resources in the component", +"items": { +"$ref": "CloudResource" +}, +"readOnly": true, +"type": "array" +}, +"sid": { +"description": "Output only. sid is the sap component identificator", +"readOnly": true, +"type": "string" +}, +"topologyType": { +"description": "The detected topology of the component.", +"enum": [ +"TOPOLOGY_TYPE_UNSPECIFIED", +"TOPOLOGY_SCALE_UP", +"TOPOLOGY_SCALE_OUT" +], +"enumDescriptions": [ +"Unspecified topology.", +"A scale-up single node system.", +"A scale-out multi-node system." +], +"type": "string" +} +}, +"type": "object" +}, "SapDiscovery": { "description": "The schema of SAP system discovery data.", "id": "SapDiscovery", @@ -2142,6 +2885,20 @@ }, "type": "object" }, +"SapInstanceProperties": { +"description": "SAP instance properties.", +"id": "SapInstanceProperties", +"properties": { +"numbers": { +"description": "Optional. SAP Instance numbers. They are from '00' to '99'.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "SapValidation": { "description": "A presentation of SAP workload insight. The schema of SAP workloads validation related data.", "id": "SapValidation", @@ -2206,6 +2963,62 @@ }, "type": "object" }, +"SapWorkload": { +"description": "The body of sap workload", +"id": "SapWorkload", +"properties": { +"application": { +"$ref": "SapComponent", +"description": "Output only. the acsc componment", +"readOnly": true +}, +"architecture": { +"description": "Output only. the architecture", +"enum": [ +"ARCHITECTURE_UNSPECIFIED", +"INVALID", +"CENTRALIZED", +"DISTRIBUTED", +"DISTRIBUTED_HA", +"STANDALONE_DATABASE", +"STANDALONE_DATABASE_HA" +], +"enumDescriptions": [ +"Unspecified architecture.", +"Invaliad architecture.", +"A centralized system.", +"A distributed system.", +"A distributed with HA system.", +"A standalone database system.", +"A standalone database with HA system." +], +"readOnly": true, +"type": "string" +}, +"database": { +"$ref": "SapComponent", +"description": "Output only. the database componment", +"readOnly": true +}, +"metadata": { +"additionalProperties": { +"type": "string" +}, +"description": "Output only. The metadata for SAP workload.", +"readOnly": true, +"type": "object" +}, +"products": { +"description": "Output only. the products on this workload.", +"items": { +"$ref": "Product" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, "ScannedResource": { "description": "Message of scanned resource", "id": "ScannedResource", @@ -2329,6 +3142,39 @@ }, "type": "object" }, +"SqlserverWorkload": { +"description": "The body of sqlserver workload", +"id": "SqlserverWorkload", +"properties": { +"ags": { +"description": "Output only. The availability groups for sqlserver", +"items": { +"$ref": "AvailabilityGroup" +}, +"readOnly": true, +"type": "array" +}, +"cluster": { +"$ref": "Cluster", +"description": "Output only. The cluster for sqlserver", +"readOnly": true +}, +"databases": { +"description": "Output only. The databases for sqlserver", +"items": { +"$ref": "Database" +}, +"readOnly": true, +"type": "array" +}, +"loadBalancerServer": { +"$ref": "LoadBalancerServer", +"description": "Output only. The load balancer for sqlserver", +"readOnly": true +} +}, +"type": "object" +}, "Status": { "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). 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).", "id": "Status", @@ -2381,6 +3227,33 @@ }, "type": "object" }, +"ThreeTierWorkload": { +"description": "The body of three tier workload", +"id": "ThreeTierWorkload", +"properties": { +"apiLayer": { +"$ref": "APILayerServer", +"description": "Output only. The API layer for three tier workload", +"readOnly": true +}, +"backend": { +"$ref": "BackendServer", +"description": "Output only. The backend for three tier workload", +"readOnly": true +}, +"endpoint": { +"description": "Output only. the workload endpoint", +"readOnly": true, +"type": "string" +}, +"frontend": { +"$ref": "FrontEndServer", +"description": "Output only. The frontend for three tier workload", +"readOnly": true +} +}, +"type": "object" +}, "TorsoValidation": { "description": "The schema of torso workload validation data.", "id": "TorsoValidation", @@ -2423,6 +3296,31 @@ }, "type": "object" }, +"UpcomingMaintenanceEvent": { +"description": "Maintenance Event", +"id": "UpcomingMaintenanceEvent", +"properties": { +"endTime": { +"description": "Optional. End time", +"format": "google-datetime", +"type": "string" +}, +"maintenanceStatus": { +"description": "Optional. Maintenance status", +"type": "string" +}, +"startTime": { +"description": "Optional. Start time", +"format": "google-datetime", +"type": "string" +}, +"type": { +"description": "Optional. Type", +"type": "string" +} +}, +"type": "object" +}, "ViolationDetails": { "description": "Message describing the violation in an evaluation result.", "id": "ViolationDetails", @@ -2445,6 +3343,130 @@ }, "type": "object" }, +"WorkloadProfile": { +"description": "workload resource", +"id": "WorkloadProfile", +"properties": { +"application": { +"$ref": "Layer", +"deprecated": true, +"description": "Optional. The application layer" +}, +"ascs": { +"$ref": "Layer", +"deprecated": true, +"description": "Optional. The ascs layer" +}, +"database": { +"$ref": "Layer", +"deprecated": true, +"description": "Optional. The database layer" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. such as name, description, version. More example can be found in deployment", +"type": "object" +}, +"name": { +"description": "Identifier. name of resource names have the form 'projects/{project_id}/workloads/{workload_id}'", +"type": "string" +}, +"refreshedTime": { +"description": "Required. time when the workload data was refreshed", +"format": "google-datetime", +"type": "string" +}, +"sapWorkload": { +"$ref": "SapWorkload", +"description": "The sap workload content" +}, +"sqlserverWorkload": { +"$ref": "SqlserverWorkload", +"description": "The sqlserver workload content" +}, +"state": { +"deprecated": true, +"description": "Output only. [output only] the current state if a a workload", +"enum": [ +"STATE_UNSPECIFIED", +"ACTIVE", +"DEPLOYING", +"DESTROYING", +"MAINTENANCE" +], +"enumDescriptions": [ +"unspecified", +"ACTIVE state", +"workload is in Deploying state", +"The workload is in Destroying state", +"The Workload is undermaintance" +], +"readOnly": true, +"type": "string" +}, +"threeTierWorkload": { +"$ref": "ThreeTierWorkload", +"description": "The 3 tier web app workload content" +}, +"workloadType": { +"description": "Required. The type of the workload", +"enum": [ +"WORKLOAD_TYPE_UNSPECIFIED", +"S4_HANA", +"SQL_SERVER", +"THREE_TIER_WEB_APP" +], +"enumDescriptions": [ +"unspecified workload type", +"running sap workload s4/hana", +"running sqlserver workload", +"running 3 tier web app workload" +], +"type": "string" +} +}, +"type": "object" +}, +"WorkloadProfileHealth": { +"description": "WorkloadProfileHealth contains the detailed health check of workload.", +"id": "WorkloadProfileHealth", +"properties": { +"checkTime": { +"description": "The time when the health check was performed.", +"format": "google-datetime", +"type": "string" +}, +"componentHealthes": { +"description": "The detailed condition reports of each component.", +"items": { +"$ref": "ComponentHealth" +}, +"type": "array" +}, +"state": { +"description": "Output only. The health state of the workload.", +"enum": [ +"HEALTH_STATE_UNSPECIFIED", +"HEALTHY", +"UNHEALTHY", +"CRITICAL", +"UNSUPPORTED" +], +"enumDescriptions": [ +"Unspecified", +"healthy workload", +"unhealthy workload", +"has critical issues", +"unsupported" +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "WriteInsightRequest": { "description": "Request for sending the data insights.", "id": "WriteInsightRequest", From d20853b01a5688534873c5e14f2729c136b3d896 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 25 Feb 2025 07:08:21 +0000 Subject: [PATCH 36/36] chore(docs): Add new discovery artifacts and artifacts with minor updates --- ...r_v1.accessPolicies.servicePerimeters.html | 20 ++-- docs/dyn/admin_directory_v1.users.html | 4 +- docs/dyn/adsense_v2.accounts.reports.html | 4 +- ...nizations.environments.apis.revisions.html | 4 +- docs/dyn/areainsights_v1.v1.html | 2 +- docs/dyn/chat_v1.spaces.messages.html | 32 +++--- docs/dyn/chat_v1.spaces.spaceEvents.html | 48 ++++---- docs/dyn/cloudasset_v1.assets.html | 4 +- docs/dyn/cloudasset_v1.v1.html | 12 +- .../dyn/cloudasset_v1beta1.organizations.html | 4 +- docs/dyn/cloudasset_v1beta1.projects.html | 4 +- .../dyn/cloudasset_v1p1beta1.iamPolicies.html | 2 +- docs/dyn/cloudasset_v1p5beta1.assets.html | 4 +- ....projects.locations.deliveryPipelines.html | 8 +- ....locations.deliveryPipelines.releases.html | 6 +- ...s.deliveryPipelines.releases.rollouts.html | 2 +- .../dyn/css_v1.accounts.cssProductInputs.html | 12 +- docs/dyn/css_v1.accounts.html | 6 +- docs/dyn/dfareporting_v4.conversions.html | 32 +++--- docs/dyn/dfareporting_v4.placements.html | 8 ++ docs/dyn/dfareporting_v4.sites.html | 8 ++ ....projects.locations.publishers.models.html | 12 +- docs/dyn/forms_v1.forms.html | 10 +- docs/dyn/iam_v2.policies.html | 8 +- docs/dyn/iam_v2beta.policies.html | 8 +- .../ids_v1.projects.locations.operations.html | 4 +- ...er_v1alpha1.projects.locations.assets.html | 56 ++++----- ...rojects.locations.sources.errorFrames.html | 16 +-- ...ices_v1.projects.locations.grpcRoutes.html | 9 +- ...ices_v1.projects.locations.httpRoutes.html | 9 +- ...vices_v1.projects.locations.tcpRoutes.html | 9 +- ...vices_v1.projects.locations.tlsRoutes.html | 9 +- ...ment_v1.projects.locations.collectors.html | 4 +- .../realtimebidding_v1.bidders.creatives.html | 2 +- .../realtimebidding_v1.buyers.creatives.html | 12 +- docs/dyn/sheets_v4.spreadsheets.html | 2 +- ...anner_v1.projects.instances.databases.html | 2 +- ...projects.instances.databases.sessions.html | 12 +- docs/dyn/spanner_v1.projects.instances.html | 16 +-- ...ocations.sources.datacenterConnectors.html | 6 +- ...ions.sources.migratingVms.cutoverJobs.html | 6 +- ...ojects.locations.sources.migratingVms.html | 8 +- ...ocations.sources.datacenterConnectors.html | 6 +- ...ions.sources.migratingVms.cutoverJobs.html | 6 +- ...ojects.locations.sources.migratingVms.html | 8 +- ...ojects.locations.workflows.executions.html | 10 +- ...ions.workflows.executions.stepEntries.html | 12 +- ...tions_v1.projects.locations.workflows.html | 2 +- ...flows_v1.projects.locations.workflows.html | 10 +- .../documents/accesscontextmanager.v1.json | 4 +- .../documents/admin.directory_v1.json | 6 +- .../discovery_cache/documents/adsense.v2.json | 108 +++++++++++++++++- .../discovery_cache/documents/apigee.v1.json | 4 +- .../documents/appengine.v1.json | 4 +- .../documents/appengine.v1beta.json | 4 +- .../documents/areainsights.v1.json | 6 +- .../discovery_cache/documents/chat.v1.json | 22 ++-- .../documents/cloudasset.v1.json | 14 +-- .../documents/cloudasset.v1beta1.json | 4 +- .../documents/cloudasset.v1p1beta1.json | 6 +- .../documents/cloudasset.v1p5beta1.json | 4 +- .../documents/cloudasset.v1p7beta1.json | 8 +- .../documents/clouddeploy.v1.json | 16 +-- .../discovery_cache/documents/css.v1.json | 10 +- .../documents/datastore.v1.json | 4 +- .../documents/datastore.v1beta1.json | 4 +- .../documents/datastore.v1beta3.json | 4 +- .../documents/dfareporting.v4.json | 14 ++- .../documents/firebaseml.v2beta.json | 6 +- .../discovery_cache/documents/forms.v1.json | 12 +- .../discovery_cache/documents/iam.v1.json | 8 +- .../discovery_cache/documents/iam.v2.json | 4 +- .../discovery_cache/documents/iam.v2beta.json | 4 +- .../discovery_cache/documents/ids.v1.json | 6 +- .../documents/migrationcenter.v1alpha1.json | 6 +- .../documents/networkmanagement.v1.json | 9 +- .../documents/networkmanagement.v1beta1.json | 9 +- .../documents/networkservices.v1.json | 38 +----- .../rapidmigrationassessment.v1.json | 4 +- .../documents/realtimebidding.v1.json | 4 +- .../documents/servicenetworking.v1.json | 6 +- .../documents/servicenetworking.v1beta.json | 6 +- .../discovery_cache/documents/sheets.v4.json | 4 +- .../discovery_cache/documents/spanner.v1.json | 10 +- .../documents/vmmigration.v1.json | 6 +- .../documents/vmmigration.v1alpha1.json | 6 +- .../documents/workflowexecutions.v1.json | 10 +- .../documents/workflows.v1.json | 4 +- 88 files changed, 491 insertions(+), 417 deletions(-) diff --git a/docs/dyn/accesscontextmanager_v1.accessPolicies.servicePerimeters.html b/docs/dyn/accesscontextmanager_v1.accessPolicies.servicePerimeters.html index 549792b5ca4..67df03cc8bb 100644 --- a/docs/dyn/accesscontextmanager_v1.accessPolicies.servicePerimeters.html +++ b/docs/dyn/accesscontextmanager_v1.accessPolicies.servicePerimeters.html @@ -181,7 +181,7 @@

Method Details

"sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. - "resource": "A String", # A Google Cloud resource that you want to allow to egress the perimeter. These resources can access data outside the perimeter. This field only supports projects. The project format is `projects/{project_number}`. The resource can be in any Google Cloud organization, not just the organization where the perimeter is defined. You can't use `*` in this field to allow all Google Cloud resources. + "resource": "A String", # A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources. }, ], }, @@ -268,7 +268,7 @@

Method Details

"sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. - "resource": "A String", # A Google Cloud resource that you want to allow to egress the perimeter. These resources can access data outside the perimeter. This field only supports projects. The project format is `projects/{project_number}`. The resource can be in any Google Cloud organization, not just the organization where the perimeter is defined. You can't use `*` in this field to allow all Google Cloud resources. + "resource": "A String", # A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources. }, ], }, @@ -442,7 +442,7 @@

Method Details

"sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. - "resource": "A String", # A Google Cloud resource that you want to allow to egress the perimeter. These resources can access data outside the perimeter. This field only supports projects. The project format is `projects/{project_number}`. The resource can be in any Google Cloud organization, not just the organization where the perimeter is defined. You can't use `*` in this field to allow all Google Cloud resources. + "resource": "A String", # A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources. }, ], }, @@ -529,7 +529,7 @@

Method Details

"sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. - "resource": "A String", # A Google Cloud resource that you want to allow to egress the perimeter. These resources can access data outside the perimeter. This field only supports projects. The project format is `projects/{project_number}`. The resource can be in any Google Cloud organization, not just the organization where the perimeter is defined. You can't use `*` in this field to allow all Google Cloud resources. + "resource": "A String", # A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources. }, ], }, @@ -645,7 +645,7 @@

Method Details

"sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. - "resource": "A String", # A Google Cloud resource that you want to allow to egress the perimeter. These resources can access data outside the perimeter. This field only supports projects. The project format is `projects/{project_number}`. The resource can be in any Google Cloud organization, not just the organization where the perimeter is defined. You can't use `*` in this field to allow all Google Cloud resources. + "resource": "A String", # A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources. }, ], }, @@ -732,7 +732,7 @@

Method Details

"sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. - "resource": "A String", # A Google Cloud resource that you want to allow to egress the perimeter. These resources can access data outside the perimeter. This field only supports projects. The project format is `projects/{project_number}`. The resource can be in any Google Cloud organization, not just the organization where the perimeter is defined. You can't use `*` in this field to allow all Google Cloud resources. + "resource": "A String", # A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources. }, ], }, @@ -854,7 +854,7 @@

Method Details

"sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. - "resource": "A String", # A Google Cloud resource that you want to allow to egress the perimeter. These resources can access data outside the perimeter. This field only supports projects. The project format is `projects/{project_number}`. The resource can be in any Google Cloud organization, not just the organization where the perimeter is defined. You can't use `*` in this field to allow all Google Cloud resources. + "resource": "A String", # A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources. }, ], }, @@ -941,7 +941,7 @@

Method Details

"sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. - "resource": "A String", # A Google Cloud resource that you want to allow to egress the perimeter. These resources can access data outside the perimeter. This field only supports projects. The project format is `projects/{project_number}`. The resource can be in any Google Cloud organization, not just the organization where the perimeter is defined. You can't use `*` in this field to allow all Google Cloud resources. + "resource": "A String", # A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources. }, ], }, @@ -1079,7 +1079,7 @@

Method Details

"sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. - "resource": "A String", # A Google Cloud resource that you want to allow to egress the perimeter. These resources can access data outside the perimeter. This field only supports projects. The project format is `projects/{project_number}`. The resource can be in any Google Cloud organization, not just the organization where the perimeter is defined. You can't use `*` in this field to allow all Google Cloud resources. + "resource": "A String", # A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources. }, ], }, @@ -1166,7 +1166,7 @@

Method Details

"sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. - "resource": "A String", # A Google Cloud resource that you want to allow to egress the perimeter. These resources can access data outside the perimeter. This field only supports projects. The project format is `projects/{project_number}`. The resource can be in any Google Cloud organization, not just the organization where the perimeter is defined. You can't use `*` in this field to allow all Google Cloud resources. + "resource": "A String", # A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources. }, ], }, diff --git a/docs/dyn/admin_directory_v1.users.html b/docs/dyn/admin_directory_v1.users.html index 2f72e9c9cd6..0a0e8ed759e 100644 --- a/docs/dyn/admin_directory_v1.users.html +++ b/docs/dyn/admin_directory_v1.users.html @@ -389,7 +389,7 @@

Method Details

email - Primary email of the user. familyName - User's family name. givenName - User's given name. - pageToken: string, Token to specify next page in the list + pageToken: string, Token to specify next page in the list. The page token is only valid for three days. projection: string, What subset of fields to fetch for this user. Allowed values basic - Do not include any custom fields for the user. @@ -416,7 +416,7 @@

Method Details

{ "etag": "A String", # ETag of the resource. "kind": "admin#directory#users", # Kind of resource this is. - "nextPageToken": "A String", # Token used to access next page of this result. + "nextPageToken": "A String", # Token used to access next page of this result. The page token is only valid for three days. "trigger_event": "A String", # Event that triggered this response (only used in case of Push Response) "users": [ # A list of user objects. { # The Directory API allows you to create and manage your account's users, user aliases, and user Google profile photos. For more information about common tasks, see the [User Accounts Developer's Guide](/admin-sdk/directory/v1/guides/manage-users.html) and the [User Aliases Developer's Guide](/admin-sdk/directory/v1/guides/manage-user-aliases.html). diff --git a/docs/dyn/adsense_v2.accounts.reports.html b/docs/dyn/adsense_v2.accounts.reports.html index a8084ea08d4..b4c8cc553c3 100644 --- a/docs/dyn/adsense_v2.accounts.reports.html +++ b/docs/dyn/adsense_v2.accounts.reports.html @@ -131,7 +131,7 @@

Method Details

AD_UNIT_SIZE_CODE - The size code of an ad unit (e.g. "728x90", "responsive"). CUSTOM_CHANNEL_NAME - Custom channel name. The members of this dimension match the values from CustomChannel.display_name. CUSTOM_CHANNEL_ID - Unique ID of a custom channel. The members of this dimension match the values from CustomChannel.reporting_dimension_id. - HOSTED_CUSTOM_CHANNEL_ID - Unique ID of a hosted client's custom channel. + HOSTED_CUSTOM_CHANNEL_ID - Not supported. OWNED_SITE_DOMAIN_NAME - Domain name of a verified site (e.g. "example.com"). The members of this dimension match the values from Site.domain. OWNED_SITE_ID - Unique ID of a verified site. The members of this dimension match the values from Site.reporting_dimension_id. PAGE_URL - URL of the page upon which the ad was served. This is a complete URL including scheme and query parameters. Note that the URL that appears in this dimension may be a canonicalized version of the one that was used in the original request, and so may not exactly match the URL that a user might have seen. Note that there are also some caveats to be aware of when using this dimension. For more information, see [Page URL breakdown](https://support.google.com/adsense/answer/11988478). @@ -309,7 +309,7 @@

Method Details

AD_UNIT_SIZE_CODE - The size code of an ad unit (e.g. "728x90", "responsive"). CUSTOM_CHANNEL_NAME - Custom channel name. The members of this dimension match the values from CustomChannel.display_name. CUSTOM_CHANNEL_ID - Unique ID of a custom channel. The members of this dimension match the values from CustomChannel.reporting_dimension_id. - HOSTED_CUSTOM_CHANNEL_ID - Unique ID of a hosted client's custom channel. + HOSTED_CUSTOM_CHANNEL_ID - Not supported. OWNED_SITE_DOMAIN_NAME - Domain name of a verified site (e.g. "example.com"). The members of this dimension match the values from Site.domain. OWNED_SITE_ID - Unique ID of a verified site. The members of this dimension match the values from Site.reporting_dimension_id. PAGE_URL - URL of the page upon which the ad was served. This is a complete URL including scheme and query parameters. Note that the URL that appears in this dimension may be a canonicalized version of the one that was used in the original request, and so may not exactly match the URL that a user might have seen. Note that there are also some caveats to be aware of when using this dimension. For more information, see [Page URL breakdown](https://support.google.com/adsense/answer/11988478). diff --git a/docs/dyn/apigee_v1.organizations.environments.apis.revisions.html b/docs/dyn/apigee_v1.organizations.environments.apis.revisions.html index d57b3801a4e..2d26efe8a14 100644 --- a/docs/dyn/apigee_v1.organizations.environments.apis.revisions.html +++ b/docs/dyn/apigee_v1.organizations.environments.apis.revisions.html @@ -89,7 +89,7 @@

Instance Methods

Close httplib2 connections.

deploy(name, override=None, sequencedRollout=None, serviceAccount=None, x__xgafv=None)

-

Deploys a revision of an API proxy. If another revision of the same API proxy revision is currently deployed, set the `override` parameter to `true` to have this revision replace the currently deployed revision. You cannot invoke an API proxy until it has been deployed to an environment. After you deploy an API proxy revision, you cannot edit it. To edit the API proxy, you must create and deploy a new revision. For a request path `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments`, two permissions are required: * `apigee.deployments.create` on the resource `organizations/{org}/environments/{env}` * `apigee.proxyrevisions.deploy` on the resource `organizations/{org}/apis/{api}/revisions/{rev}`

+

Deploys a revision of an API proxy. If another revision of the same API proxy revision is currently deployed, set the `override` parameter to `true` to have this revision replace the currently deployed revision. You cannot invoke an API proxy until it has been deployed to an environment. After you deploy an API proxy revision, you cannot edit it. To edit the API proxy, you must create and deploy a new revision. For a request path `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments`, two permissions are required: * `apigee.deployments.create` on the resource `organizations/{org}/environments/{env}` * `apigee.proxyrevisions.deploy` on the resource `organizations/{org}/apis/{api}/revisions/{rev}` Apigee hybrid validates the dependencies between shared flows and API proxies at deployment time. For example, if the Flow Callout policy in an API proxy references a shared flow that either doesn't exist or isn't deployed, the API proxy deployment fails.

getDeployments(name, x__xgafv=None)

Gets the deployment of an API proxy revision and actual state reported by runtime pods.

@@ -104,7 +104,7 @@

Method Details

deploy(name, override=None, sequencedRollout=None, serviceAccount=None, x__xgafv=None) -
Deploys a revision of an API proxy. If another revision of the same API proxy revision is currently deployed, set the `override` parameter to `true` to have this revision replace the currently deployed revision. You cannot invoke an API proxy until it has been deployed to an environment. After you deploy an API proxy revision, you cannot edit it. To edit the API proxy, you must create and deploy a new revision. For a request path `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments`, two permissions are required: * `apigee.deployments.create` on the resource `organizations/{org}/environments/{env}` * `apigee.proxyrevisions.deploy` on the resource `organizations/{org}/apis/{api}/revisions/{rev}` 
+  
Deploys a revision of an API proxy. If another revision of the same API proxy revision is currently deployed, set the `override` parameter to `true` to have this revision replace the currently deployed revision. You cannot invoke an API proxy until it has been deployed to an environment. After you deploy an API proxy revision, you cannot edit it. To edit the API proxy, you must create and deploy a new revision. For a request path `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments`, two permissions are required: * `apigee.deployments.create` on the resource `organizations/{org}/environments/{env}` * `apigee.proxyrevisions.deploy` on the resource `organizations/{org}/apis/{api}/revisions/{rev}` Apigee hybrid validates the dependencies between shared flows and API proxies at deployment time. For example, if the Flow Callout policy in an API proxy references a shared flow that either doesn't exist or isn't deployed, the API proxy deployment fails.
 
 Args:
   name: string, Required. Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}` (required)
diff --git a/docs/dyn/areainsights_v1.v1.html b/docs/dyn/areainsights_v1.v1.html
index 067c55e2d93..6815218143e 100644
--- a/docs/dyn/areainsights_v1.v1.html
+++ b/docs/dyn/areainsights_v1.v1.html
@@ -102,7 +102,7 @@ 

Method Details

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, - "place": "A String", # The Place resource name of the center of the circle. Only point places are supported. + "place": "A String", # **Format:** Must be in the format `places/PLACE_ID`, where `PLACE_ID` is the unique identifier of a place. For example: `places/ChIJgUbEo8cfqokR5lP9_Wh_DaM`. "radius": 42, # Optional. The radius of the circle in meters }, "customArea": { # Custom Area. # Custom area specified by a polygon. diff --git a/docs/dyn/chat_v1.spaces.messages.html b/docs/dyn/chat_v1.spaces.messages.html index 8c2d1cfe1d1..132fb5b6a3d 100644 --- a/docs/dyn/chat_v1.spaces.messages.html +++ b/docs/dyn/chat_v1.spaces.messages.html @@ -2322,8 +2322,8 @@

Method Details

"name": "A String", # Resource name for a Google Chat user. Format: `users/{user}`. `users/app` can be used as an alias for the calling app bot user. For human users, `{user}` is the same user identifier as: - the `id` for the [Person](https://developers.google.com/people/api/rest/v1/people) in the People API. For example, `users/123456789` in Chat API represents the same person as the `123456789` Person profile ID in People API. - the `id` for a [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. - the user's email address can be used as an alias for `{user}` in API requests. For example, if the People API Person profile ID for `user@example.com` is `123456789`, you can use `users/user@example.com` as an alias to reference `users/123456789`. Only the canonical resource name (for example `users/123456789`) will be returned from the API. "type": "A String", # User type. }, - "slashCommand": { # A [slash command](https://developers.google.com/workspace/chat/slash-commands) in Google Chat. # Output only. Slash command information, if applicable. - "commandId": "A String", # The ID of the slash command invoked. + "slashCommand": { # Metadata about a [slash command](https://developers.google.com/workspace/chat/commands) in Google Chat. # Output only. Slash command information, if applicable. + "commandId": "A String", # The ID of the slash command. }, "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # Output only. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output only populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. @@ -4612,8 +4612,8 @@

Method Details

"name": "A String", # Resource name for a Google Chat user. Format: `users/{user}`. `users/app` can be used as an alias for the calling app bot user. For human users, `{user}` is the same user identifier as: - the `id` for the [Person](https://developers.google.com/people/api/rest/v1/people) in the People API. For example, `users/123456789` in Chat API represents the same person as the `123456789` Person profile ID in People API. - the `id` for a [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. - the user's email address can be used as an alias for `{user}` in API requests. For example, if the People API Person profile ID for `user@example.com` is `123456789`, you can use `users/user@example.com` as an alias to reference `users/123456789`. Only the canonical resource name (for example `users/123456789`) will be returned from the API. "type": "A String", # User type. }, - "slashCommand": { # A [slash command](https://developers.google.com/workspace/chat/slash-commands) in Google Chat. # Output only. Slash command information, if applicable. - "commandId": "A String", # The ID of the slash command invoked. + "slashCommand": { # Metadata about a [slash command](https://developers.google.com/workspace/chat/commands) in Google Chat. # Output only. Slash command information, if applicable. + "commandId": "A String", # The ID of the slash command. }, "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # Output only. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output only populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. @@ -6920,8 +6920,8 @@

Method Details

"name": "A String", # Resource name for a Google Chat user. Format: `users/{user}`. `users/app` can be used as an alias for the calling app bot user. For human users, `{user}` is the same user identifier as: - the `id` for the [Person](https://developers.google.com/people/api/rest/v1/people) in the People API. For example, `users/123456789` in Chat API represents the same person as the `123456789` Person profile ID in People API. - the `id` for a [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. - the user's email address can be used as an alias for `{user}` in API requests. For example, if the People API Person profile ID for `user@example.com` is `123456789`, you can use `users/user@example.com` as an alias to reference `users/123456789`. Only the canonical resource name (for example `users/123456789`) will be returned from the API. "type": "A String", # User type. }, - "slashCommand": { # A [slash command](https://developers.google.com/workspace/chat/slash-commands) in Google Chat. # Output only. Slash command information, if applicable. - "commandId": "A String", # The ID of the slash command invoked. + "slashCommand": { # Metadata about a [slash command](https://developers.google.com/workspace/chat/commands) in Google Chat. # Output only. Slash command information, if applicable. + "commandId": "A String", # The ID of the slash command. }, "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # Output only. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output only populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. @@ -9216,8 +9216,8 @@

Method Details

"name": "A String", # Resource name for a Google Chat user. Format: `users/{user}`. `users/app` can be used as an alias for the calling app bot user. For human users, `{user}` is the same user identifier as: - the `id` for the [Person](https://developers.google.com/people/api/rest/v1/people) in the People API. For example, `users/123456789` in Chat API represents the same person as the `123456789` Person profile ID in People API. - the `id` for a [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. - the user's email address can be used as an alias for `{user}` in API requests. For example, if the People API Person profile ID for `user@example.com` is `123456789`, you can use `users/user@example.com` as an alias to reference `users/123456789`. Only the canonical resource name (for example `users/123456789`) will be returned from the API. "type": "A String", # User type. }, - "slashCommand": { # A [slash command](https://developers.google.com/workspace/chat/slash-commands) in Google Chat. # Output only. Slash command information, if applicable. - "commandId": "A String", # The ID of the slash command invoked. + "slashCommand": { # Metadata about a [slash command](https://developers.google.com/workspace/chat/commands) in Google Chat. # Output only. Slash command information, if applicable. + "commandId": "A String", # The ID of the slash command. }, "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # Output only. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output only populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. @@ -11517,8 +11517,8 @@

Method Details

"name": "A String", # Resource name for a Google Chat user. Format: `users/{user}`. `users/app` can be used as an alias for the calling app bot user. For human users, `{user}` is the same user identifier as: - the `id` for the [Person](https://developers.google.com/people/api/rest/v1/people) in the People API. For example, `users/123456789` in Chat API represents the same person as the `123456789` Person profile ID in People API. - the `id` for a [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. - the user's email address can be used as an alias for `{user}` in API requests. For example, if the People API Person profile ID for `user@example.com` is `123456789`, you can use `users/user@example.com` as an alias to reference `users/123456789`. Only the canonical resource name (for example `users/123456789`) will be returned from the API. "type": "A String", # User type. }, - "slashCommand": { # A [slash command](https://developers.google.com/workspace/chat/slash-commands) in Google Chat. # Output only. Slash command information, if applicable. - "commandId": "A String", # The ID of the slash command invoked. + "slashCommand": { # Metadata about a [slash command](https://developers.google.com/workspace/chat/commands) in Google Chat. # Output only. Slash command information, if applicable. + "commandId": "A String", # The ID of the slash command. }, "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # Output only. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output only populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. @@ -13801,8 +13801,8 @@

Method Details

"name": "A String", # Resource name for a Google Chat user. Format: `users/{user}`. `users/app` can be used as an alias for the calling app bot user. For human users, `{user}` is the same user identifier as: - the `id` for the [Person](https://developers.google.com/people/api/rest/v1/people) in the People API. For example, `users/123456789` in Chat API represents the same person as the `123456789` Person profile ID in People API. - the `id` for a [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. - the user's email address can be used as an alias for `{user}` in API requests. For example, if the People API Person profile ID for `user@example.com` is `123456789`, you can use `users/user@example.com` as an alias to reference `users/123456789`. Only the canonical resource name (for example `users/123456789`) will be returned from the API. "type": "A String", # User type. }, - "slashCommand": { # A [slash command](https://developers.google.com/workspace/chat/slash-commands) in Google Chat. # Output only. Slash command information, if applicable. - "commandId": "A String", # The ID of the slash command invoked. + "slashCommand": { # Metadata about a [slash command](https://developers.google.com/workspace/chat/commands) in Google Chat. # Output only. Slash command information, if applicable. + "commandId": "A String", # The ID of the slash command. }, "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # Output only. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output only populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. @@ -16085,8 +16085,8 @@

Method Details

"name": "A String", # Resource name for a Google Chat user. Format: `users/{user}`. `users/app` can be used as an alias for the calling app bot user. For human users, `{user}` is the same user identifier as: - the `id` for the [Person](https://developers.google.com/people/api/rest/v1/people) in the People API. For example, `users/123456789` in Chat API represents the same person as the `123456789` Person profile ID in People API. - the `id` for a [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. - the user's email address can be used as an alias for `{user}` in API requests. For example, if the People API Person profile ID for `user@example.com` is `123456789`, you can use `users/user@example.com` as an alias to reference `users/123456789`. Only the canonical resource name (for example `users/123456789`) will be returned from the API. "type": "A String", # User type. }, - "slashCommand": { # A [slash command](https://developers.google.com/workspace/chat/slash-commands) in Google Chat. # Output only. Slash command information, if applicable. - "commandId": "A String", # The ID of the slash command invoked. + "slashCommand": { # Metadata about a [slash command](https://developers.google.com/workspace/chat/commands) in Google Chat. # Output only. Slash command information, if applicable. + "commandId": "A String", # The ID of the slash command. }, "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # Output only. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output only populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. @@ -18369,8 +18369,8 @@

Method Details

"name": "A String", # Resource name for a Google Chat user. Format: `users/{user}`. `users/app` can be used as an alias for the calling app bot user. For human users, `{user}` is the same user identifier as: - the `id` for the [Person](https://developers.google.com/people/api/rest/v1/people) in the People API. For example, `users/123456789` in Chat API represents the same person as the `123456789` Person profile ID in People API. - the `id` for a [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. - the user's email address can be used as an alias for `{user}` in API requests. For example, if the People API Person profile ID for `user@example.com` is `123456789`, you can use `users/user@example.com` as an alias to reference `users/123456789`. Only the canonical resource name (for example `users/123456789`) will be returned from the API. "type": "A String", # User type. }, - "slashCommand": { # A [slash command](https://developers.google.com/workspace/chat/slash-commands) in Google Chat. # Output only. Slash command information, if applicable. - "commandId": "A String", # The ID of the slash command invoked. + "slashCommand": { # Metadata about a [slash command](https://developers.google.com/workspace/chat/commands) in Google Chat. # Output only. Slash command information, if applicable. + "commandId": "A String", # The ID of the slash command. }, "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # Output only. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output only populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. diff --git a/docs/dyn/chat_v1.spaces.spaceEvents.html b/docs/dyn/chat_v1.spaces.spaceEvents.html index 0db0c1d60ae..70a2946e510 100644 --- a/docs/dyn/chat_v1.spaces.spaceEvents.html +++ b/docs/dyn/chat_v1.spaces.spaceEvents.html @@ -2437,8 +2437,8 @@

Method Details

"name": "A String", # Resource name for a Google Chat user. Format: `users/{user}`. `users/app` can be used as an alias for the calling app bot user. For human users, `{user}` is the same user identifier as: - the `id` for the [Person](https://developers.google.com/people/api/rest/v1/people) in the People API. For example, `users/123456789` in Chat API represents the same person as the `123456789` Person profile ID in People API. - the `id` for a [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. - the user's email address can be used as an alias for `{user}` in API requests. For example, if the People API Person profile ID for `user@example.com` is `123456789`, you can use `users/user@example.com` as an alias to reference `users/123456789`. Only the canonical resource name (for example `users/123456789`) will be returned from the API. "type": "A String", # User type. }, - "slashCommand": { # A [slash command](https://developers.google.com/workspace/chat/slash-commands) in Google Chat. # Output only. Slash command information, if applicable. - "commandId": "A String", # The ID of the slash command invoked. + "slashCommand": { # Metadata about a [slash command](https://developers.google.com/workspace/chat/commands) in Google Chat. # Output only. Slash command information, if applicable. + "commandId": "A String", # The ID of the slash command. }, "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # Output only. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output only populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. @@ -4716,8 +4716,8 @@

Method Details

"name": "A String", # Resource name for a Google Chat user. Format: `users/{user}`. `users/app` can be used as an alias for the calling app bot user. For human users, `{user}` is the same user identifier as: - the `id` for the [Person](https://developers.google.com/people/api/rest/v1/people) in the People API. For example, `users/123456789` in Chat API represents the same person as the `123456789` Person profile ID in People API. - the `id` for a [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. - the user's email address can be used as an alias for `{user}` in API requests. For example, if the People API Person profile ID for `user@example.com` is `123456789`, you can use `users/user@example.com` as an alias to reference `users/123456789`. Only the canonical resource name (for example `users/123456789`) will be returned from the API. "type": "A String", # User type. }, - "slashCommand": { # A [slash command](https://developers.google.com/workspace/chat/slash-commands) in Google Chat. # Output only. Slash command information, if applicable. - "commandId": "A String", # The ID of the slash command invoked. + "slashCommand": { # Metadata about a [slash command](https://developers.google.com/workspace/chat/commands) in Google Chat. # Output only. Slash command information, if applicable. + "commandId": "A String", # The ID of the slash command. }, "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # Output only. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output only populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. @@ -6995,8 +6995,8 @@

Method Details

"name": "A String", # Resource name for a Google Chat user. Format: `users/{user}`. `users/app` can be used as an alias for the calling app bot user. For human users, `{user}` is the same user identifier as: - the `id` for the [Person](https://developers.google.com/people/api/rest/v1/people) in the People API. For example, `users/123456789` in Chat API represents the same person as the `123456789` Person profile ID in People API. - the `id` for a [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. - the user's email address can be used as an alias for `{user}` in API requests. For example, if the People API Person profile ID for `user@example.com` is `123456789`, you can use `users/user@example.com` as an alias to reference `users/123456789`. Only the canonical resource name (for example `users/123456789`) will be returned from the API. "type": "A String", # User type. }, - "slashCommand": { # A [slash command](https://developers.google.com/workspace/chat/slash-commands) in Google Chat. # Output only. Slash command information, if applicable. - "commandId": "A String", # The ID of the slash command invoked. + "slashCommand": { # Metadata about a [slash command](https://developers.google.com/workspace/chat/commands) in Google Chat. # Output only. Slash command information, if applicable. + "commandId": "A String", # The ID of the slash command. }, "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # Output only. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output only populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. @@ -9272,8 +9272,8 @@

Method Details

"name": "A String", # Resource name for a Google Chat user. Format: `users/{user}`. `users/app` can be used as an alias for the calling app bot user. For human users, `{user}` is the same user identifier as: - the `id` for the [Person](https://developers.google.com/people/api/rest/v1/people) in the People API. For example, `users/123456789` in Chat API represents the same person as the `123456789` Person profile ID in People API. - the `id` for a [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. - the user's email address can be used as an alias for `{user}` in API requests. For example, if the People API Person profile ID for `user@example.com` is `123456789`, you can use `users/user@example.com` as an alias to reference `users/123456789`. Only the canonical resource name (for example `users/123456789`) will be returned from the API. "type": "A String", # User type. }, - "slashCommand": { # A [slash command](https://developers.google.com/workspace/chat/slash-commands) in Google Chat. # Output only. Slash command information, if applicable. - "commandId": "A String", # The ID of the slash command invoked. + "slashCommand": { # Metadata about a [slash command](https://developers.google.com/workspace/chat/commands) in Google Chat. # Output only. Slash command information, if applicable. + "commandId": "A String", # The ID of the slash command. }, "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # Output only. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output only populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. @@ -11547,8 +11547,8 @@

Method Details

"name": "A String", # Resource name for a Google Chat user. Format: `users/{user}`. `users/app` can be used as an alias for the calling app bot user. For human users, `{user}` is the same user identifier as: - the `id` for the [Person](https://developers.google.com/people/api/rest/v1/people) in the People API. For example, `users/123456789` in Chat API represents the same person as the `123456789` Person profile ID in People API. - the `id` for a [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. - the user's email address can be used as an alias for `{user}` in API requests. For example, if the People API Person profile ID for `user@example.com` is `123456789`, you can use `users/user@example.com` as an alias to reference `users/123456789`. Only the canonical resource name (for example `users/123456789`) will be returned from the API. "type": "A String", # User type. }, - "slashCommand": { # A [slash command](https://developers.google.com/workspace/chat/slash-commands) in Google Chat. # Output only. Slash command information, if applicable. - "commandId": "A String", # The ID of the slash command invoked. + "slashCommand": { # Metadata about a [slash command](https://developers.google.com/workspace/chat/commands) in Google Chat. # Output only. Slash command information, if applicable. + "commandId": "A String", # The ID of the slash command. }, "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # Output only. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output only populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. @@ -13822,8 +13822,8 @@

Method Details

"name": "A String", # Resource name for a Google Chat user. Format: `users/{user}`. `users/app` can be used as an alias for the calling app bot user. For human users, `{user}` is the same user identifier as: - the `id` for the [Person](https://developers.google.com/people/api/rest/v1/people) in the People API. For example, `users/123456789` in Chat API represents the same person as the `123456789` Person profile ID in People API. - the `id` for a [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. - the user's email address can be used as an alias for `{user}` in API requests. For example, if the People API Person profile ID for `user@example.com` is `123456789`, you can use `users/user@example.com` as an alias to reference `users/123456789`. Only the canonical resource name (for example `users/123456789`) will be returned from the API. "type": "A String", # User type. }, - "slashCommand": { # A [slash command](https://developers.google.com/workspace/chat/slash-commands) in Google Chat. # Output only. Slash command information, if applicable. - "commandId": "A String", # The ID of the slash command invoked. + "slashCommand": { # Metadata about a [slash command](https://developers.google.com/workspace/chat/commands) in Google Chat. # Output only. Slash command information, if applicable. + "commandId": "A String", # The ID of the slash command. }, "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # Output only. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output only populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. @@ -16468,8 +16468,8 @@

Method Details

"name": "A String", # Resource name for a Google Chat user. Format: `users/{user}`. `users/app` can be used as an alias for the calling app bot user. For human users, `{user}` is the same user identifier as: - the `id` for the [Person](https://developers.google.com/people/api/rest/v1/people) in the People API. For example, `users/123456789` in Chat API represents the same person as the `123456789` Person profile ID in People API. - the `id` for a [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. - the user's email address can be used as an alias for `{user}` in API requests. For example, if the People API Person profile ID for `user@example.com` is `123456789`, you can use `users/user@example.com` as an alias to reference `users/123456789`. Only the canonical resource name (for example `users/123456789`) will be returned from the API. "type": "A String", # User type. }, - "slashCommand": { # A [slash command](https://developers.google.com/workspace/chat/slash-commands) in Google Chat. # Output only. Slash command information, if applicable. - "commandId": "A String", # The ID of the slash command invoked. + "slashCommand": { # Metadata about a [slash command](https://developers.google.com/workspace/chat/commands) in Google Chat. # Output only. Slash command information, if applicable. + "commandId": "A String", # The ID of the slash command. }, "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # Output only. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output only populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. @@ -18747,8 +18747,8 @@

Method Details

"name": "A String", # Resource name for a Google Chat user. Format: `users/{user}`. `users/app` can be used as an alias for the calling app bot user. For human users, `{user}` is the same user identifier as: - the `id` for the [Person](https://developers.google.com/people/api/rest/v1/people) in the People API. For example, `users/123456789` in Chat API represents the same person as the `123456789` Person profile ID in People API. - the `id` for a [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. - the user's email address can be used as an alias for `{user}` in API requests. For example, if the People API Person profile ID for `user@example.com` is `123456789`, you can use `users/user@example.com` as an alias to reference `users/123456789`. Only the canonical resource name (for example `users/123456789`) will be returned from the API. "type": "A String", # User type. }, - "slashCommand": { # A [slash command](https://developers.google.com/workspace/chat/slash-commands) in Google Chat. # Output only. Slash command information, if applicable. - "commandId": "A String", # The ID of the slash command invoked. + "slashCommand": { # Metadata about a [slash command](https://developers.google.com/workspace/chat/commands) in Google Chat. # Output only. Slash command information, if applicable. + "commandId": "A String", # The ID of the slash command. }, "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # Output only. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output only populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. @@ -21026,8 +21026,8 @@

Method Details

"name": "A String", # Resource name for a Google Chat user. Format: `users/{user}`. `users/app` can be used as an alias for the calling app bot user. For human users, `{user}` is the same user identifier as: - the `id` for the [Person](https://developers.google.com/people/api/rest/v1/people) in the People API. For example, `users/123456789` in Chat API represents the same person as the `123456789` Person profile ID in People API. - the `id` for a [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. - the user's email address can be used as an alias for `{user}` in API requests. For example, if the People API Person profile ID for `user@example.com` is `123456789`, you can use `users/user@example.com` as an alias to reference `users/123456789`. Only the canonical resource name (for example `users/123456789`) will be returned from the API. "type": "A String", # User type. }, - "slashCommand": { # A [slash command](https://developers.google.com/workspace/chat/slash-commands) in Google Chat. # Output only. Slash command information, if applicable. - "commandId": "A String", # The ID of the slash command invoked. + "slashCommand": { # Metadata about a [slash command](https://developers.google.com/workspace/chat/commands) in Google Chat. # Output only. Slash command information, if applicable. + "commandId": "A String", # The ID of the slash command. }, "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # Output only. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output only populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. @@ -23303,8 +23303,8 @@

Method Details

"name": "A String", # Resource name for a Google Chat user. Format: `users/{user}`. `users/app` can be used as an alias for the calling app bot user. For human users, `{user}` is the same user identifier as: - the `id` for the [Person](https://developers.google.com/people/api/rest/v1/people) in the People API. For example, `users/123456789` in Chat API represents the same person as the `123456789` Person profile ID in People API. - the `id` for a [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. - the user's email address can be used as an alias for `{user}` in API requests. For example, if the People API Person profile ID for `user@example.com` is `123456789`, you can use `users/user@example.com` as an alias to reference `users/123456789`. Only the canonical resource name (for example `users/123456789`) will be returned from the API. "type": "A String", # User type. }, - "slashCommand": { # A [slash command](https://developers.google.com/workspace/chat/slash-commands) in Google Chat. # Output only. Slash command information, if applicable. - "commandId": "A String", # The ID of the slash command invoked. + "slashCommand": { # Metadata about a [slash command](https://developers.google.com/workspace/chat/commands) in Google Chat. # Output only. Slash command information, if applicable. + "commandId": "A String", # The ID of the slash command. }, "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # Output only. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output only populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. @@ -25578,8 +25578,8 @@

Method Details

"name": "A String", # Resource name for a Google Chat user. Format: `users/{user}`. `users/app` can be used as an alias for the calling app bot user. For human users, `{user}` is the same user identifier as: - the `id` for the [Person](https://developers.google.com/people/api/rest/v1/people) in the People API. For example, `users/123456789` in Chat API represents the same person as the `123456789` Person profile ID in People API. - the `id` for a [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. - the user's email address can be used as an alias for `{user}` in API requests. For example, if the People API Person profile ID for `user@example.com` is `123456789`, you can use `users/user@example.com` as an alias to reference `users/123456789`. Only the canonical resource name (for example `users/123456789`) will be returned from the API. "type": "A String", # User type. }, - "slashCommand": { # A [slash command](https://developers.google.com/workspace/chat/slash-commands) in Google Chat. # Output only. Slash command information, if applicable. - "commandId": "A String", # The ID of the slash command invoked. + "slashCommand": { # Metadata about a [slash command](https://developers.google.com/workspace/chat/commands) in Google Chat. # Output only. Slash command information, if applicable. + "commandId": "A String", # The ID of the slash command. }, "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # Output only. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output only populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. @@ -27853,8 +27853,8 @@

Method Details

"name": "A String", # Resource name for a Google Chat user. Format: `users/{user}`. `users/app` can be used as an alias for the calling app bot user. For human users, `{user}` is the same user identifier as: - the `id` for the [Person](https://developers.google.com/people/api/rest/v1/people) in the People API. For example, `users/123456789` in Chat API represents the same person as the `123456789` Person profile ID in People API. - the `id` for a [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. - the user's email address can be used as an alias for `{user}` in API requests. For example, if the People API Person profile ID for `user@example.com` is `123456789`, you can use `users/user@example.com` as an alias to reference `users/123456789`. Only the canonical resource name (for example `users/123456789`) will be returned from the API. "type": "A String", # User type. }, - "slashCommand": { # A [slash command](https://developers.google.com/workspace/chat/slash-commands) in Google Chat. # Output only. Slash command information, if applicable. - "commandId": "A String", # The ID of the slash command invoked. + "slashCommand": { # Metadata about a [slash command](https://developers.google.com/workspace/chat/commands) in Google Chat. # Output only. Slash command information, if applicable. + "commandId": "A String", # The ID of the slash command. }, "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # Output only. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output only populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. diff --git a/docs/dyn/cloudasset_v1.assets.html b/docs/dyn/cloudasset_v1.assets.html index d17662e268b..85defb892a6 100644 --- a/docs/dyn/cloudasset_v1.assets.html +++ b/docs/dyn/cloudasset_v1.assets.html @@ -470,7 +470,7 @@

Method Details

"sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. - "resource": "A String", # A Google Cloud resource that you want to allow to egress the perimeter. These resources can access data outside the perimeter. This field only supports projects. The project format is `projects/{project_number}`. The resource can be in any Google Cloud organization, not just the organization where the perimeter is defined. You can't use `*` in this field to allow all Google Cloud resources. + "resource": "A String", # A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources. }, ], }, @@ -557,7 +557,7 @@

Method Details

"sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. - "resource": "A String", # A Google Cloud resource that you want to allow to egress the perimeter. These resources can access data outside the perimeter. This field only supports projects. The project format is `projects/{project_number}`. The resource can be in any Google Cloud organization, not just the organization where the perimeter is defined. You can't use `*` in this field to allow all Google Cloud resources. + "resource": "A String", # A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources. }, ], }, diff --git a/docs/dyn/cloudasset_v1.v1.html b/docs/dyn/cloudasset_v1.v1.html index f735964768a..1f908de3d64 100644 --- a/docs/dyn/cloudasset_v1.v1.html +++ b/docs/dyn/cloudasset_v1.v1.html @@ -455,7 +455,7 @@

Method Details

Args: resource: string, Required. Name of the resource to perform the analysis against. Only Google Cloud projects are supported as of today. Hence, this can only be a project ID (such as "projects/my-project-id") or a project number (such as "projects/12345"). (required) - destinationParent: string, Required. Name of the Google Cloud folder or organization to reparent the target resource. The analysis will be performed against hypothetically moving the resource to this specified desitination parent. This can only be a folder number (such as "folders/123") or an organization number (such as "organizations/123"). + destinationParent: string, Required. Name of the Google Cloud folder or organization to reparent the target resource. The analysis will be performed against hypothetically moving the resource to this specified destination parent. This can only be a folder number (such as "folders/123") or an organization number (such as "organizations/123"). view: string, Analysis view indicating what information should be included in the analysis response. If unspecified, the default view is FULL. Allowed values ANALYSIS_VIEW_UNSPECIFIED - The default/unset value. The API will default to the FULL view. @@ -1358,7 +1358,7 @@

Method Details

"sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. - "resource": "A String", # A Google Cloud resource that you want to allow to egress the perimeter. These resources can access data outside the perimeter. This field only supports projects. The project format is `projects/{project_number}`. The resource can be in any Google Cloud organization, not just the organization where the perimeter is defined. You can't use `*` in this field to allow all Google Cloud resources. + "resource": "A String", # A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources. }, ], }, @@ -1445,7 +1445,7 @@

Method Details

"sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. - "resource": "A String", # A Google Cloud resource that you want to allow to egress the perimeter. These resources can access data outside the perimeter. This field only supports projects. The project format is `projects/{project_number}`. The resource can be in any Google Cloud organization, not just the organization where the perimeter is defined. You can't use `*` in this field to allow all Google Cloud resources. + "resource": "A String", # A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources. }, ], }, @@ -1874,7 +1874,7 @@

Method Details

"sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. - "resource": "A String", # A Google Cloud resource that you want to allow to egress the perimeter. These resources can access data outside the perimeter. This field only supports projects. The project format is `projects/{project_number}`. The resource can be in any Google Cloud organization, not just the organization where the perimeter is defined. You can't use `*` in this field to allow all Google Cloud resources. + "resource": "A String", # A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources. }, ], }, @@ -1961,7 +1961,7 @@

Method Details

"sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. - "resource": "A String", # A Google Cloud resource that you want to allow to egress the perimeter. These resources can access data outside the perimeter. This field only supports projects. The project format is `projects/{project_number}`. The resource can be in any Google Cloud organization, not just the organization where the perimeter is defined. You can't use `*` in this field to allow all Google Cloud resources. + "resource": "A String", # A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources. }, ], }, @@ -2265,7 +2265,7 @@

Method Details

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, - "project": "A String", # The project that the associated Google Cloud resource belongs to, in the form of projects/{PROJECT_NUMBER}. If an IAM policy is set on a resource (like VM instance, Cloud Storage bucket), the project field will indicate the project that contains the resource. If an IAM policy is set on a folder or orgnization, this field will be empty. To search against the `project`: * specify the `scope` field as this project in your search request. + "project": "A String", # The project that the associated Google Cloud resource belongs to, in the form of projects/{PROJECT_NUMBER}. If an IAM policy is set on a resource (like VM instance, Cloud Storage bucket), the project field will indicate the project that contains the resource. If an IAM policy is set on a folder or organization, this field will be empty. To search against the `project`: * specify the `scope` field as this project in your search request. "resource": "A String", # The full resource name of the resource associated with this IAM policy. Example: `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`. See [Cloud Asset Inventory Resource Name Format](https://cloud.google.com/asset-inventory/docs/resource-name-format) for more information. To search against the `resource`: * use a field query. Example: `resource:organizations/123` }, ], diff --git a/docs/dyn/cloudasset_v1beta1.organizations.html b/docs/dyn/cloudasset_v1beta1.organizations.html index 10d07389a67..5d902a5cd30 100644 --- a/docs/dyn/cloudasset_v1beta1.organizations.html +++ b/docs/dyn/cloudasset_v1beta1.organizations.html @@ -272,7 +272,7 @@

Method Details

"sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. - "resource": "A String", # A Google Cloud resource that you want to allow to egress the perimeter. These resources can access data outside the perimeter. This field only supports projects. The project format is `projects/{project_number}`. The resource can be in any Google Cloud organization, not just the organization where the perimeter is defined. You can't use `*` in this field to allow all Google Cloud resources. + "resource": "A String", # A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources. }, ], }, @@ -359,7 +359,7 @@

Method Details

"sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. - "resource": "A String", # A Google Cloud resource that you want to allow to egress the perimeter. These resources can access data outside the perimeter. This field only supports projects. The project format is `projects/{project_number}`. The resource can be in any Google Cloud organization, not just the organization where the perimeter is defined. You can't use `*` in this field to allow all Google Cloud resources. + "resource": "A String", # A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources. }, ], }, diff --git a/docs/dyn/cloudasset_v1beta1.projects.html b/docs/dyn/cloudasset_v1beta1.projects.html index fe3deaffb14..8b51be2f1d6 100644 --- a/docs/dyn/cloudasset_v1beta1.projects.html +++ b/docs/dyn/cloudasset_v1beta1.projects.html @@ -272,7 +272,7 @@

Method Details

"sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. - "resource": "A String", # A Google Cloud resource that you want to allow to egress the perimeter. These resources can access data outside the perimeter. This field only supports projects. The project format is `projects/{project_number}`. The resource can be in any Google Cloud organization, not just the organization where the perimeter is defined. You can't use `*` in this field to allow all Google Cloud resources. + "resource": "A String", # A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources. }, ], }, @@ -359,7 +359,7 @@

Method Details

"sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. - "resource": "A String", # A Google Cloud resource that you want to allow to egress the perimeter. These resources can access data outside the perimeter. This field only supports projects. The project format is `projects/{project_number}`. The resource can be in any Google Cloud organization, not just the organization where the perimeter is defined. You can't use `*` in this field to allow all Google Cloud resources. + "resource": "A String", # A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources. }, ], }, diff --git a/docs/dyn/cloudasset_v1p1beta1.iamPolicies.html b/docs/dyn/cloudasset_v1p1beta1.iamPolicies.html index 9f00012f544..3d1b14d7699 100644 --- a/docs/dyn/cloudasset_v1p1beta1.iamPolicies.html +++ b/docs/dyn/cloudasset_v1p1beta1.iamPolicies.html @@ -150,7 +150,7 @@

Method Details

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, - "project": "A String", # The project that the associated Google Cloud resource belongs to, in the form of `projects/{project_number}`. If an IAM policy is set on a resource -- such as a Compute Engine instance or a Cloud Storage bucket -- the project field will indicate the project that contains the resource. If an IAM policy is set on a folder or orgnization, the project field will be empty. + "project": "A String", # The project that the associated Google Cloud resource belongs to, in the form of `projects/{project_number}`. If an IAM policy is set on a resource -- such as a Compute Engine instance or a Cloud Storage bucket -- the project field will indicate the project that contains the resource. If an IAM policy is set on a folder or organization, the project field will be empty. "resource": "A String", # The [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name) of the resource associated with this IAM policy. }, ], diff --git a/docs/dyn/cloudasset_v1p5beta1.assets.html b/docs/dyn/cloudasset_v1p5beta1.assets.html index cfd38af4e7f..c545ae5748f 100644 --- a/docs/dyn/cloudasset_v1p5beta1.assets.html +++ b/docs/dyn/cloudasset_v1p5beta1.assets.html @@ -277,7 +277,7 @@

Method Details

"sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. - "resource": "A String", # A Google Cloud resource that you want to allow to egress the perimeter. These resources can access data outside the perimeter. This field only supports projects. The project format is `projects/{project_number}`. The resource can be in any Google Cloud organization, not just the organization where the perimeter is defined. You can't use `*` in this field to allow all Google Cloud resources. + "resource": "A String", # A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources. }, ], }, @@ -364,7 +364,7 @@

Method Details

"sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. - "resource": "A String", # A Google Cloud resource that you want to allow to egress the perimeter. These resources can access data outside the perimeter. This field only supports projects. The project format is `projects/{project_number}`. The resource can be in any Google Cloud organization, not just the organization where the perimeter is defined. You can't use `*` in this field to allow all Google Cloud resources. + "resource": "A String", # A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources. }, ], }, diff --git a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.html b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.html index c56c5c30076..1d5da9f913c 100644 --- a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.html +++ b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.html @@ -243,7 +243,7 @@

Method Details

"destinationIds": [ # Required. The clusters where the Gateway API HTTPRoute resource will be deployed to. Valid entries include the associated entities IDs configured in the Target resource and "@self" to include the Target cluster. "A String", ], - "propagateService": True or False, # Optional. Whether to propagate the Kubernetes Service to the route destination clusters. The Service will always be deployed to the Target cluster even if the HTTPRoute is not. This option may be used to facilitiate successful DNS lookup in the route destination clusters. Can only be set to true if destinations are specified. + "propagateService": True or False, # Optional. Whether to propagate the Kubernetes Service to the route destination clusters. The Service will always be deployed to the Target cluster even if the HTTPRoute is not. This option may be used to facilitate successful DNS lookup in the route destination clusters. Can only be set to true if destinations are specified. }, "routeUpdateWaitTime": "A String", # Optional. The time to wait for route updates to propagate. The maximum configurable time is 3 hours, in seconds format. If unspecified, there is no wait time. "service": "A String", # Required. Name of the Kubernetes Service. @@ -473,7 +473,7 @@

Method Details

"destinationIds": [ # Required. The clusters where the Gateway API HTTPRoute resource will be deployed to. Valid entries include the associated entities IDs configured in the Target resource and "@self" to include the Target cluster. "A String", ], - "propagateService": True or False, # Optional. Whether to propagate the Kubernetes Service to the route destination clusters. The Service will always be deployed to the Target cluster even if the HTTPRoute is not. This option may be used to facilitiate successful DNS lookup in the route destination clusters. Can only be set to true if destinations are specified. + "propagateService": True or False, # Optional. Whether to propagate the Kubernetes Service to the route destination clusters. The Service will always be deployed to the Target cluster even if the HTTPRoute is not. This option may be used to facilitate successful DNS lookup in the route destination clusters. Can only be set to true if destinations are specified. }, "routeUpdateWaitTime": "A String", # Optional. The time to wait for route updates to propagate. The maximum configurable time is 3 hours, in seconds format. If unspecified, there is no wait time. "service": "A String", # Required. Name of the Kubernetes Service. @@ -686,7 +686,7 @@

Method Details

"destinationIds": [ # Required. The clusters where the Gateway API HTTPRoute resource will be deployed to. Valid entries include the associated entities IDs configured in the Target resource and "@self" to include the Target cluster. "A String", ], - "propagateService": True or False, # Optional. Whether to propagate the Kubernetes Service to the route destination clusters. The Service will always be deployed to the Target cluster even if the HTTPRoute is not. This option may be used to facilitiate successful DNS lookup in the route destination clusters. Can only be set to true if destinations are specified. + "propagateService": True or False, # Optional. Whether to propagate the Kubernetes Service to the route destination clusters. The Service will always be deployed to the Target cluster even if the HTTPRoute is not. This option may be used to facilitate successful DNS lookup in the route destination clusters. Can only be set to true if destinations are specified. }, "routeUpdateWaitTime": "A String", # Optional. The time to wait for route updates to propagate. The maximum configurable time is 3 hours, in seconds format. If unspecified, there is no wait time. "service": "A String", # Required. Name of the Kubernetes Service. @@ -860,7 +860,7 @@

Method Details

"destinationIds": [ # Required. The clusters where the Gateway API HTTPRoute resource will be deployed to. Valid entries include the associated entities IDs configured in the Target resource and "@self" to include the Target cluster. "A String", ], - "propagateService": True or False, # Optional. Whether to propagate the Kubernetes Service to the route destination clusters. The Service will always be deployed to the Target cluster even if the HTTPRoute is not. This option may be used to facilitiate successful DNS lookup in the route destination clusters. Can only be set to true if destinations are specified. + "propagateService": True or False, # Optional. Whether to propagate the Kubernetes Service to the route destination clusters. The Service will always be deployed to the Target cluster even if the HTTPRoute is not. This option may be used to facilitate successful DNS lookup in the route destination clusters. Can only be set to true if destinations are specified. }, "routeUpdateWaitTime": "A String", # Optional. The time to wait for route updates to propagate. The maximum configurable time is 3 hours, in seconds format. If unspecified, there is no wait time. "service": "A String", # Required. Name of the Kubernetes Service. diff --git a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.html b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.html index b72662358d2..a50f0fb9088 100644 --- a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.html +++ b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.html @@ -307,7 +307,7 @@

Method Details

"destinationIds": [ # Required. The clusters where the Gateway API HTTPRoute resource will be deployed to. Valid entries include the associated entities IDs configured in the Target resource and "@self" to include the Target cluster. "A String", ], - "propagateService": True or False, # Optional. Whether to propagate the Kubernetes Service to the route destination clusters. The Service will always be deployed to the Target cluster even if the HTTPRoute is not. This option may be used to facilitiate successful DNS lookup in the route destination clusters. Can only be set to true if destinations are specified. + "propagateService": True or False, # Optional. Whether to propagate the Kubernetes Service to the route destination clusters. The Service will always be deployed to the Target cluster even if the HTTPRoute is not. This option may be used to facilitate successful DNS lookup in the route destination clusters. Can only be set to true if destinations are specified. }, "routeUpdateWaitTime": "A String", # Optional. The time to wait for route updates to propagate. The maximum configurable time is 3 hours, in seconds format. If unspecified, there is no wait time. "service": "A String", # Required. Name of the Kubernetes Service. @@ -691,7 +691,7 @@

Method Details

"destinationIds": [ # Required. The clusters where the Gateway API HTTPRoute resource will be deployed to. Valid entries include the associated entities IDs configured in the Target resource and "@self" to include the Target cluster. "A String", ], - "propagateService": True or False, # Optional. Whether to propagate the Kubernetes Service to the route destination clusters. The Service will always be deployed to the Target cluster even if the HTTPRoute is not. This option may be used to facilitiate successful DNS lookup in the route destination clusters. Can only be set to true if destinations are specified. + "propagateService": True or False, # Optional. Whether to propagate the Kubernetes Service to the route destination clusters. The Service will always be deployed to the Target cluster even if the HTTPRoute is not. This option may be used to facilitate successful DNS lookup in the route destination clusters. Can only be set to true if destinations are specified. }, "routeUpdateWaitTime": "A String", # Optional. The time to wait for route updates to propagate. The maximum configurable time is 3 hours, in seconds format. If unspecified, there is no wait time. "service": "A String", # Required. Name of the Kubernetes Service. @@ -1050,7 +1050,7 @@

Method Details

"destinationIds": [ # Required. The clusters where the Gateway API HTTPRoute resource will be deployed to. Valid entries include the associated entities IDs configured in the Target resource and "@self" to include the Target cluster. "A String", ], - "propagateService": True or False, # Optional. Whether to propagate the Kubernetes Service to the route destination clusters. The Service will always be deployed to the Target cluster even if the HTTPRoute is not. This option may be used to facilitiate successful DNS lookup in the route destination clusters. Can only be set to true if destinations are specified. + "propagateService": True or False, # Optional. Whether to propagate the Kubernetes Service to the route destination clusters. The Service will always be deployed to the Target cluster even if the HTTPRoute is not. This option may be used to facilitate successful DNS lookup in the route destination clusters. Can only be set to true if destinations are specified. }, "routeUpdateWaitTime": "A String", # Optional. The time to wait for route updates to propagate. The maximum configurable time is 3 hours, in seconds format. If unspecified, there is no wait time. "service": "A String", # Required. Name of the Kubernetes Service. diff --git a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.html b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.html index 0a2e3236ed7..ffbfa3c6898 100644 --- a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.html +++ b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.html @@ -729,7 +729,7 @@

Method Details

Returns: An object of the form: - { # ListRolloutsResponse is the response object reutrned by `ListRollouts`. + { # ListRolloutsResponse is the response object returned by `ListRollouts`. "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. "rollouts": [ # The `Rollout` objects. { # A `Rollout` resource in the Cloud Deploy API. A `Rollout` contains information around a specific deployment to a `Target`. diff --git a/docs/dyn/css_v1.accounts.cssProductInputs.html b/docs/dyn/css_v1.accounts.cssProductInputs.html index 91281b2ca66..fdf490e97fc 100644 --- a/docs/dyn/css_v1.accounts.cssProductInputs.html +++ b/docs/dyn/css_v1.accounts.cssProductInputs.html @@ -97,7 +97,7 @@

Method Details

Deletes a CSS Product input from your CSS Center account. After a delete it may take several minutes until the input is no longer available.
 
 Args:
-  name: string, Required. The name of the CSS product input resource to delete. Format: accounts/{account}/cssProductInputs/{css_product_input} (required)
+  name: string, Required. The name of the CSS product input resource to delete. Format: accounts/{account}/cssProductInputs/{css_product_input}, where the last section `css_product_input` consists of 3 parts: contentLanguage~feedLabel~offerId. Example: accounts/123/cssProductInputs/de~DE~rawProvidedId123 (required)
   supplementalFeedId: string, The Content API Supplemental Feed ID. The field must not be set if the action applies to a primary feed. If the field is set, then product action applies to a supplemental feed instead of primary Content API feed.
   x__xgafv: string, V1 error format.
     Allowed values
@@ -251,7 +251,7 @@ 

Method Details

"feedLabel": "A String", # Required. The [feed label](https://developers.google.com/shopping-content/guides/products/feed-labels) for the CSS Product. Feed Label is synonymous to "target country" and hence should always be a valid region code. For example: 'DE' for Germany, 'FR' for France. "finalName": "A String", # Output only. The name of the processed CSS Product. Format: `accounts/{account}/cssProducts/{css_product}` " "freshnessTime": "A String", # DEPRECATED. Use expiration_date instead. Represents the existing version (freshness) of the CSS Product, which can be used to preserve the right order when multiple updates are done at the same time. This field must not be set to the future time. If set, the update is prevented if a newer version of the item already exists in our system (that is the last update time of the existing CSS products is later than the freshness time set in the update). If the update happens, the last update time is then set to this freshness time. If not set, the update will not be prevented and the last update time will default to when this request was received by the CSS API. If the operation is prevented, the aborted exception will be thrown. - "name": "A String", # The name of the CSS Product input. Format: `accounts/{account}/cssProductInputs/{css_product_input}` + "name": "A String", # The name of the CSS Product input. Format: `accounts/{account}/cssProductInputs/{css_product_input}`, where the last section `css_product_input` consists of 3 parts: contentLanguage~feedLabel~offerId. Example: accounts/123/cssProductInputs/de~DE~rawProvidedId123 "rawProvidedId": "A String", # Required. Your unique identifier for the CSS Product. This is the same for the CSS Product input and processed CSS Product. We only allow ids with alphanumerics, underscores and dashes. See the [products feed specification](https://support.google.com/merchants/answer/188494#id) for details. } @@ -395,7 +395,7 @@

Method Details

"feedLabel": "A String", # Required. The [feed label](https://developers.google.com/shopping-content/guides/products/feed-labels) for the CSS Product. Feed Label is synonymous to "target country" and hence should always be a valid region code. For example: 'DE' for Germany, 'FR' for France. "finalName": "A String", # Output only. The name of the processed CSS Product. Format: `accounts/{account}/cssProducts/{css_product}` " "freshnessTime": "A String", # DEPRECATED. Use expiration_date instead. Represents the existing version (freshness) of the CSS Product, which can be used to preserve the right order when multiple updates are done at the same time. This field must not be set to the future time. If set, the update is prevented if a newer version of the item already exists in our system (that is the last update time of the existing CSS products is later than the freshness time set in the update). If the update happens, the last update time is then set to this freshness time. If not set, the update will not be prevented and the last update time will default to when this request was received by the CSS API. If the operation is prevented, the aborted exception will be thrown. - "name": "A String", # The name of the CSS Product input. Format: `accounts/{account}/cssProductInputs/{css_product_input}` + "name": "A String", # The name of the CSS Product input. Format: `accounts/{account}/cssProductInputs/{css_product_input}`, where the last section `css_product_input` consists of 3 parts: contentLanguage~feedLabel~offerId. Example: accounts/123/cssProductInputs/de~DE~rawProvidedId123 "rawProvidedId": "A String", # Required. Your unique identifier for the CSS Product. This is the same for the CSS Product input and processed CSS Product. We only allow ids with alphanumerics, underscores and dashes. See the [products feed specification](https://support.google.com/merchants/answer/188494#id) for details. }
@@ -405,7 +405,7 @@

Method Details

Updates the existing Css Product input in your CSS Center account. After inserting, updating, or deleting a CSS Product input, it may take several minutes before the processed Css Product can be retrieved.
 
 Args:
-  name: string, The name of the CSS Product input. Format: `accounts/{account}/cssProductInputs/{css_product_input}` (required)
+  name: string, The name of the CSS Product input. Format: `accounts/{account}/cssProductInputs/{css_product_input}`, where the last section `css_product_input` consists of 3 parts: contentLanguage~feedLabel~offerId. Example: accounts/123/cssProductInputs/de~DE~rawProvidedId123 (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -540,7 +540,7 @@ 

Method Details

"feedLabel": "A String", # Required. The [feed label](https://developers.google.com/shopping-content/guides/products/feed-labels) for the CSS Product. Feed Label is synonymous to "target country" and hence should always be a valid region code. For example: 'DE' for Germany, 'FR' for France. "finalName": "A String", # Output only. The name of the processed CSS Product. Format: `accounts/{account}/cssProducts/{css_product}` " "freshnessTime": "A String", # DEPRECATED. Use expiration_date instead. Represents the existing version (freshness) of the CSS Product, which can be used to preserve the right order when multiple updates are done at the same time. This field must not be set to the future time. If set, the update is prevented if a newer version of the item already exists in our system (that is the last update time of the existing CSS products is later than the freshness time set in the update). If the update happens, the last update time is then set to this freshness time. If not set, the update will not be prevented and the last update time will default to when this request was received by the CSS API. If the operation is prevented, the aborted exception will be thrown. - "name": "A String", # The name of the CSS Product input. Format: `accounts/{account}/cssProductInputs/{css_product_input}` + "name": "A String", # The name of the CSS Product input. Format: `accounts/{account}/cssProductInputs/{css_product_input}`, where the last section `css_product_input` consists of 3 parts: contentLanguage~feedLabel~offerId. Example: accounts/123/cssProductInputs/de~DE~rawProvidedId123 "rawProvidedId": "A String", # Required. Your unique identifier for the CSS Product. This is the same for the CSS Product input and processed CSS Product. We only allow ids with alphanumerics, underscores and dashes. See the [products feed specification](https://support.google.com/merchants/answer/188494#id) for details. } @@ -684,7 +684,7 @@

Method Details

"feedLabel": "A String", # Required. The [feed label](https://developers.google.com/shopping-content/guides/products/feed-labels) for the CSS Product. Feed Label is synonymous to "target country" and hence should always be a valid region code. For example: 'DE' for Germany, 'FR' for France. "finalName": "A String", # Output only. The name of the processed CSS Product. Format: `accounts/{account}/cssProducts/{css_product}` " "freshnessTime": "A String", # DEPRECATED. Use expiration_date instead. Represents the existing version (freshness) of the CSS Product, which can be used to preserve the right order when multiple updates are done at the same time. This field must not be set to the future time. If set, the update is prevented if a newer version of the item already exists in our system (that is the last update time of the existing CSS products is later than the freshness time set in the update). If the update happens, the last update time is then set to this freshness time. If not set, the update will not be prevented and the last update time will default to when this request was received by the CSS API. If the operation is prevented, the aborted exception will be thrown. - "name": "A String", # The name of the CSS Product input. Format: `accounts/{account}/cssProductInputs/{css_product_input}` + "name": "A String", # The name of the CSS Product input. Format: `accounts/{account}/cssProductInputs/{css_product_input}`, where the last section `css_product_input` consists of 3 parts: contentLanguage~feedLabel~offerId. Example: accounts/123/cssProductInputs/de~DE~rawProvidedId123 "rawProvidedId": "A String", # Required. Your unique identifier for the CSS Product. This is the same for the CSS Product input and processed CSS Product. We only allow ids with alphanumerics, underscores and dashes. See the [products feed specification](https://support.google.com/merchants/answer/188494#id) for details. }
diff --git a/docs/dyn/css_v1.accounts.html b/docs/dyn/css_v1.accounts.html index c2e1a9e8700..2a5b462c9ec 100644 --- a/docs/dyn/css_v1.accounts.html +++ b/docs/dyn/css_v1.accounts.html @@ -137,7 +137,7 @@

Method Details

"A String", ], "name": "A String", # The label resource name. Format: accounts/{account} - "parent": "A String", # The CSS/MC account's parent resource. CSS group for CSS domains; CSS domain for MC accounts. Returned only if the user has access to the parent account. + "parent": "A String", # The CSS/MC account's parent resource. CSS group for CSS domains; CSS domain for MC accounts. Returned only if the user has access to the parent account. Note: For MC sub-accounts, this is also the CSS domain that is the parent resource of the MCA account, since we are effectively flattening the hierarchy." }
@@ -173,7 +173,7 @@

Method Details

"A String", ], "name": "A String", # The label resource name. Format: accounts/{account} - "parent": "A String", # The CSS/MC account's parent resource. CSS group for CSS domains; CSS domain for MC accounts. Returned only if the user has access to the parent account. + "parent": "A String", # The CSS/MC account's parent resource. CSS group for CSS domains; CSS domain for MC accounts. Returned only if the user has access to the parent account. Note: For MC sub-accounts, this is also the CSS domain that is the parent resource of the MCA account, since we are effectively flattening the hierarchy." }, ], "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. @@ -230,7 +230,7 @@

Method Details

"A String", ], "name": "A String", # The label resource name. Format: accounts/{account} - "parent": "A String", # The CSS/MC account's parent resource. CSS group for CSS domains; CSS domain for MC accounts. Returned only if the user has access to the parent account. + "parent": "A String", # The CSS/MC account's parent resource. CSS group for CSS domains; CSS domain for MC accounts. Returned only if the user has access to the parent account. Note: For MC sub-accounts, this is also the CSS domain that is the parent resource of the MCA account, since we are effectively flattening the hierarchy." } diff --git a/docs/dyn/dfareporting_v4.conversions.html b/docs/dyn/dfareporting_v4.conversions.html index cdb79082086..0adbdc4d504 100644 --- a/docs/dyn/dfareporting_v4.conversions.html +++ b/docs/dyn/dfareporting_v4.conversions.html @@ -105,9 +105,9 @@

Method Details

"unitPrice": 3.14, # Unit price excluding tax, shipping, and any transaction level discounts. Interpreted in CM360 Floodlight config parent advertiser's currency code. This is a required field. }, ], - "merchantFeedLabel": "A String", # The feed labels associated with the feed where your items are uploaded. For more information, please refer to ​​ https://support.google.com/merchants/answer/12453549. This is a required field. - "merchantFeedLanguage": "A String", # The language associated with the feed where your items are uploaded. Use ISO 639-1 language codes. This field is needed only when item IDs are not unique across multiple Merchant Center feeds. - "merchantId": "A String", # The Merchant Center ID where the items are uploaded. This is a required field. + "merchantFeedLabel": "A String", # The feed labels associated with the feed where your items are uploaded. For more information, please refer to ​​ https://support.google.com/merchants/answer/12453549. Providing the feed label reduces ambiguity in identifying the right offer details. + "merchantFeedLanguage": "A String", # The language associated with the feed where your items are uploaded. Use ISO 639-1 language codes. Providing the feed language reduces ambiguity in identifying the right offer details. + "merchantId": "A String", # The Merchant Center ID where the items are uploaded. Providing Merchant Center ID reduces ambiguity in identifying the right offer details. }, "childDirectedTreatment": True or False, # Whether this particular request may come from a user under the age of 13, under COPPA compliance. "customVariables": [ # Custom floodlight variables. @@ -150,7 +150,7 @@

Method Details

"hashedPhoneNumber": "A String", # Hashed phone number using SHA-256 hash function after normalization (E164 standard). }, ], - "value": 3.14, # The value of the conversion. This is a required field. + "value": 3.14, # The value of the conversion. Interpreted in CM360 Floodlight config parent advertiser's currency code. This is a required field. }, ], "encryptionInfo": { # A description of how user IDs are encrypted. # Describes how encryptedUserId or encryptedUserIdCandidates[] is encrypted. This is a required field if encryptedUserId or encryptedUserIdCandidates[] is used. @@ -185,9 +185,9 @@

Method Details

"unitPrice": 3.14, # Unit price excluding tax, shipping, and any transaction level discounts. Interpreted in CM360 Floodlight config parent advertiser's currency code. This is a required field. }, ], - "merchantFeedLabel": "A String", # The feed labels associated with the feed where your items are uploaded. For more information, please refer to ​​ https://support.google.com/merchants/answer/12453549. This is a required field. - "merchantFeedLanguage": "A String", # The language associated with the feed where your items are uploaded. Use ISO 639-1 language codes. This field is needed only when item IDs are not unique across multiple Merchant Center feeds. - "merchantId": "A String", # The Merchant Center ID where the items are uploaded. This is a required field. + "merchantFeedLabel": "A String", # The feed labels associated with the feed where your items are uploaded. For more information, please refer to ​​ https://support.google.com/merchants/answer/12453549. Providing the feed label reduces ambiguity in identifying the right offer details. + "merchantFeedLanguage": "A String", # The language associated with the feed where your items are uploaded. Use ISO 639-1 language codes. Providing the feed language reduces ambiguity in identifying the right offer details. + "merchantId": "A String", # The Merchant Center ID where the items are uploaded. Providing Merchant Center ID reduces ambiguity in identifying the right offer details. }, "childDirectedTreatment": True or False, # Whether this particular request may come from a user under the age of 13, under COPPA compliance. "customVariables": [ # Custom floodlight variables. @@ -230,7 +230,7 @@

Method Details

"hashedPhoneNumber": "A String", # Hashed phone number using SHA-256 hash function after normalization (E164 standard). }, ], - "value": 3.14, # The value of the conversion. This is a required field. + "value": 3.14, # The value of the conversion. Interpreted in CM360 Floodlight config parent advertiser's currency code. This is a required field. }, "errors": [ # A list of errors related to this conversion. { # The error code and description for a conversion that failed to insert or update. @@ -266,9 +266,9 @@

Method Details

"unitPrice": 3.14, # Unit price excluding tax, shipping, and any transaction level discounts. Interpreted in CM360 Floodlight config parent advertiser's currency code. This is a required field. }, ], - "merchantFeedLabel": "A String", # The feed labels associated with the feed where your items are uploaded. For more information, please refer to ​​ https://support.google.com/merchants/answer/12453549. This is a required field. - "merchantFeedLanguage": "A String", # The language associated with the feed where your items are uploaded. Use ISO 639-1 language codes. This field is needed only when item IDs are not unique across multiple Merchant Center feeds. - "merchantId": "A String", # The Merchant Center ID where the items are uploaded. This is a required field. + "merchantFeedLabel": "A String", # The feed labels associated with the feed where your items are uploaded. For more information, please refer to ​​ https://support.google.com/merchants/answer/12453549. Providing the feed label reduces ambiguity in identifying the right offer details. + "merchantFeedLanguage": "A String", # The language associated with the feed where your items are uploaded. Use ISO 639-1 language codes. Providing the feed language reduces ambiguity in identifying the right offer details. + "merchantId": "A String", # The Merchant Center ID where the items are uploaded. Providing Merchant Center ID reduces ambiguity in identifying the right offer details. }, "childDirectedTreatment": True or False, # Whether this particular request may come from a user under the age of 13, under COPPA compliance. "customVariables": [ # Custom floodlight variables. @@ -311,7 +311,7 @@

Method Details

"hashedPhoneNumber": "A String", # Hashed phone number using SHA-256 hash function after normalization (E164 standard). }, ], - "value": 3.14, # The value of the conversion. This is a required field. + "value": 3.14, # The value of the conversion. Interpreted in CM360 Floodlight config parent advertiser's currency code. This is a required field. }, ], "encryptionInfo": { # A description of how user IDs are encrypted. # Describes how encryptedUserId is encrypted. This is a required field if encryptedUserId is used. @@ -346,9 +346,9 @@

Method Details

"unitPrice": 3.14, # Unit price excluding tax, shipping, and any transaction level discounts. Interpreted in CM360 Floodlight config parent advertiser's currency code. This is a required field. }, ], - "merchantFeedLabel": "A String", # The feed labels associated with the feed where your items are uploaded. For more information, please refer to ​​ https://support.google.com/merchants/answer/12453549. This is a required field. - "merchantFeedLanguage": "A String", # The language associated with the feed where your items are uploaded. Use ISO 639-1 language codes. This field is needed only when item IDs are not unique across multiple Merchant Center feeds. - "merchantId": "A String", # The Merchant Center ID where the items are uploaded. This is a required field. + "merchantFeedLabel": "A String", # The feed labels associated with the feed where your items are uploaded. For more information, please refer to ​​ https://support.google.com/merchants/answer/12453549. Providing the feed label reduces ambiguity in identifying the right offer details. + "merchantFeedLanguage": "A String", # The language associated with the feed where your items are uploaded. Use ISO 639-1 language codes. Providing the feed language reduces ambiguity in identifying the right offer details. + "merchantId": "A String", # The Merchant Center ID where the items are uploaded. Providing Merchant Center ID reduces ambiguity in identifying the right offer details. }, "childDirectedTreatment": True or False, # Whether this particular request may come from a user under the age of 13, under COPPA compliance. "customVariables": [ # Custom floodlight variables. @@ -391,7 +391,7 @@

Method Details

"hashedPhoneNumber": "A String", # Hashed phone number using SHA-256 hash function after normalization (E164 standard). }, ], - "value": 3.14, # The value of the conversion. This is a required field. + "value": 3.14, # The value of the conversion. Interpreted in CM360 Floodlight config parent advertiser's currency code. This is a required field. }, "errors": [ # A list of errors related to this conversion. { # The error code and description for a conversion that failed to insert or update. diff --git a/docs/dyn/dfareporting_v4.placements.html b/docs/dyn/dfareporting_v4.placements.html index 3a77ac79ccf..34ac5949730 100644 --- a/docs/dyn/dfareporting_v4.placements.html +++ b/docs/dyn/dfareporting_v4.placements.html @@ -318,6 +318,7 @@

Method Details

"additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field. "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. New placements will default to the value set on their site. "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags. + "includeUnescapedlpurlMacro": True or False, # Optional. Indicates that the unescapedlpurl macro should be included in the tag for the static landing page. New placements will default to the value set on their site. "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders. }, "videoActiveViewOptOut": True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives for this placement. The same setting videoActiveViewOptOut exists on the site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView. @@ -532,6 +533,7 @@

Method Details

"additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field. "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. New placements will default to the value set on their site. "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags. + "includeUnescapedlpurlMacro": True or False, # Optional. Indicates that the unescapedlpurl macro should be included in the tag for the static landing page. New placements will default to the value set on their site. "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders. }, "videoActiveViewOptOut": True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives for this placement. The same setting videoActiveViewOptOut exists on the site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView. @@ -744,6 +746,7 @@

Method Details

"additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field. "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. New placements will default to the value set on their site. "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags. + "includeUnescapedlpurlMacro": True or False, # Optional. Indicates that the unescapedlpurl macro should be included in the tag for the static landing page. New placements will default to the value set on their site. "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders. }, "videoActiveViewOptOut": True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives for this placement. The same setting videoActiveViewOptOut exists on the site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView. @@ -1018,6 +1021,7 @@

Method Details

"additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field. "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. New placements will default to the value set on their site. "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags. + "includeUnescapedlpurlMacro": True or False, # Optional. Indicates that the unescapedlpurl macro should be included in the tag for the static landing page. New placements will default to the value set on their site. "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders. }, "videoActiveViewOptOut": True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives for this placement. The same setting videoActiveViewOptOut exists on the site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView. @@ -1249,6 +1253,7 @@

Method Details

"additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field. "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. New placements will default to the value set on their site. "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags. + "includeUnescapedlpurlMacro": True or False, # Optional. Indicates that the unescapedlpurl macro should be included in the tag for the static landing page. New placements will default to the value set on their site. "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders. }, "videoActiveViewOptOut": True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives for this placement. The same setting videoActiveViewOptOut exists on the site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView. @@ -1461,6 +1466,7 @@

Method Details

"additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field. "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. New placements will default to the value set on their site. "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags. + "includeUnescapedlpurlMacro": True or False, # Optional. Indicates that the unescapedlpurl macro should be included in the tag for the static landing page. New placements will default to the value set on their site. "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders. }, "videoActiveViewOptOut": True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives for this placement. The same setting videoActiveViewOptOut exists on the site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView. @@ -1675,6 +1681,7 @@

Method Details

"additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field. "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. New placements will default to the value set on their site. "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags. + "includeUnescapedlpurlMacro": True or False, # Optional. Indicates that the unescapedlpurl macro should be included in the tag for the static landing page. New placements will default to the value set on their site. "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders. }, "videoActiveViewOptOut": True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives for this placement. The same setting videoActiveViewOptOut exists on the site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView. @@ -1887,6 +1894,7 @@

Method Details

"additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field. "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. New placements will default to the value set on their site. "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags. + "includeUnescapedlpurlMacro": True or False, # Optional. Indicates that the unescapedlpurl macro should be included in the tag for the static landing page. New placements will default to the value set on their site. "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders. }, "videoActiveViewOptOut": True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives for this placement. The same setting videoActiveViewOptOut exists on the site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView. diff --git a/docs/dyn/dfareporting_v4.sites.html b/docs/dyn/dfareporting_v4.sites.html index f7cf4e05bce..361be66cda5 100644 --- a/docs/dyn/dfareporting_v4.sites.html +++ b/docs/dyn/dfareporting_v4.sites.html @@ -161,6 +161,7 @@

Method Details

"additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field. "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. New placements will default to the value set on their site. "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags. + "includeUnescapedlpurlMacro": True or False, # Optional. Indicates that the unescapedlpurl macro should be included in the tag for the static landing page. New placements will default to the value set on their site. "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders. }, "videoActiveViewOptOutTemplate": True or False, # Whether Verification and ActiveView for in-stream video creatives are disabled by default for new placements created under this site. This value will be used to populate the placement.videoActiveViewOptOut field, when no value is specified for the new placement. @@ -278,6 +279,7 @@

Method Details

"additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field. "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. New placements will default to the value set on their site. "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags. + "includeUnescapedlpurlMacro": True or False, # Optional. Indicates that the unescapedlpurl macro should be included in the tag for the static landing page. New placements will default to the value set on their site. "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders. }, "videoActiveViewOptOutTemplate": True or False, # Whether Verification and ActiveView for in-stream video creatives are disabled by default for new placements created under this site. This value will be used to populate the placement.videoActiveViewOptOut field, when no value is specified for the new placement. @@ -393,6 +395,7 @@

Method Details

"additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field. "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. New placements will default to the value set on their site. "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags. + "includeUnescapedlpurlMacro": True or False, # Optional. Indicates that the unescapedlpurl macro should be included in the tag for the static landing page. New placements will default to the value set on their site. "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders. }, "videoActiveViewOptOutTemplate": True or False, # Whether Verification and ActiveView for in-stream video creatives are disabled by default for new placements created under this site. This value will be used to populate the placement.videoActiveViewOptOut field, when no value is specified for the new placement. @@ -540,6 +543,7 @@

Method Details

"additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field. "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. New placements will default to the value set on their site. "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags. + "includeUnescapedlpurlMacro": True or False, # Optional. Indicates that the unescapedlpurl macro should be included in the tag for the static landing page. New placements will default to the value set on their site. "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders. }, "videoActiveViewOptOutTemplate": True or False, # Whether Verification and ActiveView for in-stream video creatives are disabled by default for new placements created under this site. This value will be used to populate the placement.videoActiveViewOptOut field, when no value is specified for the new placement. @@ -674,6 +678,7 @@

Method Details

"additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field. "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. New placements will default to the value set on their site. "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags. + "includeUnescapedlpurlMacro": True or False, # Optional. Indicates that the unescapedlpurl macro should be included in the tag for the static landing page. New placements will default to the value set on their site. "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders. }, "videoActiveViewOptOutTemplate": True or False, # Whether Verification and ActiveView for in-stream video creatives are disabled by default for new placements created under this site. This value will be used to populate the placement.videoActiveViewOptOut field, when no value is specified for the new placement. @@ -789,6 +794,7 @@

Method Details

"additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field. "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. New placements will default to the value set on their site. "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags. + "includeUnescapedlpurlMacro": True or False, # Optional. Indicates that the unescapedlpurl macro should be included in the tag for the static landing page. New placements will default to the value set on their site. "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders. }, "videoActiveViewOptOutTemplate": True or False, # Whether Verification and ActiveView for in-stream video creatives are disabled by default for new placements created under this site. This value will be used to populate the placement.videoActiveViewOptOut field, when no value is specified for the new placement. @@ -906,6 +912,7 @@

Method Details

"additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field. "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. New placements will default to the value set on their site. "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags. + "includeUnescapedlpurlMacro": True or False, # Optional. Indicates that the unescapedlpurl macro should be included in the tag for the static landing page. New placements will default to the value set on their site. "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders. }, "videoActiveViewOptOutTemplate": True or False, # Whether Verification and ActiveView for in-stream video creatives are disabled by default for new placements created under this site. This value will be used to populate the placement.videoActiveViewOptOut field, when no value is specified for the new placement. @@ -1021,6 +1028,7 @@

Method Details

"additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field. "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. New placements will default to the value set on their site. "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags. + "includeUnescapedlpurlMacro": True or False, # Optional. Indicates that the unescapedlpurl macro should be included in the tag for the static landing page. New placements will default to the value set on their site. "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders. }, "videoActiveViewOptOutTemplate": True or False, # Whether Verification and ActiveView for in-stream video creatives are disabled by default for new placements created under this site. This value will be used to populate the placement.videoActiveViewOptOut field, when no value is specified for the new placement. diff --git a/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html b/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html index 6998b892305..524cbd115dd 100644 --- a/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html +++ b/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html @@ -352,8 +352,8 @@

Method Details

}, "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. - "vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. - "datastore": "A String", # Required. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` }, "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. "ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead. @@ -696,8 +696,8 @@

Method Details

}, "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. - "vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. - "datastore": "A String", # Required. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` }, "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. "ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead. @@ -1221,8 +1221,8 @@

Method Details

}, "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. - "vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. - "datastore": "A String", # Required. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` }, "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. "ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead. diff --git a/docs/dyn/forms_v1.forms.html b/docs/dyn/forms_v1.forms.html index 77c0f46d925..588036834d7 100644 --- a/docs/dyn/forms_v1.forms.html +++ b/docs/dyn/forms_v1.forms.html @@ -744,7 +744,7 @@

Method Details

}, "updateSettings": { # Update Form's FormSettings. # Updates the Form's settings. "settings": { # A form's settings. # Required. The settings to update with. - "emailCollectionType": "A String", # Optional. Kind of email collection configured in the form. + "emailCollectionType": "A String", # Optional. The setting that determines whether the form collects email addresses from respondents. "quizSettings": { # Settings related to quiz forms and grading. These must be updated with the UpdateSettingsRequest. # Settings related to quiz forms and grading. "isQuiz": True or False, # Whether this form is a quiz or not. When true, responses are graded based on question Grading. Upon setting to false, all question Grading is deleted. }, @@ -1081,7 +1081,7 @@

Method Details

"responderUri": "A String", # Output only. The form URI to share with responders. This opens a page that allows the user to submit responses but not edit the questions. "revisionId": "A String", # Output only. The revision ID of the form. Used in the WriteControl in update requests to identify the revision on which the changes are based. The format of the revision ID may change over time, so it should be treated opaquely. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the form has not changed. Conversely, a changed ID (for the same form and user) usually means the form has been updated; however, a changed ID can also be due to internal factors such as ID format changes. "settings": { # A form's settings. # The form's settings. This must be updated with UpdateSettingsRequest; it is ignored during `forms.create` and UpdateFormInfoRequest. - "emailCollectionType": "A String", # Optional. Kind of email collection configured in the form. + "emailCollectionType": "A String", # Optional. The setting that determines whether the form collects email addresses from respondents. "quizSettings": { # Settings related to quiz forms and grading. These must be updated with the UpdateSettingsRequest. # Settings related to quiz forms and grading. "isQuiz": True or False, # Whether this form is a quiz or not. When true, responses are graded based on question Grading. Upon setting to false, all question Grading is deleted. }, @@ -1430,7 +1430,7 @@

Method Details

"responderUri": "A String", # Output only. The form URI to share with responders. This opens a page that allows the user to submit responses but not edit the questions. "revisionId": "A String", # Output only. The revision ID of the form. Used in the WriteControl in update requests to identify the revision on which the changes are based. The format of the revision ID may change over time, so it should be treated opaquely. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the form has not changed. Conversely, a changed ID (for the same form and user) usually means the form has been updated; however, a changed ID can also be due to internal factors such as ID format changes. "settings": { # A form's settings. # The form's settings. This must be updated with UpdateSettingsRequest; it is ignored during `forms.create` and UpdateFormInfoRequest. - "emailCollectionType": "A String", # Optional. Kind of email collection configured in the form. + "emailCollectionType": "A String", # Optional. The setting that determines whether the form collects email addresses from respondents. "quizSettings": { # Settings related to quiz forms and grading. These must be updated with the UpdateSettingsRequest. # Settings related to quiz forms and grading. "isQuiz": True or False, # Whether this form is a quiz or not. When true, responses are graded based on question Grading. Upon setting to false, all question Grading is deleted. }, @@ -1758,7 +1758,7 @@

Method Details

"responderUri": "A String", # Output only. The form URI to share with responders. This opens a page that allows the user to submit responses but not edit the questions. "revisionId": "A String", # Output only. The revision ID of the form. Used in the WriteControl in update requests to identify the revision on which the changes are based. The format of the revision ID may change over time, so it should be treated opaquely. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the form has not changed. Conversely, a changed ID (for the same form and user) usually means the form has been updated; however, a changed ID can also be due to internal factors such as ID format changes. "settings": { # A form's settings. # The form's settings. This must be updated with UpdateSettingsRequest; it is ignored during `forms.create` and UpdateFormInfoRequest. - "emailCollectionType": "A String", # Optional. Kind of email collection configured in the form. + "emailCollectionType": "A String", # Optional. The setting that determines whether the form collects email addresses from respondents. "quizSettings": { # Settings related to quiz forms and grading. These must be updated with the UpdateSettingsRequest. # Settings related to quiz forms and grading. "isQuiz": True or False, # Whether this form is a quiz or not. When true, responses are graded based on question Grading. Upon setting to false, all question Grading is deleted. }, @@ -2093,7 +2093,7 @@

Method Details

"responderUri": "A String", # Output only. The form URI to share with responders. This opens a page that allows the user to submit responses but not edit the questions. "revisionId": "A String", # Output only. The revision ID of the form. Used in the WriteControl in update requests to identify the revision on which the changes are based. The format of the revision ID may change over time, so it should be treated opaquely. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the form has not changed. Conversely, a changed ID (for the same form and user) usually means the form has been updated; however, a changed ID can also be due to internal factors such as ID format changes. "settings": { # A form's settings. # The form's settings. This must be updated with UpdateSettingsRequest; it is ignored during `forms.create` and UpdateFormInfoRequest. - "emailCollectionType": "A String", # Optional. Kind of email collection configured in the form. + "emailCollectionType": "A String", # Optional. The setting that determines whether the form collects email addresses from respondents. "quizSettings": { # Settings related to quiz forms and grading. These must be updated with the UpdateSettingsRequest. # Settings related to quiz forms and grading. "isQuiz": True or False, # Whether this form is a quiz or not. When true, responses are graded based on question Grading. Upon setting to false, all question Grading is deleted. }, diff --git a/docs/dyn/iam_v2.policies.html b/docs/dyn/iam_v2.policies.html index 71c0ae1b811..93fc7b6270d 100644 --- a/docs/dyn/iam_v2.policies.html +++ b/docs/dyn/iam_v2.policies.html @@ -137,7 +137,7 @@

Method Details

"deniedPermissions": [ # The permissions that are explicitly denied by this rule. Each permission uses the format `{service_fqdn}/{resource}.{verb}`, where `{service_fqdn}` is the fully qualified domain name for the service. For example, `iam.googleapis.com/roles.list`. "A String", ], - "deniedPrincipals": [ # The identities that are prevented from using one or more permissions on Google Cloud resources. This field can contain the following values: * `principal://goog/subject/{email_id}`: A specific Google Account. Includes Gmail, Cloud Identity, and Google Workspace user accounts. For example, `principal://goog/subject/alice@example.com`. * `principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}`: A Google Cloud service account. For example, `principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com`. * `principalSet://goog/group/{group_id}`: A Google group. For example, `principalSet://goog/group/admins@example.com`. * `principalSet://goog/public:all`: A special identifier that represents any principal that is on the internet, even if they do not have a Google Account or are not logged in. * `principalSet://goog/cloudIdentityCustomerId/{customer_id}`: All of the principals associated with the specified Google Workspace or Cloud Identity customer ID. For example, `principalSet://goog/cloudIdentityCustomerId/C01Abc35`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:principal://goog/subject/{email_id}?uid={uid}`: A specific Google Account that was deleted recently. For example, `deleted:principal://goog/subject/alice@example.com?uid=1234567890`. If the Google Account is recovered, this identifier reverts to the standard identifier for a Google Account. * `deleted:principalSet://goog/group/{group_id}?uid={uid}`: A Google group that was deleted recently. For example, `deleted:principalSet://goog/group/admins@example.com?uid=1234567890`. If the Google group is restored, this identifier reverts to the standard identifier for a Google group. * `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}?uid={uid}`: A Google Cloud service account that was deleted recently. For example, `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com?uid=1234567890`. If the service account is undeleted, this identifier reverts to the standard identifier for a service account. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + "deniedPrincipals": [ # The identities that are prevented from using one or more permissions on Google Cloud resources. This field can contain the following values: * `principal://goog/subject/{email_id}`: A specific Google Account. Includes Gmail, Cloud Identity, and Google Workspace user accounts. For example, `principal://goog/subject/alice@example.com`. * `principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}`: A Google Cloud service account. For example, `principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com`. * `principalSet://goog/group/{group_id}`: A Google group. For example, `principalSet://goog/group/admins@example.com`. * `principalSet://goog/public:all`: A special identifier that represents any principal that is on the internet, even if they do not have a Google Account or are not logged in. * `principalSet://goog/cloudIdentityCustomerId/{customer_id}`: All of the principals associated with the specified Google Workspace or Cloud Identity customer ID. For example, `principalSet://goog/cloudIdentityCustomerId/C01Abc35`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `principalSet://cloudresourcemanager.googleapis.com/[projects|folders|organizations]/{project_number|folder_number|org_number}/type/ServiceAccount`: All service accounts grouped under a resource (project, folder, or organization). * `principalSet://cloudresourcemanager.googleapis.com/[projects|folders|organizations]/{project_number|folder_number|org_number}/type/ServiceAgent`: All service agents grouped under a resource (project, folder, or organization). * `deleted:principal://goog/subject/{email_id}?uid={uid}`: A specific Google Account that was deleted recently. For example, `deleted:principal://goog/subject/alice@example.com?uid=1234567890`. If the Google Account is recovered, this identifier reverts to the standard identifier for a Google Account. * `deleted:principalSet://goog/group/{group_id}?uid={uid}`: A Google group that was deleted recently. For example, `deleted:principalSet://goog/group/admins@example.com?uid=1234567890`. If the Google group is restored, this identifier reverts to the standard identifier for a Google group. * `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}?uid={uid}`: A Google Cloud service account that was deleted recently. For example, `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com?uid=1234567890`. If the service account is undeleted, this identifier reverts to the standard identifier for a service account. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. "A String", ], "exceptionPermissions": [ # Specifies the permissions that this rule excludes from the set of denied permissions given by `denied_permissions`. If a permission appears in `denied_permissions` _and_ in `exception_permissions` then it will _not_ be denied. The excluded permissions can be specified using the same syntax as `denied_permissions`. @@ -256,7 +256,7 @@

Method Details

"deniedPermissions": [ # The permissions that are explicitly denied by this rule. Each permission uses the format `{service_fqdn}/{resource}.{verb}`, where `{service_fqdn}` is the fully qualified domain name for the service. For example, `iam.googleapis.com/roles.list`. "A String", ], - "deniedPrincipals": [ # The identities that are prevented from using one or more permissions on Google Cloud resources. This field can contain the following values: * `principal://goog/subject/{email_id}`: A specific Google Account. Includes Gmail, Cloud Identity, and Google Workspace user accounts. For example, `principal://goog/subject/alice@example.com`. * `principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}`: A Google Cloud service account. For example, `principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com`. * `principalSet://goog/group/{group_id}`: A Google group. For example, `principalSet://goog/group/admins@example.com`. * `principalSet://goog/public:all`: A special identifier that represents any principal that is on the internet, even if they do not have a Google Account or are not logged in. * `principalSet://goog/cloudIdentityCustomerId/{customer_id}`: All of the principals associated with the specified Google Workspace or Cloud Identity customer ID. For example, `principalSet://goog/cloudIdentityCustomerId/C01Abc35`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:principal://goog/subject/{email_id}?uid={uid}`: A specific Google Account that was deleted recently. For example, `deleted:principal://goog/subject/alice@example.com?uid=1234567890`. If the Google Account is recovered, this identifier reverts to the standard identifier for a Google Account. * `deleted:principalSet://goog/group/{group_id}?uid={uid}`: A Google group that was deleted recently. For example, `deleted:principalSet://goog/group/admins@example.com?uid=1234567890`. If the Google group is restored, this identifier reverts to the standard identifier for a Google group. * `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}?uid={uid}`: A Google Cloud service account that was deleted recently. For example, `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com?uid=1234567890`. If the service account is undeleted, this identifier reverts to the standard identifier for a service account. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + "deniedPrincipals": [ # The identities that are prevented from using one or more permissions on Google Cloud resources. This field can contain the following values: * `principal://goog/subject/{email_id}`: A specific Google Account. Includes Gmail, Cloud Identity, and Google Workspace user accounts. For example, `principal://goog/subject/alice@example.com`. * `principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}`: A Google Cloud service account. For example, `principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com`. * `principalSet://goog/group/{group_id}`: A Google group. For example, `principalSet://goog/group/admins@example.com`. * `principalSet://goog/public:all`: A special identifier that represents any principal that is on the internet, even if they do not have a Google Account or are not logged in. * `principalSet://goog/cloudIdentityCustomerId/{customer_id}`: All of the principals associated with the specified Google Workspace or Cloud Identity customer ID. For example, `principalSet://goog/cloudIdentityCustomerId/C01Abc35`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `principalSet://cloudresourcemanager.googleapis.com/[projects|folders|organizations]/{project_number|folder_number|org_number}/type/ServiceAccount`: All service accounts grouped under a resource (project, folder, or organization). * `principalSet://cloudresourcemanager.googleapis.com/[projects|folders|organizations]/{project_number|folder_number|org_number}/type/ServiceAgent`: All service agents grouped under a resource (project, folder, or organization). * `deleted:principal://goog/subject/{email_id}?uid={uid}`: A specific Google Account that was deleted recently. For example, `deleted:principal://goog/subject/alice@example.com?uid=1234567890`. If the Google Account is recovered, this identifier reverts to the standard identifier for a Google Account. * `deleted:principalSet://goog/group/{group_id}?uid={uid}`: A Google group that was deleted recently. For example, `deleted:principalSet://goog/group/admins@example.com?uid=1234567890`. If the Google group is restored, this identifier reverts to the standard identifier for a Google group. * `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}?uid={uid}`: A Google Cloud service account that was deleted recently. For example, `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com?uid=1234567890`. If the service account is undeleted, this identifier reverts to the standard identifier for a service account. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. "A String", ], "exceptionPermissions": [ # Specifies the permissions that this rule excludes from the set of denied permissions given by `denied_permissions`. If a permission appears in `denied_permissions` _and_ in `exception_permissions` then it will _not_ be denied. The excluded permissions can be specified using the same syntax as `denied_permissions`. @@ -315,7 +315,7 @@

Method Details

"deniedPermissions": [ # The permissions that are explicitly denied by this rule. Each permission uses the format `{service_fqdn}/{resource}.{verb}`, where `{service_fqdn}` is the fully qualified domain name for the service. For example, `iam.googleapis.com/roles.list`. "A String", ], - "deniedPrincipals": [ # The identities that are prevented from using one or more permissions on Google Cloud resources. This field can contain the following values: * `principal://goog/subject/{email_id}`: A specific Google Account. Includes Gmail, Cloud Identity, and Google Workspace user accounts. For example, `principal://goog/subject/alice@example.com`. * `principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}`: A Google Cloud service account. For example, `principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com`. * `principalSet://goog/group/{group_id}`: A Google group. For example, `principalSet://goog/group/admins@example.com`. * `principalSet://goog/public:all`: A special identifier that represents any principal that is on the internet, even if they do not have a Google Account or are not logged in. * `principalSet://goog/cloudIdentityCustomerId/{customer_id}`: All of the principals associated with the specified Google Workspace or Cloud Identity customer ID. For example, `principalSet://goog/cloudIdentityCustomerId/C01Abc35`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:principal://goog/subject/{email_id}?uid={uid}`: A specific Google Account that was deleted recently. For example, `deleted:principal://goog/subject/alice@example.com?uid=1234567890`. If the Google Account is recovered, this identifier reverts to the standard identifier for a Google Account. * `deleted:principalSet://goog/group/{group_id}?uid={uid}`: A Google group that was deleted recently. For example, `deleted:principalSet://goog/group/admins@example.com?uid=1234567890`. If the Google group is restored, this identifier reverts to the standard identifier for a Google group. * `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}?uid={uid}`: A Google Cloud service account that was deleted recently. For example, `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com?uid=1234567890`. If the service account is undeleted, this identifier reverts to the standard identifier for a service account. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + "deniedPrincipals": [ # The identities that are prevented from using one or more permissions on Google Cloud resources. This field can contain the following values: * `principal://goog/subject/{email_id}`: A specific Google Account. Includes Gmail, Cloud Identity, and Google Workspace user accounts. For example, `principal://goog/subject/alice@example.com`. * `principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}`: A Google Cloud service account. For example, `principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com`. * `principalSet://goog/group/{group_id}`: A Google group. For example, `principalSet://goog/group/admins@example.com`. * `principalSet://goog/public:all`: A special identifier that represents any principal that is on the internet, even if they do not have a Google Account or are not logged in. * `principalSet://goog/cloudIdentityCustomerId/{customer_id}`: All of the principals associated with the specified Google Workspace or Cloud Identity customer ID. For example, `principalSet://goog/cloudIdentityCustomerId/C01Abc35`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `principalSet://cloudresourcemanager.googleapis.com/[projects|folders|organizations]/{project_number|folder_number|org_number}/type/ServiceAccount`: All service accounts grouped under a resource (project, folder, or organization). * `principalSet://cloudresourcemanager.googleapis.com/[projects|folders|organizations]/{project_number|folder_number|org_number}/type/ServiceAgent`: All service agents grouped under a resource (project, folder, or organization). * `deleted:principal://goog/subject/{email_id}?uid={uid}`: A specific Google Account that was deleted recently. For example, `deleted:principal://goog/subject/alice@example.com?uid=1234567890`. If the Google Account is recovered, this identifier reverts to the standard identifier for a Google Account. * `deleted:principalSet://goog/group/{group_id}?uid={uid}`: A Google group that was deleted recently. For example, `deleted:principalSet://goog/group/admins@example.com?uid=1234567890`. If the Google group is restored, this identifier reverts to the standard identifier for a Google group. * `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}?uid={uid}`: A Google Cloud service account that was deleted recently. For example, `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com?uid=1234567890`. If the service account is undeleted, this identifier reverts to the standard identifier for a service account. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. "A String", ], "exceptionPermissions": [ # Specifies the permissions that this rule excludes from the set of denied permissions given by `denied_permissions`. If a permission appears in `denied_permissions` _and_ in `exception_permissions` then it will _not_ be denied. The excluded permissions can be specified using the same syntax as `denied_permissions`. @@ -380,7 +380,7 @@

Method Details

"deniedPermissions": [ # The permissions that are explicitly denied by this rule. Each permission uses the format `{service_fqdn}/{resource}.{verb}`, where `{service_fqdn}` is the fully qualified domain name for the service. For example, `iam.googleapis.com/roles.list`. "A String", ], - "deniedPrincipals": [ # The identities that are prevented from using one or more permissions on Google Cloud resources. This field can contain the following values: * `principal://goog/subject/{email_id}`: A specific Google Account. Includes Gmail, Cloud Identity, and Google Workspace user accounts. For example, `principal://goog/subject/alice@example.com`. * `principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}`: A Google Cloud service account. For example, `principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com`. * `principalSet://goog/group/{group_id}`: A Google group. For example, `principalSet://goog/group/admins@example.com`. * `principalSet://goog/public:all`: A special identifier that represents any principal that is on the internet, even if they do not have a Google Account or are not logged in. * `principalSet://goog/cloudIdentityCustomerId/{customer_id}`: All of the principals associated with the specified Google Workspace or Cloud Identity customer ID. For example, `principalSet://goog/cloudIdentityCustomerId/C01Abc35`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:principal://goog/subject/{email_id}?uid={uid}`: A specific Google Account that was deleted recently. For example, `deleted:principal://goog/subject/alice@example.com?uid=1234567890`. If the Google Account is recovered, this identifier reverts to the standard identifier for a Google Account. * `deleted:principalSet://goog/group/{group_id}?uid={uid}`: A Google group that was deleted recently. For example, `deleted:principalSet://goog/group/admins@example.com?uid=1234567890`. If the Google group is restored, this identifier reverts to the standard identifier for a Google group. * `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}?uid={uid}`: A Google Cloud service account that was deleted recently. For example, `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com?uid=1234567890`. If the service account is undeleted, this identifier reverts to the standard identifier for a service account. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + "deniedPrincipals": [ # The identities that are prevented from using one or more permissions on Google Cloud resources. This field can contain the following values: * `principal://goog/subject/{email_id}`: A specific Google Account. Includes Gmail, Cloud Identity, and Google Workspace user accounts. For example, `principal://goog/subject/alice@example.com`. * `principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}`: A Google Cloud service account. For example, `principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com`. * `principalSet://goog/group/{group_id}`: A Google group. For example, `principalSet://goog/group/admins@example.com`. * `principalSet://goog/public:all`: A special identifier that represents any principal that is on the internet, even if they do not have a Google Account or are not logged in. * `principalSet://goog/cloudIdentityCustomerId/{customer_id}`: All of the principals associated with the specified Google Workspace or Cloud Identity customer ID. For example, `principalSet://goog/cloudIdentityCustomerId/C01Abc35`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `principalSet://cloudresourcemanager.googleapis.com/[projects|folders|organizations]/{project_number|folder_number|org_number}/type/ServiceAccount`: All service accounts grouped under a resource (project, folder, or organization). * `principalSet://cloudresourcemanager.googleapis.com/[projects|folders|organizations]/{project_number|folder_number|org_number}/type/ServiceAgent`: All service agents grouped under a resource (project, folder, or organization). * `deleted:principal://goog/subject/{email_id}?uid={uid}`: A specific Google Account that was deleted recently. For example, `deleted:principal://goog/subject/alice@example.com?uid=1234567890`. If the Google Account is recovered, this identifier reverts to the standard identifier for a Google Account. * `deleted:principalSet://goog/group/{group_id}?uid={uid}`: A Google group that was deleted recently. For example, `deleted:principalSet://goog/group/admins@example.com?uid=1234567890`. If the Google group is restored, this identifier reverts to the standard identifier for a Google group. * `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}?uid={uid}`: A Google Cloud service account that was deleted recently. For example, `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com?uid=1234567890`. If the service account is undeleted, this identifier reverts to the standard identifier for a service account. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. "A String", ], "exceptionPermissions": [ # Specifies the permissions that this rule excludes from the set of denied permissions given by `denied_permissions`. If a permission appears in `denied_permissions` _and_ in `exception_permissions` then it will _not_ be denied. The excluded permissions can be specified using the same syntax as `denied_permissions`. diff --git a/docs/dyn/iam_v2beta.policies.html b/docs/dyn/iam_v2beta.policies.html index c89c57e6ade..0fd203d7926 100644 --- a/docs/dyn/iam_v2beta.policies.html +++ b/docs/dyn/iam_v2beta.policies.html @@ -137,7 +137,7 @@

Method Details

"deniedPermissions": [ # The permissions that are explicitly denied by this rule. Each permission uses the format `{service_fqdn}/{resource}.{verb}`, where `{service_fqdn}` is the fully qualified domain name for the service. For example, `iam.googleapis.com/roles.list`. "A String", ], - "deniedPrincipals": [ # The identities that are prevented from using one or more permissions on Google Cloud resources. This field can contain the following values: * `principal://goog/subject/{email_id}`: A specific Google Account. Includes Gmail, Cloud Identity, and Google Workspace user accounts. For example, `principal://goog/subject/alice@example.com`. * `principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}`: A Google Cloud service account. For example, `principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com`. * `principalSet://goog/group/{group_id}`: A Google group. For example, `principalSet://goog/group/admins@example.com`. * `principalSet://goog/public:all`: A special identifier that represents any principal that is on the internet, even if they do not have a Google Account or are not logged in. * `principalSet://goog/cloudIdentityCustomerId/{customer_id}`: All of the principals associated with the specified Google Workspace or Cloud Identity customer ID. For example, `principalSet://goog/cloudIdentityCustomerId/C01Abc35`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:principal://goog/subject/{email_id}?uid={uid}`: A specific Google Account that was deleted recently. For example, `deleted:principal://goog/subject/alice@example.com?uid=1234567890`. If the Google Account is recovered, this identifier reverts to the standard identifier for a Google Account. * `deleted:principalSet://goog/group/{group_id}?uid={uid}`: A Google group that was deleted recently. For example, `deleted:principalSet://goog/group/admins@example.com?uid=1234567890`. If the Google group is restored, this identifier reverts to the standard identifier for a Google group. * `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}?uid={uid}`: A Google Cloud service account that was deleted recently. For example, `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com?uid=1234567890`. If the service account is undeleted, this identifier reverts to the standard identifier for a service account. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + "deniedPrincipals": [ # The identities that are prevented from using one or more permissions on Google Cloud resources. This field can contain the following values: * `principal://goog/subject/{email_id}`: A specific Google Account. Includes Gmail, Cloud Identity, and Google Workspace user accounts. For example, `principal://goog/subject/alice@example.com`. * `principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}`: A Google Cloud service account. For example, `principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com`. * `principalSet://goog/group/{group_id}`: A Google group. For example, `principalSet://goog/group/admins@example.com`. * `principalSet://goog/public:all`: A special identifier that represents any principal that is on the internet, even if they do not have a Google Account or are not logged in. * `principalSet://goog/cloudIdentityCustomerId/{customer_id}`: All of the principals associated with the specified Google Workspace or Cloud Identity customer ID. For example, `principalSet://goog/cloudIdentityCustomerId/C01Abc35`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `principalSet://cloudresourcemanager.googleapis.com/[projects|folders|organizations]/{project_number|folder_number|org_number}/type/ServiceAccount`: All service accounts grouped under a resource (project, folder, or organization). * `principalSet://cloudresourcemanager.googleapis.com/[projects|folders|organizations]/{project_number|folder_number|org_number}/type/ServiceAgent`: All service agents grouped under a resource (project, folder, or organization). * `deleted:principal://goog/subject/{email_id}?uid={uid}`: A specific Google Account that was deleted recently. For example, `deleted:principal://goog/subject/alice@example.com?uid=1234567890`. If the Google Account is recovered, this identifier reverts to the standard identifier for a Google Account. * `deleted:principalSet://goog/group/{group_id}?uid={uid}`: A Google group that was deleted recently. For example, `deleted:principalSet://goog/group/admins@example.com?uid=1234567890`. If the Google group is restored, this identifier reverts to the standard identifier for a Google group. * `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}?uid={uid}`: A Google Cloud service account that was deleted recently. For example, `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com?uid=1234567890`. If the service account is undeleted, this identifier reverts to the standard identifier for a service account. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. "A String", ], "exceptionPermissions": [ # Specifies the permissions that this rule excludes from the set of denied permissions given by `denied_permissions`. If a permission appears in `denied_permissions` _and_ in `exception_permissions` then it will _not_ be denied. The excluded permissions can be specified using the same syntax as `denied_permissions`. @@ -256,7 +256,7 @@

Method Details

"deniedPermissions": [ # The permissions that are explicitly denied by this rule. Each permission uses the format `{service_fqdn}/{resource}.{verb}`, where `{service_fqdn}` is the fully qualified domain name for the service. For example, `iam.googleapis.com/roles.list`. "A String", ], - "deniedPrincipals": [ # The identities that are prevented from using one or more permissions on Google Cloud resources. This field can contain the following values: * `principal://goog/subject/{email_id}`: A specific Google Account. Includes Gmail, Cloud Identity, and Google Workspace user accounts. For example, `principal://goog/subject/alice@example.com`. * `principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}`: A Google Cloud service account. For example, `principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com`. * `principalSet://goog/group/{group_id}`: A Google group. For example, `principalSet://goog/group/admins@example.com`. * `principalSet://goog/public:all`: A special identifier that represents any principal that is on the internet, even if they do not have a Google Account or are not logged in. * `principalSet://goog/cloudIdentityCustomerId/{customer_id}`: All of the principals associated with the specified Google Workspace or Cloud Identity customer ID. For example, `principalSet://goog/cloudIdentityCustomerId/C01Abc35`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:principal://goog/subject/{email_id}?uid={uid}`: A specific Google Account that was deleted recently. For example, `deleted:principal://goog/subject/alice@example.com?uid=1234567890`. If the Google Account is recovered, this identifier reverts to the standard identifier for a Google Account. * `deleted:principalSet://goog/group/{group_id}?uid={uid}`: A Google group that was deleted recently. For example, `deleted:principalSet://goog/group/admins@example.com?uid=1234567890`. If the Google group is restored, this identifier reverts to the standard identifier for a Google group. * `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}?uid={uid}`: A Google Cloud service account that was deleted recently. For example, `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com?uid=1234567890`. If the service account is undeleted, this identifier reverts to the standard identifier for a service account. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + "deniedPrincipals": [ # The identities that are prevented from using one or more permissions on Google Cloud resources. This field can contain the following values: * `principal://goog/subject/{email_id}`: A specific Google Account. Includes Gmail, Cloud Identity, and Google Workspace user accounts. For example, `principal://goog/subject/alice@example.com`. * `principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}`: A Google Cloud service account. For example, `principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com`. * `principalSet://goog/group/{group_id}`: A Google group. For example, `principalSet://goog/group/admins@example.com`. * `principalSet://goog/public:all`: A special identifier that represents any principal that is on the internet, even if they do not have a Google Account or are not logged in. * `principalSet://goog/cloudIdentityCustomerId/{customer_id}`: All of the principals associated with the specified Google Workspace or Cloud Identity customer ID. For example, `principalSet://goog/cloudIdentityCustomerId/C01Abc35`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `principalSet://cloudresourcemanager.googleapis.com/[projects|folders|organizations]/{project_number|folder_number|org_number}/type/ServiceAccount`: All service accounts grouped under a resource (project, folder, or organization). * `principalSet://cloudresourcemanager.googleapis.com/[projects|folders|organizations]/{project_number|folder_number|org_number}/type/ServiceAgent`: All service agents grouped under a resource (project, folder, or organization). * `deleted:principal://goog/subject/{email_id}?uid={uid}`: A specific Google Account that was deleted recently. For example, `deleted:principal://goog/subject/alice@example.com?uid=1234567890`. If the Google Account is recovered, this identifier reverts to the standard identifier for a Google Account. * `deleted:principalSet://goog/group/{group_id}?uid={uid}`: A Google group that was deleted recently. For example, `deleted:principalSet://goog/group/admins@example.com?uid=1234567890`. If the Google group is restored, this identifier reverts to the standard identifier for a Google group. * `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}?uid={uid}`: A Google Cloud service account that was deleted recently. For example, `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com?uid=1234567890`. If the service account is undeleted, this identifier reverts to the standard identifier for a service account. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. "A String", ], "exceptionPermissions": [ # Specifies the permissions that this rule excludes from the set of denied permissions given by `denied_permissions`. If a permission appears in `denied_permissions` _and_ in `exception_permissions` then it will _not_ be denied. The excluded permissions can be specified using the same syntax as `denied_permissions`. @@ -315,7 +315,7 @@

Method Details

"deniedPermissions": [ # The permissions that are explicitly denied by this rule. Each permission uses the format `{service_fqdn}/{resource}.{verb}`, where `{service_fqdn}` is the fully qualified domain name for the service. For example, `iam.googleapis.com/roles.list`. "A String", ], - "deniedPrincipals": [ # The identities that are prevented from using one or more permissions on Google Cloud resources. This field can contain the following values: * `principal://goog/subject/{email_id}`: A specific Google Account. Includes Gmail, Cloud Identity, and Google Workspace user accounts. For example, `principal://goog/subject/alice@example.com`. * `principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}`: A Google Cloud service account. For example, `principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com`. * `principalSet://goog/group/{group_id}`: A Google group. For example, `principalSet://goog/group/admins@example.com`. * `principalSet://goog/public:all`: A special identifier that represents any principal that is on the internet, even if they do not have a Google Account or are not logged in. * `principalSet://goog/cloudIdentityCustomerId/{customer_id}`: All of the principals associated with the specified Google Workspace or Cloud Identity customer ID. For example, `principalSet://goog/cloudIdentityCustomerId/C01Abc35`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:principal://goog/subject/{email_id}?uid={uid}`: A specific Google Account that was deleted recently. For example, `deleted:principal://goog/subject/alice@example.com?uid=1234567890`. If the Google Account is recovered, this identifier reverts to the standard identifier for a Google Account. * `deleted:principalSet://goog/group/{group_id}?uid={uid}`: A Google group that was deleted recently. For example, `deleted:principalSet://goog/group/admins@example.com?uid=1234567890`. If the Google group is restored, this identifier reverts to the standard identifier for a Google group. * `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}?uid={uid}`: A Google Cloud service account that was deleted recently. For example, `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com?uid=1234567890`. If the service account is undeleted, this identifier reverts to the standard identifier for a service account. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + "deniedPrincipals": [ # The identities that are prevented from using one or more permissions on Google Cloud resources. This field can contain the following values: * `principal://goog/subject/{email_id}`: A specific Google Account. Includes Gmail, Cloud Identity, and Google Workspace user accounts. For example, `principal://goog/subject/alice@example.com`. * `principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}`: A Google Cloud service account. For example, `principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com`. * `principalSet://goog/group/{group_id}`: A Google group. For example, `principalSet://goog/group/admins@example.com`. * `principalSet://goog/public:all`: A special identifier that represents any principal that is on the internet, even if they do not have a Google Account or are not logged in. * `principalSet://goog/cloudIdentityCustomerId/{customer_id}`: All of the principals associated with the specified Google Workspace or Cloud Identity customer ID. For example, `principalSet://goog/cloudIdentityCustomerId/C01Abc35`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `principalSet://cloudresourcemanager.googleapis.com/[projects|folders|organizations]/{project_number|folder_number|org_number}/type/ServiceAccount`: All service accounts grouped under a resource (project, folder, or organization). * `principalSet://cloudresourcemanager.googleapis.com/[projects|folders|organizations]/{project_number|folder_number|org_number}/type/ServiceAgent`: All service agents grouped under a resource (project, folder, or organization). * `deleted:principal://goog/subject/{email_id}?uid={uid}`: A specific Google Account that was deleted recently. For example, `deleted:principal://goog/subject/alice@example.com?uid=1234567890`. If the Google Account is recovered, this identifier reverts to the standard identifier for a Google Account. * `deleted:principalSet://goog/group/{group_id}?uid={uid}`: A Google group that was deleted recently. For example, `deleted:principalSet://goog/group/admins@example.com?uid=1234567890`. If the Google group is restored, this identifier reverts to the standard identifier for a Google group. * `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}?uid={uid}`: A Google Cloud service account that was deleted recently. For example, `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com?uid=1234567890`. If the service account is undeleted, this identifier reverts to the standard identifier for a service account. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. "A String", ], "exceptionPermissions": [ # Specifies the permissions that this rule excludes from the set of denied permissions given by `denied_permissions`. If a permission appears in `denied_permissions` _and_ in `exception_permissions` then it will _not_ be denied. The excluded permissions can be specified using the same syntax as `denied_permissions`. @@ -380,7 +380,7 @@

Method Details

"deniedPermissions": [ # The permissions that are explicitly denied by this rule. Each permission uses the format `{service_fqdn}/{resource}.{verb}`, where `{service_fqdn}` is the fully qualified domain name for the service. For example, `iam.googleapis.com/roles.list`. "A String", ], - "deniedPrincipals": [ # The identities that are prevented from using one or more permissions on Google Cloud resources. This field can contain the following values: * `principal://goog/subject/{email_id}`: A specific Google Account. Includes Gmail, Cloud Identity, and Google Workspace user accounts. For example, `principal://goog/subject/alice@example.com`. * `principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}`: A Google Cloud service account. For example, `principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com`. * `principalSet://goog/group/{group_id}`: A Google group. For example, `principalSet://goog/group/admins@example.com`. * `principalSet://goog/public:all`: A special identifier that represents any principal that is on the internet, even if they do not have a Google Account or are not logged in. * `principalSet://goog/cloudIdentityCustomerId/{customer_id}`: All of the principals associated with the specified Google Workspace or Cloud Identity customer ID. For example, `principalSet://goog/cloudIdentityCustomerId/C01Abc35`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:principal://goog/subject/{email_id}?uid={uid}`: A specific Google Account that was deleted recently. For example, `deleted:principal://goog/subject/alice@example.com?uid=1234567890`. If the Google Account is recovered, this identifier reverts to the standard identifier for a Google Account. * `deleted:principalSet://goog/group/{group_id}?uid={uid}`: A Google group that was deleted recently. For example, `deleted:principalSet://goog/group/admins@example.com?uid=1234567890`. If the Google group is restored, this identifier reverts to the standard identifier for a Google group. * `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}?uid={uid}`: A Google Cloud service account that was deleted recently. For example, `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com?uid=1234567890`. If the service account is undeleted, this identifier reverts to the standard identifier for a service account. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + "deniedPrincipals": [ # The identities that are prevented from using one or more permissions on Google Cloud resources. This field can contain the following values: * `principal://goog/subject/{email_id}`: A specific Google Account. Includes Gmail, Cloud Identity, and Google Workspace user accounts. For example, `principal://goog/subject/alice@example.com`. * `principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}`: A Google Cloud service account. For example, `principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com`. * `principalSet://goog/group/{group_id}`: A Google group. For example, `principalSet://goog/group/admins@example.com`. * `principalSet://goog/public:all`: A special identifier that represents any principal that is on the internet, even if they do not have a Google Account or are not logged in. * `principalSet://goog/cloudIdentityCustomerId/{customer_id}`: All of the principals associated with the specified Google Workspace or Cloud Identity customer ID. For example, `principalSet://goog/cloudIdentityCustomerId/C01Abc35`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `principalSet://cloudresourcemanager.googleapis.com/[projects|folders|organizations]/{project_number|folder_number|org_number}/type/ServiceAccount`: All service accounts grouped under a resource (project, folder, or organization). * `principalSet://cloudresourcemanager.googleapis.com/[projects|folders|organizations]/{project_number|folder_number|org_number}/type/ServiceAgent`: All service agents grouped under a resource (project, folder, or organization). * `deleted:principal://goog/subject/{email_id}?uid={uid}`: A specific Google Account that was deleted recently. For example, `deleted:principal://goog/subject/alice@example.com?uid=1234567890`. If the Google Account is recovered, this identifier reverts to the standard identifier for a Google Account. * `deleted:principalSet://goog/group/{group_id}?uid={uid}`: A Google group that was deleted recently. For example, `deleted:principalSet://goog/group/admins@example.com?uid=1234567890`. If the Google group is restored, this identifier reverts to the standard identifier for a Google group. * `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}?uid={uid}`: A Google Cloud service account that was deleted recently. For example, `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com?uid=1234567890`. If the service account is undeleted, this identifier reverts to the standard identifier for a service account. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. "A String", ], "exceptionPermissions": [ # Specifies the permissions that this rule excludes from the set of denied permissions given by `denied_permissions`. If a permission appears in `denied_permissions` _and_ in `exception_permissions` then it will _not_ be denied. The excluded permissions can be specified using the same syntax as `denied_permissions`. diff --git a/docs/dyn/ids_v1.projects.locations.operations.html b/docs/dyn/ids_v1.projects.locations.operations.html index e505f7f6688..726ffb1189f 100644 --- a/docs/dyn/ids_v1.projects.locations.operations.html +++ b/docs/dyn/ids_v1.projects.locations.operations.html @@ -76,7 +76,7 @@

Cloud IDS API . pro

Instance Methods

cancel(name, body=None, 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`.

+

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.

@@ -95,7 +95,7 @@

Instance Methods

Method Details

cancel(name, body=None, 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`.
+  
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)
diff --git a/docs/dyn/migrationcenter_v1alpha1.projects.locations.assets.html b/docs/dyn/migrationcenter_v1alpha1.projects.locations.assets.html
index 0bc4ce25f34..b96ce8dd5bd 100644
--- a/docs/dyn/migrationcenter_v1alpha1.projects.locations.assets.html
+++ b/docs/dyn/migrationcenter_v1alpha1.projects.locations.assets.html
@@ -501,7 +501,7 @@ 

Method Details

"capacityBytes": "A String", # Partition capacity. "fileSystem": "A String", # Partition file system. "freeBytes": "A String", # Partition free space. - "mountPoint": "A String", # Mount pount (Linux/Windows) or drive letter (Windows). + "mountPoint": "A String", # Mount point (Linux/Windows) or drive letter (Windows). "subPartitions": # Object with schema name: DiskPartitionList # Sub-partitions. "type": "A String", # Partition type (e.g. BIOS boot). "uuid": "A String", # Partition UUID. @@ -524,7 +524,7 @@

Method Details

"capacityBytes": "A String", # Partition capacity. "fileSystem": "A String", # Partition file system. "freeBytes": "A String", # Partition free space. - "mountPoint": "A String", # Mount pount (Linux/Windows) or drive letter (Windows). + "mountPoint": "A String", # Mount point (Linux/Windows) or drive letter (Windows). "subPartitions": # Object with schema name: DiskPartitionList # Sub-partitions. "type": "A String", # Partition type (e.g. BIOS boot). "uuid": "A String", # Partition UUID. @@ -813,7 +813,7 @@

Method Details

"capacityBytes": "A String", # Partition capacity. "fileSystem": "A String", # Partition file system. "freeBytes": "A String", # Partition free space. - "mountPoint": "A String", # Mount pount (Linux/Windows) or drive letter (Windows). + "mountPoint": "A String", # Mount point (Linux/Windows) or drive letter (Windows). "subPartitions": # Object with schema name: DiskPartitionList # Sub-partitions. "type": "A String", # Partition type (e.g. BIOS boot). "uuid": "A String", # Partition UUID. @@ -1019,7 +1019,7 @@

Method Details

"capacityBytes": "A String", # Partition capacity. "fileSystem": "A String", # Partition file system. "freeBytes": "A String", # Partition free space. - "mountPoint": "A String", # Mount pount (Linux/Windows) or drive letter (Windows). + "mountPoint": "A String", # Mount point (Linux/Windows) or drive letter (Windows). "subPartitions": # Object with schema name: DiskPartitionList # Sub-partitions. "type": "A String", # Partition type (e.g. BIOS boot). "uuid": "A String", # Partition UUID. @@ -1370,7 +1370,7 @@

Method Details

"capacityBytes": "A String", # Partition capacity. "fileSystem": "A String", # Partition file system. "freeBytes": "A String", # Partition free space. - "mountPoint": "A String", # Mount pount (Linux/Windows) or drive letter (Windows). + "mountPoint": "A String", # Mount point (Linux/Windows) or drive letter (Windows). "subPartitions": # Object with schema name: DiskPartitionList # Sub-partitions. "type": "A String", # Partition type (e.g. BIOS boot). "uuid": "A String", # Partition UUID. @@ -1393,7 +1393,7 @@

Method Details

"capacityBytes": "A String", # Partition capacity. "fileSystem": "A String", # Partition file system. "freeBytes": "A String", # Partition free space. - "mountPoint": "A String", # Mount pount (Linux/Windows) or drive letter (Windows). + "mountPoint": "A String", # Mount point (Linux/Windows) or drive letter (Windows). "subPartitions": # Object with schema name: DiskPartitionList # Sub-partitions. "type": "A String", # Partition type (e.g. BIOS boot). "uuid": "A String", # Partition UUID. @@ -1682,7 +1682,7 @@

Method Details

"capacityBytes": "A String", # Partition capacity. "fileSystem": "A String", # Partition file system. "freeBytes": "A String", # Partition free space. - "mountPoint": "A String", # Mount pount (Linux/Windows) or drive letter (Windows). + "mountPoint": "A String", # Mount point (Linux/Windows) or drive letter (Windows). "subPartitions": # Object with schema name: DiskPartitionList # Sub-partitions. "type": "A String", # Partition type (e.g. BIOS boot). "uuid": "A String", # Partition UUID. @@ -1888,7 +1888,7 @@

Method Details

"capacityBytes": "A String", # Partition capacity. "fileSystem": "A String", # Partition file system. "freeBytes": "A String", # Partition free space. - "mountPoint": "A String", # Mount pount (Linux/Windows) or drive letter (Windows). + "mountPoint": "A String", # Mount point (Linux/Windows) or drive letter (Windows). "subPartitions": # Object with schema name: DiskPartitionList # Sub-partitions. "type": "A String", # Partition type (e.g. BIOS boot). "uuid": "A String", # Partition UUID. @@ -2271,7 +2271,7 @@

Method Details

"capacityBytes": "A String", # Partition capacity. "fileSystem": "A String", # Partition file system. "freeBytes": "A String", # Partition free space. - "mountPoint": "A String", # Mount pount (Linux/Windows) or drive letter (Windows). + "mountPoint": "A String", # Mount point (Linux/Windows) or drive letter (Windows). "subPartitions": # Object with schema name: DiskPartitionList # Sub-partitions. "type": "A String", # Partition type (e.g. BIOS boot). "uuid": "A String", # Partition UUID. @@ -2294,7 +2294,7 @@

Method Details

"capacityBytes": "A String", # Partition capacity. "fileSystem": "A String", # Partition file system. "freeBytes": "A String", # Partition free space. - "mountPoint": "A String", # Mount pount (Linux/Windows) or drive letter (Windows). + "mountPoint": "A String", # Mount point (Linux/Windows) or drive letter (Windows). "subPartitions": # Object with schema name: DiskPartitionList # Sub-partitions. "type": "A String", # Partition type (e.g. BIOS boot). "uuid": "A String", # Partition UUID. @@ -2583,7 +2583,7 @@

Method Details

"capacityBytes": "A String", # Partition capacity. "fileSystem": "A String", # Partition file system. "freeBytes": "A String", # Partition free space. - "mountPoint": "A String", # Mount pount (Linux/Windows) or drive letter (Windows). + "mountPoint": "A String", # Mount point (Linux/Windows) or drive letter (Windows). "subPartitions": # Object with schema name: DiskPartitionList # Sub-partitions. "type": "A String", # Partition type (e.g. BIOS boot). "uuid": "A String", # Partition UUID. @@ -2789,7 +2789,7 @@

Method Details

"capacityBytes": "A String", # Partition capacity. "fileSystem": "A String", # Partition file system. "freeBytes": "A String", # Partition free space. - "mountPoint": "A String", # Mount pount (Linux/Windows) or drive letter (Windows). + "mountPoint": "A String", # Mount point (Linux/Windows) or drive letter (Windows). "subPartitions": # Object with schema name: DiskPartitionList # Sub-partitions. "type": "A String", # Partition type (e.g. BIOS boot). "uuid": "A String", # Partition UUID. @@ -3153,7 +3153,7 @@

Method Details

"capacityBytes": "A String", # Partition capacity. "fileSystem": "A String", # Partition file system. "freeBytes": "A String", # Partition free space. - "mountPoint": "A String", # Mount pount (Linux/Windows) or drive letter (Windows). + "mountPoint": "A String", # Mount point (Linux/Windows) or drive letter (Windows). "subPartitions": # Object with schema name: DiskPartitionList # Sub-partitions. "type": "A String", # Partition type (e.g. BIOS boot). "uuid": "A String", # Partition UUID. @@ -3176,7 +3176,7 @@

Method Details

"capacityBytes": "A String", # Partition capacity. "fileSystem": "A String", # Partition file system. "freeBytes": "A String", # Partition free space. - "mountPoint": "A String", # Mount pount (Linux/Windows) or drive letter (Windows). + "mountPoint": "A String", # Mount point (Linux/Windows) or drive letter (Windows). "subPartitions": # Object with schema name: DiskPartitionList # Sub-partitions. "type": "A String", # Partition type (e.g. BIOS boot). "uuid": "A String", # Partition UUID. @@ -3465,7 +3465,7 @@

Method Details

"capacityBytes": "A String", # Partition capacity. "fileSystem": "A String", # Partition file system. "freeBytes": "A String", # Partition free space. - "mountPoint": "A String", # Mount pount (Linux/Windows) or drive letter (Windows). + "mountPoint": "A String", # Mount point (Linux/Windows) or drive letter (Windows). "subPartitions": # Object with schema name: DiskPartitionList # Sub-partitions. "type": "A String", # Partition type (e.g. BIOS boot). "uuid": "A String", # Partition UUID. @@ -3671,7 +3671,7 @@

Method Details

"capacityBytes": "A String", # Partition capacity. "fileSystem": "A String", # Partition file system. "freeBytes": "A String", # Partition free space. - "mountPoint": "A String", # Mount pount (Linux/Windows) or drive letter (Windows). + "mountPoint": "A String", # Mount point (Linux/Windows) or drive letter (Windows). "subPartitions": # Object with schema name: DiskPartitionList # Sub-partitions. "type": "A String", # Partition type (e.g. BIOS boot). "uuid": "A String", # Partition UUID. @@ -4037,7 +4037,7 @@

Method Details

"capacityBytes": "A String", # Partition capacity. "fileSystem": "A String", # Partition file system. "freeBytes": "A String", # Partition free space. - "mountPoint": "A String", # Mount pount (Linux/Windows) or drive letter (Windows). + "mountPoint": "A String", # Mount point (Linux/Windows) or drive letter (Windows). "subPartitions": # Object with schema name: DiskPartitionList # Sub-partitions. "type": "A String", # Partition type (e.g. BIOS boot). "uuid": "A String", # Partition UUID. @@ -4060,7 +4060,7 @@

Method Details

"capacityBytes": "A String", # Partition capacity. "fileSystem": "A String", # Partition file system. "freeBytes": "A String", # Partition free space. - "mountPoint": "A String", # Mount pount (Linux/Windows) or drive letter (Windows). + "mountPoint": "A String", # Mount point (Linux/Windows) or drive letter (Windows). "subPartitions": # Object with schema name: DiskPartitionList # Sub-partitions. "type": "A String", # Partition type (e.g. BIOS boot). "uuid": "A String", # Partition UUID. @@ -4349,7 +4349,7 @@

Method Details

"capacityBytes": "A String", # Partition capacity. "fileSystem": "A String", # Partition file system. "freeBytes": "A String", # Partition free space. - "mountPoint": "A String", # Mount pount (Linux/Windows) or drive letter (Windows). + "mountPoint": "A String", # Mount point (Linux/Windows) or drive letter (Windows). "subPartitions": # Object with schema name: DiskPartitionList # Sub-partitions. "type": "A String", # Partition type (e.g. BIOS boot). "uuid": "A String", # Partition UUID. @@ -4555,7 +4555,7 @@

Method Details

"capacityBytes": "A String", # Partition capacity. "fileSystem": "A String", # Partition file system. "freeBytes": "A String", # Partition free space. - "mountPoint": "A String", # Mount pount (Linux/Windows) or drive letter (Windows). + "mountPoint": "A String", # Mount point (Linux/Windows) or drive letter (Windows). "subPartitions": # Object with schema name: DiskPartitionList # Sub-partitions. "type": "A String", # Partition type (e.g. BIOS boot). "uuid": "A String", # Partition UUID. @@ -4901,7 +4901,7 @@

Method Details

"capacityBytes": "A String", # Partition capacity. "fileSystem": "A String", # Partition file system. "freeBytes": "A String", # Partition free space. - "mountPoint": "A String", # Mount pount (Linux/Windows) or drive letter (Windows). + "mountPoint": "A String", # Mount point (Linux/Windows) or drive letter (Windows). "subPartitions": # Object with schema name: DiskPartitionList # Sub-partitions. "type": "A String", # Partition type (e.g. BIOS boot). "uuid": "A String", # Partition UUID. @@ -4924,7 +4924,7 @@

Method Details

"capacityBytes": "A String", # Partition capacity. "fileSystem": "A String", # Partition file system. "freeBytes": "A String", # Partition free space. - "mountPoint": "A String", # Mount pount (Linux/Windows) or drive letter (Windows). + "mountPoint": "A String", # Mount point (Linux/Windows) or drive letter (Windows). "subPartitions": # Object with schema name: DiskPartitionList # Sub-partitions. "type": "A String", # Partition type (e.g. BIOS boot). "uuid": "A String", # Partition UUID. @@ -5213,7 +5213,7 @@

Method Details

"capacityBytes": "A String", # Partition capacity. "fileSystem": "A String", # Partition file system. "freeBytes": "A String", # Partition free space. - "mountPoint": "A String", # Mount pount (Linux/Windows) or drive letter (Windows). + "mountPoint": "A String", # Mount point (Linux/Windows) or drive letter (Windows). "subPartitions": # Object with schema name: DiskPartitionList # Sub-partitions. "type": "A String", # Partition type (e.g. BIOS boot). "uuid": "A String", # Partition UUID. @@ -5419,7 +5419,7 @@

Method Details

"capacityBytes": "A String", # Partition capacity. "fileSystem": "A String", # Partition file system. "freeBytes": "A String", # Partition free space. - "mountPoint": "A String", # Mount pount (Linux/Windows) or drive letter (Windows). + "mountPoint": "A String", # Mount point (Linux/Windows) or drive letter (Windows). "subPartitions": # Object with schema name: DiskPartitionList # Sub-partitions. "type": "A String", # Partition type (e.g. BIOS boot). "uuid": "A String", # Partition UUID. @@ -5660,7 +5660,7 @@

Method Details

"capacityBytes": "A String", # Partition capacity. "fileSystem": "A String", # Partition file system. "freeBytes": "A String", # Partition free space. - "mountPoint": "A String", # Mount pount (Linux/Windows) or drive letter (Windows). + "mountPoint": "A String", # Mount point (Linux/Windows) or drive letter (Windows). "subPartitions": # Object with schema name: DiskPartitionList # Sub-partitions. "type": "A String", # Partition type (e.g. BIOS boot). "uuid": "A String", # Partition UUID. @@ -5683,7 +5683,7 @@

Method Details

"capacityBytes": "A String", # Partition capacity. "fileSystem": "A String", # Partition file system. "freeBytes": "A String", # Partition free space. - "mountPoint": "A String", # Mount pount (Linux/Windows) or drive letter (Windows). + "mountPoint": "A String", # Mount point (Linux/Windows) or drive letter (Windows). "subPartitions": # Object with schema name: DiskPartitionList # Sub-partitions. "type": "A String", # Partition type (e.g. BIOS boot). "uuid": "A String", # Partition UUID. @@ -5927,7 +5927,7 @@

Method Details

"capacityBytes": "A String", # Partition capacity. "fileSystem": "A String", # Partition file system. "freeBytes": "A String", # Partition free space. - "mountPoint": "A String", # Mount pount (Linux/Windows) or drive letter (Windows). + "mountPoint": "A String", # Mount point (Linux/Windows) or drive letter (Windows). "subPartitions": # Object with schema name: DiskPartitionList # Sub-partitions. "type": "A String", # Partition type (e.g. BIOS boot). "uuid": "A String", # Partition UUID. @@ -6133,7 +6133,7 @@

Method Details

"capacityBytes": "A String", # Partition capacity. "fileSystem": "A String", # Partition file system. "freeBytes": "A String", # Partition free space. - "mountPoint": "A String", # Mount pount (Linux/Windows) or drive letter (Windows). + "mountPoint": "A String", # Mount point (Linux/Windows) or drive letter (Windows). "subPartitions": # Object with schema name: DiskPartitionList # Sub-partitions. "type": "A String", # Partition type (e.g. BIOS boot). "uuid": "A String", # Partition UUID. diff --git a/docs/dyn/migrationcenter_v1alpha1.projects.locations.sources.errorFrames.html b/docs/dyn/migrationcenter_v1alpha1.projects.locations.sources.errorFrames.html index 19f20e007e0..cc72394fbdd 100644 --- a/docs/dyn/migrationcenter_v1alpha1.projects.locations.sources.errorFrames.html +++ b/docs/dyn/migrationcenter_v1alpha1.projects.locations.sources.errorFrames.html @@ -290,7 +290,7 @@

Method Details

"capacityBytes": "A String", # Partition capacity. "fileSystem": "A String", # Partition file system. "freeBytes": "A String", # Partition free space. - "mountPoint": "A String", # Mount pount (Linux/Windows) or drive letter (Windows). + "mountPoint": "A String", # Mount point (Linux/Windows) or drive letter (Windows). "subPartitions": # Object with schema name: DiskPartitionList # Sub-partitions. "type": "A String", # Partition type (e.g. BIOS boot). "uuid": "A String", # Partition UUID. @@ -313,7 +313,7 @@

Method Details

"capacityBytes": "A String", # Partition capacity. "fileSystem": "A String", # Partition file system. "freeBytes": "A String", # Partition free space. - "mountPoint": "A String", # Mount pount (Linux/Windows) or drive letter (Windows). + "mountPoint": "A String", # Mount point (Linux/Windows) or drive letter (Windows). "subPartitions": # Object with schema name: DiskPartitionList # Sub-partitions. "type": "A String", # Partition type (e.g. BIOS boot). "uuid": "A String", # Partition UUID. @@ -557,7 +557,7 @@

Method Details

"capacityBytes": "A String", # Partition capacity. "fileSystem": "A String", # Partition file system. "freeBytes": "A String", # Partition free space. - "mountPoint": "A String", # Mount pount (Linux/Windows) or drive letter (Windows). + "mountPoint": "A String", # Mount point (Linux/Windows) or drive letter (Windows). "subPartitions": # Object with schema name: DiskPartitionList # Sub-partitions. "type": "A String", # Partition type (e.g. BIOS boot). "uuid": "A String", # Partition UUID. @@ -763,7 +763,7 @@

Method Details

"capacityBytes": "A String", # Partition capacity. "fileSystem": "A String", # Partition file system. "freeBytes": "A String", # Partition free space. - "mountPoint": "A String", # Mount pount (Linux/Windows) or drive letter (Windows). + "mountPoint": "A String", # Mount point (Linux/Windows) or drive letter (Windows). "subPartitions": # Object with schema name: DiskPartitionList # Sub-partitions. "type": "A String", # Partition type (e.g. BIOS boot). "uuid": "A String", # Partition UUID. @@ -1026,7 +1026,7 @@

Method Details

"capacityBytes": "A String", # Partition capacity. "fileSystem": "A String", # Partition file system. "freeBytes": "A String", # Partition free space. - "mountPoint": "A String", # Mount pount (Linux/Windows) or drive letter (Windows). + "mountPoint": "A String", # Mount point (Linux/Windows) or drive letter (Windows). "subPartitions": # Object with schema name: DiskPartitionList # Sub-partitions. "type": "A String", # Partition type (e.g. BIOS boot). "uuid": "A String", # Partition UUID. @@ -1049,7 +1049,7 @@

Method Details

"capacityBytes": "A String", # Partition capacity. "fileSystem": "A String", # Partition file system. "freeBytes": "A String", # Partition free space. - "mountPoint": "A String", # Mount pount (Linux/Windows) or drive letter (Windows). + "mountPoint": "A String", # Mount point (Linux/Windows) or drive letter (Windows). "subPartitions": # Object with schema name: DiskPartitionList # Sub-partitions. "type": "A String", # Partition type (e.g. BIOS boot). "uuid": "A String", # Partition UUID. @@ -1293,7 +1293,7 @@

Method Details

"capacityBytes": "A String", # Partition capacity. "fileSystem": "A String", # Partition file system. "freeBytes": "A String", # Partition free space. - "mountPoint": "A String", # Mount pount (Linux/Windows) or drive letter (Windows). + "mountPoint": "A String", # Mount point (Linux/Windows) or drive letter (Windows). "subPartitions": # Object with schema name: DiskPartitionList # Sub-partitions. "type": "A String", # Partition type (e.g. BIOS boot). "uuid": "A String", # Partition UUID. @@ -1499,7 +1499,7 @@

Method Details

"capacityBytes": "A String", # Partition capacity. "fileSystem": "A String", # Partition file system. "freeBytes": "A String", # Partition free space. - "mountPoint": "A String", # Mount pount (Linux/Windows) or drive letter (Windows). + "mountPoint": "A String", # Mount point (Linux/Windows) or drive letter (Windows). "subPartitions": # Object with schema name: DiskPartitionList # Sub-partitions. "type": "A String", # Partition type (e.g. BIOS boot). "uuid": "A String", # Partition UUID. diff --git a/docs/dyn/networkservices_v1.projects.locations.grpcRoutes.html b/docs/dyn/networkservices_v1.projects.locations.grpcRoutes.html index e7032ca81d8..49a1c289088 100644 --- a/docs/dyn/networkservices_v1.projects.locations.grpcRoutes.html +++ b/docs/dyn/networkservices_v1.projects.locations.grpcRoutes.html @@ -81,7 +81,7 @@

Instance Methods

create(parent, body=None, grpcRouteId=None, x__xgafv=None)

Creates a new GrpcRoute in a given project and location.

- delete(name, etag=None, x__xgafv=None)

+ delete(name, x__xgafv=None)

Deletes a single GrpcRoute.

get(name, x__xgafv=None)

@@ -113,7 +113,6 @@

Method Details

{ # GrpcRoute is the resource defining how gRPC traffic routed by a Mesh or Gateway resource is routed. "createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A free-text description of the resource. Max length 1024 characters. - "etag": "A String", # Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error. "gateways": [ # Optional. Gateways defines a list of gateways this GrpcRoute is attached to, as one of the routing rules to route the requests served by the gateway. Each gateway reference should match the pattern: `projects/*/locations/global/gateways/` "A String", ], @@ -212,12 +211,11 @@

Method Details

- delete(name, etag=None, x__xgafv=None) + delete(name, x__xgafv=None)
Deletes a single GrpcRoute.
 
 Args:
   name: string, Required. A name of the GrpcRoute to delete. Must be in the format `projects/*/locations/global/grpcRoutes/*`. (required)
-  etag: string, Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -264,7 +262,6 @@ 

Method Details

{ # GrpcRoute is the resource defining how gRPC traffic routed by a Mesh or Gateway resource is routed. "createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A free-text description of the resource. Max length 1024 characters. - "etag": "A String", # Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error. "gateways": [ # Optional. Gateways defines a list of gateways this GrpcRoute is attached to, as one of the routing rules to route the requests served by the gateway. Each gateway reference should match the pattern: `projects/*/locations/global/gateways/` "A String", ], @@ -354,7 +351,6 @@

Method Details

{ # GrpcRoute is the resource defining how gRPC traffic routed by a Mesh or Gateway resource is routed. "createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A free-text description of the resource. Max length 1024 characters. - "etag": "A String", # Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error. "gateways": [ # Optional. Gateways defines a list of gateways this GrpcRoute is attached to, as one of the routing rules to route the requests served by the gateway. Each gateway reference should match the pattern: `projects/*/locations/global/gateways/` "A String", ], @@ -452,7 +448,6 @@

Method Details

{ # GrpcRoute is the resource defining how gRPC traffic routed by a Mesh or Gateway resource is routed. "createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A free-text description of the resource. Max length 1024 characters. - "etag": "A String", # Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error. "gateways": [ # Optional. Gateways defines a list of gateways this GrpcRoute is attached to, as one of the routing rules to route the requests served by the gateway. Each gateway reference should match the pattern: `projects/*/locations/global/gateways/` "A String", ], diff --git a/docs/dyn/networkservices_v1.projects.locations.httpRoutes.html b/docs/dyn/networkservices_v1.projects.locations.httpRoutes.html index a7c888fc911..626a1aae09f 100644 --- a/docs/dyn/networkservices_v1.projects.locations.httpRoutes.html +++ b/docs/dyn/networkservices_v1.projects.locations.httpRoutes.html @@ -81,7 +81,7 @@

Instance Methods

create(parent, body=None, httpRouteId=None, x__xgafv=None)

Creates a new HttpRoute in a given project and location.

- delete(name, etag=None, x__xgafv=None)

+ delete(name, x__xgafv=None)

Deletes a single HttpRoute.

get(name, x__xgafv=None)

@@ -113,7 +113,6 @@

Method Details

{ # HttpRoute is the resource defining how HTTP traffic should be routed by a Mesh or Gateway resource. "createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A free-text description of the resource. Max length 1024 characters. - "etag": "A String", # Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error. "gateways": [ # Optional. Gateways defines a list of gateways this HttpRoute is attached to, as one of the routing rules to route the requests served by the gateway. Each gateway reference should match the pattern: `projects/*/locations/global/gateways/` "A String", ], @@ -338,12 +337,11 @@

Method Details

- delete(name, etag=None, x__xgafv=None) + delete(name, x__xgafv=None)
Deletes a single HttpRoute.
 
 Args:
   name: string, Required. A name of the HttpRoute to delete. Must be in the format `projects/*/locations/global/httpRoutes/*`. (required)
-  etag: string, Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -390,7 +388,6 @@ 

Method Details

{ # HttpRoute is the resource defining how HTTP traffic should be routed by a Mesh or Gateway resource. "createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A free-text description of the resource. Max length 1024 characters. - "etag": "A String", # Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error. "gateways": [ # Optional. Gateways defines a list of gateways this HttpRoute is attached to, as one of the routing rules to route the requests served by the gateway. Each gateway reference should match the pattern: `projects/*/locations/global/gateways/` "A String", ], @@ -606,7 +603,6 @@

Method Details

{ # HttpRoute is the resource defining how HTTP traffic should be routed by a Mesh or Gateway resource. "createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A free-text description of the resource. Max length 1024 characters. - "etag": "A String", # Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error. "gateways": [ # Optional. Gateways defines a list of gateways this HttpRoute is attached to, as one of the routing rules to route the requests served by the gateway. Each gateway reference should match the pattern: `projects/*/locations/global/gateways/` "A String", ], @@ -830,7 +826,6 @@

Method Details

{ # HttpRoute is the resource defining how HTTP traffic should be routed by a Mesh or Gateway resource. "createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A free-text description of the resource. Max length 1024 characters. - "etag": "A String", # Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error. "gateways": [ # Optional. Gateways defines a list of gateways this HttpRoute is attached to, as one of the routing rules to route the requests served by the gateway. Each gateway reference should match the pattern: `projects/*/locations/global/gateways/` "A String", ], diff --git a/docs/dyn/networkservices_v1.projects.locations.tcpRoutes.html b/docs/dyn/networkservices_v1.projects.locations.tcpRoutes.html index e8dced35ad1..6f42fd0fe50 100644 --- a/docs/dyn/networkservices_v1.projects.locations.tcpRoutes.html +++ b/docs/dyn/networkservices_v1.projects.locations.tcpRoutes.html @@ -81,7 +81,7 @@

Instance Methods

create(parent, body=None, tcpRouteId=None, x__xgafv=None)

Creates a new TcpRoute in a given project and location.

- delete(name, etag=None, x__xgafv=None)

+ delete(name, x__xgafv=None)

Deletes a single TcpRoute.

get(name, x__xgafv=None)

@@ -113,7 +113,6 @@

Method Details

{ # TcpRoute is the resource defining how TCP traffic should be routed by a Mesh/Gateway resource. "createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A free-text description of the resource. Max length 1024 characters. - "etag": "A String", # Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error. "gateways": [ # Optional. Gateways defines a list of gateways this TcpRoute is attached to, as one of the routing rules to route the requests served by the gateway. Each gateway reference should match the pattern: `projects/*/locations/global/gateways/` "A String", ], @@ -179,12 +178,11 @@

Method Details

- delete(name, etag=None, x__xgafv=None) + delete(name, x__xgafv=None)
Deletes a single TcpRoute.
 
 Args:
   name: string, Required. A name of the TcpRoute to delete. Must be in the format `projects/*/locations/global/tcpRoutes/*`. (required)
-  etag: string, Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -231,7 +229,6 @@ 

Method Details

{ # TcpRoute is the resource defining how TCP traffic should be routed by a Mesh/Gateway resource. "createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A free-text description of the resource. Max length 1024 characters. - "etag": "A String", # Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error. "gateways": [ # Optional. Gateways defines a list of gateways this TcpRoute is attached to, as one of the routing rules to route the requests served by the gateway. Each gateway reference should match the pattern: `projects/*/locations/global/gateways/` "A String", ], @@ -289,7 +286,6 @@

Method Details

{ # TcpRoute is the resource defining how TCP traffic should be routed by a Mesh/Gateway resource. "createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A free-text description of the resource. Max length 1024 characters. - "etag": "A String", # Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error. "gateways": [ # Optional. Gateways defines a list of gateways this TcpRoute is attached to, as one of the routing rules to route the requests served by the gateway. Each gateway reference should match the pattern: `projects/*/locations/global/gateways/` "A String", ], @@ -353,7 +349,6 @@

Method Details

{ # TcpRoute is the resource defining how TCP traffic should be routed by a Mesh/Gateway resource. "createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A free-text description of the resource. Max length 1024 characters. - "etag": "A String", # Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error. "gateways": [ # Optional. Gateways defines a list of gateways this TcpRoute is attached to, as one of the routing rules to route the requests served by the gateway. Each gateway reference should match the pattern: `projects/*/locations/global/gateways/` "A String", ], diff --git a/docs/dyn/networkservices_v1.projects.locations.tlsRoutes.html b/docs/dyn/networkservices_v1.projects.locations.tlsRoutes.html index 5cb57eae994..fbd2f404243 100644 --- a/docs/dyn/networkservices_v1.projects.locations.tlsRoutes.html +++ b/docs/dyn/networkservices_v1.projects.locations.tlsRoutes.html @@ -81,7 +81,7 @@

Instance Methods

create(parent, body=None, tlsRouteId=None, x__xgafv=None)

Creates a new TlsRoute in a given project and location.

- delete(name, etag=None, x__xgafv=None)

+ delete(name, x__xgafv=None)

Deletes a single TlsRoute.

get(name, x__xgafv=None)

@@ -113,7 +113,6 @@

Method Details

{ # TlsRoute defines how traffic should be routed based on SNI and other matching L3 attributes. "createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A free-text description of the resource. Max length 1024 characters. - "etag": "A String", # Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error. "gateways": [ # Optional. Gateways defines a list of gateways this TlsRoute is attached to, as one of the routing rules to route the requests served by the gateway. Each gateway reference should match the pattern: `projects/*/locations/global/gateways/` "A String", ], @@ -182,12 +181,11 @@

Method Details

- delete(name, etag=None, x__xgafv=None) + delete(name, x__xgafv=None)
Deletes a single TlsRoute.
 
 Args:
   name: string, Required. A name of the TlsRoute to delete. Must be in the format `projects/*/locations/global/tlsRoutes/*`. (required)
-  etag: string, Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -234,7 +232,6 @@ 

Method Details

{ # TlsRoute defines how traffic should be routed based on SNI and other matching L3 attributes. "createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A free-text description of the resource. Max length 1024 characters. - "etag": "A String", # Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error. "gateways": [ # Optional. Gateways defines a list of gateways this TlsRoute is attached to, as one of the routing rules to route the requests served by the gateway. Each gateway reference should match the pattern: `projects/*/locations/global/gateways/` "A String", ], @@ -295,7 +292,6 @@

Method Details

{ # TlsRoute defines how traffic should be routed based on SNI and other matching L3 attributes. "createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A free-text description of the resource. Max length 1024 characters. - "etag": "A String", # Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error. "gateways": [ # Optional. Gateways defines a list of gateways this TlsRoute is attached to, as one of the routing rules to route the requests served by the gateway. Each gateway reference should match the pattern: `projects/*/locations/global/gateways/` "A String", ], @@ -362,7 +358,6 @@

Method Details

{ # TlsRoute defines how traffic should be routed based on SNI and other matching L3 attributes. "createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A free-text description of the resource. Max length 1024 characters. - "etag": "A String", # Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error. "gateways": [ # Optional. Gateways defines a list of gateways this TlsRoute is attached to, as one of the routing rules to route the requests served by the gateway. Each gateway reference should match the pattern: `projects/*/locations/global/gateways/` "A String", ], diff --git a/docs/dyn/rapidmigrationassessment_v1.projects.locations.collectors.html b/docs/dyn/rapidmigrationassessment_v1.projects.locations.collectors.html index 274d5312404..7375932427a 100644 --- a/docs/dyn/rapidmigrationassessment_v1.projects.locations.collectors.html +++ b/docs/dyn/rapidmigrationassessment_v1.projects.locations.collectors.html @@ -82,7 +82,7 @@

Instance Methods

Create a Collector to manage the on-prem appliance which collects information about Customer assets.

delete(name, requestId=None, x__xgafv=None)

-

Deletes a single Collector - changes state of collector to "Deleting". Background jobs does final deletion thorugh producer api.

+

Deletes a single Collector - changes state of collector to "Deleting". Background jobs does final deletion through producer API.

get(name, x__xgafv=None)

Gets details of a single Collector.

@@ -176,7 +176,7 @@

Method Details

delete(name, requestId=None, x__xgafv=None) -
Deletes a single Collector - changes state of collector to "Deleting". Background jobs does final deletion thorugh producer api.
+  
Deletes a single Collector - changes state of collector to "Deleting". Background jobs does final deletion through producer API.
 
 Args:
   name: string, Required. Name of the resource. (required)
diff --git a/docs/dyn/realtimebidding_v1.bidders.creatives.html b/docs/dyn/realtimebidding_v1.bidders.creatives.html
index 63742a28309..a0bce21ef79 100644
--- a/docs/dyn/realtimebidding_v1.bidders.creatives.html
+++ b/docs/dyn/realtimebidding_v1.bidders.creatives.html
@@ -269,7 +269,7 @@ 

Method Details

"detectedAttributes": [ # Publisher-excludable attributes that were detected for this creative. Can be used to filter the response of the creatives.list method. If the `excluded_attribute` field of a [bid request](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) contains one of the attributes that were declared or detected for a given creative, and a bid is submitted with that creative, the bid will be filtered before the auction. "A String", ], - "detectedCategories": [ # Output only. IDs of the detected categories, if any. The taxonomy in which the categories are expressed is specified by the detected_categories_taxonomy field. Can be used to filter the response of the creatives.list method. + "detectedCategories": [ # Output only. IDs of the detected categories. The taxonomy in which the categories are expressed is specified by the detected_categories_taxonomy field. Use this in conjunction with BidRequest.bcat to avoid bidding on impressions where a given ad category is blocked, or to troubleshoot filtered bids. Can be used to filter the response of the creatives.list method. "A String", ], "detectedCategoriesTaxonomy": "A String", # Output only. The taxonomy in which the detected_categories field is expressed. diff --git a/docs/dyn/realtimebidding_v1.buyers.creatives.html b/docs/dyn/realtimebidding_v1.buyers.creatives.html index 6e61dcd1750..14c12673962 100644 --- a/docs/dyn/realtimebidding_v1.buyers.creatives.html +++ b/docs/dyn/realtimebidding_v1.buyers.creatives.html @@ -260,7 +260,7 @@

Method Details

"detectedAttributes": [ # Publisher-excludable attributes that were detected for this creative. Can be used to filter the response of the creatives.list method. If the `excluded_attribute` field of a [bid request](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) contains one of the attributes that were declared or detected for a given creative, and a bid is submitted with that creative, the bid will be filtered before the auction. "A String", ], - "detectedCategories": [ # Output only. IDs of the detected categories, if any. The taxonomy in which the categories are expressed is specified by the detected_categories_taxonomy field. Can be used to filter the response of the creatives.list method. + "detectedCategories": [ # Output only. IDs of the detected categories. The taxonomy in which the categories are expressed is specified by the detected_categories_taxonomy field. Use this in conjunction with BidRequest.bcat to avoid bidding on impressions where a given ad category is blocked, or to troubleshoot filtered bids. Can be used to filter the response of the creatives.list method. "A String", ], "detectedCategoriesTaxonomy": "A String", # Output only. The taxonomy in which the detected_categories field is expressed. @@ -703,7 +703,7 @@

Method Details

"detectedAttributes": [ # Publisher-excludable attributes that were detected for this creative. Can be used to filter the response of the creatives.list method. If the `excluded_attribute` field of a [bid request](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) contains one of the attributes that were declared or detected for a given creative, and a bid is submitted with that creative, the bid will be filtered before the auction. "A String", ], - "detectedCategories": [ # Output only. IDs of the detected categories, if any. The taxonomy in which the categories are expressed is specified by the detected_categories_taxonomy field. Can be used to filter the response of the creatives.list method. + "detectedCategories": [ # Output only. IDs of the detected categories. The taxonomy in which the categories are expressed is specified by the detected_categories_taxonomy field. Use this in conjunction with BidRequest.bcat to avoid bidding on impressions where a given ad category is blocked, or to troubleshoot filtered bids. Can be used to filter the response of the creatives.list method. "A String", ], "detectedCategoriesTaxonomy": "A String", # Output only. The taxonomy in which the detected_categories field is expressed. @@ -1158,7 +1158,7 @@

Method Details

"detectedAttributes": [ # Publisher-excludable attributes that were detected for this creative. Can be used to filter the response of the creatives.list method. If the `excluded_attribute` field of a [bid request](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) contains one of the attributes that were declared or detected for a given creative, and a bid is submitted with that creative, the bid will be filtered before the auction. "A String", ], - "detectedCategories": [ # Output only. IDs of the detected categories, if any. The taxonomy in which the categories are expressed is specified by the detected_categories_taxonomy field. Can be used to filter the response of the creatives.list method. + "detectedCategories": [ # Output only. IDs of the detected categories. The taxonomy in which the categories are expressed is specified by the detected_categories_taxonomy field. Use this in conjunction with BidRequest.bcat to avoid bidding on impressions where a given ad category is blocked, or to troubleshoot filtered bids. Can be used to filter the response of the creatives.list method. "A String", ], "detectedCategoriesTaxonomy": "A String", # Output only. The taxonomy in which the detected_categories field is expressed. @@ -1618,7 +1618,7 @@

Method Details

"detectedAttributes": [ # Publisher-excludable attributes that were detected for this creative. Can be used to filter the response of the creatives.list method. If the `excluded_attribute` field of a [bid request](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) contains one of the attributes that were declared or detected for a given creative, and a bid is submitted with that creative, the bid will be filtered before the auction. "A String", ], - "detectedCategories": [ # Output only. IDs of the detected categories, if any. The taxonomy in which the categories are expressed is specified by the detected_categories_taxonomy field. Can be used to filter the response of the creatives.list method. + "detectedCategories": [ # Output only. IDs of the detected categories. The taxonomy in which the categories are expressed is specified by the detected_categories_taxonomy field. Use this in conjunction with BidRequest.bcat to avoid bidding on impressions where a given ad category is blocked, or to troubleshoot filtered bids. Can be used to filter the response of the creatives.list method. "A String", ], "detectedCategoriesTaxonomy": "A String", # Output only. The taxonomy in which the detected_categories field is expressed. @@ -2080,7 +2080,7 @@

Method Details

"detectedAttributes": [ # Publisher-excludable attributes that were detected for this creative. Can be used to filter the response of the creatives.list method. If the `excluded_attribute` field of a [bid request](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) contains one of the attributes that were declared or detected for a given creative, and a bid is submitted with that creative, the bid will be filtered before the auction. "A String", ], - "detectedCategories": [ # Output only. IDs of the detected categories, if any. The taxonomy in which the categories are expressed is specified by the detected_categories_taxonomy field. Can be used to filter the response of the creatives.list method. + "detectedCategories": [ # Output only. IDs of the detected categories. The taxonomy in which the categories are expressed is specified by the detected_categories_taxonomy field. Use this in conjunction with BidRequest.bcat to avoid bidding on impressions where a given ad category is blocked, or to troubleshoot filtered bids. Can be used to filter the response of the creatives.list method. "A String", ], "detectedCategoriesTaxonomy": "A String", # Output only. The taxonomy in which the detected_categories field is expressed. @@ -2524,7 +2524,7 @@

Method Details

"detectedAttributes": [ # Publisher-excludable attributes that were detected for this creative. Can be used to filter the response of the creatives.list method. If the `excluded_attribute` field of a [bid request](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) contains one of the attributes that were declared or detected for a given creative, and a bid is submitted with that creative, the bid will be filtered before the auction. "A String", ], - "detectedCategories": [ # Output only. IDs of the detected categories, if any. The taxonomy in which the categories are expressed is specified by the detected_categories_taxonomy field. Can be used to filter the response of the creatives.list method. + "detectedCategories": [ # Output only. IDs of the detected categories. The taxonomy in which the categories are expressed is specified by the detected_categories_taxonomy field. Use this in conjunction with BidRequest.bcat to avoid bidding on impressions where a given ad category is blocked, or to troubleshoot filtered bids. Can be used to filter the response of the creatives.list method. "A String", ], "detectedCategoriesTaxonomy": "A String", # Output only. The taxonomy in which the detected_categories field is expressed. diff --git a/docs/dyn/sheets_v4.spreadsheets.html b/docs/dyn/sheets_v4.spreadsheets.html index 7eb2a1a8bb3..aa31ee7bf1b 100644 --- a/docs/dyn/sheets_v4.spreadsheets.html +++ b/docs/dyn/sheets_v4.spreadsheets.html @@ -3544,7 +3544,7 @@

Method Details

}, }, "insertRange": { # Inserts cells into a range, shifting the existing cells over or down. # Inserts new cells in a sheet, shifting the existing cells. - "range": { # A range on a sheet. All indexes are zero-based. Indexes are half open, i.e. the start index is inclusive and the end index is exclusive -- [start_index, end_index). Missing indexes indicate the range is unbounded on that side. For example, if `"Sheet1"` is sheet ID 123456, then: `Sheet1!A1:A1 == sheet_id: 123456, start_row_index: 0, end_row_index: 1, start_column_index: 0, end_column_index: 1` `Sheet1!A3:B4 == sheet_id: 123456, start_row_index: 2, end_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1!A:B == sheet_id: 123456, start_column_index: 0, end_column_index: 2` `Sheet1!A5:B == sheet_id: 123456, start_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1 == sheet_id: 123456` The start index must always be less than or equal to the end index. If the start index equals the end index, then the range is empty. Empty ranges are typically not meaningful and are usually rendered in the UI as `#REF!`. # The range to insert new cells into. + "range": { # A range on a sheet. All indexes are zero-based. Indexes are half open, i.e. the start index is inclusive and the end index is exclusive -- [start_index, end_index). Missing indexes indicate the range is unbounded on that side. For example, if `"Sheet1"` is sheet ID 123456, then: `Sheet1!A1:A1 == sheet_id: 123456, start_row_index: 0, end_row_index: 1, start_column_index: 0, end_column_index: 1` `Sheet1!A3:B4 == sheet_id: 123456, start_row_index: 2, end_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1!A:B == sheet_id: 123456, start_column_index: 0, end_column_index: 2` `Sheet1!A5:B == sheet_id: 123456, start_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1 == sheet_id: 123456` The start index must always be less than or equal to the end index. If the start index equals the end index, then the range is empty. Empty ranges are typically not meaningful and are usually rendered in the UI as `#REF!`. # The range to insert new cells into. The range is constrained to the current sheet boundaries. "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded. "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded. "sheetId": 42, # The sheet this range is on. diff --git a/docs/dyn/spanner_v1.projects.instances.databases.html b/docs/dyn/spanner_v1.projects.instances.databases.html index 455b11a2a99..edaa2a78239 100644 --- a/docs/dyn/spanner_v1.projects.instances.databases.html +++ b/docs/dyn/spanner_v1.projects.instances.databases.html @@ -153,7 +153,7 @@

Method Details

The object takes the form of: { # The request for AddSplitPoints. - "initiator": "A String", # Optional. A user-supplied tag associated with the split points. For example, "intital_data_load", "special_event_1". Defaults to "CloudAddSplitPointsAPI" if not specified. The length of the tag must not exceed 50 characters,else will be trimmed. Only valid UTF8 characters are allowed. + "initiator": "A String", # Optional. A user-supplied tag associated with the split points. For example, "initial_data_load", "special_event_1". Defaults to "CloudAddSplitPointsAPI" if not specified. The length of the tag must not exceed 50 characters,else will be trimmed. Only valid UTF8 characters are allowed. "splitPoints": [ # Required. The split points to add. { # The split points of a table/index. "expireTime": "A String", # Optional. The expiration timestamp of the split points. A timestamp in the past means immediate expiration. The maximum value can be 30 days in the future. Defaults to 10 days in the future if not specified. diff --git a/docs/dyn/spanner_v1.projects.instances.databases.sessions.html b/docs/dyn/spanner_v1.projects.instances.databases.sessions.html index 8ddb03d4131..9cfdf8f2d54 100644 --- a/docs/dyn/spanner_v1.projects.instances.databases.sessions.html +++ b/docs/dyn/spanner_v1.projects.instances.databases.sessions.html @@ -147,7 +147,7 @@

Method Details

"labels": { # The labels for the session. * Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. * Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. * No more than 64 labels can be associated with a given session. See https://goo.gl/xmQnxf for more information on and examples of labels. "a_key": "A String", }, - "multiplexed": True or False, # Optional. If true, specifies a multiplexed session. Use a multiplexed session for multiple, concurrent read-only operations. Don't use them for read-write transactions, partitioned reads, or partitioned queries. Use CreateSession to create multiplexed sessions. Don't use BatchCreateSessions to create a multiplexed session. You can't delete or list multiplexed sessions. + "multiplexed": True or False, # Optional. If true, specifies a multiplexed session. Use a multiplexed session for multiple, concurrent read-only operations. Don't use them for read-write transactions, partitioned reads, or partitioned queries. Use `sessions.create` to create multiplexed sessions. Don't use BatchCreateSessions to create a multiplexed session. You can't delete or list multiplexed sessions. "name": "A String", # Output only. The name of the session. This is always system-assigned. }, } @@ -169,7 +169,7 @@

Method Details

"labels": { # The labels for the session. * Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. * Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. * No more than 64 labels can be associated with a given session. See https://goo.gl/xmQnxf for more information on and examples of labels. "a_key": "A String", }, - "multiplexed": True or False, # Optional. If true, specifies a multiplexed session. Use a multiplexed session for multiple, concurrent read-only operations. Don't use them for read-write transactions, partitioned reads, or partitioned queries. Use CreateSession to create multiplexed sessions. Don't use BatchCreateSessions to create a multiplexed session. You can't delete or list multiplexed sessions. + "multiplexed": True or False, # Optional. If true, specifies a multiplexed session. Use a multiplexed session for multiple, concurrent read-only operations. Don't use them for read-write transactions, partitioned reads, or partitioned queries. Use `sessions.create` to create multiplexed sessions. Don't use BatchCreateSessions to create a multiplexed session. You can't delete or list multiplexed sessions. "name": "A String", # Output only. The name of the session. This is always system-assigned. }, ], @@ -581,7 +581,7 @@

Method Details

"labels": { # The labels for the session. * Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. * Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. * No more than 64 labels can be associated with a given session. See https://goo.gl/xmQnxf for more information on and examples of labels. "a_key": "A String", }, - "multiplexed": True or False, # Optional. If true, specifies a multiplexed session. Use a multiplexed session for multiple, concurrent read-only operations. Don't use them for read-write transactions, partitioned reads, or partitioned queries. Use CreateSession to create multiplexed sessions. Don't use BatchCreateSessions to create a multiplexed session. You can't delete or list multiplexed sessions. + "multiplexed": True or False, # Optional. If true, specifies a multiplexed session. Use a multiplexed session for multiple, concurrent read-only operations. Don't use them for read-write transactions, partitioned reads, or partitioned queries. Use `sessions.create` to create multiplexed sessions. Don't use BatchCreateSessions to create a multiplexed session. You can't delete or list multiplexed sessions. "name": "A String", # Output only. The name of the session. This is always system-assigned. }, } @@ -601,7 +601,7 @@

Method Details

"labels": { # The labels for the session. * Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. * Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. * No more than 64 labels can be associated with a given session. See https://goo.gl/xmQnxf for more information on and examples of labels. "a_key": "A String", }, - "multiplexed": True or False, # Optional. If true, specifies a multiplexed session. Use a multiplexed session for multiple, concurrent read-only operations. Don't use them for read-write transactions, partitioned reads, or partitioned queries. Use CreateSession to create multiplexed sessions. Don't use BatchCreateSessions to create a multiplexed session. You can't delete or list multiplexed sessions. + "multiplexed": True or False, # Optional. If true, specifies a multiplexed session. Use a multiplexed session for multiple, concurrent read-only operations. Don't use them for read-write transactions, partitioned reads, or partitioned queries. Use `sessions.create` to create multiplexed sessions. Don't use BatchCreateSessions to create a multiplexed session. You can't delete or list multiplexed sessions. "name": "A String", # Output only. The name of the session. This is always system-assigned. }
@@ -1224,7 +1224,7 @@

Method Details

"labels": { # The labels for the session. * Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. * Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. * No more than 64 labels can be associated with a given session. See https://goo.gl/xmQnxf for more information on and examples of labels. "a_key": "A String", }, - "multiplexed": True or False, # Optional. If true, specifies a multiplexed session. Use a multiplexed session for multiple, concurrent read-only operations. Don't use them for read-write transactions, partitioned reads, or partitioned queries. Use CreateSession to create multiplexed sessions. Don't use BatchCreateSessions to create a multiplexed session. You can't delete or list multiplexed sessions. + "multiplexed": True or False, # Optional. If true, specifies a multiplexed session. Use a multiplexed session for multiple, concurrent read-only operations. Don't use them for read-write transactions, partitioned reads, or partitioned queries. Use `sessions.create` to create multiplexed sessions. Don't use BatchCreateSessions to create a multiplexed session. You can't delete or list multiplexed sessions. "name": "A String", # Output only. The name of the session. This is always system-assigned. }
@@ -1256,7 +1256,7 @@

Method Details

"labels": { # The labels for the session. * Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. * Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. * No more than 64 labels can be associated with a given session. See https://goo.gl/xmQnxf for more information on and examples of labels. "a_key": "A String", }, - "multiplexed": True or False, # Optional. If true, specifies a multiplexed session. Use a multiplexed session for multiple, concurrent read-only operations. Don't use them for read-write transactions, partitioned reads, or partitioned queries. Use CreateSession to create multiplexed sessions. Don't use BatchCreateSessions to create a multiplexed session. You can't delete or list multiplexed sessions. + "multiplexed": True or False, # Optional. If true, specifies a multiplexed session. Use a multiplexed session for multiple, concurrent read-only operations. Don't use them for read-write transactions, partitioned reads, or partitioned queries. Use `sessions.create` to create multiplexed sessions. Don't use BatchCreateSessions to create a multiplexed session. You can't delete or list multiplexed sessions. "name": "A String", # Output only. The name of the session. This is always system-assigned. }, ], diff --git a/docs/dyn/spanner_v1.projects.instances.html b/docs/dyn/spanner_v1.projects.instances.html index fc28cbc22eb..e640acd5328 100644 --- a/docs/dyn/spanner_v1.projects.instances.html +++ b/docs/dyn/spanner_v1.projects.instances.html @@ -205,8 +205,8 @@

Method Details

"a_key": "A String", }, "name": "A String", # Required. A unique identifier for the instance, which cannot be changed after the instance is created. Values are of the form `projects//instances/a-z*[a-z0-9]`. The final segment of the name must be between 2 and 64 characters in length. - "nodeCount": 42, # The number of nodes allocated to this instance. At most, one of either `node_count` or `processing_units` should be present in the message. Users can set the `node_count` field to specify the target number of nodes allocated to the instance. If autoscaling is enabled, `node_count` is treated as an `OUTPUT_ONLY` field and reflects the current number of nodes allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. For more information, see [Compute capacity, nodes, and processing units](https://cloud.google.com/spanner/docs/compute-capacity). - "processingUnits": 42, # The number of processing units allocated to this instance. At most, one of either `processing_units` or `node_count` should be present in the message. Users can set the `processing_units` field to specify the target number of processing units allocated to the instance. If autoscaling is enabled, `processing_units` is treated as an `OUTPUT_ONLY` field and reflects the current number of processing units allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. For more information, see [Compute capacity, nodes and processing units](https://cloud.google.com/spanner/docs/compute-capacity). + "nodeCount": 42, # The number of nodes allocated to this instance. At most, one of either `node_count` or `processing_units` should be present in the message. Users can set the `node_count` field to specify the target number of nodes allocated to the instance. If autoscaling is enabled, `node_count` is treated as an `OUTPUT_ONLY` field and reflects the current number of nodes allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. If the instance has varying node count across replicas (achieved by setting `asymmetric_autoscaling_options` in the autoscaling configuration), the `node_count` set here is the maximum node count across all replicas. For more information, see [Compute capacity, nodes, and processing units](https://cloud.google.com/spanner/docs/compute-capacity). + "processingUnits": 42, # The number of processing units allocated to this instance. At most, one of either `processing_units` or `node_count` should be present in the message. Users can set the `processing_units` field to specify the target number of processing units allocated to the instance. If autoscaling is enabled, `processing_units` is treated as an `OUTPUT_ONLY` field and reflects the current number of processing units allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. If the instance has varying processing units per replica (achieved by setting `asymmetric_autoscaling_options` in the autoscaling configuration), the `processing_units` set here is the maximum processing units across all replicas. For more information, see [Compute capacity, nodes and processing units](https://cloud.google.com/spanner/docs/compute-capacity). "replicaComputeCapacity": [ # Output only. Lists the compute capacity per ReplicaSelection. A replica selection identifies a set of replicas with common properties. Replicas identified by a ReplicaSelection are scaled with the same compute capacity. { # ReplicaComputeCapacity describes the amount of server resources that are allocated to each replica identified by the replica selection. "nodeCount": 42, # The number of nodes allocated to each replica. This may be zero in API responses for instances that are not yet in state `READY`. @@ -331,8 +331,8 @@

Method Details

"a_key": "A String", }, "name": "A String", # Required. A unique identifier for the instance, which cannot be changed after the instance is created. Values are of the form `projects//instances/a-z*[a-z0-9]`. The final segment of the name must be between 2 and 64 characters in length. - "nodeCount": 42, # The number of nodes allocated to this instance. At most, one of either `node_count` or `processing_units` should be present in the message. Users can set the `node_count` field to specify the target number of nodes allocated to the instance. If autoscaling is enabled, `node_count` is treated as an `OUTPUT_ONLY` field and reflects the current number of nodes allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. For more information, see [Compute capacity, nodes, and processing units](https://cloud.google.com/spanner/docs/compute-capacity). - "processingUnits": 42, # The number of processing units allocated to this instance. At most, one of either `processing_units` or `node_count` should be present in the message. Users can set the `processing_units` field to specify the target number of processing units allocated to the instance. If autoscaling is enabled, `processing_units` is treated as an `OUTPUT_ONLY` field and reflects the current number of processing units allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. For more information, see [Compute capacity, nodes and processing units](https://cloud.google.com/spanner/docs/compute-capacity). + "nodeCount": 42, # The number of nodes allocated to this instance. At most, one of either `node_count` or `processing_units` should be present in the message. Users can set the `node_count` field to specify the target number of nodes allocated to the instance. If autoscaling is enabled, `node_count` is treated as an `OUTPUT_ONLY` field and reflects the current number of nodes allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. If the instance has varying node count across replicas (achieved by setting `asymmetric_autoscaling_options` in the autoscaling configuration), the `node_count` set here is the maximum node count across all replicas. For more information, see [Compute capacity, nodes, and processing units](https://cloud.google.com/spanner/docs/compute-capacity). + "processingUnits": 42, # The number of processing units allocated to this instance. At most, one of either `processing_units` or `node_count` should be present in the message. Users can set the `processing_units` field to specify the target number of processing units allocated to the instance. If autoscaling is enabled, `processing_units` is treated as an `OUTPUT_ONLY` field and reflects the current number of processing units allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. If the instance has varying processing units per replica (achieved by setting `asymmetric_autoscaling_options` in the autoscaling configuration), the `processing_units` set here is the maximum processing units across all replicas. For more information, see [Compute capacity, nodes and processing units](https://cloud.google.com/spanner/docs/compute-capacity). "replicaComputeCapacity": [ # Output only. Lists the compute capacity per ReplicaSelection. A replica selection identifies a set of replicas with common properties. Replicas identified by a ReplicaSelection are scaled with the same compute capacity. { # ReplicaComputeCapacity describes the amount of server resources that are allocated to each replica identified by the replica selection. "nodeCount": 42, # The number of nodes allocated to each replica. This may be zero in API responses for instances that are not yet in state `READY`. @@ -457,8 +457,8 @@

Method Details

"a_key": "A String", }, "name": "A String", # Required. A unique identifier for the instance, which cannot be changed after the instance is created. Values are of the form `projects//instances/a-z*[a-z0-9]`. The final segment of the name must be between 2 and 64 characters in length. - "nodeCount": 42, # The number of nodes allocated to this instance. At most, one of either `node_count` or `processing_units` should be present in the message. Users can set the `node_count` field to specify the target number of nodes allocated to the instance. If autoscaling is enabled, `node_count` is treated as an `OUTPUT_ONLY` field and reflects the current number of nodes allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. For more information, see [Compute capacity, nodes, and processing units](https://cloud.google.com/spanner/docs/compute-capacity). - "processingUnits": 42, # The number of processing units allocated to this instance. At most, one of either `processing_units` or `node_count` should be present in the message. Users can set the `processing_units` field to specify the target number of processing units allocated to the instance. If autoscaling is enabled, `processing_units` is treated as an `OUTPUT_ONLY` field and reflects the current number of processing units allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. For more information, see [Compute capacity, nodes and processing units](https://cloud.google.com/spanner/docs/compute-capacity). + "nodeCount": 42, # The number of nodes allocated to this instance. At most, one of either `node_count` or `processing_units` should be present in the message. Users can set the `node_count` field to specify the target number of nodes allocated to the instance. If autoscaling is enabled, `node_count` is treated as an `OUTPUT_ONLY` field and reflects the current number of nodes allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. If the instance has varying node count across replicas (achieved by setting `asymmetric_autoscaling_options` in the autoscaling configuration), the `node_count` set here is the maximum node count across all replicas. For more information, see [Compute capacity, nodes, and processing units](https://cloud.google.com/spanner/docs/compute-capacity). + "processingUnits": 42, # The number of processing units allocated to this instance. At most, one of either `processing_units` or `node_count` should be present in the message. Users can set the `processing_units` field to specify the target number of processing units allocated to the instance. If autoscaling is enabled, `processing_units` is treated as an `OUTPUT_ONLY` field and reflects the current number of processing units allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. If the instance has varying processing units per replica (achieved by setting `asymmetric_autoscaling_options` in the autoscaling configuration), the `processing_units` set here is the maximum processing units across all replicas. For more information, see [Compute capacity, nodes and processing units](https://cloud.google.com/spanner/docs/compute-capacity). "replicaComputeCapacity": [ # Output only. Lists the compute capacity per ReplicaSelection. A replica selection identifies a set of replicas with common properties. Replicas identified by a ReplicaSelection are scaled with the same compute capacity. { # ReplicaComputeCapacity describes the amount of server resources that are allocated to each replica identified by the replica selection. "nodeCount": 42, # The number of nodes allocated to each replica. This may be zero in API responses for instances that are not yet in state `READY`. @@ -593,8 +593,8 @@

Method Details

"a_key": "A String", }, "name": "A String", # Required. A unique identifier for the instance, which cannot be changed after the instance is created. Values are of the form `projects//instances/a-z*[a-z0-9]`. The final segment of the name must be between 2 and 64 characters in length. - "nodeCount": 42, # The number of nodes allocated to this instance. At most, one of either `node_count` or `processing_units` should be present in the message. Users can set the `node_count` field to specify the target number of nodes allocated to the instance. If autoscaling is enabled, `node_count` is treated as an `OUTPUT_ONLY` field and reflects the current number of nodes allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. For more information, see [Compute capacity, nodes, and processing units](https://cloud.google.com/spanner/docs/compute-capacity). - "processingUnits": 42, # The number of processing units allocated to this instance. At most, one of either `processing_units` or `node_count` should be present in the message. Users can set the `processing_units` field to specify the target number of processing units allocated to the instance. If autoscaling is enabled, `processing_units` is treated as an `OUTPUT_ONLY` field and reflects the current number of processing units allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. For more information, see [Compute capacity, nodes and processing units](https://cloud.google.com/spanner/docs/compute-capacity). + "nodeCount": 42, # The number of nodes allocated to this instance. At most, one of either `node_count` or `processing_units` should be present in the message. Users can set the `node_count` field to specify the target number of nodes allocated to the instance. If autoscaling is enabled, `node_count` is treated as an `OUTPUT_ONLY` field and reflects the current number of nodes allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. If the instance has varying node count across replicas (achieved by setting `asymmetric_autoscaling_options` in the autoscaling configuration), the `node_count` set here is the maximum node count across all replicas. For more information, see [Compute capacity, nodes, and processing units](https://cloud.google.com/spanner/docs/compute-capacity). + "processingUnits": 42, # The number of processing units allocated to this instance. At most, one of either `processing_units` or `node_count` should be present in the message. Users can set the `processing_units` field to specify the target number of processing units allocated to the instance. If autoscaling is enabled, `processing_units` is treated as an `OUTPUT_ONLY` field and reflects the current number of processing units allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. If the instance has varying processing units per replica (achieved by setting `asymmetric_autoscaling_options` in the autoscaling configuration), the `processing_units` set here is the maximum processing units across all replicas. For more information, see [Compute capacity, nodes and processing units](https://cloud.google.com/spanner/docs/compute-capacity). "replicaComputeCapacity": [ # Output only. Lists the compute capacity per ReplicaSelection. A replica selection identifies a set of replicas with common properties. Replicas identified by a ReplicaSelection are scaled with the same compute capacity. { # ReplicaComputeCapacity describes the amount of server resources that are allocated to each replica identified by the replica selection. "nodeCount": 42, # The number of nodes allocated to each replica. This may be zero in API responses for instances that are not yet in state `READY`. diff --git a/docs/dyn/vmmigration_v1.projects.locations.sources.datacenterConnectors.html b/docs/dyn/vmmigration_v1.projects.locations.sources.datacenterConnectors.html index 5beb152f040..4566bec577f 100644 --- a/docs/dyn/vmmigration_v1.projects.locations.sources.datacenterConnectors.html +++ b/docs/dyn/vmmigration_v1.projects.locations.sources.datacenterConnectors.html @@ -113,7 +113,7 @@

Method Details

{ # DatacenterConnector message describes a connector between the Source and Google Cloud, which is installed on a vmware datacenter (an OVA vm installed by the user) to connect the Datacenter to Google Cloud and support vm migration data transfer. "applianceInfrastructureVersion": "A String", # Output only. Appliance OVA version. This is the OVA which is manually installed by the user and contains the infrastructure for the automatically updatable components on the appliance. "applianceSoftwareVersion": "A String", # Output only. Appliance last installed update bundle version. This is the version of the automatically updatable components on the appliance. - "availableVersions": { # Holds informatiom about the available versions for upgrade. # Output only. The available versions for updating this appliance. + "availableVersions": { # Holds information about the available versions for upgrade. # Output only. The available versions for updating this appliance. "inPlaceUpdate": { # Describes an appliance version. # The latest version for in place update. The current appliance can be updated to this version using the API or m4c CLI. "critical": True or False, # Determine whether it's critical to upgrade the appliance to this version. "releaseNotesUri": "A String", # Link to a page that contains the version release notes. @@ -246,7 +246,7 @@

Method Details

{ # DatacenterConnector message describes a connector between the Source and Google Cloud, which is installed on a vmware datacenter (an OVA vm installed by the user) to connect the Datacenter to Google Cloud and support vm migration data transfer. "applianceInfrastructureVersion": "A String", # Output only. Appliance OVA version. This is the OVA which is manually installed by the user and contains the infrastructure for the automatically updatable components on the appliance. "applianceSoftwareVersion": "A String", # Output only. Appliance last installed update bundle version. This is the version of the automatically updatable components on the appliance. - "availableVersions": { # Holds informatiom about the available versions for upgrade. # Output only. The available versions for updating this appliance. + "availableVersions": { # Holds information about the available versions for upgrade. # Output only. The available versions for updating this appliance. "inPlaceUpdate": { # Describes an appliance version. # The latest version for in place update. The current appliance can be updated to this version using the API or m4c CLI. "critical": True or False, # Determine whether it's critical to upgrade the appliance to this version. "releaseNotesUri": "A String", # Link to a page that contains the version release notes. @@ -319,7 +319,7 @@

Method Details

{ # DatacenterConnector message describes a connector between the Source and Google Cloud, which is installed on a vmware datacenter (an OVA vm installed by the user) to connect the Datacenter to Google Cloud and support vm migration data transfer. "applianceInfrastructureVersion": "A String", # Output only. Appliance OVA version. This is the OVA which is manually installed by the user and contains the infrastructure for the automatically updatable components on the appliance. "applianceSoftwareVersion": "A String", # Output only. Appliance last installed update bundle version. This is the version of the automatically updatable components on the appliance. - "availableVersions": { # Holds informatiom about the available versions for upgrade. # Output only. The available versions for updating this appliance. + "availableVersions": { # Holds information about the available versions for upgrade. # Output only. The available versions for updating this appliance. "inPlaceUpdate": { # Describes an appliance version. # The latest version for in place update. The current appliance can be updated to this version using the API or m4c CLI. "critical": True or False, # Determine whether it's critical to upgrade the appliance to this version. "releaseNotesUri": "A String", # Link to a page that contains the version release notes. diff --git a/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cutoverJobs.html b/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cutoverJobs.html index 3136a1b91cc..8bee0512455 100644 --- a/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cutoverJobs.html +++ b/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cutoverJobs.html @@ -148,7 +148,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and clonning the VM using the replicated snapshot. +{ # CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and cloning the VM using the replicated snapshot. "computeEngineDisksTargetDetails": { # ComputeEngineDisksTargetDetails is a collection of created Persistent Disks details. # Output only. Details of the target Persistent Disks in Compute Engine. "disks": [ # The details of each created Persistent Disk. { # Details of a created Persistent Disk. @@ -403,7 +403,7 @@

Method Details

Returns: An object of the form: - { # CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and clonning the VM using the replicated snapshot. + { # CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and cloning the VM using the replicated snapshot. "computeEngineDisksTargetDetails": { # ComputeEngineDisksTargetDetails is a collection of created Persistent Disks details. # Output only. Details of the target Persistent Disks in Compute Engine. "disks": [ # The details of each created Persistent Disk. { # Details of a created Persistent Disk. @@ -634,7 +634,7 @@

Method Details

{ # Response message for 'ListCutoverJobs' request. "cutoverJobs": [ # Output only. The list of cutover jobs response. - { # CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and clonning the VM using the replicated snapshot. + { # CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and cloning the VM using the replicated snapshot. "computeEngineDisksTargetDetails": { # ComputeEngineDisksTargetDetails is a collection of created Persistent Disks details. # Output only. Details of the target Persistent Disks in Compute Engine. "disks": [ # The details of each created Persistent Disk. { # Details of a created Persistent Disk. diff --git a/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.html b/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.html index 1bd01384d63..ad4275667b0 100644 --- a/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.html +++ b/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.html @@ -550,7 +550,7 @@

Method Details

}, ], "recentCutoverJobs": [ # Output only. The recent cutover jobs performed on the migrating VM. This field holds the vm's last completed cutover job and the vm's running cutover job, if one exists. Note: To have this field populated you need to explicitly request it via the "view" parameter of the Get/List request. - { # CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and clonning the VM using the replicated snapshot. + { # CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and cloning the VM using the replicated snapshot. "computeEngineDisksTargetDetails": { # ComputeEngineDisksTargetDetails is a collection of created Persistent Disks details. # Output only. Details of the target Persistent Disks in Compute Engine. "disks": [ # The details of each created Persistent Disk. { # Details of a created Persistent Disk. @@ -1323,7 +1323,7 @@

Method Details

}, ], "recentCutoverJobs": [ # Output only. The recent cutover jobs performed on the migrating VM. This field holds the vm's last completed cutover job and the vm's running cutover job, if one exists. Note: To have this field populated you need to explicitly request it via the "view" parameter of the Get/List request. - { # CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and clonning the VM using the replicated snapshot. + { # CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and cloning the VM using the replicated snapshot. "computeEngineDisksTargetDetails": { # ComputeEngineDisksTargetDetails is a collection of created Persistent Disks details. # Output only. Details of the target Persistent Disks in Compute Engine. "disks": [ # The details of each created Persistent Disk. { # Details of a created Persistent Disk. @@ -1996,7 +1996,7 @@

Method Details

}, ], "recentCutoverJobs": [ # Output only. The recent cutover jobs performed on the migrating VM. This field holds the vm's last completed cutover job and the vm's running cutover job, if one exists. Note: To have this field populated you need to explicitly request it via the "view" parameter of the Get/List request. - { # CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and clonning the VM using the replicated snapshot. + { # CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and cloning the VM using the replicated snapshot. "computeEngineDisksTargetDetails": { # ComputeEngineDisksTargetDetails is a collection of created Persistent Disks details. # Output only. Details of the target Persistent Disks in Compute Engine. "disks": [ # The details of each created Persistent Disk. { # Details of a created Persistent Disk. @@ -2673,7 +2673,7 @@

Method Details

}, ], "recentCutoverJobs": [ # Output only. The recent cutover jobs performed on the migrating VM. This field holds the vm's last completed cutover job and the vm's running cutover job, if one exists. Note: To have this field populated you need to explicitly request it via the "view" parameter of the Get/List request. - { # CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and clonning the VM using the replicated snapshot. + { # CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and cloning the VM using the replicated snapshot. "computeEngineDisksTargetDetails": { # ComputeEngineDisksTargetDetails is a collection of created Persistent Disks details. # Output only. Details of the target Persistent Disks in Compute Engine. "disks": [ # The details of each created Persistent Disk. { # Details of a created Persistent Disk. diff --git a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.datacenterConnectors.html b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.datacenterConnectors.html index 693bfbe2867..314eec3647c 100644 --- a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.datacenterConnectors.html +++ b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.datacenterConnectors.html @@ -113,7 +113,7 @@

Method Details

{ # DatacenterConnector message describes a connector between the Source and Google Cloud, which is installed on a vmware datacenter (an OVA vm installed by the user) to connect the Datacenter to Google Cloud and support vm migration data transfer. "applianceInfrastructureVersion": "A String", # Output only. Appliance OVA version. This is the OVA which is manually installed by the user and contains the infrastructure for the automatically updatable components on the appliance. "applianceSoftwareVersion": "A String", # Output only. Appliance last installed update bundle version. This is the version of the automatically updatable components on the appliance. - "availableVersions": { # Holds informatiom about the available versions for upgrade. # Output only. The available versions for updating this appliance. + "availableVersions": { # Holds information about the available versions for upgrade. # Output only. The available versions for updating this appliance. "inPlaceUpdate": { # Describes an appliance version. # The latest version for in place update. The current appliance can be updated to this version using the API or m4c CLI. "critical": True or False, # Determine whether it's critical to upgrade the appliance to this version. "releaseNotesUri": "A String", # Link to a page that contains the version release notes. @@ -246,7 +246,7 @@

Method Details

{ # DatacenterConnector message describes a connector between the Source and Google Cloud, which is installed on a vmware datacenter (an OVA vm installed by the user) to connect the Datacenter to Google Cloud and support vm migration data transfer. "applianceInfrastructureVersion": "A String", # Output only. Appliance OVA version. This is the OVA which is manually installed by the user and contains the infrastructure for the automatically updatable components on the appliance. "applianceSoftwareVersion": "A String", # Output only. Appliance last installed update bundle version. This is the version of the automatically updatable components on the appliance. - "availableVersions": { # Holds informatiom about the available versions for upgrade. # Output only. The available versions for updating this appliance. + "availableVersions": { # Holds information about the available versions for upgrade. # Output only. The available versions for updating this appliance. "inPlaceUpdate": { # Describes an appliance version. # The latest version for in place update. The current appliance can be updated to this version using the API or m4c CLI. "critical": True or False, # Determine whether it's critical to upgrade the appliance to this version. "releaseNotesUri": "A String", # Link to a page that contains the version release notes. @@ -319,7 +319,7 @@

Method Details

{ # DatacenterConnector message describes a connector between the Source and Google Cloud, which is installed on a vmware datacenter (an OVA vm installed by the user) to connect the Datacenter to Google Cloud and support vm migration data transfer. "applianceInfrastructureVersion": "A String", # Output only. Appliance OVA version. This is the OVA which is manually installed by the user and contains the infrastructure for the automatically updatable components on the appliance. "applianceSoftwareVersion": "A String", # Output only. Appliance last installed update bundle version. This is the version of the automatically updatable components on the appliance. - "availableVersions": { # Holds informatiom about the available versions for upgrade. # Output only. The available versions for updating this appliance. + "availableVersions": { # Holds information about the available versions for upgrade. # Output only. The available versions for updating this appliance. "inPlaceUpdate": { # Describes an appliance version. # The latest version for in place update. The current appliance can be updated to this version using the API or m4c CLI. "critical": True or False, # Determine whether it's critical to upgrade the appliance to this version. "releaseNotesUri": "A String", # Link to a page that contains the version release notes. diff --git a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.cutoverJobs.html b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.cutoverJobs.html index 3f620c8e81a..69c8d877a45 100644 --- a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.cutoverJobs.html +++ b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.cutoverJobs.html @@ -148,7 +148,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and clonning the VM using the replicated snapshot. +{ # CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and cloning the VM using the replicated snapshot. "computeEngineDisksTargetDetails": { # ComputeEngineDisksTargetDetails is a collection of created Persistent Disks details. # Output only. Details of the target Persistent Disks in Compute Engine. "disks": [ # The details of each created Persistent Disk. { # Details of a created Persistent Disk. @@ -515,7 +515,7 @@

Method Details

Returns: An object of the form: - { # CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and clonning the VM using the replicated snapshot. + { # CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and cloning the VM using the replicated snapshot. "computeEngineDisksTargetDetails": { # ComputeEngineDisksTargetDetails is a collection of created Persistent Disks details. # Output only. Details of the target Persistent Disks in Compute Engine. "disks": [ # The details of each created Persistent Disk. { # Details of a created Persistent Disk. @@ -858,7 +858,7 @@

Method Details

{ # Response message for 'ListCutoverJobs' request. "cutoverJobs": [ # Output only. The list of cutover jobs response. - { # CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and clonning the VM using the replicated snapshot. + { # CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and cloning the VM using the replicated snapshot. "computeEngineDisksTargetDetails": { # ComputeEngineDisksTargetDetails is a collection of created Persistent Disks details. # Output only. Details of the target Persistent Disks in Compute Engine. "disks": [ # The details of each created Persistent Disk. { # Details of a created Persistent Disk. diff --git a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.html b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.html index f784dcdc4af..9ddb1773d53 100644 --- a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.html +++ b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.html @@ -717,7 +717,7 @@

Method Details

}, ], "recentCutoverJobs": [ # Output only. The recent cutover jobs performed on the migrating VM. This field holds the vm's last completed cutover job and the vm's running cutover job, if one exists. Note: To have this field populated you need to explicitly request it via the "view" parameter of the Get/List request. - { # CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and clonning the VM using the replicated snapshot. + { # CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and cloning the VM using the replicated snapshot. "computeEngineDisksTargetDetails": { # ComputeEngineDisksTargetDetails is a collection of created Persistent Disks details. # Output only. Details of the target Persistent Disks in Compute Engine. "disks": [ # The details of each created Persistent Disk. { # Details of a created Persistent Disk. @@ -1823,7 +1823,7 @@

Method Details

}, ], "recentCutoverJobs": [ # Output only. The recent cutover jobs performed on the migrating VM. This field holds the vm's last completed cutover job and the vm's running cutover job, if one exists. Note: To have this field populated you need to explicitly request it via the "view" parameter of the Get/List request. - { # CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and clonning the VM using the replicated snapshot. + { # CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and cloning the VM using the replicated snapshot. "computeEngineDisksTargetDetails": { # ComputeEngineDisksTargetDetails is a collection of created Persistent Disks details. # Output only. Details of the target Persistent Disks in Compute Engine. "disks": [ # The details of each created Persistent Disk. { # Details of a created Persistent Disk. @@ -2829,7 +2829,7 @@

Method Details

}, ], "recentCutoverJobs": [ # Output only. The recent cutover jobs performed on the migrating VM. This field holds the vm's last completed cutover job and the vm's running cutover job, if one exists. Note: To have this field populated you need to explicitly request it via the "view" parameter of the Get/List request. - { # CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and clonning the VM using the replicated snapshot. + { # CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and cloning the VM using the replicated snapshot. "computeEngineDisksTargetDetails": { # ComputeEngineDisksTargetDetails is a collection of created Persistent Disks details. # Output only. Details of the target Persistent Disks in Compute Engine. "disks": [ # The details of each created Persistent Disk. { # Details of a created Persistent Disk. @@ -3839,7 +3839,7 @@

Method Details

}, ], "recentCutoverJobs": [ # Output only. The recent cutover jobs performed on the migrating VM. This field holds the vm's last completed cutover job and the vm's running cutover job, if one exists. Note: To have this field populated you need to explicitly request it via the "view" parameter of the Get/List request. - { # CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and clonning the VM using the replicated snapshot. + { # CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and cloning the VM using the replicated snapshot. "computeEngineDisksTargetDetails": { # ComputeEngineDisksTargetDetails is a collection of created Persistent Disks details. # Output only. Details of the target Persistent Disks in Compute Engine. "disks": [ # The details of each created Persistent Disk. { # Details of a created Persistent Disk. diff --git a/docs/dyn/workflowexecutions_v1.projects.locations.workflows.executions.html b/docs/dyn/workflowexecutions_v1.projects.locations.workflows.executions.html index e8affacb683..3f0cb9a1f22 100644 --- a/docs/dyn/workflowexecutions_v1.projects.locations.workflows.executions.html +++ b/docs/dyn/workflowexecutions_v1.projects.locations.workflows.executions.html @@ -153,7 +153,7 @@

Method Details

], }, }, - "executionHistoryLevel": "A String", # Optional. Describes the level of the execution history feature to apply to this execution. If not specified, the level of the execution history feature will be determined by its workflow's execution history level. If the value is different from its workflow's value, it will override the workflow's execution history level for this exeuction. + "executionHistoryLevel": "A String", # Optional. Describes the execution history level to apply to this execution. If not specified, the execution history level is determined by its workflow's execution history level. If the levels are different, the executionHistoryLevel overrides the workflow's execution history level for this execution. "labels": { # Labels associated with this execution. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed. By default, labels are inherited from the workflow but are overridden by any labels associated with the execution. "a_key": "A String", }, @@ -215,7 +215,7 @@

Method Details

], }, }, - "executionHistoryLevel": "A String", # Optional. Describes the level of the execution history feature to apply to this execution. If not specified, the level of the execution history feature will be determined by its workflow's execution history level. If the value is different from its workflow's value, it will override the workflow's execution history level for this exeuction. + "executionHistoryLevel": "A String", # Optional. Describes the execution history level to apply to this execution. If not specified, the execution history level is determined by its workflow's execution history level. If the levels are different, the executionHistoryLevel overrides the workflow's execution history level for this execution. "labels": { # Labels associated with this execution. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed. By default, labels are inherited from the workflow but are overridden by any labels associated with the execution. "a_key": "A String", }, @@ -270,7 +270,7 @@

Method Details

], }, }, - "executionHistoryLevel": "A String", # Optional. Describes the level of the execution history feature to apply to this execution. If not specified, the level of the execution history feature will be determined by its workflow's execution history level. If the value is different from its workflow's value, it will override the workflow's execution history level for this exeuction. + "executionHistoryLevel": "A String", # Optional. Describes the execution history level to apply to this execution. If not specified, the execution history level is determined by its workflow's execution history level. If the levels are different, the executionHistoryLevel overrides the workflow's execution history level for this execution. "labels": { # Labels associated with this execution. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed. By default, labels are inherited from the workflow but are overridden by any labels associated with the execution. "a_key": "A String", }, @@ -380,7 +380,7 @@

Method Details

], }, }, - "executionHistoryLevel": "A String", # Optional. Describes the level of the execution history feature to apply to this execution. If not specified, the level of the execution history feature will be determined by its workflow's execution history level. If the value is different from its workflow's value, it will override the workflow's execution history level for this exeuction. + "executionHistoryLevel": "A String", # Optional. Describes the execution history level to apply to this execution. If not specified, the execution history level is determined by its workflow's execution history level. If the levels are different, the executionHistoryLevel overrides the workflow's execution history level for this execution. "labels": { # Labels associated with this execution. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed. By default, labels are inherited from the workflow but are overridden by any labels associated with the execution. "a_key": "A String", }, @@ -453,7 +453,7 @@

Method Details

], }, }, - "executionHistoryLevel": "A String", # Optional. Describes the level of the execution history feature to apply to this execution. If not specified, the level of the execution history feature will be determined by its workflow's execution history level. If the value is different from its workflow's value, it will override the workflow's execution history level for this exeuction. + "executionHistoryLevel": "A String", # Optional. Describes the execution history level to apply to this execution. If not specified, the execution history level is determined by its workflow's execution history level. If the levels are different, the executionHistoryLevel overrides the workflow's execution history level for this execution. "labels": { # Labels associated with this execution. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed. By default, labels are inherited from the workflow but are overridden by any labels associated with the execution. "a_key": "A String", }, diff --git a/docs/dyn/workflowexecutions_v1.projects.locations.workflows.executions.stepEntries.html b/docs/dyn/workflowexecutions_v1.projects.locations.workflows.executions.stepEntries.html index f544e5c3fb6..c9173d70560 100644 --- a/docs/dyn/workflowexecutions_v1.projects.locations.workflows.executions.stepEntries.html +++ b/docs/dyn/workflowexecutions_v1.projects.locations.workflows.executions.stepEntries.html @@ -118,7 +118,7 @@

Method Details

"payload": "A String", # Error message represented as a JSON string. }, "name": "A String", # Output only. The full resource name of the step entry. Each step entry has a unique entry ID, which is a monotonically increasing counter. Step entry names have the format: `projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}/stepEntries/{step_entry}`. - "navigationInfo": { # NavigationInfo describes what steps if any come before or after this step, or what steps are parents or children of this step. # Output only. The NavigationInfo associated to this step. + "navigationInfo": { # NavigationInfo describes what steps if any come before or after this step, or what steps are parents or children of this step. # Output only. The NavigationInfo associated with this step. "children": [ # Step entries that can be reached by "stepping into" e.g. a subworkflow call. "A String", ], @@ -129,7 +129,7 @@

Method Details

"routine": "A String", # Output only. The name of the routine this step entry belongs to. A routine name is the subworkflow name defined in the YAML source code. The top level routine name is `main`. "state": "A String", # Output only. The state of the step entry. "step": "A String", # Output only. The name of the step this step entry belongs to. - "stepEntryMetadata": { # StepEntryMetadata contains metadata information about this step. # Output only. The StepEntryMetadata associated to this step. + "stepEntryMetadata": { # StepEntryMetadata contains metadata information about this step. # Output only. The StepEntryMetadata associated with this step. "expectedIteration": "A String", # Expected iteration represents the expected number of iterations in the step's progress. "progressNumber": "A String", # Progress number represents the current state of the current progress. eg: A step entry represents the 4th iteration in a progress of PROGRESS_TYPE_FOR. Note: This field is only populated when an iteration exists and the starting value is 1. "progressType": "A String", # Progress type of this step entry. @@ -137,7 +137,7 @@

Method Details

}, "stepType": "A String", # Output only. The type of the step this step entry belongs to. "updateTime": "A String", # Output only. The most recently updated time of the step entry. - "variableData": { # VariableData contains the variable data for this step. # Output only. The VariableData associated to this step. + "variableData": { # VariableData contains the variable data for this step. # Output only. The VariableData associated with this step. "variables": { # Variables that are associated with this step. "a_key": "", }, @@ -179,7 +179,7 @@

Method Details

"payload": "A String", # Error message represented as a JSON string. }, "name": "A String", # Output only. The full resource name of the step entry. Each step entry has a unique entry ID, which is a monotonically increasing counter. Step entry names have the format: `projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}/stepEntries/{step_entry}`. - "navigationInfo": { # NavigationInfo describes what steps if any come before or after this step, or what steps are parents or children of this step. # Output only. The NavigationInfo associated to this step. + "navigationInfo": { # NavigationInfo describes what steps if any come before or after this step, or what steps are parents or children of this step. # Output only. The NavigationInfo associated with this step. "children": [ # Step entries that can be reached by "stepping into" e.g. a subworkflow call. "A String", ], @@ -190,7 +190,7 @@

Method Details

"routine": "A String", # Output only. The name of the routine this step entry belongs to. A routine name is the subworkflow name defined in the YAML source code. The top level routine name is `main`. "state": "A String", # Output only. The state of the step entry. "step": "A String", # Output only. The name of the step this step entry belongs to. - "stepEntryMetadata": { # StepEntryMetadata contains metadata information about this step. # Output only. The StepEntryMetadata associated to this step. + "stepEntryMetadata": { # StepEntryMetadata contains metadata information about this step. # Output only. The StepEntryMetadata associated with this step. "expectedIteration": "A String", # Expected iteration represents the expected number of iterations in the step's progress. "progressNumber": "A String", # Progress number represents the current state of the current progress. eg: A step entry represents the 4th iteration in a progress of PROGRESS_TYPE_FOR. Note: This field is only populated when an iteration exists and the starting value is 1. "progressType": "A String", # Progress type of this step entry. @@ -198,7 +198,7 @@

Method Details

}, "stepType": "A String", # Output only. The type of the step this step entry belongs to. "updateTime": "A String", # Output only. The most recently updated time of the step entry. - "variableData": { # VariableData contains the variable data for this step. # Output only. The VariableData associated to this step. + "variableData": { # VariableData contains the variable data for this step. # Output only. The VariableData associated with this step. "variables": { # Variables that are associated with this step. "a_key": "", }, diff --git a/docs/dyn/workflowexecutions_v1.projects.locations.workflows.html b/docs/dyn/workflowexecutions_v1.projects.locations.workflows.html index 0f54472c459..c4bae3a536b 100644 --- a/docs/dyn/workflowexecutions_v1.projects.locations.workflows.html +++ b/docs/dyn/workflowexecutions_v1.projects.locations.workflows.html @@ -147,7 +147,7 @@

Method Details

], }, }, - "executionHistoryLevel": "A String", # Optional. Describes the level of the execution history feature to apply to this execution. If not specified, the level of the execution history feature will be determined by its workflow's execution history level. If the value is different from its workflow's value, it will override the workflow's execution history level for this exeuction. + "executionHistoryLevel": "A String", # Optional. Describes the execution history level to apply to this execution. If not specified, the execution history level is determined by its workflow's execution history level. If the levels are different, the executionHistoryLevel overrides the workflow's execution history level for this execution. "labels": { # Labels associated with this execution. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed. By default, labels are inherited from the workflow but are overridden by any labels associated with the execution. "a_key": "A String", }, diff --git a/docs/dyn/workflows_v1.projects.locations.workflows.html b/docs/dyn/workflows_v1.projects.locations.workflows.html index 806b072e2e9..91b509cee6a 100644 --- a/docs/dyn/workflows_v1.projects.locations.workflows.html +++ b/docs/dyn/workflows_v1.projects.locations.workflows.html @@ -128,7 +128,7 @@

Method Details

"cryptoKeyName": "A String", # Optional. The resource name of a KMS crypto key used to encrypt or decrypt the data associated with the workflow. Format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey} Using `-` as a wildcard for the `{project}` or not providing one at all will infer the project from the account. If not provided, data associated with the workflow will not be CMEK-encrypted. "cryptoKeyVersion": "A String", # Output only. The resource name of a KMS crypto key version used to encrypt or decrypt the data associated with the workflow. Format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey}/cryptoKeyVersions/{cryptoKeyVersion} "description": "A String", # Description of the workflow provided by the user. Must be at most 1000 Unicode characters long. This is a workflow-wide field and is not tied to a specific revision. - "executionHistoryLevel": "A String", # Optional. Describes the level of the execution history feature to apply to this workflow. + "executionHistoryLevel": "A String", # Optional. Describes the execution history level to apply to this workflow. "labels": { # Labels associated with this workflow. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed. This is a workflow-wide field and is not tied to a specific revision. "a_key": "A String", }, @@ -243,7 +243,7 @@

Method Details

"cryptoKeyName": "A String", # Optional. The resource name of a KMS crypto key used to encrypt or decrypt the data associated with the workflow. Format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey} Using `-` as a wildcard for the `{project}` or not providing one at all will infer the project from the account. If not provided, data associated with the workflow will not be CMEK-encrypted. "cryptoKeyVersion": "A String", # Output only. The resource name of a KMS crypto key version used to encrypt or decrypt the data associated with the workflow. Format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey}/cryptoKeyVersions/{cryptoKeyVersion} "description": "A String", # Description of the workflow provided by the user. Must be at most 1000 Unicode characters long. This is a workflow-wide field and is not tied to a specific revision. - "executionHistoryLevel": "A String", # Optional. Describes the level of the execution history feature to apply to this workflow. + "executionHistoryLevel": "A String", # Optional. Describes the execution history level to apply to this workflow. "labels": { # Labels associated with this workflow. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed. This is a workflow-wide field and is not tied to a specific revision. "a_key": "A String", }, @@ -303,7 +303,7 @@

Method Details

"cryptoKeyName": "A String", # Optional. The resource name of a KMS crypto key used to encrypt or decrypt the data associated with the workflow. Format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey} Using `-` as a wildcard for the `{project}` or not providing one at all will infer the project from the account. If not provided, data associated with the workflow will not be CMEK-encrypted. "cryptoKeyVersion": "A String", # Output only. The resource name of a KMS crypto key version used to encrypt or decrypt the data associated with the workflow. Format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey}/cryptoKeyVersions/{cryptoKeyVersion} "description": "A String", # Description of the workflow provided by the user. Must be at most 1000 Unicode characters long. This is a workflow-wide field and is not tied to a specific revision. - "executionHistoryLevel": "A String", # Optional. Describes the level of the execution history feature to apply to this workflow. + "executionHistoryLevel": "A String", # Optional. Describes the execution history level to apply to this workflow. "labels": { # Labels associated with this workflow. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed. This is a workflow-wide field and is not tied to a specific revision. "a_key": "A String", }, @@ -360,7 +360,7 @@

Method Details

"cryptoKeyName": "A String", # Optional. The resource name of a KMS crypto key used to encrypt or decrypt the data associated with the workflow. Format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey} Using `-` as a wildcard for the `{project}` or not providing one at all will infer the project from the account. If not provided, data associated with the workflow will not be CMEK-encrypted. "cryptoKeyVersion": "A String", # Output only. The resource name of a KMS crypto key version used to encrypt or decrypt the data associated with the workflow. Format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey}/cryptoKeyVersions/{cryptoKeyVersion} "description": "A String", # Description of the workflow provided by the user. Must be at most 1000 Unicode characters long. This is a workflow-wide field and is not tied to a specific revision. - "executionHistoryLevel": "A String", # Optional. Describes the level of the execution history feature to apply to this workflow. + "executionHistoryLevel": "A String", # Optional. Describes the execution history level to apply to this workflow. "labels": { # Labels associated with this workflow. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed. This is a workflow-wide field and is not tied to a specific revision. "a_key": "A String", }, @@ -435,7 +435,7 @@

Method Details

"cryptoKeyName": "A String", # Optional. The resource name of a KMS crypto key used to encrypt or decrypt the data associated with the workflow. Format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey} Using `-` as a wildcard for the `{project}` or not providing one at all will infer the project from the account. If not provided, data associated with the workflow will not be CMEK-encrypted. "cryptoKeyVersion": "A String", # Output only. The resource name of a KMS crypto key version used to encrypt or decrypt the data associated with the workflow. Format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey}/cryptoKeyVersions/{cryptoKeyVersion} "description": "A String", # Description of the workflow provided by the user. Must be at most 1000 Unicode characters long. This is a workflow-wide field and is not tied to a specific revision. - "executionHistoryLevel": "A String", # Optional. Describes the level of the execution history feature to apply to this workflow. + "executionHistoryLevel": "A String", # Optional. Describes the execution history level to apply to this workflow. "labels": { # Labels associated with this workflow. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed. This is a workflow-wide field and is not tied to a specific revision. "a_key": "A String", }, diff --git a/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json b/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json index c6c323c49bf..d159cd6393f 100644 --- a/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json +++ b/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json @@ -1295,7 +1295,7 @@ } } }, -"revision": "20250115", +"revision": "20250212", "rootUrl": "https://accesscontextmanager.googleapis.com/", "schemas": { "AccessContextManagerOperationMetadata": { @@ -1824,7 +1824,7 @@ "type": "string" }, "resource": { -"description": "A Google Cloud resource that you want to allow to egress the perimeter. These resources can access data outside the perimeter. This field only supports projects. The project format is `projects/{project_number}`. The resource can be in any Google Cloud organization, not just the organization where the perimeter is defined. You can't use `*` in this field to allow all Google Cloud resources.", +"description": "A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources.", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/admin.directory_v1.json b/googleapiclient/discovery_cache/documents/admin.directory_v1.json index cd2b4fc0f5a..9a4e56b3652 100644 --- a/googleapiclient/discovery_cache/documents/admin.directory_v1.json +++ b/googleapiclient/discovery_cache/documents/admin.directory_v1.json @@ -4020,7 +4020,7 @@ "type": "string" }, "pageToken": { -"description": "Token to specify next page in the list", +"description": "Token to specify next page in the list. The page token is only valid for three days.", "location": "query", "type": "string" }, @@ -4671,7 +4671,7 @@ } } }, -"revision": "20241210", +"revision": "20250217", "rootUrl": "https://admin.googleapis.com/", "schemas": { "Alias": { @@ -8658,7 +8658,7 @@ false "type": "string" }, "nextPageToken": { -"description": "Token used to access next page of this result.", +"description": "Token used to access next page of this result. The page token is only valid for three days.", "type": "string" }, "trigger_event": { diff --git a/googleapiclient/discovery_cache/documents/adsense.v2.json b/googleapiclient/discovery_cache/documents/adsense.v2.json index f1d37367010..0b23372cfe4 100644 --- a/googleapiclient/discovery_cache/documents/adsense.v2.json +++ b/googleapiclient/discovery_cache/documents/adsense.v2.json @@ -1006,6 +1006,57 @@ "DOMAIN_REGISTRANT", "WEBSEARCH_QUERY_STRING" ], +"enumDeprecated": [ +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +true, +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, +false, +false, +false, +false, +false +], "enumDescriptions": [ "Unspecified dimension.", "Date dimension in YYYY-MM-DD format (e.g. \"2010-02-10\").", @@ -1022,7 +1073,7 @@ "The size code of an ad unit (e.g. \"728x90\", \"responsive\").", "Custom channel name. The members of this dimension match the values from CustomChannel.display_name.", "Unique ID of a custom channel. The members of this dimension match the values from CustomChannel.reporting_dimension_id.", -"Unique ID of a hosted client's custom channel.", +"Not supported.", "Domain name of a verified site (e.g. \"example.com\"). The members of this dimension match the values from Site.domain.", "Unique ID of a verified site. The members of this dimension match the values from Site.reporting_dimension_id.", "URL of the page upon which the ad was served. This is a complete URL including scheme and query parameters. Note that the URL that appears in this dimension may be a canonicalized version of the one that was used in the original request, and so may not exactly match the URL that a user might have seen. Note that there are also some caveats to be aware of when using this dimension. For more information, see [Page URL breakdown](https://support.google.com/adsense/answer/11988478).", @@ -1328,6 +1379,57 @@ "DOMAIN_REGISTRANT", "WEBSEARCH_QUERY_STRING" ], +"enumDeprecated": [ +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +true, +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, +false, +false, +false, +false, +false +], "enumDescriptions": [ "Unspecified dimension.", "Date dimension in YYYY-MM-DD format (e.g. \"2010-02-10\").", @@ -1344,7 +1446,7 @@ "The size code of an ad unit (e.g. \"728x90\", \"responsive\").", "Custom channel name. The members of this dimension match the values from CustomChannel.display_name.", "Unique ID of a custom channel. The members of this dimension match the values from CustomChannel.reporting_dimension_id.", -"Unique ID of a hosted client's custom channel.", +"Not supported.", "Domain name of a verified site (e.g. \"example.com\"). The members of this dimension match the values from Site.domain.", "Unique ID of a verified site. The members of this dimension match the values from Site.reporting_dimension_id.", "URL of the page upon which the ad was served. This is a complete URL including scheme and query parameters. Note that the URL that appears in this dimension may be a canonicalized version of the one that was used in the original request, and so may not exactly match the URL that a user might have seen. Note that there are also some caveats to be aware of when using this dimension. For more information, see [Page URL breakdown](https://support.google.com/adsense/answer/11988478).", @@ -1916,7 +2018,7 @@ } } }, -"revision": "20241211", +"revision": "20250220", "rootUrl": "https://adsense.googleapis.com/", "schemas": { "Account": { diff --git a/googleapiclient/discovery_cache/documents/apigee.v1.json b/googleapiclient/discovery_cache/documents/apigee.v1.json index 8a18ca696df..b2be445a6bb 100644 --- a/googleapiclient/discovery_cache/documents/apigee.v1.json +++ b/googleapiclient/discovery_cache/documents/apigee.v1.json @@ -4955,7 +4955,7 @@ "revisions": { "methods": { "deploy": { -"description": "Deploys a revision of an API proxy. If another revision of the same API proxy revision is currently deployed, set the `override` parameter to `true` to have this revision replace the currently deployed revision. You cannot invoke an API proxy until it has been deployed to an environment. After you deploy an API proxy revision, you cannot edit it. To edit the API proxy, you must create and deploy a new revision. For a request path `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments`, two permissions are required: * `apigee.deployments.create` on the resource `organizations/{org}/environments/{env}` * `apigee.proxyrevisions.deploy` on the resource `organizations/{org}/apis/{api}/revisions/{rev}` ", +"description": "Deploys a revision of an API proxy. If another revision of the same API proxy revision is currently deployed, set the `override` parameter to `true` to have this revision replace the currently deployed revision. You cannot invoke an API proxy until it has been deployed to an environment. After you deploy an API proxy revision, you cannot edit it. To edit the API proxy, you must create and deploy a new revision. For a request path `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments`, two permissions are required: * `apigee.deployments.create` on the resource `organizations/{org}/environments/{env}` * `apigee.proxyrevisions.deploy` on the resource `organizations/{org}/apis/{api}/revisions/{rev}` Apigee hybrid validates the dependencies between shared flows and API proxies at deployment time. For example, if the Flow Callout policy in an API proxy references a shared flow that either doesn't exist or isn't deployed, the API proxy deployment fails.", "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/deployments", "httpMethod": "POST", "id": "apigee.organizations.environments.apis.revisions.deploy", @@ -10425,7 +10425,7 @@ } } }, -"revision": "20250207", +"revision": "20250214", "rootUrl": "https://apigee.googleapis.com/", "schemas": { "EdgeConfigstoreBundleBadBundle": { diff --git a/googleapiclient/discovery_cache/documents/appengine.v1.json b/googleapiclient/discovery_cache/documents/appengine.v1.json index f748d74166d..b8d822be710 100644 --- a/googleapiclient/discovery_cache/documents/appengine.v1.json +++ b/googleapiclient/discovery_cache/documents/appengine.v1.json @@ -1835,7 +1835,7 @@ } } }, -"revision": "20250210", +"revision": "20250217", "rootUrl": "https://appengine.googleapis.com/", "schemas": { "ApiConfigHandler": { @@ -3923,7 +3923,7 @@ true "enumDescriptions": [ "Defaults to AUTOMATIC.", "SSL support for this domain is configured automatically. The mapped SSL certificate will be automatically renewed.", -"SSL support for this domain is configured manually by the user. Either the domain has no SSL support or a user-obtained SSL certificate has been explictly mapped to this domain." +"SSL support for this domain is configured manually by the user. Either the domain has no SSL support or a user-obtained SSL certificate has been explicitly mapped to this domain." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/appengine.v1beta.json b/googleapiclient/discovery_cache/documents/appengine.v1beta.json index 78f62e2cafb..9167016b4a2 100644 --- a/googleapiclient/discovery_cache/documents/appengine.v1beta.json +++ b/googleapiclient/discovery_cache/documents/appengine.v1beta.json @@ -2035,7 +2035,7 @@ } } }, -"revision": "20250210", +"revision": "20250217", "rootUrl": "https://appengine.googleapis.com/", "schemas": { "ApiConfigHandler": { @@ -4170,7 +4170,7 @@ true ], "enumDescriptions": [ "SSL support for this domain is configured automatically. The mapped SSL certificate will be automatically renewed.", -"SSL support for this domain is configured manually by the user. Either the domain has no SSL support or a user-obtained SSL certificate has been explictly mapped to this domain." +"SSL support for this domain is configured manually by the user. Either the domain has no SSL support or a user-obtained SSL certificate has been explicitly mapped to this domain." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/areainsights.v1.json b/googleapiclient/discovery_cache/documents/areainsights.v1.json index 725926bc53e..92627bcd81b 100644 --- a/googleapiclient/discovery_cache/documents/areainsights.v1.json +++ b/googleapiclient/discovery_cache/documents/areainsights.v1.json @@ -128,7 +128,7 @@ } } }, -"revision": "20241211", +"revision": "20250219", "rootUrl": "https://areainsights.googleapis.com/", "schemas": { "Circle": { @@ -140,7 +140,7 @@ "description": "The latitude and longitude of the center of the circle." }, "place": { -"description": "The Place resource name of the center of the circle. Only point places are supported.", +"description": "**Format:** Must be in the format `places/PLACE_ID`, where `PLACE_ID` is the unique identifier of a place. For example: `places/ChIJgUbEo8cfqokR5lP9_Wh_DaM`.", "type": "string" }, "radius": { @@ -230,7 +230,7 @@ "Not Specified.", "The place is operational and its open during its defined hours.", "The Place is no longer in business.", -"The Place is temporarily closed and expected to reopen in the future." +"The place is temporarily closed and expected to reopen in the future." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/chat.v1.json b/googleapiclient/discovery_cache/documents/chat.v1.json index ddab4854ec4..fda7b1042b6 100644 --- a/googleapiclient/discovery_cache/documents/chat.v1.json +++ b/googleapiclient/discovery_cache/documents/chat.v1.json @@ -1344,7 +1344,7 @@ } } }, -"revision": "20250209", +"revision": "20250213", "rootUrl": "https://chat.googleapis.com/", "schemas": { "AccessSettings": { @@ -1545,16 +1545,16 @@ "type": "object" }, "AppCommandMetadata": { -"description": "Metadata associated with app commands. App commands are a way for users to invoke and interact with a Chat app. These can be slash commands typed in the compose box, or items directly selected from the integration menu. For more information, see [Respond to quick commands](https://developers.google.com/workspace/chat/quick-commands).", +"description": "Metadata about a [Chat app command](https://developers.google.com/workspace/chat/commands).", "id": "AppCommandMetadata", "properties": { "appCommandId": { -"description": "The command ID for the given app interaction.", +"description": "The ID for the command specified in the Chat API configuration.", "format": "int32", "type": "integer" }, "appCommandType": { -"description": "The type of the app command.", +"description": "The type of Chat app command.", "enum": [ "APP_COMMAND_TYPE_UNSPECIFIED", "SLASH_COMMAND", @@ -1562,8 +1562,8 @@ ], "enumDescriptions": [ "Default value. Unspecified.", -"A slash command sent in a message.", -"A quick command that is invoked by the user. This can result from an action taken in the integration menu." +"A slash command. The user sends the command in a Chat message.", +"A quick command. The user selects the command from the Chat menu in the message reply area." ], "type": "string" } @@ -2026,7 +2026,7 @@ }, "appCommandMetadata": { "$ref": "AppCommandMetadata", -"description": "Populated for app commands, including slash commands and quick commands." +"description": "Metadata about a Chat app command." }, "common": { "$ref": "CommonEventObject", @@ -2094,12 +2094,12 @@ ], "enumDescriptions": [ "Default value for the enum. DO NOT USE.", -"A user sends the Chat app a message, or invokes the Chat app in a space, such as any of the following examples: * Any message in a direct message (DM) space with the Chat app. * A message in a multi-person space where a person @mentions the Chat app, or uses one of its slash commands. * If you've configured link previews for your Chat app, a user posts a message that contains a link that matches the configured URL pattern.", +"A user sends the Chat app a message, or invokes the Chat app in a space, such as any of the following examples: * Any message in a direct message (DM) space with the Chat app. * A message in a multi-person space where a person @mentions the Chat app, or uses one of its [slash commands](https://developers.google.com/workspace/chat/commands#types). * If you've configured link previews for your Chat app, a user posts a message that contains a link that matches the configured URL pattern.", "A user adds the Chat app to a space, or a Google Workspace administrator installs the Chat app in direct message spaces for users in their organization. Chat apps typically respond to this interaction event by posting a welcome message in the space. When administrators install Chat apps, the `space.adminInstalled` field is set to `true` and users can't uninstall them. To learn about Chat apps installed by administrators, see Google Workspace Admin Help's documentation, [Install Marketplace apps in your domain](https://support.google.com/a/answer/172482).", "A user removes the Chat app from a space, or a Google Workspace administrator uninstalls the Chat app for a user in their organization. Chat apps can't respond with messages to this event, because they have already been removed. When administrators uninstall Chat apps, the `space.adminInstalled` field is set to `false`. If a user installed the Chat app before the administrator, the Chat app remains installed for the user and the Chat app doesn't receive a `REMOVED_FROM_SPACE` interaction event.", "A user clicks an interactive element of a card or dialog from a Chat app, such as a button. To receive an interaction event, the button must trigger another interaction with the Chat app. For example, a Chat app doesn't receive a `CARD_CLICKED` interaction event if a user clicks a button that opens a link to a website, but receives interaction events in the following examples: * The user clicks a `Send feedback` button on a card, which opens a dialog for the user to input information. * The user clicks a `Submit` button after inputting information into a card or dialog. If a user clicks a button to open, submit, or cancel a dialog, the `CARD_CLICKED` interaction event's `isDialogEvent` field is set to `true` and includes a [`DialogEventType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/DialogEventType).", "A user updates a widget in a card message or dialog.", -"A user invokes a command of the app." +"A user uses a Chat app [quick command](https://developers.google.com/workspace/chat/commands#types)." ], "type": "string" }, @@ -4578,11 +4578,11 @@ "type": "object" }, "SlashCommand": { -"description": "A [slash command](https://developers.google.com/workspace/chat/slash-commands) in Google Chat.", +"description": "Metadata about a [slash command](https://developers.google.com/workspace/chat/commands) in Google Chat.", "id": "SlashCommand", "properties": { "commandId": { -"description": "The ID of the slash command invoked.", +"description": "The ID of the slash command.", "format": "int64", "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/cloudasset.v1.json b/googleapiclient/discovery_cache/documents/cloudasset.v1.json index 4cd53591f0b..ff1a7f521fa 100644 --- a/googleapiclient/discovery_cache/documents/cloudasset.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudasset.v1.json @@ -681,7 +681,7 @@ ], "parameters": { "destinationParent": { -"description": "Required. Name of the Google Cloud folder or organization to reparent the target resource. The analysis will be performed against hypothetically moving the resource to this specified desitination parent. This can only be a folder number (such as \"folders/123\") or an organization number (such as \"organizations/123\").", +"description": "Required. Name of the Google Cloud folder or organization to reparent the target resource. The analysis will be performed against hypothetically moving the resource to this specified destination parent. This can only be a folder number (such as \"folders/123\") or an organization number (such as \"organizations/123\").", "location": "query", "type": "string" }, @@ -1095,7 +1095,7 @@ } } }, -"revision": "20250104", +"revision": "20250215", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AccessSelector": { @@ -1984,7 +1984,7 @@ ], "enumDescriptions": [ "Unspecified partition key. Tables won't be partitioned using this option.", -"The time when the request is received. If specified as partition key, the result table(s) is partitoned by the RequestTime column, an additional timestamp column representing when the request was received." +"The time when the request is received. If specified as partition key, the result table(s) is partitioned by the RequestTime column, an additional timestamp column representing when the request was received." ], "type": "string" }, @@ -2888,7 +2888,7 @@ "type": "string" }, "resource": { -"description": "A Google Cloud resource that you want to allow to egress the perimeter. These resources can access data outside the perimeter. This field only supports projects. The project format is `projects/{project_number}`. The resource can be in any Google Cloud organization, not just the organization where the perimeter is defined. You can't use `*` in this field to allow all Google Cloud resources.", +"description": "A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources.", "type": "string" } }, @@ -3392,7 +3392,7 @@ "description": "The IAM policy directly set on the given resource. Note that the original IAM policy can contain multiple bindings. This only contains the bindings that match the given query. For queries that don't contain a constrain on policies (e.g., an empty query), this contains all the bindings. To search against the `policy` bindings: * use a field query: - query by the policy contained members. Example: `policy:amy@gmail.com` - query by the policy contained roles. Example: `policy:roles/compute.admin` - query by the policy contained roles' included permissions. Example: `policy.role.permissions:compute.instances.create`" }, "project": { -"description": "The project that the associated Google Cloud resource belongs to, in the form of projects/{PROJECT_NUMBER}. If an IAM policy is set on a resource (like VM instance, Cloud Storage bucket), the project field will indicate the project that contains the resource. If an IAM policy is set on a folder or orgnization, this field will be empty. To search against the `project`: * specify the `scope` field as this project in your search request.", +"description": "The project that the associated Google Cloud resource belongs to, in the form of projects/{PROJECT_NUMBER}. If an IAM policy is set on a resource (like VM instance, Cloud Storage bucket), the project field will indicate the project that contains the resource. If an IAM policy is set on a folder or organization, this field will be empty. To search against the `project`: * specify the `scope` field as this project in your search request.", "type": "string" }, "resource": { @@ -3768,8 +3768,8 @@ ], "enumDescriptions": [ "Unspecified partition key. If used, it means using non-partitioned table.", -"The time when the snapshot is taken. If specified as partition key, the result table(s) is partitoned by the additional timestamp column, readTime. If [read_time] in ExportAssetsRequest is specified, the readTime column's value will be the same as it. Otherwise, its value will be the current time that is used to take the snapshot.", -"The time when the request is received and started to be processed. If specified as partition key, the result table(s) is partitoned by the requestTime column, an additional timestamp column representing when the request was received." +"The time when the snapshot is taken. If specified as partition key, the result table(s) is partitioned by the additional timestamp column, readTime. If [read_time] in ExportAssetsRequest is specified, the readTime column's value will be the same as it. Otherwise, its value will be the current time that is used to take the snapshot.", +"The time when the request is received and started to be processed. If specified as partition key, the result table(s) is partitioned by the requestTime column, an additional timestamp column representing when the request was received." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/cloudasset.v1beta1.json b/googleapiclient/discovery_cache/documents/cloudasset.v1beta1.json index d1d163acd4f..46dd5d74fd0 100644 --- a/googleapiclient/discovery_cache/documents/cloudasset.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudasset.v1beta1.json @@ -411,7 +411,7 @@ } } }, -"revision": "20250104", +"revision": "20250215", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AnalyzeIamPolicyLongrunningMetadata": { @@ -1198,7 +1198,7 @@ "type": "string" }, "resource": { -"description": "A Google Cloud resource that you want to allow to egress the perimeter. These resources can access data outside the perimeter. This field only supports projects. The project format is `projects/{project_number}`. The resource can be in any Google Cloud organization, not just the organization where the perimeter is defined. You can't use `*` in this field to allow all Google Cloud resources.", +"description": "A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources.", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/cloudasset.v1p1beta1.json b/googleapiclient/discovery_cache/documents/cloudasset.v1p1beta1.json index 81937f9e4eb..77d55ead1fa 100644 --- a/googleapiclient/discovery_cache/documents/cloudasset.v1p1beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudasset.v1p1beta1.json @@ -207,7 +207,7 @@ } } }, -"revision": "20250104", +"revision": "20250215", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AnalyzeIamPolicyLongrunningMetadata": { @@ -900,7 +900,7 @@ "type": "string" }, "resource": { -"description": "A Google Cloud resource that you want to allow to egress the perimeter. These resources can access data outside the perimeter. This field only supports projects. The project format is `projects/{project_number}`. The resource can be in any Google Cloud organization, not just the organization where the perimeter is defined. You can't use `*` in this field to allow all Google Cloud resources.", +"description": "A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources.", "type": "string" } }, @@ -1231,7 +1231,7 @@ "description": "The IAM policy attached to the specified resource. Note that the original IAM policy can contain multiple bindings. This only contains the bindings that match the given query. For queries that don't contain a constraint on policies (e.g. an empty query), this contains all the bindings." }, "project": { -"description": "The project that the associated Google Cloud resource belongs to, in the form of `projects/{project_number}`. If an IAM policy is set on a resource -- such as a Compute Engine instance or a Cloud Storage bucket -- the project field will indicate the project that contains the resource. If an IAM policy is set on a folder or orgnization, the project field will be empty.", +"description": "The project that the associated Google Cloud resource belongs to, in the form of `projects/{project_number}`. If an IAM policy is set on a resource -- such as a Compute Engine instance or a Cloud Storage bucket -- the project field will indicate the project that contains the resource. If an IAM policy is set on a folder or organization, the project field will be empty.", "type": "string" }, "resource": { diff --git a/googleapiclient/discovery_cache/documents/cloudasset.v1p5beta1.json b/googleapiclient/discovery_cache/documents/cloudasset.v1p5beta1.json index 9d8dacbe614..3e26832f9be 100644 --- a/googleapiclient/discovery_cache/documents/cloudasset.v1p5beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudasset.v1p5beta1.json @@ -177,7 +177,7 @@ } } }, -"revision": "20250104", +"revision": "20250215", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AnalyzeIamPolicyLongrunningMetadata": { @@ -905,7 +905,7 @@ "type": "string" }, "resource": { -"description": "A Google Cloud resource that you want to allow to egress the perimeter. These resources can access data outside the perimeter. This field only supports projects. The project format is `projects/{project_number}`. The resource can be in any Google Cloud organization, not just the organization where the perimeter is defined. You can't use `*` in this field to allow all Google Cloud resources.", +"description": "A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources.", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/cloudasset.v1p7beta1.json b/googleapiclient/discovery_cache/documents/cloudasset.v1p7beta1.json index 2eff25d12ad..2ad9b5f578a 100644 --- a/googleapiclient/discovery_cache/documents/cloudasset.v1p7beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudasset.v1p7beta1.json @@ -167,7 +167,7 @@ } } }, -"revision": "20250104", +"revision": "20250215", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AnalyzeIamPolicyLongrunningMetadata": { @@ -460,8 +460,8 @@ ], "enumDescriptions": [ "Unspecified partition key. If used, it means using non-partitioned table.", -"The time when the snapshot is taken. If specified as partition key, the result table(s) is partitoned by the additional timestamp column, readTime. If [read_time] in ExportAssetsRequest is specified, the readTime column's value will be the same as it. Otherwise, its value will be the current time that is used to take the snapshot.", -"The time when the request is received and started to be processed. If specified as partition key, the result table(s) is partitoned by the requestTime column, an additional timestamp column representing when the request was received." +"The time when the snapshot is taken. If specified as partition key, the result table(s) is partitioned by the additional timestamp column, readTime. If [read_time] in ExportAssetsRequest is specified, the readTime column's value will be the same as it. Otherwise, its value will be the current time that is used to take the snapshot.", +"The time when the request is received and started to be processed. If specified as partition key, the result table(s) is partitioned by the requestTime column, an additional timestamp column representing when the request was received." ], "type": "string" } @@ -974,7 +974,7 @@ "type": "string" }, "resource": { -"description": "A Google Cloud resource that you want to allow to egress the perimeter. These resources can access data outside the perimeter. This field only supports projects. The project format is `projects/{project_number}`. The resource can be in any Google Cloud organization, not just the organization where the perimeter is defined. You can't use `*` in this field to allow all Google Cloud resources.", +"description": "A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources.", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/clouddeploy.v1.json b/googleapiclient/discovery_cache/documents/clouddeploy.v1.json index 4b85c718cc9..7075f7fe66f 100644 --- a/googleapiclient/discovery_cache/documents/clouddeploy.v1.json +++ b/googleapiclient/discovery_cache/documents/clouddeploy.v1.json @@ -2348,7 +2348,7 @@ } } }, -"revision": "20250122", +"revision": "20250212", "rootUrl": "https://clouddeploy.googleapis.com/", "schemas": { "AbandonReleaseRequest": { @@ -3655,7 +3655,7 @@ true "No reason for failure is specified.", "Cloud Build is not available, either because it is not enabled or because Cloud Deploy has insufficient permissions. See [Required permission](https://cloud.google.com/deploy/docs/cloud-deploy-service-account#required_permissions).", "The deploy operation did not complete successfully; check Cloud Build logs.", -"The deploy job run did not complete within the alloted time.", +"The deploy job run did not complete within the allotted time.", "There were missing resources in the runtime environment required for a canary deployment. Check the Cloud Build logs for more information.", "Cloud Build failed to fulfill Cloud Deploy's request. See failure_message for additional details.", "The deploy operation had a feature configured that is not supported." @@ -4637,7 +4637,7 @@ true "type": "object" }, "ListRolloutsResponse": { -"description": "ListRolloutsResponse is the response object reutrned by `ListRollouts`.", +"description": "ListRolloutsResponse is the response object returned by `ListRollouts`.", "id": "ListRolloutsResponse", "properties": { "nextPageToken": { @@ -5126,7 +5126,7 @@ true "No reason for failure is specified.", "Cloud Build is not available, either because it is not enabled or because Cloud Deploy has insufficient permissions. See [required permission](https://cloud.google.com/deploy/docs/cloud-deploy-service-account#required_permissions).", "The postdeploy operation did not complete successfully; check Cloud Build logs.", -"The postdeploy job run did not complete within the alloted time.", +"The postdeploy job run did not complete within the allotted time.", "Cloud Build failed to fulfill Cloud Deploy's request. See failure_message for additional details." ], "readOnly": true, @@ -5191,7 +5191,7 @@ true "No reason for failure is specified.", "Cloud Build is not available, either because it is not enabled or because Cloud Deploy has insufficient permissions. See [required permission](https://cloud.google.com/deploy/docs/cloud-deploy-service-account#required_permissions).", "The predeploy operation did not complete successfully; check Cloud Build logs.", -"The predeploy job run did not complete within the alloted time.", +"The predeploy job run did not complete within the allotted time.", "Cloud Build failed to fulfill Cloud Deploy's request. See failure_message for additional details." ], "readOnly": true, @@ -6053,7 +6053,7 @@ true "No reason for failure is specified.", "Cloud Build is not available, either because it is not enabled or because Cloud Deploy has insufficient permissions. See [required permission](https://cloud.google.com/deploy/docs/cloud-deploy-service-account#required_permissions).", "The deploy operation did not complete successfully; check Cloud Build logs.", -"Deployment did not complete within the alloted time.", +"Deployment did not complete within the allotted time.", "Release is in a failed state.", "Release is abandoned.", "No Skaffold verify configuration was found.", @@ -6422,7 +6422,7 @@ true "type": "array" }, "propagateService": { -"description": "Optional. Whether to propagate the Kubernetes Service to the route destination clusters. The Service will always be deployed to the Target cluster even if the HTTPRoute is not. This option may be used to facilitiate successful DNS lookup in the route destination clusters. Can only be set to true if destinations are specified.", +"description": "Optional. Whether to propagate the Kubernetes Service to the route destination clusters. The Service will always be deployed to the Target cluster even if the HTTPRoute is not. This option may be used to facilitate successful DNS lookup in the route destination clusters. Can only be set to true if destinations are specified.", "type": "boolean" } }, @@ -7258,7 +7258,7 @@ true "No reason for failure is specified.", "Cloud Build is not available, either because it is not enabled or because Cloud Deploy has insufficient permissions. See [required permission](https://cloud.google.com/deploy/docs/cloud-deploy-service-account#required_permissions).", "The verify operation did not complete successfully; check Cloud Build logs.", -"The verify job run did not complete within the alloted time.", +"The verify job run did not complete within the allotted time.", "No Skaffold verify configuration was found.", "Cloud Build failed to fulfill Cloud Deploy's request. See failure_message for additional details." ], diff --git a/googleapiclient/discovery_cache/documents/css.v1.json b/googleapiclient/discovery_cache/documents/css.v1.json index ae811c51780..4c36cedea1a 100644 --- a/googleapiclient/discovery_cache/documents/css.v1.json +++ b/googleapiclient/discovery_cache/documents/css.v1.json @@ -226,7 +226,7 @@ ], "parameters": { "name": { -"description": "Required. The name of the CSS product input resource to delete. Format: accounts/{account}/cssProductInputs/{css_product_input}", +"description": "Required. The name of the CSS product input resource to delete. Format: accounts/{account}/cssProductInputs/{css_product_input}, where the last section `css_product_input` consists of 3 parts: contentLanguage~feedLabel~offerId. Example: accounts/123/cssProductInputs/de~DE~rawProvidedId123", "location": "path", "pattern": "^accounts/[^/]+/cssProductInputs/[^/]+$", "required": true, @@ -292,7 +292,7 @@ ], "parameters": { "name": { -"description": "The name of the CSS Product input. Format: `accounts/{account}/cssProductInputs/{css_product_input}`", +"description": "The name of the CSS Product input. Format: `accounts/{account}/cssProductInputs/{css_product_input}`, where the last section `css_product_input` consists of 3 parts: contentLanguage~feedLabel~offerId. Example: accounts/123/cssProductInputs/de~DE~rawProvidedId123", "location": "path", "pattern": "^accounts/[^/]+/cssProductInputs/[^/]+$", "required": true, @@ -507,7 +507,7 @@ } } }, -"revision": "20250106", +"revision": "20250219", "rootUrl": "https://css.googleapis.com/", "schemas": { "Account": { @@ -576,7 +576,7 @@ "type": "string" }, "parent": { -"description": "The CSS/MC account's parent resource. CSS group for CSS domains; CSS domain for MC accounts. Returned only if the user has access to the parent account.", +"description": "The CSS/MC account's parent resource. CSS group for CSS domains; CSS domain for MC accounts. Returned only if the user has access to the parent account. Note: For MC sub-accounts, this is also the CSS domain that is the parent resource of the MCA account, since we are effectively flattening the hierarchy.\"", "type": "string" } }, @@ -960,7 +960,7 @@ "type": "string" }, "name": { -"description": "The name of the CSS Product input. Format: `accounts/{account}/cssProductInputs/{css_product_input}`", +"description": "The name of the CSS Product input. Format: `accounts/{account}/cssProductInputs/{css_product_input}`, where the last section `css_product_input` consists of 3 parts: contentLanguage~feedLabel~offerId. Example: accounts/123/cssProductInputs/de~DE~rawProvidedId123", "type": "string" }, "rawProvidedId": { diff --git a/googleapiclient/discovery_cache/documents/datastore.v1.json b/googleapiclient/discovery_cache/documents/datastore.v1.json index e388ea30ec6..8bb3a86e662 100644 --- a/googleapiclient/discovery_cache/documents/datastore.v1.json +++ b/googleapiclient/discovery_cache/documents/datastore.v1.json @@ -654,7 +654,7 @@ } } }, -"revision": "20250204", +"revision": "20250212", "rootUrl": "https://datastore.googleapis.com/", "schemas": { "Aggregation": { @@ -1582,7 +1582,7 @@ "id": "GoogleDatastoreAdminV1RedirectWritesStepDetails", "properties": { "concurrencyMode": { -"description": "Ths concurrency mode for this database.", +"description": "The concurrency mode for this database.", "enum": [ "CONCURRENCY_MODE_UNSPECIFIED", "PESSIMISTIC", diff --git a/googleapiclient/discovery_cache/documents/datastore.v1beta1.json b/googleapiclient/discovery_cache/documents/datastore.v1beta1.json index 2a8e82466b8..c0923425c67 100644 --- a/googleapiclient/discovery_cache/documents/datastore.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/datastore.v1beta1.json @@ -168,7 +168,7 @@ } } }, -"revision": "20240626", +"revision": "20250212", "rootUrl": "https://datastore.googleapis.com/", "schemas": { "GoogleDatastoreAdminV1CommonMetadata": { @@ -496,7 +496,7 @@ "id": "GoogleDatastoreAdminV1RedirectWritesStepDetails", "properties": { "concurrencyMode": { -"description": "Ths concurrency mode for this database.", +"description": "The concurrency mode for this database.", "enum": [ "CONCURRENCY_MODE_UNSPECIFIED", "PESSIMISTIC", diff --git a/googleapiclient/discovery_cache/documents/datastore.v1beta3.json b/googleapiclient/discovery_cache/documents/datastore.v1beta3.json index 83ac451cfe9..2b4749e9c9e 100644 --- a/googleapiclient/discovery_cache/documents/datastore.v1beta3.json +++ b/googleapiclient/discovery_cache/documents/datastore.v1beta3.json @@ -336,7 +336,7 @@ } } }, -"revision": "20250204", +"revision": "20250212", "rootUrl": "https://datastore.googleapis.com/", "schemas": { "Aggregation": { @@ -1094,7 +1094,7 @@ "id": "GoogleDatastoreAdminV1RedirectWritesStepDetails", "properties": { "concurrencyMode": { -"description": "Ths concurrency mode for this database.", +"description": "The concurrency mode for this database.", "enum": [ "CONCURRENCY_MODE_UNSPECIFIED", "PESSIMISTIC", diff --git a/googleapiclient/discovery_cache/documents/dfareporting.v4.json b/googleapiclient/discovery_cache/documents/dfareporting.v4.json index 31ca8b0fe6d..001ca6d9c5d 100644 --- a/googleapiclient/discovery_cache/documents/dfareporting.v4.json +++ b/googleapiclient/discovery_cache/documents/dfareporting.v4.json @@ -10152,7 +10152,7 @@ } } }, -"revision": "20240926", +"revision": "20250218", "rootUrl": "https://dfareporting.googleapis.com/", "schemas": { "Account": { @@ -11760,15 +11760,15 @@ "type": "array" }, "merchantFeedLabel": { -"description": "The feed labels associated with the feed where your items are uploaded. For more information, please refer to \u200b\u200b https://support.google.com/merchants/answer/12453549. This is a required field.", +"description": "The feed labels associated with the feed where your items are uploaded. For more information, please refer to \u200b\u200b https://support.google.com/merchants/answer/12453549. Providing the feed label reduces ambiguity in identifying the right offer details.", "type": "string" }, "merchantFeedLanguage": { -"description": "The language associated with the feed where your items are uploaded. Use ISO 639-1 language codes. This field is needed only when item IDs are not unique across multiple Merchant Center feeds.", +"description": "The language associated with the feed where your items are uploaded. Use ISO 639-1 language codes. Providing the feed language reduces ambiguity in identifying the right offer details.", "type": "string" }, "merchantId": { -"description": "The Merchant Center ID where the items are uploaded. This is a required field.", +"description": "The Merchant Center ID where the items are uploaded. Providing Merchant Center ID reduces ambiguity in identifying the right offer details.", "format": "int64", "type": "string" } @@ -12281,7 +12281,7 @@ "type": "array" }, "value": { -"description": "The value of the conversion. This is a required field.", +"description": "The value of the conversion. Interpreted in CM360 Floodlight config parent advertiser's currency code. This is a required field.", "format": "double", "type": "number" } @@ -20324,6 +20324,10 @@ "description": "Whether click-tracking string should be included in the tags.", "type": "boolean" }, +"includeUnescapedlpurlMacro": { +"description": "Optional. Indicates that the unescapedlpurl macro should be included in the tag for the static landing page. New placements will default to the value set on their site.", +"type": "boolean" +}, "keywordOption": { "description": "Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.", "enum": [ diff --git a/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json b/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json index 77c1749105d..8cc0ff48afb 100644 --- a/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json +++ b/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json @@ -206,7 +206,7 @@ } } }, -"revision": "20250212", +"revision": "20250219", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "Date": { @@ -1826,11 +1826,11 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1VertexAISearch": { -"description": "Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/products/agent-builder", +"description": "Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder", "id": "GoogleCloudAiplatformV1beta1VertexAISearch", "properties": { "datastore": { -"description": "Required. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`", +"description": "Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/forms.v1.json b/googleapiclient/discovery_cache/documents/forms.v1.json index 779815cfd25..9b08db2cd62 100644 --- a/googleapiclient/discovery_cache/documents/forms.v1.json +++ b/googleapiclient/discovery_cache/documents/forms.v1.json @@ -423,7 +423,7 @@ } } }, -"revision": "20250121", +"revision": "20250211", "rootUrl": "https://forms.googleapis.com/", "schemas": { "Answer": { @@ -864,7 +864,7 @@ "id": "FormSettings", "properties": { "emailCollectionType": { -"description": "Optional. Kind of email collection configured in the form.", +"description": "Optional. The setting that determines whether the form collects email addresses from respondents.", "enum": [ "EMAIL_COLLECTION_TYPE_UNSPECIFIED", "DO_NOT_COLLECT", @@ -872,10 +872,10 @@ "RESPONDER_INPUT" ], "enumDescriptions": [ -"Default value. The default for forms owned by Google Workspace users is VERIFIED. For forms owned by other types of Google accounts, the default is DO_NO_COLLECT.", -"Email Field is not collected for the user.", -"Email Field is collected automatically from the logged in user.", -"Email Field needs to be manually filled." +"Unspecified. This value is unused.", +"The form doesn't collect email addresses. Default value if the form owner uses a Google account.", +"The form collects email addresses automatically based on the account of the signed-in user. Default value if the form owner uses a Google Workspace account.", +"The form collects email addresses using a field that the respondent completes on the form." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/iam.v1.json b/googleapiclient/discovery_cache/documents/iam.v1.json index 363312de8c9..e5aefe09354 100644 --- a/googleapiclient/discovery_cache/documents/iam.v1.json +++ b/googleapiclient/discovery_cache/documents/iam.v1.json @@ -3188,7 +3188,7 @@ } } }, -"revision": "20250116", +"revision": "20250213", "rootUrl": "https://iam.googleapis.com/", "schemas": { "AccessRestrictions": { @@ -3551,11 +3551,13 @@ "description": "Required. Represents the IdP and type of claims that should be fetched.", "enum": [ "ATTRIBUTES_TYPE_UNSPECIFIED", -"AZURE_AD_GROUPS_MAIL" +"AZURE_AD_GROUPS_MAIL", +"AZURE_AD_GROUPS_ID" ], "enumDescriptions": [ "No AttributesType specified.", -"Used to get the user's group claims from the Microsoft Entra ID identity provider using configuration provided in ExtraAttributesOAuth2Client and `mail` property of the `microsoft.graph.group` object is used for claim mapping. See https://learn.microsoft.com/en-us/graph/api/resources/group?view=graph-rest-1.0#properties for more details on `microsoft.graph.group` properties. The attributes obtained from idntity provider are mapped to `assertion.groups`." +"Used to get the user's group claims from the Microsoft Entra ID identity provider using configuration provided in ExtraAttributesOAuth2Client and `mail` property of the `microsoft.graph.group` object is used for claim mapping. See https://learn.microsoft.com/en-us/graph/api/resources/group?view=graph-rest-1.0#properties for more details on `microsoft.graph.group` properties. The attributes obtained from idntity provider are mapped to `assertion.groups`.", +"Used to get the user's group claims from the Microsoft Entra ID identity provider using configuration provided in ExtraAttributesOAuth2Client and `id` property of the `microsoft.graph.group` object is used for claim mapping. See https://learn.microsoft.com/en-us/graph/api/resources/group?view=graph-rest-1.0#properties for more details on `microsoft.graph.group` properties. The group IDs obtained from Microsoft Entra ID are present in `assertion. groups` for OIDC providers and `assertion.attributes.groups` for SAML providers for attribute mapping." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/iam.v2.json b/googleapiclient/discovery_cache/documents/iam.v2.json index 0d16cf93282..4783317e404 100644 --- a/googleapiclient/discovery_cache/documents/iam.v2.json +++ b/googleapiclient/discovery_cache/documents/iam.v2.json @@ -293,7 +293,7 @@ } } }, -"revision": "20241114", +"revision": "20250213", "rootUrl": "https://iam.googleapis.com/", "schemas": { "CloudControl2SharedOperationsReconciliationOperationMetadata": { @@ -483,7 +483,7 @@ false "type": "array" }, "deniedPrincipals": { -"description": "The identities that are prevented from using one or more permissions on Google Cloud resources. This field can contain the following values: * `principal://goog/subject/{email_id}`: A specific Google Account. Includes Gmail, Cloud Identity, and Google Workspace user accounts. For example, `principal://goog/subject/alice@example.com`. * `principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}`: A Google Cloud service account. For example, `principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com`. * `principalSet://goog/group/{group_id}`: A Google group. For example, `principalSet://goog/group/admins@example.com`. * `principalSet://goog/public:all`: A special identifier that represents any principal that is on the internet, even if they do not have a Google Account or are not logged in. * `principalSet://goog/cloudIdentityCustomerId/{customer_id}`: All of the principals associated with the specified Google Workspace or Cloud Identity customer ID. For example, `principalSet://goog/cloudIdentityCustomerId/C01Abc35`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:principal://goog/subject/{email_id}?uid={uid}`: A specific Google Account that was deleted recently. For example, `deleted:principal://goog/subject/alice@example.com?uid=1234567890`. If the Google Account is recovered, this identifier reverts to the standard identifier for a Google Account. * `deleted:principalSet://goog/group/{group_id}?uid={uid}`: A Google group that was deleted recently. For example, `deleted:principalSet://goog/group/admins@example.com?uid=1234567890`. If the Google group is restored, this identifier reverts to the standard identifier for a Google group. * `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}?uid={uid}`: A Google Cloud service account that was deleted recently. For example, `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com?uid=1234567890`. If the service account is undeleted, this identifier reverts to the standard identifier for a service account. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.", +"description": "The identities that are prevented from using one or more permissions on Google Cloud resources. This field can contain the following values: * `principal://goog/subject/{email_id}`: A specific Google Account. Includes Gmail, Cloud Identity, and Google Workspace user accounts. For example, `principal://goog/subject/alice@example.com`. * `principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}`: A Google Cloud service account. For example, `principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com`. * `principalSet://goog/group/{group_id}`: A Google group. For example, `principalSet://goog/group/admins@example.com`. * `principalSet://goog/public:all`: A special identifier that represents any principal that is on the internet, even if they do not have a Google Account or are not logged in. * `principalSet://goog/cloudIdentityCustomerId/{customer_id}`: All of the principals associated with the specified Google Workspace or Cloud Identity customer ID. For example, `principalSet://goog/cloudIdentityCustomerId/C01Abc35`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `principalSet://cloudresourcemanager.googleapis.com/[projects|folders|organizations]/{project_number|folder_number|org_number}/type/ServiceAccount`: All service accounts grouped under a resource (project, folder, or organization). * `principalSet://cloudresourcemanager.googleapis.com/[projects|folders|organizations]/{project_number|folder_number|org_number}/type/ServiceAgent`: All service agents grouped under a resource (project, folder, or organization). * `deleted:principal://goog/subject/{email_id}?uid={uid}`: A specific Google Account that was deleted recently. For example, `deleted:principal://goog/subject/alice@example.com?uid=1234567890`. If the Google Account is recovered, this identifier reverts to the standard identifier for a Google Account. * `deleted:principalSet://goog/group/{group_id}?uid={uid}`: A Google group that was deleted recently. For example, `deleted:principalSet://goog/group/admins@example.com?uid=1234567890`. If the Google group is restored, this identifier reverts to the standard identifier for a Google group. * `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}?uid={uid}`: A Google Cloud service account that was deleted recently. For example, `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com?uid=1234567890`. If the service account is undeleted, this identifier reverts to the standard identifier for a service account. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.", "items": { "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/iam.v2beta.json b/googleapiclient/discovery_cache/documents/iam.v2beta.json index e5875c4eee8..406196127da 100644 --- a/googleapiclient/discovery_cache/documents/iam.v2beta.json +++ b/googleapiclient/discovery_cache/documents/iam.v2beta.json @@ -293,7 +293,7 @@ } } }, -"revision": "20241114", +"revision": "20250213", "rootUrl": "https://iam.googleapis.com/", "schemas": { "CloudControl2SharedOperationsReconciliationOperationMetadata": { @@ -483,7 +483,7 @@ false "type": "array" }, "deniedPrincipals": { -"description": "The identities that are prevented from using one or more permissions on Google Cloud resources. This field can contain the following values: * `principal://goog/subject/{email_id}`: A specific Google Account. Includes Gmail, Cloud Identity, and Google Workspace user accounts. For example, `principal://goog/subject/alice@example.com`. * `principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}`: A Google Cloud service account. For example, `principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com`. * `principalSet://goog/group/{group_id}`: A Google group. For example, `principalSet://goog/group/admins@example.com`. * `principalSet://goog/public:all`: A special identifier that represents any principal that is on the internet, even if they do not have a Google Account or are not logged in. * `principalSet://goog/cloudIdentityCustomerId/{customer_id}`: All of the principals associated with the specified Google Workspace or Cloud Identity customer ID. For example, `principalSet://goog/cloudIdentityCustomerId/C01Abc35`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:principal://goog/subject/{email_id}?uid={uid}`: A specific Google Account that was deleted recently. For example, `deleted:principal://goog/subject/alice@example.com?uid=1234567890`. If the Google Account is recovered, this identifier reverts to the standard identifier for a Google Account. * `deleted:principalSet://goog/group/{group_id}?uid={uid}`: A Google group that was deleted recently. For example, `deleted:principalSet://goog/group/admins@example.com?uid=1234567890`. If the Google group is restored, this identifier reverts to the standard identifier for a Google group. * `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}?uid={uid}`: A Google Cloud service account that was deleted recently. For example, `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com?uid=1234567890`. If the service account is undeleted, this identifier reverts to the standard identifier for a service account. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.", +"description": "The identities that are prevented from using one or more permissions on Google Cloud resources. This field can contain the following values: * `principal://goog/subject/{email_id}`: A specific Google Account. Includes Gmail, Cloud Identity, and Google Workspace user accounts. For example, `principal://goog/subject/alice@example.com`. * `principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}`: A Google Cloud service account. For example, `principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com`. * `principalSet://goog/group/{group_id}`: A Google group. For example, `principalSet://goog/group/admins@example.com`. * `principalSet://goog/public:all`: A special identifier that represents any principal that is on the internet, even if they do not have a Google Account or are not logged in. * `principalSet://goog/cloudIdentityCustomerId/{customer_id}`: All of the principals associated with the specified Google Workspace or Cloud Identity customer ID. For example, `principalSet://goog/cloudIdentityCustomerId/C01Abc35`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `principalSet://cloudresourcemanager.googleapis.com/[projects|folders|organizations]/{project_number|folder_number|org_number}/type/ServiceAccount`: All service accounts grouped under a resource (project, folder, or organization). * `principalSet://cloudresourcemanager.googleapis.com/[projects|folders|organizations]/{project_number|folder_number|org_number}/type/ServiceAgent`: All service agents grouped under a resource (project, folder, or organization). * `deleted:principal://goog/subject/{email_id}?uid={uid}`: A specific Google Account that was deleted recently. For example, `deleted:principal://goog/subject/alice@example.com?uid=1234567890`. If the Google Account is recovered, this identifier reverts to the standard identifier for a Google Account. * `deleted:principalSet://goog/group/{group_id}?uid={uid}`: A Google group that was deleted recently. For example, `deleted:principalSet://goog/group/admins@example.com?uid=1234567890`. If the Google group is restored, this identifier reverts to the standard identifier for a Google group. * `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}?uid={uid}`: A Google Cloud service account that was deleted recently. For example, `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com?uid=1234567890`. If the service account is undeleted, this identifier reverts to the standard identifier for a service account. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.", "items": { "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/ids.v1.json b/googleapiclient/discovery_cache/documents/ids.v1.json index 77aa4511424..4391a4797c1 100644 --- a/googleapiclient/discovery_cache/documents/ids.v1.json +++ b/googleapiclient/discovery_cache/documents/ids.v1.json @@ -449,7 +449,7 @@ "operations": { "methods": { "cancel": { -"description": "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`.", +"description": "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`.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "httpMethod": "POST", "id": "ids.projects.locations.operations.cancel", @@ -574,7 +574,7 @@ } } }, -"revision": "20240627", +"revision": "20250214", "rootUrl": "https://ids.googleapis.com/", "schemas": { "AuditConfig": { @@ -942,7 +942,7 @@ "type": "string" }, "requestedCancellation": { -"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", +"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", "readOnly": true, "type": "boolean" }, diff --git a/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json b/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json index 6c69efce159..4f15909a7a5 100644 --- a/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json @@ -2548,7 +2548,7 @@ } } }, -"revision": "20250206", +"revision": "20250220", "rootUrl": "https://migrationcenter.googleapis.com/", "schemas": { "AddAssetsToGroupRequest": { @@ -4653,7 +4653,7 @@ "type": "string" }, "mountPoint": { -"description": "Mount pount (Linux/Windows) or drive letter (Windows).", +"description": "Mount point (Linux/Windows) or drive letter (Windows).", "type": "string" }, "subPartitions": { @@ -6514,7 +6514,7 @@ false ], "enumDescriptions": [ "Unknown (default value).", -"Staticly assigned IP.", +"Statically assigned IP.", "Dynamically assigned IP (DHCP)." ], "type": "string" diff --git a/googleapiclient/discovery_cache/documents/networkmanagement.v1.json b/googleapiclient/discovery_cache/documents/networkmanagement.v1.json index 38adaf6cfe8..9fe2f18968c 100644 --- a/googleapiclient/discovery_cache/documents/networkmanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/networkmanagement.v1.json @@ -758,7 +758,7 @@ } } }, -"revision": "20250101", +"revision": "20250212", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -803,7 +803,8 @@ "SOURCE_FORWARDING_RULE_UNSUPPORTED", "NON_ROUTABLE_IP_ADDRESS", "UNKNOWN_ISSUE_IN_GOOGLE_MANAGED_PROJECT", -"UNSUPPORTED_GOOGLE_MANAGED_PROJECT_CONFIG" +"UNSUPPORTED_GOOGLE_MANAGED_PROJECT_CONFIG", +"NO_SERVERLESS_IP_RANGES" ], "enumDeprecated": [ false, @@ -841,6 +842,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -879,7 +881,8 @@ false "Aborted because tests with a forwarding rule as a source are not supported.", "Aborted because one of the endpoints is a non-routable IP address (loopback, link-local, etc).", "Aborted due to an unknown issue in the Google-managed project.", -"Aborted due to an unsupported configuration of the Google-managed project." +"Aborted due to an unsupported configuration of the Google-managed project.", +"Aborted because the source endpoint is a Cloud Run revision with direct VPC access enabled, but there are no reserved serverless IP ranges." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json b/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json index 7ddbe95bbf7..1e1e6b11f07 100644 --- a/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json @@ -961,7 +961,7 @@ } } }, -"revision": "20250205", +"revision": "20250212", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -1006,7 +1006,8 @@ "SOURCE_FORWARDING_RULE_UNSUPPORTED", "NON_ROUTABLE_IP_ADDRESS", "UNKNOWN_ISSUE_IN_GOOGLE_MANAGED_PROJECT", -"UNSUPPORTED_GOOGLE_MANAGED_PROJECT_CONFIG" +"UNSUPPORTED_GOOGLE_MANAGED_PROJECT_CONFIG", +"NO_SERVERLESS_IP_RANGES" ], "enumDeprecated": [ false, @@ -1044,6 +1045,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -1082,7 +1084,8 @@ false "Aborted because tests with a forwarding rule as a source are not supported.", "Aborted because one of the endpoints is a non-routable IP address (loopback, link-local, etc).", "Aborted due to an unknown issue in the Google-managed project.", -"Aborted due to an unsupported configuration of the Google-managed project." +"Aborted due to an unsupported configuration of the Google-managed project.", +"Aborted because the source endpoint is a Cloud Run revision with direct VPC access enabled, but there are no reserved serverless IP ranges." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/networkservices.v1.json b/googleapiclient/discovery_cache/documents/networkservices.v1.json index 88d88c27d94..91ecd2da1e8 100644 --- a/googleapiclient/discovery_cache/documents/networkservices.v1.json +++ b/googleapiclient/discovery_cache/documents/networkservices.v1.json @@ -1057,11 +1057,6 @@ "name" ], "parameters": { -"etag": { -"description": "Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.", -"location": "query", -"type": "string" -}, "name": { "description": "Required. A name of the GrpcRoute to delete. Must be in the format `projects/*/locations/global/grpcRoutes/*`.", "location": "path", @@ -1219,11 +1214,6 @@ "name" ], "parameters": { -"etag": { -"description": "Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.", -"location": "query", -"type": "string" -}, "name": { "description": "Required. A name of the HttpRoute to delete. Must be in the format `projects/*/locations/global/httpRoutes/*`.", "location": "path", @@ -2372,11 +2362,6 @@ "name" ], "parameters": { -"etag": { -"description": "Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.", -"location": "query", -"type": "string" -}, "name": { "description": "Required. A name of the TcpRoute to delete. Must be in the format `projects/*/locations/global/tcpRoutes/*`.", "location": "path", @@ -2534,11 +2519,6 @@ "name" ], "parameters": { -"etag": { -"description": "Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.", -"location": "query", -"type": "string" -}, "name": { "description": "Required. A name of the TlsRoute to delete. Must be in the format `projects/*/locations/global/tlsRoutes/*`.", "location": "path", @@ -2954,7 +2934,7 @@ } } }, -"revision": "20250127", +"revision": "20250212", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { "AuditConfig": { @@ -3559,10 +3539,6 @@ "description": "Optional. A free-text description of the resource. Max length 1024 characters.", "type": "string" }, -"etag": { -"description": "Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.", -"type": "string" -}, "gateways": { "description": "Optional. Gateways defines a list of gateways this GrpcRoute is attached to, as one of the routing rules to route the requests served by the gateway. Each gateway reference should match the pattern: `projects/*/locations/global/gateways/`", "items": { @@ -3860,10 +3836,6 @@ "description": "Optional. A free-text description of the resource. Max length 1024 characters.", "type": "string" }, -"etag": { -"description": "Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.", -"type": "string" -}, "gateways": { "description": "Optional. Gateways defines a list of gateways this HttpRoute is attached to, as one of the routing rules to route the requests served by the gateway. Each gateway reference should match the pattern: `projects/*/locations/global/gateways/`", "items": { @@ -5365,10 +5337,6 @@ "description": "Optional. A free-text description of the resource. Max length 1024 characters.", "type": "string" }, -"etag": { -"description": "Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.", -"type": "string" -}, "gateways": { "description": "Optional. Gateways defines a list of gateways this TcpRoute is attached to, as one of the routing rules to route the requests served by the gateway. Each gateway reference should match the pattern: `projects/*/locations/global/gateways/`", "items": { @@ -5529,10 +5497,6 @@ "description": "Optional. A free-text description of the resource. Max length 1024 characters.", "type": "string" }, -"etag": { -"description": "Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.", -"type": "string" -}, "gateways": { "description": "Optional. Gateways defines a list of gateways this TlsRoute is attached to, as one of the routing rules to route the requests served by the gateway. Each gateway reference should match the pattern: `projects/*/locations/global/gateways/`", "items": { diff --git a/googleapiclient/discovery_cache/documents/rapidmigrationassessment.v1.json b/googleapiclient/discovery_cache/documents/rapidmigrationassessment.v1.json index a1c4be09a3c..78106747142 100644 --- a/googleapiclient/discovery_cache/documents/rapidmigrationassessment.v1.json +++ b/googleapiclient/discovery_cache/documents/rapidmigrationassessment.v1.json @@ -280,7 +280,7 @@ ] }, "delete": { -"description": "Deletes a single Collector - changes state of collector to \"Deleting\". Background jobs does final deletion thorugh producer api.", +"description": "Deletes a single Collector - changes state of collector to \"Deleting\". Background jobs does final deletion through producer API.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collectors/{collectorsId}", "httpMethod": "DELETE", "id": "rapidmigrationassessment.projects.locations.collectors.delete", @@ -633,7 +633,7 @@ } } }, -"revision": "20241211", +"revision": "20250214", "rootUrl": "https://rapidmigrationassessment.googleapis.com/", "schemas": { "Annotation": { diff --git a/googleapiclient/discovery_cache/documents/realtimebidding.v1.json b/googleapiclient/discovery_cache/documents/realtimebidding.v1.json index 9824fcca59e..de59abbd1f0 100644 --- a/googleapiclient/discovery_cache/documents/realtimebidding.v1.json +++ b/googleapiclient/discovery_cache/documents/realtimebidding.v1.json @@ -1305,7 +1305,7 @@ } } }, -"revision": "20250213", +"revision": "20250219", "rootUrl": "https://realtimebidding.googleapis.com/", "schemas": { "ActivatePretargetingConfigRequest": { @@ -1971,7 +1971,7 @@ "type": "array" }, "detectedCategories": { -"description": "Output only. IDs of the detected categories, if any. The taxonomy in which the categories are expressed is specified by the detected_categories_taxonomy field. Can be used to filter the response of the creatives.list method.", +"description": "Output only. IDs of the detected categories. The taxonomy in which the categories are expressed is specified by the detected_categories_taxonomy field. Use this in conjunction with BidRequest.bcat to avoid bidding on impressions where a given ad category is blocked, or to troubleshoot filtered bids. Can be used to filter the response of the creatives.list method.", "items": { "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/servicenetworking.v1.json b/googleapiclient/discovery_cache/documents/servicenetworking.v1.json index ccaabbc0119..e1e716b6e27 100644 --- a/googleapiclient/discovery_cache/documents/servicenetworking.v1.json +++ b/googleapiclient/discovery_cache/documents/servicenetworking.v1.json @@ -1029,7 +1029,7 @@ } } }, -"revision": "20250209", +"revision": "20250218", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { @@ -2018,7 +2018,7 @@ "type": "array" }, "sectionOverrides": { -"description": "Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries", +"description": "Specifies section and content to override the boilerplate content. Currently overrides following sections: 1. rest.service.client_libraries", "items": { "$ref": "Page" }, @@ -2048,7 +2048,7 @@ "type": "string" }, "disableReplacementWords": { -"description": "String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen.", +"description": "String of comma or space separated case-sensitive words for which method/field name replacement will be disabled.", "type": "string" }, "selector": { diff --git a/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json b/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json index 3f96f3a8be4..10626dd7350 100644 --- a/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json +++ b/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json @@ -307,7 +307,7 @@ } } }, -"revision": "20250209", +"revision": "20250218", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { @@ -1130,7 +1130,7 @@ "type": "array" }, "sectionOverrides": { -"description": "Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries", +"description": "Specifies section and content to override the boilerplate content. Currently overrides following sections: 1. rest.service.client_libraries", "items": { "$ref": "Page" }, @@ -1160,7 +1160,7 @@ "type": "string" }, "disableReplacementWords": { -"description": "String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen.", +"description": "String of comma or space separated case-sensitive words for which method/field name replacement will be disabled.", "type": "string" }, "selector": { diff --git a/googleapiclient/discovery_cache/documents/sheets.v4.json b/googleapiclient/discovery_cache/documents/sheets.v4.json index 3a8d0097d47..5208cbd6848 100644 --- a/googleapiclient/discovery_cache/documents/sheets.v4.json +++ b/googleapiclient/discovery_cache/documents/sheets.v4.json @@ -870,7 +870,7 @@ } } }, -"revision": "20250106", +"revision": "20250211", "rootUrl": "https://sheets.googleapis.com/", "schemas": { "AddBandingRequest": { @@ -4970,7 +4970,7 @@ "properties": { "range": { "$ref": "GridRange", -"description": "The range to insert new cells into." +"description": "The range to insert new cells into. The range is constrained to the current sheet boundaries." }, "shiftDimension": { "description": "The dimension which will be shifted when inserting cells. If ROWS, existing cells will be shifted down. If COLUMNS, existing cells will be shifted right.", diff --git a/googleapiclient/discovery_cache/documents/spanner.v1.json b/googleapiclient/discovery_cache/documents/spanner.v1.json index ab62a75ebe7..f77c8e2700d 100644 --- a/googleapiclient/discovery_cache/documents/spanner.v1.json +++ b/googleapiclient/discovery_cache/documents/spanner.v1.json @@ -3348,7 +3348,7 @@ } } }, -"revision": "20250201", +"revision": "20250218", "rootUrl": "https://spanner.googleapis.com/", "schemas": { "AddSplitPointsRequest": { @@ -3356,7 +3356,7 @@ "id": "AddSplitPointsRequest", "properties": { "initiator": { -"description": "Optional. A user-supplied tag associated with the split points. For example, \"intital_data_load\", \"special_event_1\". Defaults to \"CloudAddSplitPointsAPI\" if not specified. The length of the tag must not exceed 50 characters,else will be trimmed. Only valid UTF8 characters are allowed.", +"description": "Optional. A user-supplied tag associated with the split points. For example, \"initial_data_load\", \"special_event_1\". Defaults to \"CloudAddSplitPointsAPI\" if not specified. The length of the tag must not exceed 50 characters,else will be trimmed. Only valid UTF8 characters are allowed.", "type": "string" }, "splitPoints": { @@ -5053,12 +5053,12 @@ "type": "string" }, "nodeCount": { -"description": "The number of nodes allocated to this instance. At most, one of either `node_count` or `processing_units` should be present in the message. Users can set the `node_count` field to specify the target number of nodes allocated to the instance. If autoscaling is enabled, `node_count` is treated as an `OUTPUT_ONLY` field and reflects the current number of nodes allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. For more information, see [Compute capacity, nodes, and processing units](https://cloud.google.com/spanner/docs/compute-capacity).", +"description": "The number of nodes allocated to this instance. At most, one of either `node_count` or `processing_units` should be present in the message. Users can set the `node_count` field to specify the target number of nodes allocated to the instance. If autoscaling is enabled, `node_count` is treated as an `OUTPUT_ONLY` field and reflects the current number of nodes allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. If the instance has varying node count across replicas (achieved by setting `asymmetric_autoscaling_options` in the autoscaling configuration), the `node_count` set here is the maximum node count across all replicas. For more information, see [Compute capacity, nodes, and processing units](https://cloud.google.com/spanner/docs/compute-capacity).", "format": "int32", "type": "integer" }, "processingUnits": { -"description": "The number of processing units allocated to this instance. At most, one of either `processing_units` or `node_count` should be present in the message. Users can set the `processing_units` field to specify the target number of processing units allocated to the instance. If autoscaling is enabled, `processing_units` is treated as an `OUTPUT_ONLY` field and reflects the current number of processing units allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. For more information, see [Compute capacity, nodes and processing units](https://cloud.google.com/spanner/docs/compute-capacity).", +"description": "The number of processing units allocated to this instance. At most, one of either `processing_units` or `node_count` should be present in the message. Users can set the `processing_units` field to specify the target number of processing units allocated to the instance. If autoscaling is enabled, `processing_units` is treated as an `OUTPUT_ONLY` field and reflects the current number of processing units allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. If the instance has varying processing units per replica (achieved by setting `asymmetric_autoscaling_options` in the autoscaling configuration), the `processing_units` set here is the maximum processing units across all replicas. For more information, see [Compute capacity, nodes and processing units](https://cloud.google.com/spanner/docs/compute-capacity).", "format": "int32", "type": "integer" }, @@ -6925,7 +6925,7 @@ "type": "object" }, "multiplexed": { -"description": "Optional. If true, specifies a multiplexed session. Use a multiplexed session for multiple, concurrent read-only operations. Don't use them for read-write transactions, partitioned reads, or partitioned queries. Use CreateSession to create multiplexed sessions. Don't use BatchCreateSessions to create a multiplexed session. You can't delete or list multiplexed sessions.", +"description": "Optional. If true, specifies a multiplexed session. Use a multiplexed session for multiple, concurrent read-only operations. Don't use them for read-write transactions, partitioned reads, or partitioned queries. Use `sessions.create` to create multiplexed sessions. Don't use BatchCreateSessions to create a multiplexed session. You can't delete or list multiplexed sessions.", "type": "boolean" }, "name": { diff --git a/googleapiclient/discovery_cache/documents/vmmigration.v1.json b/googleapiclient/discovery_cache/documents/vmmigration.v1.json index 4893e4634d1..f12d949c213 100644 --- a/googleapiclient/discovery_cache/documents/vmmigration.v1.json +++ b/googleapiclient/discovery_cache/documents/vmmigration.v1.json @@ -2220,7 +2220,7 @@ } } }, -"revision": "20250116", +"revision": "20250213", "rootUrl": "https://vmmigration.googleapis.com/", "schemas": { "AccessKeyCredentials": { @@ -2310,7 +2310,7 @@ "type": "object" }, "AvailableUpdates": { -"description": "Holds informatiom about the available versions for upgrade.", +"description": "Holds information about the available versions for upgrade.", "id": "AvailableUpdates", "properties": { "inPlaceUpdate": { @@ -3514,7 +3514,7 @@ "type": "object" }, "CutoverJob": { -"description": "CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and clonning the VM using the replicated snapshot.", +"description": "CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and cloning the VM using the replicated snapshot.", "id": "CutoverJob", "properties": { "computeEngineDisksTargetDetails": { diff --git a/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json b/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json index 15a13942602..9e4c5e88a8a 100644 --- a/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json @@ -2220,7 +2220,7 @@ } } }, -"revision": "20250116", +"revision": "20250213", "rootUrl": "https://vmmigration.googleapis.com/", "schemas": { "AccessKeyCredentials": { @@ -2310,7 +2310,7 @@ "type": "object" }, "AvailableUpdates": { -"description": "Holds informatiom about the available versions for upgrade.", +"description": "Holds information about the available versions for upgrade.", "id": "AvailableUpdates", "properties": { "inPlaceUpdate": { @@ -3530,7 +3530,7 @@ "type": "object" }, "CutoverJob": { -"description": "CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and clonning the VM using the replicated snapshot.", +"description": "CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and cloning the VM using the replicated snapshot.", "id": "CutoverJob", "properties": { "computeEngineDisksTargetDetails": { diff --git a/googleapiclient/discovery_cache/documents/workflowexecutions.v1.json b/googleapiclient/discovery_cache/documents/workflowexecutions.v1.json index 0260a373fd7..960c64de52e 100644 --- a/googleapiclient/discovery_cache/documents/workflowexecutions.v1.json +++ b/googleapiclient/discovery_cache/documents/workflowexecutions.v1.json @@ -517,7 +517,7 @@ } } }, -"revision": "20241001", +"revision": "20250211", "rootUrl": "https://workflowexecutions.googleapis.com/", "schemas": { "Callback": { @@ -651,7 +651,7 @@ "readOnly": true }, "executionHistoryLevel": { -"description": "Optional. Describes the level of the execution history feature to apply to this execution. If not specified, the level of the execution history feature will be determined by its workflow's execution history level. If the value is different from its workflow's value, it will override the workflow's execution history level for this exeuction.", +"description": "Optional. Describes the execution history level to apply to this execution. If not specified, the execution history level is determined by its workflow's execution history level. If the levels are different, the executionHistoryLevel overrides the workflow's execution history level for this execution.", "enum": [ "EXECUTION_HISTORY_LEVEL_UNSPECIFIED", "EXECUTION_HISTORY_BASIC", @@ -995,7 +995,7 @@ }, "navigationInfo": { "$ref": "NavigationInfo", -"description": "Output only. The NavigationInfo associated to this step.", +"description": "Output only. The NavigationInfo associated with this step.", "readOnly": true }, "routine": { @@ -1029,7 +1029,7 @@ }, "stepEntryMetadata": { "$ref": "StepEntryMetadata", -"description": "Output only. The StepEntryMetadata associated to this step.", +"description": "Output only. The StepEntryMetadata associated with this step.", "readOnly": true }, "stepType": { @@ -1089,7 +1089,7 @@ }, "variableData": { "$ref": "VariableData", -"description": "Output only. The VariableData associated to this step.", +"description": "Output only. The VariableData associated with this step.", "readOnly": true } }, diff --git a/googleapiclient/discovery_cache/documents/workflows.v1.json b/googleapiclient/discovery_cache/documents/workflows.v1.json index 6cefa439a63..77483adbb07 100644 --- a/googleapiclient/discovery_cache/documents/workflows.v1.json +++ b/googleapiclient/discovery_cache/documents/workflows.v1.json @@ -485,7 +485,7 @@ } } }, -"revision": "20241204", +"revision": "20250212", "rootUrl": "https://workflows.googleapis.com/", "schemas": { "Empty": { @@ -777,7 +777,7 @@ "type": "string" }, "executionHistoryLevel": { -"description": "Optional. Describes the level of the execution history feature to apply to this workflow.", +"description": "Optional. Describes the execution history level to apply to this workflow.", "enum": [ "EXECUTION_HISTORY_LEVEL_UNSPECIFIED", "EXECUTION_HISTORY_BASIC",